mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-18 07:33:12 +09:00
Use a diff and author friendly markdown formatting (#370)
Simplify the the way markdown files are formatted to make them easier to author without editors that do auto line breaking, and make the diffs from them simpler to read.
This commit is contained in:
1 parent
a2d56d4a8d
commit
9542246414
21 files changed
+1021
-1788
No files matched your search
@@ -1,16 +1,13 @@
|
||||
Clusterio Global Chat Plugin
|
||||
============================
|
||||
# Clusterio Global Chat Plugin
|
||||
|
||||
Plugin sharing the in-game chat between instances.
|
||||
|
||||
|
||||
Installation
|
||||
============
|
||||
## Installation
|
||||
|
||||
Run the following commands in the folder Clusterio is installed to:
|
||||
|
||||
npm install @clusterio/plugin-global_chat
|
||||
npx clusteriomaster plugin add @clusterio/plugin-global_chat
|
||||
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a
|
||||
dedicate slave or ctl installation respectively.
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
@@ -1,42 +1,31 @@
|
||||
Clusterio Player Auth Plugin
|
||||
============================
|
||||
# Clusterio Player Auth Plugin
|
||||
|
||||
Plugin authenticating logged in players to the web interface.
|
||||
Authentication is achieved by a simple challenge response mechanism
|
||||
where players have to log into one of the Factorio server in the cluster
|
||||
and open a dialog that presents a code, this code is input into the
|
||||
login form on the web interface which gives back a second code. Once
|
||||
the player enters the second code into the dialog in-game the web
|
||||
interface is authenticated.
|
||||
Authentication is achieved by a simple challenge response mechanism where players have to log into one of the Factorio server in the cluster and open a dialog that presents a code, this code is input into the login form on the web interface which gives back a second code.
|
||||
Once the player enters the second code into the dialog in-game the web interface is authenticated.
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
## Installation
|
||||
|
||||
Run the following commands in the folder Clusterio is installed to:
|
||||
|
||||
npm install @clusterio/plugin-player_auth
|
||||
npx clusteriomaster plugin add @clusterio/plugin-player_auth
|
||||
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a
|
||||
dedicate slave or ctl installation respectively.
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
|
||||
|
||||
Master Configuration
|
||||
--------------------
|
||||
## Master Configuration
|
||||
|
||||
#### player_auth.code_length
|
||||
|
||||
Length in character of the generated challenge codes that need to be
|
||||
input between the web interface login form and the in-game Factorio
|
||||
login dialog.
|
||||
Length in character of the generated challenge codes that need to be input between the web interface login form and the in-game Factorio login dialog.
|
||||
|
||||
Defaults to `6`.
|
||||
|
||||
#### player_auth.code_timeout
|
||||
|
||||
Time in seconds the first code generated stays valid. The login must be
|
||||
completed in less than this time starting from when the login dialog is
|
||||
opened in-game.
|
||||
Time in seconds the first code generated stays valid.
|
||||
The login must be completed in less than this time starting from when the login dialog is opened in-game.
|
||||
|
||||
Defaults to `120`.
|
||||
@@ -1,17 +1,13 @@
|
||||
Clusterio Research Sync Plugin
|
||||
==============================
|
||||
# Clusterio Research Sync Plugin
|
||||
|
||||
Plugin synchronizing research progress between instances and the
|
||||
cluster.
|
||||
Plugin synchronizing research progress between instances and the cluster.
|
||||
|
||||
|
||||
Installation
|
||||
============
|
||||
## Installation
|
||||
|
||||
Run the following commands in the folder Clusterio is installed to:
|
||||
|
||||
npm install @clusterio/plugin-research_sync
|
||||
npx clusteriomaster plugin add @clusterio/plugin-research_sync
|
||||
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a
|
||||
dedicate slave or ctl installation respectively.
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
@@ -1,33 +1,24 @@
|
||||
Clusterio Statistics Exporter Plugin
|
||||
====================================
|
||||
# Clusterio Statistics Exporter Plugin
|
||||
|
||||
Plugin exporting item production, fluid production, kill count, entity
|
||||
build and pollution statistics to the Prometheus integration to
|
||||
Clusterio.
|
||||
Plugin exporting item production, fluid production, kill count, entity build and pollution statistics to the Prometheus integration to Clusterio.
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
## Installation
|
||||
|
||||
Run the following commands in the folder Clusterio is installed to:
|
||||
|
||||
npm install @clusterio/plugin-statistics_exporter
|
||||
npx clusteriomaster plugin add @clusterio/plugin-statistics_exporter
|
||||
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a
|
||||
dedicate slave or ctl installation respectively.
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
|
||||
|
||||
Instance Configuration
|
||||
----------------------
|
||||
## Instance Configuration
|
||||
|
||||
### statistics_exporter.command_timeout
|
||||
|
||||
Timeout in seconds to wait for the statitics gathering command to the
|
||||
Factorio server return the result. If the timeout is exceeded the
|
||||
previous collected results are returned instead. Normally the command
|
||||
returns immediatly with the data, but if the RCON interface is
|
||||
overloaded then the command may take too long to timely answer the
|
||||
metrics collection request.
|
||||
Timeout in seconds to wait for the statitics gathering command to the Factorio server return the result.
|
||||
If the timeout is exceeded the previous collected results are returned instead.
|
||||
Normally the command returns immediatly with the data, but if the RCON interface is overloaded then the command may take too long to timely answer the metrics collection request.
|
||||
|
||||
Defaults to `1`.
|
||||
@@ -1,16 +1,13 @@
|
||||
Clusterio Subspace Storage Plugin
|
||||
=================================
|
||||
# Clusterio Subspace Storage Plugin
|
||||
|
||||
Plugin for the Subpsace Storage mod.
|
||||
|
||||
|
||||
Installation
|
||||
============
|
||||
## Installation
|
||||
|
||||
Run the following commands in the folder Clusterio is installed to:
|
||||
|
||||
npm install @clusterio/plugin-subspace_storage
|
||||
npx clusteriomaster plugin add @clusterio/plugin-subspace_storage
|
||||
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a
|
||||
dedicate slave or ctl installation respectively.
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a dedicate slave or ctl installation respectively.
|
||||
Reference in new issue
Block a user