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.

Sign up for GitHub

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(explorer): update README #3088

Closed
wants to merge 1 commit into from
Closed

docs(explorer): update README #3088

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions packages/explorer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ World Explorer is a GUI tool designed for visually exploring and manipulating th
Alternatively, if you have a worlds configuration file:

```sh
npx @latticexyz/explorer --worldsConfigPath <PATH_TO_WORLDS_CONFIG>
npx @latticexyz/explorer --worldsFile <PATH_TO_WORLDS_CONFIG>
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this defaults to the location we put the file in, I think we can remove this arg and let folks figure out how to customize the arg

and maybe instead of "if you have a worlds config file" something like "if you've deployed a world from your project"

Copy link
Contributor Author

@karooolis karooolis Aug 29, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Closing this PR in favor of @qbzzt #3074 , let's take the discussion there, it includes an updated README.


Note: You can use `@latticexyz/store-indexer` for indexing your world's data.
Expand All @@ -35,7 +35,7 @@ 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) | 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 |
Expand Down Expand Up @@ -73,7 +73,7 @@ To contribute to or modify the World Explorer, the easiest way is to run the exa

```yaml
explorer:
shell: pnpm explorer --worldsConfigPath packages/contracts/worlds.json --env development
shell: pnpm explorer --env development
```

3. **Run**
Expand Down
Loading