Skip to content

Commit

Permalink
Update user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Danielv123 committed Jun 10, 2024
1 parent bc26177 commit 7eddd49
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,26 @@ Run the following commands in the folder Clusterio is installed to:

npm install @danielv123/gridworld
npx clusteriocontroller plugin add @danielv123/gridworld
npm install universal_edges
npx clusteriocontroller plugin add universal_edges

Substitute clusteriocontroller with clusteriohost or clusterioctl if this a dedicated host or ctl installation respectively.

## Usage

Open the web UI, navigate to the gridworld page and create a new gridworld. A lobby server will be created. If you want to use a custom map exchange string, navigate to the controller page and set "Gridworld map exchange string" to the long string you get from the game.

Once this is done, join the lobby server and press the "Joing game button". Additional server are created on demand as you explore. The load balancing picks the host with the fewest instances to create the new server on.

### Transfers between servers

The universal_edges plugin is used to transfer items between servers. When an edge is green, it is active and can be used for transfers. Connectors are set up by placing the following items up against the edge:

* Transport belts
* Pipes
* Substations
* Straight rails (the departing train can't leave from a curve, leave a long straight)

![Visualization of this repo](./images/diagram.svg)

## Development setup
Expand Down

0 comments on commit 7eddd49

Please sign in to comment.