We'd love your support in improving Obelisk! This monorepo includes all of Obelisk's source code, and pull requests are always welcome. To discuss new features or changes join our Discord(opens in a new tab).

Local development setup

The following steps are only necessary if you want to contribute to Obelisk. To use Obelisk Engine in your project, set up a new project with the Obelisk CLI.

  1. Install Rust : https://www.rust-lang.org/tools/install (opens in a new tab)

  2. Install Sui (required to build and test Obelisk Move Packages): [https://docs.sui.io/build/install/ (opens in a new tab))

  3. Install pnpm

npm install pnpm --global
  1. Clone the Obelisk monorepo
git clone https://github.com/0xobelisk/engine
  1. Install Obelisk dependencies and setup local environment
cd mud && pnpm install

Pull requests

Obelisk follows the conventional commit specification (opens in a new tab) for commit messages and PR titles. Please keep the scope of your PR small (rather open multiple small PRs than one huge PR) and follow the conventional commit spec.