Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cli): add worldgen to newdocs #1883

Merged
merged 5 commits into from
Nov 13, 2023
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions next-docs/pages/cli/worldgen.mdx
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
# mud worldgen

Autogenerate the MUD World interface based on Systems registered in the World.

Use the `System`s under `src`<sup>1</sup> to generate the Solidity interface definitions for those `Systems` and put them in `src/codegen/world`.
Also, create `src/codegen/world/IWorld.sol` which imports all the `System` interfaces.

(1) By default this is any file that ends with `...System.sol`, for example `IncrementSystem.sol`.
However, in the config file you can specify additional `System`s, under `systems`, as well as exclude files that end in `..System.sol`, by putting them under `excludeSystems`.


## Sample usage

```sh copy
pnpm mud worldgen
```

## Options

These are the command line options you can specify on `mud worldgen`:

| Option | Meaning | Type | Default value |
| -------------- | ------------------------------------------------------------- | ------- | --------------- |
| `--version` | Show version number | boolean | `false` |
| `--configPath` | Path to the config file | string | `mud.config.ts` |
| `--clean` | Clear the worldgen directory before generating new interfaces | boolean | `true` |
| `--help` | Show help | boolean | `false` |

## Debugging

To generate debug messages, use this command:

```sh copy
export DEBUG=mud:common:codegen
```
Loading