Dojo is a community driven open-source, Provable Game Engine, providing a comprehensive toolkit for building verifiable games and autonomous worlds.
Here's a more refined and structured version:
This is a monorepo for the dojo engine npm packages.
- Bun Installation: We use bun in this repository. To install it, run:
curl -fsSL https://bun.sh/install | bash
From the repository root, run the following to install all the necessary package dependencies:
bun install
To link the packages to the examples or your own project, from the root directory, run:
bun link
Note: Before running the examples, you must build each package.
To do so, navigate to a specific package directory and run the command below. This will initiate bun in watch mode, which will automatically compile and update based on local changes:
bun run build --watch
To build all packages, from the root directory, run:
bun run build
To watch for changes on all packages in parallel, from the root directory, run:
bun run build-watch
To install dojo-starter submodule, run:
git submodule update --init --recursive
To scaffold a new project from an example:
npx @dojoengine/create-dojo
If you have issues on WSL, install package first then run command :
npm i @dojoengine/create-dojo -g
npx @dojoengine/create-dojo
To run the examples that have the linked packages, follow the steps below:
Terminal 1: Set up the dojo starter with specific configurations.
cd examples/dojo-starter
katana --disable-fee --block-time 1000
Terminal 2: Build and migrate the dojo starter.
cd examples/dojo-starter
sozo build
sozo migrate
Terminal 3: Start the React app.
cd examples/<package>
bun install
bun dev