Skip to content

Commit

Permalink
update MUD book
Browse files Browse the repository at this point in the history
  • Loading branch information
Ladmv committed Apr 22, 2024
1 parent 39ca5c7 commit ed7b393
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
4 changes: 2 additions & 2 deletions src/build-app/1-build-app-mud.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Lets check out the folder structure first of the [App Template](https://github.c
- `deploy.sh` deploy your app contract and init your app.
- `upload_json.sh` upload your abi to github.
- `mud.config.ts` your app's table and namespace config.
- `.env` contains the values required to deploy the MUD and pixelLAW core
- `.env` contains the values required to deploy the MUD and pixeLAW core

The default App Template includes the contract code of Paint App which allows users to paint any pixel with any color.

Expand All @@ -27,7 +27,7 @@ Let's dive into the code of the [App Template](https://github.com/themetacat/pix

### Imports

At first we require certain imports from the core to enable our paint app. Depending on your use case you might require different imports. Refer to the [Pixel Core](https://github.com/themetacat/pixelaw_core),
At first we require certain imports from the core to enable our paint app. Depending on your use case you might require different imports. Refer to the [PixeLAW Core](https://github.com/themetacat/pixelaw_core),

```solidity
import { System } from "@latticexyz/world/src/System.sol";
Expand Down
11 changes: 7 additions & 4 deletions src/getting-started/quick-start-mud.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,23 @@ git clone https://github.com/themetacat/pixelaw_core pixelaw_core

To make sure everything is working correctly, run the following command to do all things:

```console
cd pixelaw_core && chmod u+x ./start.sh && ./start.sh
```sh
cd pixelaw_core && pnpm install
```
```sh
pnpm run start
```

After some time (around 10 minute) you should be able to see PixeLAW running on [http://localhost:3000](http://localhost:3000).

You should be able to see PixeLAW in its true glory: ![PixelCore](../images/PixelCore.png)

If you run into any issues you can check out the [github repo](https://github.com/pixelaw/app_template/tree/main), and read [start.sh](https://github.com/themetacat/pixelaw_core/blob/main/start.sh) to see the build and deploy details.
If you run into any issues you can check out the [github repo](https://github.com/themetacat/pixelaw_app_template_mud/tree/main), and read [start.sh](https://github.com/themetacat/pixelaw_core/blob/main/start.sh) to see the build and deploy details.

## Next Step

Awesome, you just successfully deployed the Pixel Core.

The next step should be for you to build your own PixeLAW App. We will remain in the `app_template_mud` repo.

Go and be a Pixel Builder and [deploy your own App to the core](../build-app/build-app-mud.md)!
Go and be a Pixel Builder and [deploy your own App to the core](../build-app/1-build-app-mud.md)!

0 comments on commit ed7b393

Please sign in to comment.