/dojo.js

Dojo NPM packages

Primary LanguageTypeScript


discord Github Actions Telegram Chat

Dojo: The Provable Game Engine

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:


Dojo Engine Packages Monorepo

This is a monorepo for the dojo engine npm packages.

Available Packages:


Environment Setup

  1. Bun Installation: We use bun in this repository. To install it, run:
    curl -fsSL https://bun.sh/install | bash

Development

Package Dependencies Installation:

From the repository root, run the following to install all the necessary package dependencies:

bun install

Package Linking:

To link the packages to the examples or your own project, from the root directory, run:

bun link

Building Packages:

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

Dojo starter:

To install dojo-starter submodule, run:

git submodule update --init --recursive

Examples

To run the examples that have the linked packages, follow the steps below:

Terminal 1: Start the React app.

cd examples/react-app
bun install 
bun dev

Terminal 2: Set up the dojo starter with specific configurations.

cd examples/dojo-starter
katana --disable-fee --block-time 1000

Terminal 3: Build and migrate the dojo starter.

cd examples/dojo-starter
sozo build
sozo migrate