Contribute

Contribute

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

You can find a list of good first issues (that don't require a lot of context on the full system) at contribute.mud.dev (opens in a new tab).

Local development setup

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

  1. Ensure you have these applications installed:

    SoftwareTested with version
    curl (opens in a new tab)7.74.0
    node (opens in a new tab)18.17.0
    pnpm (opens in a new tab)8.6.11
    Foundry (opens in a new tab)0.2.0

  2. Download the source code for MUD.

    git clone https://github.com/latticexyz/mud.git
cd mud

  3. Install and build packages.

    pnpm install
pnpm build

Pull requests

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

Advanced featuresChangelog