World Explorer

World Explorer is a GUI tool designed for visually exploring and manipulating the state of worlds. It is available in the MUD TypeScript templates starting with version 2.2.

Usage

If you are running locally a MUD TypeScript template version 2.2 or later, the URL for World Explorer is http://localhost:13690 (opens in a new tab).

CLI options

To use the explorer with different command-line options, use this process:

In the mprocs screen, go down to the explorer process.
Type x to stop the default explorer.
In a different command-line window, go to packages/contract.
Run the explorer using pnpm explorer <options>.

The World Explorer accepts the following CLI arguments:

Argument	Description	Default value
`worldAddress`	The address of the world to explore	None
`worldsFile`	Path to a worlds configuration file (used to resolve world address)	"worlds.json"
`indexerDatabase`	Path to your SQLite indexer database	"indexer.db"
`chainId`	The chain ID of the network	31337
`port`	The port on which to run the World Explorer	13690
`hostname`	The host on which to run the World Explorer	0.0.0.0
`indexerPort`	The port number for the indexer	3001

Installation

These installation steps are needed to add World Explorer to MUD 2.0 and 2.1. In later versions the template already includes World Explorer.

Update to the latest MUD version (optional):

pnpm mud set-version --tag latest
pnpm install

Install the Indexer and World Explorer packages in the project root.
```
pnpm add -w @latticexyz/explorer @latticexyz/store-indexer
```

Edit mprocs.yaml to add the indexer and explorer processes.

mprocs.yaml

procs:
  client:
    cwd: packages/client
    shell: pnpm run dev
  contracts:
    cwd: packages/contracts
    shell: pnpm mud dev-contracts --rpc http://127.0.0.1:8545
  anvil:
    cwd: packages/contracts
    shell: anvil --base-fee 0 --block-time 2
  indexer:
    cwd: packages/contracts
    shell: rm -rf $SQLITE_FILENAME && pnpm sqlite-indexer
    env:
      RPC_HTTP_URL: "http://127.0.0.1:8545"
      FOLLOW_BLOCK_TAG: "latest"
      SQLITE_FILENAME: "indexer.db"
  explorer:
    cwd: packages/contracts
    shell: pnpm explorer

Restart pnpm dev.
Browse to World Explorer (opens in a new tab).

Contributing

See the README (opens in a new tab).

SQL API (Experimental)Hello World