-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from themetacat/main
Add contents about MUD based PixeLAW(not final)
- Loading branch information
Showing
7 changed files
with
60 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
## 📖 The PixeLAW Book | ||
|
||
Explore PixeLAW, an autonomous pixel play ground. [Dive in now](https://pixelaw.github.io/book/). | ||
Explore [PixeLAW](https://www.pixelaw.xyz/), an autonomous pixel play ground. [Dive in now](https://pixelaw.github.io/book/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Build your first Pixel App | ||
|
||
> **_REQUIRED:_** To create your own application in PixeLAW, you must have [set up the PixeLAW Core](../getting-started/quick-start-mud.md) environment locally. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Deploy your app locally | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Quick Start(For MUD) | ||
|
||
## Deploy the Pixel Core locally | ||
Everything in PixeLAW starts with the [core pixel layer](https://github.com/themetacat/pixelaw_core) into which you will deploy your own app. | ||
|
||
Let's get started by deploying the core pixel layer, which includes both the contracts and the PixeLAW front-end. | ||
|
||
## Prerequisites | ||
- [Node.js v18](https://nodejs.org/en/download/package-manager) | ||
- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) | ||
- [Foundry](https://book.getfoundry.sh/getting-started/installation) | ||
- [pnpm](https://pnpm.io/) | ||
` | ||
sudo npm install -g pnpm | ||
` | ||
|
||
## Clone repo | ||
|
||
Please go to [pixelaw\_core\_mud](https://github.com/themetacat/pixelaw_core). And clone it. | ||
|
||
```console | ||
git clone https://github.com/themetacat/pixelaw_core pixelaw_core | ||
``` | ||
|
||
## Build and deploy locally | ||
|
||
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 | ||
``` | ||
|
||
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. | ||
|
||
## 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)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters