Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 2.39 KB

README.md

File metadata and controls

79 lines (52 loc) · 2.39 KB

World Explorer

World Explorer is a GUI tool designed for visually exploring and manipulating the state of worlds. For the full information about it, see the official docs.

Getting started

Prerequisites

World Explorer is not intended to be used alone, and includes the following prerequisites:

Install and run

pnpm add @latticexyz/explorer
pnpm explorer

Or, can be executed with a package bin directly:

npx @latticexyz/explorer

Example setup

For a full working setup, check out the local-explorer example.

You may also want to check out the MUD Quickstart guide to set up a new MUD template project that already comes with the World Explorer included, along with all the prerequisites.

CLI arguments

The World Explorer accepts the following CLI arguments:

Argument Description Default value
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
dev Run the World Explorer in development mode false

Contributing

To contribute to World Explorer, first get familiar with the MUD contribution guidelines. Then, set up the development environment for World Explorer:

  1. Clone MUD

    git clone [email protected]:latticexyz/mud.git
cd mud
pnpm install
pnpm build

  2. Setup

    Navigate to the examples/local-explorer and install dependencies.

    cd examples/local-explorer
pnpm install

  3. Run

    pnpm dev

    Files can now be edited in the packages/explorer directory, and changes will be reflected in the running World Explorer instance.

Links