Skip to content

Commit

Permalink
Merge pull request #4 from themetacat/main
Browse files Browse the repository at this point in the history
Add contents about MUD based PixeLAW(not final)
  • Loading branch information
k1ic authored Mar 15, 2024
2 parents bc82c53 + 31ec568 commit bc4b154
Show file tree
Hide file tree
Showing 7 changed files with 60 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
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/).
2 changes: 1 addition & 1 deletion src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## PixeLAW: Autonomous Pixel Playground

PixeLAW is an anutonomous pixel playground built using [Cairo](https://book.cairo-lang.org/) and [Dojo](https://book.dojoengine.org/) on top of [Starknet](https://book.starknet.io/). PixeLAW has a core layer so that builders can create their own applications top of it. These apps share states and interact each other.
[PixeLAW](https://www.pixelaw.xyz/) is an anutonomous pixel playground, there are two implementations, [one](https://dojo.pixelaw.xyz/) is built using [Cairo](https://book.cairo-lang.org/) and [Dojo](https://book.dojoengine.org/) on top of [Starknet](https://book.starknet.io/), [another](https://mud.pixelaw.xyz/) is built using [Solidity](https://soliditylang.org/) and [MUD](https://mud.dev/) on top of [Redstone](https://redstone.xyz/). [PixeLAW](https://www.pixelaw.xyz/) has a core layer so that builders can create their own applications top of it. These apps share states and interact each other.

This book is dedicated to familiarizing you with PixeLAW and its [vision](https://medium.com/@syora/discovering-pixelaw-the-fully-onchain-planet-ac5e8bb40dfb) to create an [autonomous world](https://book.dojoengine.org/theory/autonomous-worlds.html).

Expand Down
8 changes: 6 additions & 2 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,12 @@

# Getting Started
- [Quick Start](./getting-started/quick-start.md)
- [Build a PixeLAW App](./build-app/1-build-app.md)
- [Deploy a PixeLAW App](./build-app/2-deploy-app.md)
- [For Dojo](./getting-started/quick-start.md)
- [Build a PixeLAW App](./build-app/1-build-app.md)
- [Deploy a PixeLAW App](./build-app/2-deploy-app.md)
- [For MUD](./getting-started/quick-start-mud.md)
- [Build a PixeLAW App](./build-app/1-build-app-mud.md)
- [Deploy a PixeLAW App](./build-app/2-deploy-app-mud.md)

# Community&Contribution
- [Get Started](./cc/get-started.md)
Expand Down
4 changes: 4 additions & 0 deletions src/build-app/1-build-app-mud.md
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.
2 changes: 2 additions & 0 deletions src/build-app/2-deploy-app-mud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Deploy your app locally

45 changes: 45 additions & 0 deletions src/getting-started/quick-start-mud.md
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)!
2 changes: 1 addition & 1 deletion src/getting-started/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Quick Start
# Quick Start(For Dojo)

## Deploy the Pixel Core locally
Everything in PixeLAW starts with the [core pixel layer](https://github.com/pixelaw/core) into which you will deploy your own app.
Expand Down

0 comments on commit bc4b154

Please sign in to comment.