chore(explorer): update world explorer naming (#3069)

latticexyz · Aug 27, 2024 · 0eb2556 · 0eb2556
1 parent da79454
commit 0eb2556
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 22 deletions.
diff --git a/.changeset/swift-rabbits-appear.md b/.changeset/swift-rabbits-appear.md
@@ -2,6 +2,6 @@
 "@latticexyz/explorer": minor
 ---
 
-Initial release of the @latticexyz/explorer package. Explorer is a standalone tool designed to explore and manage worlds. This initial release supports local worlds, with plans to extend support to any world in the future.
+Initial release of the `@latticexyz/explorer` package. World Explorer is a standalone tool designed to explore and manage worlds. This initial release supports local worlds, with plans to extend support to any world in the future.
 
-Read more on how to get started or contribute in the [Explorer README](https://github.com/latticexyz/mud/blob/main/packages/explorer/README.md).
+Read more on how to get started or contribute in the [World Explorer README](https://github.com/latticexyz/mud/blob/main/packages/explorer/README.md).
diff --git a/packages/explorer/README.md b/packages/explorer/README.md
@@ -1,6 +1,6 @@
-# Explorer
+# World Explorer
 
-Explorer is a GUI tool designed for visually exploring and manipulating the state of worlds.
+World Explorer is a GUI tool designed for visually exploring and manipulating the state of worlds.
 
 ## Getting started
 
@@ -14,7 +14,7 @@ Explorer is a GUI tool designed for visually exploring and manipulating the stat
 
    Ensure you have a local development chain running.
 
-3. **Run the explorer**
+3. **Run the World Explorer**
 
    ```sh
    npx @latticexyz/explorer --worldAddress <YOUR_WORLD_ADDRESS>
@@ -30,20 +30,20 @@ Explorer is a GUI tool designed for visually exploring and manipulating the stat
 
 ## CLI arguments
 
-The explorer accepts the following CLI arguments:
+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          |
-| `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 explorer                                      | 13690         |
-| `env`             | The environment to run the explorer in (e.g., "development", "production") | "production"  |
+| 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          |
+| `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         |
+| `env`             | The environment to run the World Explorer in (e.g., "development", "production") | "production"  |
 
 ## Example setup
 
-An example setup is provided in the `examples/local-explorer` directory, demonstrating a full setup for using the explorer in a local development environment:
+An example setup is provided in the `examples/local-explorer` directory, demonstrating a full setup for using the World Explorer in a local development environment:
 
 1. **Setup**
 
@@ -61,15 +61,15 @@ An example setup is provided in the `examples/local-explorer` directory, demonst
 
 ## Contributing
 
-To contribute to or modify the explorer, the easiest way is to run the example setup in `development` mode:
+To contribute to or modify the World Explorer, the easiest way is to run the example setup in `development` mode:
 
 1. **Setup**
 
    Navigate to the `examples/local-explorer` directory and locate the `mprocs.yaml` file.
 
 2. **Configure**
 
-   In `mprocs.yaml`, ensure the explorer command is set up correctly. For example:
+   In `mprocs.yaml`, ensure the `explorer` command is set up correctly. For example:
 
    ```yaml
    explorer:
@@ -82,4 +82,4 @@ To contribute to or modify the explorer, the easiest way is to run the example s
    pnpm dev
    ```
 
-   Files can now be edited in the `packages/explorer` directory, and changes will be reflected in the running explorer instance.
+   Files can now be edited in the `packages/explorer` directory, and changes will be reflected in the running World Explorer instance.
diff --git a/packages/explorer/package.json b/packages/explorer/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@latticexyz/explorer",
   "version": "2.1.1",
-  "description": "Explorer is a tool for visually exploring and manipulating the state of worlds",
+  "description": "World Explorer is a tool for visually exploring and manipulating the state of worlds",
   "type": "module",
   "bin": {
     "explorer": "./dist/explorer.js"

diff --git a/packages/explorer/src/app/Providers.tsx b/packages/explorer/src/app/Providers.tsx
@@ -15,7 +15,7 @@ export const wagmiConfig = createConfig({
     injected(),
     metaMask({
       dappMetadata: {
-        name: "Explorer",
+        name: "World Explorer",
       },
     }),
     safe(),

diff --git a/packages/explorer/src/app/layout.tsx b/packages/explorer/src/app/layout.tsx
@@ -19,8 +19,8 @@ const jetbrains = JetBrains_Mono({
 });
 
 export const metadata: Metadata = {
-  title: "Explorer",
-  description: "Explorer is a tool for visually exploring and manipulating the state of worlds",
+  title: "World Explorer",
+  description: "World Explorer is a tool for visually exploring and manipulating the state of worlds",
 };
 
 export default function RootLayout({