Fix Use of Clustorio in Readme (#6)

This commit is contained in:
2024-11-20 00:16:44 +09:00
committed by Cooldude2606
parent 9dcdc886b3
commit f09c732008

View File

@@ -28,18 +28,18 @@ Explosive Gaming (often ExpGaming) is a server hosting community with a strong f
## Installation
This is a plugin collection for [Clustorio](https://github.com/clusterio/clusterio) which provides all our scenario features.
This is a plugin collection for [Clusterio](https://github.com/clusterio/clusterio) which provides all our scenario features.
To use this plugin you must already have a clustorio instance running, see [here](https://github.com/clusterio/clusterio?tab=readme-ov-file#installation) for clustorio installation instructions.
To use this plugin you must already have a clusterio instance running, see [here](https://github.com/clusterio/clusterio?tab=readme-ov-file#installation) for clusterio installation instructions.
This module is currently not published and therefore can not be installed via `npm`. Instead follow the steps for [building from source](#building-from-source)
## Building from source
1) Create a `external_plugins` directory within your clustorio instance.
1) Create a `external_plugins` directory within your clusterio instance.
2) Clone this repository into that directory: `git clone https://github.com/explosivegaming/ExpCluster`
3) Install the package dev dependencies: `pnpm install`
4) Add the plugins to your clustorio instance such as: `npx clustorioctl plugin add ./external_plugins/ExpCluster/exp_groups`
4) Add the plugins to your clusterio instance such as: `npx clusteriocontroller plugin add ./external_plugins/ExpCluster/exp_groups`
## Contributing