Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pixelaw/game
PixeLAW, the game.
https://github.com/pixelaw/game
Last synced: 28 days ago
JSON representation
PixeLAW, the game.
- Host: GitHub
- URL: https://github.com/pixelaw/game
- Owner: pixelaw
- License: mit
- Archived: true
- Created: 2023-08-08T06:51:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-13T01:02:57.000Z (almost 1 year ago)
- Last Synced: 2024-08-04T01:11:28.797Z (4 months ago)
- Language: TypeScript
- Size: 17.3 MB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starknet - PixeLAW
README
# PixeLAW Game
A game built on top of Dojo. See live example [here](https://pixelaw.aw.oostvoort.work/)
## Prerequisites
- Rust - install [here](https://www.rust-lang.org/tools/install)
- Cairo language server - install [here](https://book.dojoengine.org/development/setup.html#3-setup-cairo-vscode-extension)
- Dojo - install [here](https://book.dojoengine.org/getting-started/quick-start.html)
- Scarb - install [here](https://docs.swmansion.com/scarb/download)
- NodeJS - install [here](https://nodejs.org/en/download)
## Developing Locally
### Step 1: Build the contracts
```shell
make build
```
This command compiles your project and prepares it for execution.
### Step 2: Start Dojo Forkserver
The Dojo Forkserver is a container that has the [Katana RPC](https://book.dojoengine.org/framework/katana/overview.html),
the [Torii World Indexer](https://book.dojoengine.org/framework/torii/overview.html), and a Forkserver
Dashboard. Once the container starts, it starts running Katana, deploys the World Container from the repo
via the contracts volume (See the docker-compose.yml for more details), runs the post_deploy script from
the repo's Scarb.toml, and starts up Torii. The Dojo Forkserver Dashboard is accesible via http://localhost:3000/fork.
```shell
make start_container
```
### Step 3: Get the React frontend ready
```shell
make prep_web
cd web
yarn
```
### Step 4: Run the frontend locally
```shell
cd web
yarn dev
```
### Step 5: Run the queue bot
````shell
cd bots
yarn install
yarn dev
````
#### NOTE
To change accounts, add an account query to the frontend url. For example: http://localhost:3000/?account=1. Add
as many accounts as desired by following the pattern set in the env.example.
The following would be example players:
````console
# for player 1
http://localhost:5173/?account=1
# for player 2
http://localhost:5173/?account=2
````
## Project Structure
This is an overview of the most important folders/files:
- `Makefile` : A collection of helpful commands, mainly for Dojo
- `contracts` : The Dojo Cairo smart contract code
- `src/components.cairo` : Dojo component definitions
- `src/systems.cairo` : Dojo component definitions
- `src/Scarb.toml` : The scarb config file used for katana
- `web` : A [Vite](https://vitejs.dev/) React project
- `.env` : (copied from env.example) Contains the hardcoded developer addresses used for Dojo
- `src/dojo/contractComponents.ts` : Client-side definitions of the components
- `src/dojo/createClientComponents.ts` : Client-side setup of the components
- `src/dojo/createSystemCalls.ts` : Client-side definitions of the systems
## Typical development activities
### Add a DOJO system
- Edit `src/systems.cairo`
- Edit `src/dojo/createSystemCalls.ts`
### Add a DOJO component
- Edit `src/components.cairo`
- Edit `src/dojo/contractComponents.ts`
- Edit `src/dojo/createClientComponents.ts`
### Redeploy to Katana
- Restart Katana
- Redeploy the contracts with `cd contracts && scarb run deploy`
## Troubleshooting / Tricks
### When using vscode, the cairo language server panics with `thread 'main' panicked at 'internal error: entered unreachable code: `
Resolution: None, this is a know issue, can ignore
### When deploying/migrating, consistent exceptions even though the contract compiles.
Resolution: Delete the `contracts/target` dir
### How do I use different accounts while testing?
Register 2 accounts (example from https://github.com/coostendorp/dojo-rps):
```
let player1 = starknet::contract_address_const::<0x1337>();
let player2 = starknet::contract_address_const::<0x1338>();
```
And then switch accounts like this:
```
starknet::testing::set_contract_address(player1);
```