v2.0.0-alpha.10

Small things 6

.dockerignore

@@ -0,0 +1,23 @@
+# No need to invalidate cache just because we try speeding up the build
+.dockerignore
+Dockerfile
+docker-compose*
+
+# Install dependencies during the build
+node_modules
+packages/**/node_modules
+plugins/**/node_modules
+
+# Download factorio during the build
+factorio
+factorio.tar.gz
+
+# We build internal mods during build, mods from local test env should not be applied
+sharedMods
+sharedModsDisabled
+
+# These files should never be required during the build
+.git
+.github
+dist
+temp

.eslintignore

@@ -0,0 +1 @@
+dist/

.eslintrc.js

@@ -0,0 +1,356 @@
+"use strict";
+module.exports = {
+	"plugins": [
+		"node",
+	],
+	"env": {
+		"node": true,
+		"commonjs": true,
+		"es6": true,
+	},
+	"parserOptions": {
+		"ecmaVersion": 11,
+	},
+
+	"overrides": [
+		{
+			"files": ["test/**/*.js", "plugins/*/test/**/*.js"],
+			"env": {
+				"mocha": "true",
+			},
+			"rules": {
+				"prefer-arrow-callback": "off",
+				"no-invalid-this": "off",
+				"node/no-unpublished-import": "off",
+				"node/no-unpublished-require": "off",
+			},
+		},
+		{
+			"files": ["packages/web_ui/src/**/*.jsx", "packages/lib/browser.js", "plugins/*/web/**/*.jsx"],
+			"env": {
+				"browser": true,
+			},
+			"parserOptions": {
+				"sourceType": "module",
+				"ecmaFeatures": {
+					"jsx": true,
+				},
+			},
+			"rules": {
+				"node/callback-return": "off",
+				"node/exports-style": "off",
+				"node/file-extension-in-import": "off",
+				"node/global-require": "off",
+				"node/handle-callback-err": "off",
+				"node/no-callback-literal": "off",
+				"node/no-deprecated-api": "off",
+				"node/no-exports-assign": "off",
+				"node/no-extraneous-import": "off",
+				"node/no-extraneous-require": "off",
+				"node/no-missing-import": "off",
+				"node/no-missing-require": "off",
+				"node/no-mixed-requires": "off",
+				"node/no-new-require": "off",
+				"node/no-path-concat": "off",
+				"node/no-process-env": "off",
+				"node/no-process-exit": "off",
+				"node/no-restricted-require": "off",
+				"node/no-sync": "off",
+				"node/no-unpublished-bin": "off",
+				"node/no-unpublished-import": "off",
+				"node/no-unpublished-require": "off",
+				"node/no-unsupported-features/es-builtins": "off",
+				"node/no-unsupported-features/es-syntax": "off",
+				"node/no-unsupported-features/node-builtins": "off",
+				"node/prefer-global/buffer": "off",
+				"node/prefer-global/console": "off",
+				"node/prefer-global/process": "off",
+				"node/prefer-global/text-decoder": "off",
+				"node/prefer-global/text-encoder": "off",
+				"node/prefer-global/url-search-params": "off",
+				"node/prefer-global/url": "off",
+				"node/prefer-promises/dns": "off",
+				"node/prefer-promises/fs": "off",
+				"node/process-exit-as-throw": "off",
+				"node/shebang": "off",
+			},
+		},
+	],
+
+	"rules": {
+		"accessor-pairs": "error",
+		"array-bracket-newline": "off",
+		"array-bracket-spacing": ["error", "never"],
+		"array-callback-return": "error",
+		"array-element-newline": "off",
+		"arrow-body-style": "error",
+		"arrow-parens": "off",
+		"arrow-spacing": ["error", { "after": true, "before": true }],
+		"block-scoped-var": "error",
+		"block-spacing": "error",
+		"brace-style": ["error", "1tbs", { "allowSingleLine": true }],
+		"camelcase": "off",
+		"capitalized-comments": "off",
+		"class-methods-use-this": "off",
+		"comma-dangle": [
+			"error",
+			{
+				"arrays": "always-multiline",
+				"objects": "always-multiline",
+				"imports": "always-multiline",
+				"exports": "always-multiline",
+				"functions": "only-multiline",
+			},
+		],
+		"comma-spacing": "error",
+		"comma-style": ["error", "last"],
+		"complexity": "error",
+		"computed-property-spacing": ["error", "never"],
+		"consistent-return": "error",
+		"consistent-this": "error",
+		"curly": "error",
+		"default-case": "error",
+		"default-case-last": "error",
+		"default-param-last": "error",
+		"dot-location": ["error", "property"],
+		"dot-notation": ["error", { "allowPattern": "^[a-z]+(_[a-z]+)*$" }],
+		"eol-last": "error",
+		"eqeqeq": "error",
+		"func-call-spacing": "error",
+		"func-name-matching": "error",
+		"func-names": "off",
+		"func-style": ["error", "declaration"],
+		"function-call-argument-newline": "off",
+		"function-paren-newline": "off",
+		"generator-star-spacing": ["error", { "before": false, "after": true }],
+		"grouped-accessor-pairs": "error",
+		"guard-for-in": "error",
+		"id-blacklist": "error",
+		"id-length": "off",
+		"id-match": "error",
+		"implicit-arrow-linebreak": "error",
+		"indent": ["error", "tab", { "SwitchCase": 1 }],
+		"indent-legacy": "off",
+		"init-declarations": "off",
+		"jsx-quotes": "error",
+		"key-spacing": "error",
+		"keyword-spacing": "error",
+		"line-comment-position": "off",
+		"linebreak-style": ["error", "unix"],
+		"lines-around-comment": "off",
+		"lines-around-directive": "off",
+		"lines-between-class-members": ["error", "always"],
+		"max-classes-per-file": "off",
+		"max-depth": "error",
+		"max-len": ["error", { "code": 120 }],
+		"max-lines": "off",
+		"max-lines-per-function": "off",
+		"max-nested-callbacks": "error",
+		"max-params": "off",
+		"max-statements": "off",
+		"max-statements-per-line": "off",
+		"multiline-comment-style": ["error", "separate-lines"],
+		"multiline-ternary": "off",
+		"new-cap": "error",
+		"new-parens": "error",
+		"newline-after-var": "off",
+		"newline-before-return": "off",
+		"newline-per-chained-call": "off",
+		"no-alert": "error",
+		"no-array-constructor": "error",
+		"no-await-in-loop": "off",
+		"no-bitwise": "off",
+		"no-buffer-constructor": "error",
+		"no-caller": "error",
+		"no-catch-shadow": "error",
+		"no-confusing-arrow": "error",
+		"no-console": "error",
+		"no-constant-condition": ["error", { "checkLoops": false }],
+		"no-constructor-return": "error",
+		"no-continue": "off",
+		"no-div-regex": "error",
+		"no-duplicate-imports": "error",
+		"no-else-return": "error",
+		"no-empty-function": "off",
+		"no-eq-null": "error",
+		"no-eval": "error",
+		"no-extend-native": "error",
+		"no-extra-bind": "error",
+		"no-extra-label": "error",
+		"no-extra-parens": "off",
+		"no-floating-decimal": "error",
+		"no-implicit-coercion": "error",
+		"no-implicit-globals": "error",
+		"no-implied-eval": "error",
+		"no-inline-comments": "off",
+		"no-invalid-this": "error",
+		"no-iterator": "error",
+		"no-label-var": "error",
+		"no-lone-blocks": "error",
+		"no-lonely-if": "error",
+		"no-loop-func": "error",
+		"no-magic-numbers": "off",
+		"no-mixed-operators": [
+			"error",
+			{
+				"groups": [
+					["&", "|", "^", "~", "<<", ">>", ">>>"],
+					["==", "!=", "===", "!==", ">", ">=", "<", "<="],
+					["in", "instanceof"],
+				],
+			},
+		],
+		"no-multi-assign": "error",
+		"no-multi-spaces": "error",
+		"no-multi-str": "error",
+		"no-multiple-empty-lines": "error",
+		"no-native-reassign": "error",
+		"no-negated-condition": "off",
+		"no-negated-in-lhs": "error",
+		"no-nested-ternary": "error",
+		"no-new": "error",
+		"no-new-func": "error",
+		"no-new-object": "error",
+		"no-new-wrappers": "error",
+		"no-octal-escape": "error",
+		"no-param-reassign": "off",
+		"no-plusplus": ["error", { "allowForLoopAfterthoughts": true }],
+		"no-proto": "error",
+		"no-restricted-exports": "error",
+		"no-restricted-globals": "error",
+		"no-restricted-imports": "error",
+		"no-restricted-properties": "error",
+		"no-restricted-syntax": "error",
+		"no-return-assign": "error",
+		"no-return-await": "off",
+		"no-script-url": "error",
+		"no-self-compare": "error",
+		"no-sequences": "error",
+		"no-shadow": ["error", { "allow": ["yargs"] }],
+		"no-spaced-func": "error",
+		"no-tabs": ["error", { "allowIndentationTabs": true }],
+		"no-template-curly-in-string": "error",
+		"no-ternary": "off",
+		"no-throw-literal": "error",
+		"no-trailing-spaces": "error",
+		"no-undef-init": "error",
+		"no-undefined": "off",
+		"no-unmodified-loop-condition": "error",
+		"no-unneeded-ternary": "error",
+		"no-unused-expressions": "error",
+		"no-use-before-define": "error",
+		"no-useless-backreference": "error",
+		"no-useless-call": "error",
+		"no-useless-computed-key": "error",
+		"no-useless-concat": "error",
+		"no-useless-constructor": "error",
+		"no-useless-rename": "error",
+		"no-useless-return": "error",
+		"no-var": "error",
+		"no-void": ["error", { "allowAsStatement": true }],
+		"no-warning-comments": "off",
+		"no-whitespace-before-property": "error",
+		"nonblock-statement-body-position": "error",
+		"object-curly-newline": "error",
+		"object-curly-spacing": "off",
+		"object-shorthand": "off",
+		"one-var": "off",
+		"one-var-declaration-per-line": "error",
+		"operator-assignment": "off",
+		"operator-linebreak": ["error", "after", {
+			"overrides": {
+				"?": "before",
+				":": "before",
+				"||": "before",
+				"&&": "before",
+			},
+		}],
+		"padded-blocks": "off",
+		"padding-line-between-statements": "error",
+		"prefer-arrow-callback": "error",
+		"prefer-const": "off",
+		"prefer-destructuring": "off",
+		"prefer-exponentiation-operator": "error",
+		"prefer-named-capture-group": "off",
+		"prefer-numeric-literals": "error",
+		"prefer-object-spread": "error",
+		"prefer-promise-reject-errors": "error",
+		"prefer-reflect": "off",
+		"prefer-regex-literals": "error",
+		"prefer-rest-params": "error",
+		"prefer-spread": "error",
+		"prefer-template": "error",
+		"quote-props": "off",
+		"quotes": ["error", "double", { "avoidEscape": true }],
+		"radix": ["error", "always"],
+		"require-atomic-updates": "off", // XXX Not sure why this triggers on process.title = ...
+		"require-await": "off",
+		"require-jsdoc": "off",
+		"require-unicode-regexp": "off",
+		"rest-spread-spacing": ["error", "never"],
+		"semi": "error",
+		"semi-spacing": "error",
+		"semi-style": "off",
+		"sort-imports": "off",
+		"sort-keys": "off",
+		"sort-vars": "error",
+		"space-before-blocks": "error",
+		"space-before-function-paren": "off",
+		"space-in-parens": ["error", "never"],
+		"space-infix-ops": "off",
+		"space-unary-ops": "error",
+		"spaced-comment": ["error", "always"],
+		"strict": "error",
+		"switch-colon-spacing": "error",
+		"symbol-description": "error",
+		"template-curly-spacing": ["error", "never"],
+		"template-tag-spacing": "error",
+		"unicode-bom": ["error", "never"],
+		"valid-jsdoc": ["error", { "requireReturn": false }],
+		"vars-on-top": "error",
+		"wrap-iife": "error",
+		"wrap-regex": "off",
+		"yield-star-spacing": "error",
+		"yoda": ["error", "never", { "exceptRange": true }],
+
+		"node/callback-return": "off",
+		"node/exports-style": "off",
+		"node/file-extension-in-import": "off",
+		"node/global-require": "error",
+		"node/handle-callback-err": "error",
+		"node/no-callback-literal": "error",
+		"node/no-deprecated-api": "error",
+		"node/no-exports-assign": "error",
+		"node/no-extraneous-import": "error",
+		"node/no-extraneous-require": "error",
+		"node/no-missing-import": "error",
+		"node/no-missing-require": "error",
+		"node/no-mixed-requires": "error",
+		"node/no-new-require": "error",
+		"node/no-path-concat": "error",
+		"node/no-process-env": "error",
+		"node/no-process-exit": "error",
+		"node/no-restricted-require": "off",
+		"node/no-sync": "error",
+		"node/no-unpublished-bin": "error",
+		"node/no-unpublished-import": "error",
+		"node/no-unpublished-require": [
+			"error",
+			{ "allowModules": ["webpack", "webpack-merge", "webpack-dev-middleware"] },
+		],
+		"node/no-unsupported-features/es-builtins": "error",
+		"node/no-unsupported-features/es-syntax": "error",
+		"node/no-unsupported-features/node-builtins": "error",
+		"node/prefer-global/buffer": "error",
+		"node/prefer-global/console": "error",
+		"node/prefer-global/process": "error",
+		"node/prefer-global/text-decoder": "error",
+		"node/prefer-global/text-encoder": "error",
+		"node/prefer-global/url-search-params": "error",
+		"node/prefer-global/url": "error",
+		"node/prefer-promises/dns": "off",
+		"node/prefer-promises/fs": "off",
+		"node/process-exit-as-throw": "error",
+		"node/shebang": "error",
+	},
+};

.gitattributes

@@ -0,0 +1 @@
+package-lock.json -diff

.github/workflows/docker-publish.yml

@@ -0,0 +1,159 @@
+name: Docker
+
+on:
+  push:
+    # Publish `master` as Docker `latest` image.
+    branches:
+      - '**'
+
+    # Publish `v1.2.3` tags as releases.
+    tags:
+      - v*
+
+  # Run tests for any PRs.
+  pull_request:
+
+  release:
+    types: [released, prereleased]
+
+env:
+  # TODO: Change variable to your image's name.
+  IMAGE_NAME: clusterio
+
+jobs:
+  # Build dependencies and clusterio image
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Build docker image
+        run: DOCKER_BUILDKIT=1 docker build . -t $IMAGE_NAME --target clusterio_final
+
+      - name: Export docker image
+        run: docker save -o clusterio_docker_image $IMAGE_NAME
+
+      - name: Upload docker image
+        uses: actions/upload-artifact@master
+        with:
+          name: clusterio_docker_image
+          path: clusterio_docker_image
+  # Build dependencies and clusterio image with test tooling
+  build_testing:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Build docker image
+        run: DOCKER_BUILDKIT=1 docker build . -t $IMAGE_NAME --target clusterio_testing
+
+      - name: Export docker image
+        run: docker save -o clusterio_docker_image_testing $IMAGE_NAME
+
+      - name: Upload docker image
+        uses: actions/upload-artifact@master
+        with:
+          name: clusterio_docker_image_testing
+          path: clusterio_docker_image_testing
+  # Upload clusterio_lib and subspace_storage versions
+  upload_mods:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download docker image
+        uses: actions/download-artifact@master
+        with:
+          name: clusterio_docker_image
+          path: .
+
+      - name: Load docker image
+        run: docker load -i clusterio_docker_image
+      
+      - name: Create container
+        run: docker create --name clusterio_container $IMAGE_NAME
+
+      - name: Move mods out of container
+        run: docker cp clusterio_container:/clusterio/sharedMods ./mods
+
+      - name: Remove container
+        run: docker rm clusterio_container
+
+      - name: List extracted mods
+        run: ls mods
+
+      - name: Upload mods
+        uses: actions/upload-artifact@master
+        with:
+          name: mods
+          path: mods
+  # Run tests.
+  # See also https://docs.docker.com/docker-hub/builds/automated-testing/
+  test:
+    needs: build_testing
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Download docker image
+        uses: actions/download-artifact@master
+        with:
+          name: clusterio_docker_image_testing
+          path: .
+      - name: ls
+        run: ls && ls clusterio_docker_image_testing && ls /home/runner/work/clusterio && ls /home/runner/work/clusterio/clusterio
+      - name: Load docker image
+        run: docker load -i clusterio_docker_image_testing
+
+      - name: Run tests
+        run: |
+          if [ -f docker-compose.test.yml ]; then
+            docker-compose --file docker-compose.test.yml run unit_test
+          else
+            docker build . --file Dockerfile
+          fi
+  # Push image to GitHub Packages.
+  # See also https://docs.docker.com/docker-hub/builds/
+  push:
+    # Ensure test job passes before pushing image.
+    needs: [test, build]
+
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Download artifact
+        uses: actions/download-artifact@master
+        with:
+          name: clusterio_docker_image
+          path: .
+
+      - name: Load docker image
+        run: docker load -i clusterio_docker_image
+
+      - name: Log into registry
+        run: echo "${{ secrets.CR_PAT }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
+
+      - name: Push image
+        run: |
+          IMAGE_ID=ghcr.io/${{ github.actor }}/$IMAGE_NAME
+
+          # Change all uppercase to lowercase
+          IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
+
+          # Strip git ref prefix from version
+          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+
+          # Strip "v" prefix from tag name
+          [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
+
+          # Use Docker `latest` tag convention
+          [ "$VERSION" == "master" ] && VERSION=latest
+
+          echo IMAGE_ID=$IMAGE_ID
+          echo VERSION=$VERSION
+
+          docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
+          docker push $IMAGE_ID:$VERSION

.gitignore

@@ -11,8 +11,9 @@ pids
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov
 
-# Coverage directory used by tools like istanbul
+# Coverage directories used by tools like nyc and codecov
 coverage
+.nyc_output
 
 # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
@@ -22,29 +23,28 @@ coverage
 
 # Compiled binary addons (http://nodejs.org/api/addons.html)
 build/Release
+dist/
 
-node_modules/*
-!node_modules/_app
+# Autogenerated docs output
+/docs/api
+
+node_modules
 
 Factorio*
 /factorio
 /instances
 /sharedMods
 /database
-database/items.db
-config.json
+/plugin-list.json
+/config-master.json
+/config-control.json
+/config-slave.json
 package-lock.json
-secret-api-token.txt
 mod_cache.json
-static/pictures/spritesheet.js
-static/pictures/spritesheet.png
-static/external
+static/export
+saves
+/temp/
 
-# weird pattern to ignore sharedPlugins except not ignore some core modules
-!sharedPlugins/
-sharedPlugins/*
-!sharedPlugins/inventoryImports/
-!sharedPlugins/UPSdisplay/
-!sharedPlugins/remoteMap/
-!sharedPlugins/remoteCommands/
-!sharedPlugins/researchSync/
+# IDE
+.idea/
+.vs/

.travis.yml

@@ -1,10 +1,15 @@
 language: node_js
 node_js:
-  - "node"
+  - 12
 before_install:
-  - sudo apt-get -qq update
-  - sudo apt-get install -y curl git tar
   - curl -o factorio.tar.gz -L https://www.factorio.com/get-download/latest/headless/linux64
-  - tar -xvf factorio.tar.gz
+  - tar -xf factorio.tar.gz
+  - npm install -g codecov
 script:
-  - npm run cover
+  - npx lerna bootstrap --hoist --no-ci
+  - node packages/lib/build_mod --source-dir packages/slave/lua/clusterio_lib --output-dir temp/test/sharedMods
+  - curl -o temp/test/sharedMods/subspace_storage_1.99.8.zip -L https://github.com/clusterio/subspace_storage/releases/download/1.99.6/subspace_storage_1.99.8.zip
+  - npx lerna run build
+  - npm run-script ci-cover
+  - codecov -f coverage/lcov.info
+  - npm run-script lint

CHANGELOG.md

@@ -0,0 +1,195 @@
+# Changelog
+
+## Version 2.0.0
+
+### Major Features
+
+- Replaced Hotpatch with save patching.
+  Removed the Hotpatch scenario and the depency on it for getting code into the game.
+  Added a save patcher than runs before starting up Factorio that patches in lua modules based on the event_loader lib into the savegame.
+  Regular freeplay games can now be used with Clusterio and will be compatible without having to convert them to Hotpatch.
+- Daemonized slaves.
+  Slaves now have the ability to run multiple Factorio instances, starting and stopping them individually.
+  To manage this the local command line interface has been replaced with a remote interface on the master server that can be accessed through the clusterioctl cli tool.
+- Rewritten the communication between slaves and the master from scratch.
+  The new system is based on a WebSocket connection between the slaves and the master server and provides efficient validated bi-directonal communication.
+- Rewritten the plugin system from scratch.
+  Plugins now inherit from a base class and use the same WebSocket connection Clusterio uses to communicate.
+- New configuration system with support for initializing configs when needed, modifying config entries using built-in commands, and updating instance configuration remotely.
+- Packaged and uploaded to npm again, greatly simplifying distribution and installation of both Clusterio and plugins.
+- Added centralized logging for the cluster.
+  All logs from both Clusterio and Factorio is stored in a shared log which can be inspected and queried.
+- Added remote save management with the ability to list, create, upload, download, delete and load saves for instances.
+
+### Features
+
+- Added export of pollution statitics.
+- Reconnection logic that esures no data is dropped talking to the master server provided the session can be resumed.
+- Added support for having multiple Factorio installs and selecting which version to use on a per instance basis.
+- Added config to specify which path the master interface is accessed under, allowing it to be proxied behind web-server.
+- Added WebSocket usage statistics.
+- Added commands sent statistic.
+- Added Factorio server CPU and memory usage statistic.
+- Added Factorio autosave size statistic.
+- Added support for extracting locale and item icons from Factorio and mods.
+- Added integrated user management for controlling access and storing per player data.
+- Added synchronization of in-game adminlist, banlist and whitelist to Clusterio core.
+  Previously this was handled by the playerManager plugin.
+- Added stripping of long paths in the Factorio server log.
+- Added option to configure maximum number of commands to send in parallel.
+- Added option to auto start instances on slave startup.
+- Added metric mapping of slave and instance ids to their names, allowing them to be displayed by name in queries that join with the mapping.
+- Added option to configure timeout for exported Prometheus metrics.
+- Added option to set address to bind HTTP(S) port to.
+- Added an overview of the installed plugins to the web interface.
+- Added clusterioctl command to list plugins on the master server.
+- Added Player Auth plugin for logging in to the web interface by proving the ability to log in to a server as a given user.
+- Added Node.js based installer to simplify setting up a cluster.
+
+### Changes
+
+- Added error handling during master startup.
+- Factorio game and rcon port now defaults to a random port above 49151.
+- Removed unimplemented mods update command.
+- Fixed rcon password being generated with Math.random().
+- Added plugins directory to the views path.
+  This makes it possible for plugins to render their own ejs views or pages in their own folders by using paths of the format "pluginName/path/to/page-or-view".
+- Replaced the per instance copy of the shared Factorio mods with symlinks.
+  On Windows hard links are used instead due to the privileges requirements of symlinks.
+- Changed the per instance scenario folder to be linked instead of copied on instance creation.
+- Instance id is no longer derived from the rcon password, instead it's generated upon instance creation and stored in the instance config.
+- The game port, RCON port and RCON password instance config entries are are now null by default, indicating that a random one will be generated every time the instance is started.
+- Removed the broken client download command as this would download pre-releases.
+- Moved the item database and HTTP definitions for /api/place, /api/remove, /api/inventory, /api/inventoryAsObject and the web interface view for the storage page into the clusterioMod plugin.
+  If you disable this plugin then these things will not be available.
+- Removed undocumented --port and --rcon-port arguments to client.
+- Removed undocumented FACTORIOPORT and RCONPORT enviroment variable handling in client.
+- Removed redundant call to /api/slaves in globalChat plugin.
+- Removed broken serverManager plugin.
+- Removed factorio_version from config.
+  The version installed is auto detected and used instead.
+- Removed the playerManager specific command CLI tools/delete_player.js.
+- Creating an instance, assigning it to a slave, creating a save for an instance and starting an instance is now four separate commands.
+- Removed oddball limits to slaves.json size.
+- Moved slave specific and instance specific configuration into their own configuration files.
+- Removed unused binary option from plugin config.
+- Removed info and shout command from globalChat plugin - Removed mirrorAllChat and enableCrossServerShout configuration options for globalChat plugin.
+- Removed UPSdisplay plugin.
+  UPS statistics is exported by the statistics exporter plugin.
+- Master server now defaults to hosting on https on port 8443.
+- Renamed client to slave.
+- Removed rotation of factorio-current.log files.
+
+### Breaking Changes
+
+- Removed lib/authenticate.
+  Breaks playerManager.
+- The masterIP and masterPort config entries has been merged into masterURL.
+  Breaks discordChat, playerManager, serverSelect, trainTeleports and clusterioModel.
+- Instance names can no longer be invalid Windows file names.
+- Removed config management from the command line and the server manager.
+- Moved ejs templates into views folder and changed their extension to .ejs.
+  Breaks playerManager.
+- Mods are no longer copied from the per instance instanceMods directory.
+  If you need per instance mods you can now place them directly in the mods directory inside the instance folder.
+- Hotpatch scenarios and code loading is no longer compatible with Clusterio.
+  Breaks playerManager, serverSelect, and tranTeleports.
+- Removed getLua and getCommand from lib/clusterTools.
+  If you need to run more than the most trivial of code in commands use the save patcher and add in a remote interface.
+- Removed mod uploading and distributing from the HTTP interface.
+  Breaks the old unmaintained and no longer needed factorioClusterioClient.
+- Removed the remoteCommands plugin and the old runCommand interface.
+  Breaks playerManager and external tools sending commands.
+- Removed broken serverManager plugin.
+- Removed fields info, time, rconPort, rconPassword, serverPort, unique, mods, instanceName, playerCount, mac, and meta from the slaves in the slave database.
+- Removed getInstanceName and lib/clusterTools.
+  Breaks playerManager, and discordChat.
+- Removed the /api/rconPasswords, and /api/slaves endpoints.
+  Breaks web interface, trainTeleports, and discordChat.
+- Removed the /api/getSlaveMeta and /api/editSlaveMeta endpoints.
+  Breaks researchSync, and UPSdisplay.
+- Removed the hello event from the socket connection handshake.
+  Breaks playerManager, trainTeleports, serverSelect, and discordChat
+- Changed the format of database/slaves.json.
+- Removed the output file subscription system.
+  Breaks inventoryImports, playerManager, trainTeleports, serverSelect and researchSync.
+- Removed the factorioOutput hook from instance plugins.
+  The onOutput hook provides parsed output instead.
+- Removed the onLoadFinish hook from master plugins.
+- Moved plugins from the sharedPlugins directory to plugins directory.
+- Implemented a new plugin system that replaces the old.
+  Breaks all plugins.
+- Removed express metric http_request_duration_milliseconds metric.
+- Removed socket.io metrics socket_io_connected, socket_io_connect_total, socket_io_disconnect_total, socket_io_events_received_total, socket_io_events_sent_total, socket_io_recieve_bytes, and socket_io_transmit_bytes,
+- Removed clusterio_connected_instaces_gauge and added clusterio_master_connected_clients_count in its place.
+- Renamed clusterio_player_count_gauge to clusterio_statistics_exporter_instance_player_count
+- Removed clusterio_UPS_gauge and added clusterio_statistics_exporter_instance_game_ticks_total in its place.
+- Renamed clusterio_endpoint_hit_gauge to clusterio_http_enpoint_hits_total
+- Renamed clusterio_statistics_gauge to clusterio_statistics_exporter_instance_force_flows
+- Renamed clusterio_nn_dole_gauge to clusterio_subspace_storage_nn_dole_gauge.
+- Renamed clusterio_dole_factor_gauge to clusterio_subspace_storage_dole_factor_gauge.
+- Renamed clusterio_import_gauge to clusterio_subspace_storage_import_total.
+- Renamed clusterio_export_gauge to clusterio_subspace_storage_export_total.
+- Renamed clusterio_master_inventory_gauge to clusterio_subspace_storage_master_inventory.
+- Removed clusterioMod plugin specific config options logItemTransfers, disableFairItemDistribution useNeuralNetDoleDivider, autosaveInterval, and disableImportsOfEverythingExceptElectricity from the master config.
+- Removed msBetweenCommands config option.
+  The RCON is instead limited to 5 concurrent commands.
+- Removed allowRemoteCommandExecution config option.
+  Remote commands are always allowed with the move to master managing slaves/instances.
+- Removed `--databaseDirectory`, `--masterPort`, and `--sslPort` command line arguments from the master server.
+- Implemented a new config system that replaces the old.
+  Breaks all plugins.
+- Removed usage of socket.io entirely in favor of a plain WebSocket connection.
+- Renamed clusterioMod plugin to subspace_storage.
+- Master no longer creates secret-api-token.txt.
+- Removed automatic creation of self-signed TLS certificate.
+- Node.js versions below 12 are no longer supported.
+
+
+## Version 1.2.4
+
+- Removed broken remote combinator signaling.
+- Fixed research sync endlessly updating already researched technologies
+- Removed obsolete item/fluid statistics from clusterioMod
+- Removed per mod upload logging when config.uploadModsToMaster disabled
+- Fixed bcrypt failing to install on windows due to the new version not having Windows binaries.
+
+
+## Version 1.2.3
+
+- Disabled uploading mods to the master server by default as this is mostly just a waste of bandwidth with the mod portal being integrated into the game now.
+- Fixed researchSync breaking with heavily modded games due to the tech tree exceeding the default 100kb limit on JSON payloads.
+- Fixed the command inventoryImport sends referencing player instead of character, and trying to count the non-existant quick bar slots.
+- Fixed inventoryImport never receiving the script output after the default mode for reading script output changed to tail mode.
+- Fixed desync caused by the mods and loaded mods arrays in Hotpatch getting out of sync when plugins update their scenario mod code.
+  To fix existing games you will need copy lib/scenarios/Hotpatch/hotpatch/mod-tools.lua over the existing mod-tools.lua in the save's hotpatch folder.
+- Updated the Windows install instructions.
+
+
+## Version 1.2.2
+
+- Fixed possible crash with modded technologies named the same as a built-in Object prototype property in researchSync.
+- Fixed progress of a current infinite tech carrying over to the next one when researching it and another node completes it in researchSync.
+- Fixed progress of a previous infinite tech from another node being applied to the current one in researchSync.
+- Fixed crash in researchSync when modded technologies are present only on some nodes.
+- Fixed install failing due to bcrypt version less than 3 not being supported on node v10.
+- Reordered install instructions to avoid problem with npm creating files owned by root in the home directory.
+- Swapped curl out with wget in the install instructions as the latter comes pre-installed on Ubuntu.
+
+### Breaking Changes
+
+- Node.js versions below 10 are no longer supported.
+
+
+## Version 1.2.1
+
+- Updated node-factorio-api to v0.3.8 to fix mod downloads randomly breaking ([#229][#229]).
+- Fixed SIGINT being sent twice to Factorio server when interrupted by CTRL+C on Linux ([#217][#217]).
+- Fixed package.json incorrectly reporting the license as ISC.
+
+[#217]: https://github.com/clusterio/clusterio/issues/217
+[#229]: https://github.com/clusterio/clusterio/issues/229
+
+### Breaking Changes
+
+- Added authentication to the socket.io server running on the master.

Dockerfile

@@ -1,19 +1,63 @@
-FROM node:latest
-RUN apt-get update && apt install git -y
+FROM node:12 as subspace_storage_builder
+RUN apt update && apt install -y git
+WORKDIR /
+RUN git clone https://github.com/clusterio/subspace_storage.git
+WORKDIR /subspace_storage
+RUN npm install \
+&& node build
 
-RUN mkdir factorioClusterio
-RUN git clone -b dev https://github.com/Danielv123/factorioClusterio.git && cd factorioClusterio && npm install && curl -o factorio.tar.gz -L https://www.factorio.com/get-download/latest/headless/linux64 && tar -xvzf factorio.tar.gz
+FROM node:12 as clusterio_builder
+RUN apt update \
+&& apt install -y wget \
+&& mkdir /clusterio
+WORKDIR /clusterio
+RUN wget -q -O factorio.tar.gz https://www.factorio.com/get-download/latest/headless/linux64 && tar -xf factorio.tar.gz && rm factorio.tar.gz
+# Copy project files into the container
+COPY . .
 
-WORKDIR factorioClusterio
-RUN mkdir instances sharedMods sharedPlugins
+RUN npm install \
+&& npx lerna bootstrap --hoist
 
-RUN node client.js download
+# Install plugins. This is intended as a reasonable default, enabling plugins to make for fun gameplay.
+# If you want a different set of plugins, consider using this as the base image for your own.
+#RUN npm install @clusterio/plugin-subspace_storage
+#RUN npx clusteriomaster plugin add @clusterio/plugin-subspace_storage
 
-LABEL maintainer "danielv@live.no"
+COPY --from=subspace_storage_builder /subspace_storage/dist/ /clusterio/sharedMods/
 
-EXPOSE 8080 34167
-VOLUME /factorioClusterio/instances
-VOLUME /factorioClusterio/sharedMods
-VOLUME /factorioClusterio/sharedPlugins
+# Build submodules (web UI, libraries, plugins etc)
+RUN npx lerna run build
+# Build Lua library mod
+RUN node packages/lib/build_mod --build --source-dir packages/slave/lua/clusterio_lib \
+&& mv dist/* sharedMods/ \
+&& mkdir temp \
+&& mkdir temp/test \
+&& cp sharedMods/ temp/test/ -r \
+&& ls sharedMods
 
-CMD RCONPORT="$RCONPORT" FACTORIOPORT="$FACTORIOPORT" MODE="$MODE" node $MODE\.js start $INSTANCE
+# Remove node_modules
+RUN find . -name 'node_modules' -type d -prune -print -exec rm -rf '{}' \;
+
+FROM frolvlad/alpine-glibc AS clusterio_final
+
+RUN apk add --update bash nodejs npm
+
+COPY --from=clusterio_builder /clusterio /clusterio
+WORKDIR /clusterio
+
+# Install runtime dependencies
+RUN npm install --production
+RUN npx lerna bootstrap -- --production --no-optional
+LABEL maintainer "danielv@danielv.no"
+
+FROM frolvlad/alpine-glibc AS clusterio_testing
+
+RUN apk add --update bash nodejs npm
+
+COPY --from=clusterio_builder /clusterio /clusterio
+WORKDIR /clusterio
+
+# Install runtime dependencies
+RUN npm install
+RUN npx lerna bootstrap
+RUN npm install chalk semver

LICENSE.md

@@ -1,4 +1,4 @@
-MIT License
+This product uses the MIT License
 
 Copyright (c) 2016 Daniel Vestøl
 

README.md

@@ -1,198 +1,304 @@
-# factorioClusterio
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FDanielv123%2FfactorioClusterio.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FDanielv123%2FfactorioClusterio?ref=badge_shield)
+<img src="./logo.svg" width="100%" align="right">
 
-| Branch | Coverage | Build |
-|--------|----------| ----- |
-| Master | [![codecov](https://codecov.io/gh/Danielv123/factorioClusterio/branch/master/graph/badge.svg)](https://codecov.io/gh/Danielv123/factorioClusterio) | [![Build Status](https://travis-ci.org/Danielv123/factorioClusterio.svg?branch=master)](https://travis-ci.org/Danielv123/factorioClusterio) |
-| Dev    | [![codecov](https://codecov.io/gh/Danielv123/factorioClusterio/branch/dev/graph/badge.svg)](https://codecov.io/gh/Danielv123/factorioClusterio) | [![Build Status](https://travis-ci.org/Danielv123/factorioClusterio.svg?branch=dev)](https://travis-ci.org/Danielv123/factorioClusterio) |
+<br/>
+<br/>
+<br/>
 
-If you want to connect to a clusterio cluster, please reffer to the [client](https://github.com/Danielv123/factorioClusterioClient)
+# Clusterio
+
+Discord for development/support/play: https://discord.gg/5XuDkje
+
+## Important notice
+
+Clusterio 2.0 is still in alpha, however the previous stable has been abandoned and is no longer supported.
+Despite being alpha it's reasonably stable now and there's no major breakages expected before a stable release of 2.0.
+If you are starting a new cluster it's highly recommended to use the 2.0 alpha.
+
+
+### Ways to support me/the project:
+
+* Contribute with code/documentation.
+  See [Contributing](docs/contributing.md) for how to make pull requests.
+  Always nice to move the project forward.
+
+* Support me monetarily on [patreon](https://www.patreon.com/danielv123) or paypal: danielv@live.no
 
 ### Table of contents
 
-* [Introduction & methodology](#introduction)
+* [Introduction](#introduction)
+* [Features](#features)
+* [Plugins](#plugins)
+* [Installation](#installation)
+  * [Ubuntu setup](#ubuntu-setup)
+  * [Windows setup](#windows-setup)
+  * [MacOS setup](#macos-setup)
+  * [Installing Plugins](#installing-plugins)
+* [Configure Master Server](#configure-master-server)
+* [Managing Factorio mods](#managing-factorio-mods)
+* [Setting up shared storage](#setting-up-shared-storage)
+* [Running Clusterio](#running-clusterio)
+* [Setting up remote slaves](#setting-up-remote-slaves)
+* [Setting up clusterioctl](#setting-up-clusterioctl)
+* [Common problems](#Common-problems)
 
-* [Ubuntu setup](#ubuntu-setup)
-
-* [Windows setup](#windows-setup)
-
-* [Command cheatsheet](#cheatsheet)
 
 ## Introduction
 
-Features:
+Clusterio is a clustered Factorio server manager that provides the tooling for implementing cross server interactions in Factorio.
+It was previously best known for implementing cross server transfer and cloud storage of items via teleporter chests.
+But this functionality has been pulled out of Clusterio into its own plugin for Clusterio named [Subspace Storage](https://github.com/clusterio/subspace_storage).
 
-- Entities to send/recieve items
+By itself Clusterio doesn't change the gameplay in any way, you could even use Clusterio to manage completely vanilla Factorio servers.
+Plugins do the work of modding in the visible changes into the game, see the [Plugins section](#plugins) for ready made plugins you can install into a Clusterio cluster.
 
-- Cross dimensional storage
 
-- Sending of liquids
+## Features
 
-- Sending of circuit network signals
+- Clustered Factorio server management allowing you manage the running of Factorio servers across a fleet of physical servers from both a web interface and a command line interface.
 
-- Inventory combinator to display item levels in the cluster (and epoch time)
+- User list management for synchronizing in-game admins, whitelisted users, and bans to all the servers in the cluster.
 
-- Reporting of graphs and UPS on master interface
+- Integrated support for exporting statistics for the whole cluster to Prometheus via a single metrics endpoint.
 
-Connection diagram:
+- Extensive plugin support for adding your own cross server features to Factorio using Clusterio's communication backbone.
 
-![http://i.imgur.com/7FdVfgB.png](http://i.imgur.com/7FdVfgB.png)
 
-There can be any number of clients connected to each slave, and any number of slaves connected to a master but there can only be one master server in each cluster.
+## Plugins
 
-**How does it work?**
+The heart of Clusterio is its plugin system.
+Plugins add functionality to Factorio servers, Clusterio itself or both.
+These are the plugins supported and maintained by the Clusterio developers:
 
-Traditional factorio mods have always been limited by the games deterministic design. This gives us a very bug free and predictable game, but doesn't allow us cool stuff such as internet communication.
-Clusterio exploits one of the games logging features, game.write_file and RCON to communicate between servers. Sending an item from one server to another takes this path:
+- [Global Chat](/plugins/global_chat/README.md): share the in-game chat between servers.
+- [Research Sync](/plugins/research_sync/README.md): synchronize research progress and technologies unlocked between servers.
+- [Statistics Exporter](/plugins/statistics_exporter/README.md): collect in-game statistics from all the servers and makes it available to the Prometheus endpoint on the master server.
+- [Subspace Storage](https://github.com/clusterio/subspace_storage): Provide shared storage that can transport items between servers via teleport chests.
+- [Player Auth](/plugins/player_auth/README.md): Provides authentication to the cluster via logging into a Factorio server.
+- [Inventory Sync](/plugins/inventory_sync/README.md): Synchronizes your inventory between servers.
 
-1. server1: Chest has stuff in it, write the contents to a file and delete them from the game world
+There's also plugins developed and maintained by the community:
 
-2. client.js on server1: File has stuff in it, parse and send to the master for storage
+- [Discord Bridge](https://github.com/Hornwitser/discord_bridge) (@hornwitser/discord_bridge): Bridges chat between instances and Discord.
+  By Hornwitser.
+- [Server Select](https://github.com/Hornwitser/server_select/tree/clusterio-2.0) (@hornwitser/server_select): In-game GUI for connecting to other server in the cluster.
+  Originally by Godmave, ported to 2.0 by Hornwitser.
 
-3. master: server1 gave us stuff, store it in the storage and write some statistics
+Want to make your own plugin?
+Check out the documentation on [Writing Plugins](/docs/writing-plugins.md) for where to start.
 
-4. server2: get-chest is empty, write a request to file
 
-5. client.js on server2: Request file has stuff in it, parse and send a request to master for more items of that type
+## Installation
 
-6. master: server2 asked for stuff, check if we have enough and how much demand there is, then send however much is appropriate back
+Clusterio runs on Node.js v12 and up, it's distributed via npm and comes with a guided install script.
+If you alread have a recent Node.js installed you can set it up in a new directory with.
 
-7. client.js on server2: We were allowed to import x of item y, run command /c remote.call("clusterio", "importMany", "{'copper-plate':120}")
+    npm init "@clusterio"
 
-This process works the same for both items and liquids, independant on what mods are used. Yes, modded items are fully supported.
+Otherwise see below for OS specific instructions.
 
-Clusterio also handles a few other neat things, such as giving you access to epoch time, transmitting combinator signals between worlds (and any other application who wants to) and 
-creating graphs on the master web interface.
 
-## Ubuntu setup
+### Ubuntu setup
 
-NodeJS does not support EOL ubuntu releases. Make sure you are on the most recent LTS release or newer.
+1.  Install Node.js v12 or higher.
+    For 20.04 LTS or below the version of Node.js provided by the Ubuntu repos are too old and you will have to use the nodesource PPA, otherwise you may skip the first line.
 
-Master and all slaves:
+        wget -qO - https://deb.nodesource.com/setup_14.x | sudo -E bash -
+        sudo apt install nodejs
 
-    sudo curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash - \
-    sudo apt install -y nodejs python-dev git wget curl tar build-essential \
-    sudo npm install pm2 -g \
-    git clone https://github.com/Danielv123/factorioClusterio.git \
-    cd factorioClusterio \
-    npm install \
-    curl -o factorio.tar.gz -L https://www.factorio.com/get-download/latest/headless/linux64 \
-    tar -xf factorio.tar.gz
+2.  Create a new directory and run the Clusterio installer:
 
-downloads and installs nodejs, pm2, git and clusterio. To specify a version, change "latest" in the link to a version number like 0.14.21.
+        mkdir clusterio
+        cd clusterio
+        npm init "@clusterio"
 
-**Master**
+    Make sure to note down the admin authentication token it provides at the end as you will need it later.
 
-    pm2 start master.js --name master
-    
-**Server Host**
-    
-To download the mod for all its non vanilla features and items, (optional)
+3.  If you chose to use local factorio directory for the Factorio installation then download the headless build of Factorio and unpack it:
 
-    node client.js download
+        wget -O factorio.tar.xz https://www.factorio.com/get-download/latest/headless/linux64
+        tar -xf factorio.tar.xz
 
-To create a new instance (its own save, set of mods and config files)
+    To specify a version of Factorio to download replace "latest" in the URL with a version number like "1.0.0".
 
-    node client.js start [instancename]
+4.  Optionally copy the generated systemd service files in `systemd` folder to `/etc/systemd/system/`.
 
-To launch an instance with pm2
-
-    pm2 start --name slave client.js -- start [instancename]
-
-use `nano config.json` to change settings.
 
 **Ubuntu with Docker**
 
-Clusterio has limited support for using docker.
+The Docker support for Clusterio is curently broken.
+If you need it open an issue about it.
+
+<!--
+Clusterio has *very* limited support for using docker.
+
+    sudo docker build -t clusterio --no-cache --force-rm clusterio
 
-    sudo docker build -t clusterio --no-cache --force-rm factorioClusterio
-	
 	sudo docker run --name master -e MODE=master -p 1234:8080 -d -it --restart=unless-stopped danielvestol/clusterio
-	
-	sudo docker run --name slave -e MODE=client -e INSTANCE=world1 -v /srv/clusterio/instances:/factorioClusterio/instances -p 1235:34167 -it --restart=unless-stopped danielvestol/clusterio
 
-The -v flag is used to specify the instance directory. Your instances (save files etc) will be stored there.
+	sudo docker run --name slave -e MODE=slave -e INSTANCE=world1 -v /srv/clusterio/instances:/clusterio/instances -p 1235:34167 -it --restart=unless-stopped danielvestol/clusterio
 
-## Windows setup
+The -v flag is used to specify the instance directory.
+Your instances (save files etc) will be stored there.
+-->
 
-Clusterio is built up of multiple parts. Here is a quick guide:
+### Windows setup
 
-Master = master.js
+1.  Download and install the latest LTS release from http://nodejs.org.
 
-Server host (Slave) = client.js + factorio server
+2.  Create a new empty directory for the installation and navigate into it.
+    Open a PowerShell window in this new directory by Shift+Right clicking inside it and choosing "Open PowerShell window here" and then run the following command.
 
-Game Client = The people connecting to the server
+        npm init "@clusterio"
 
-All Server Hosts (Slaves) AND Game Clients need to be running the clusterio mod located at [github](https://github.com/Danielv123/factorioClusterioMod) Install it by dropping it into either the sharedMods folder or instances/[instanceName]/instanceMods folder.
+    Make sure to note down the admin authentication token it provides at the end as you will need it later.
 
-There are no requirements for other mods, they can be ran in any configuration allowed by the base game.
+3.  If you chose to use local factorio directory for the Factorio installation then download the Windows 64-bit zip package from https://www.factorio.com/download and extract it to the `factorio` folder in your clusterio installation folder.
 
-**Requirements**
 
-download and install nodeJS 6+ from http://nodejs.org
+### MacOS Setup
 
-download and install git from https://git-scm.com/
+1.  Install the latest Node.js LTS release from http://nodejs.org or use brew (`brew install node`).
 
-reboot when you are done, then proceed to the next steps. *reboots matter*
+2.  Open Terminal or Command prompt in the directory you want to install to and run the following commands.
 
-**Master**
+        mkdir clusterio
+        cd clusterio
+        npm init "@clusterio"
 
-1. download and run https://puu.sh/toFHl/01eebbb333.bat
+    Make sure to note down the admin authentication token it provides at the end as you will need it later.
 
-2. You do not *need* to follow the given instructions, but you should
+3.  If you chose to use local factorio directory for the Factorio installation you will need to obtain and copy a mac version of Factorio and unpack it to to the `factorio` folder in your clusterio installation folder.
 
-3. type `node master.js`
 
-**Server Host**
+### Installing Plugins
 
-1. download and run https://puu.sh/toFHl/01eebbb333.bat
+For well known plugins you can select them during installation and no further steps are necessary to make them work.
+Installing plugins that are not offered by the installer consists of two steps.
+First install the package the plugin is provided by via npm, for example
 
-2. Follow the instructions given
+    npm install @clusterio/plugin-subspace_storage
 
-3. Type `node client.js start [instancename]` to create a new instance.
+Then tell clusterio that this plugin exists by adding it as a plugin.
 
-To connect to a master server running on a remote machine, open config.json with your favourite text editor (notepad++). You can also set it up to use the official server browser.
+    npx clusteriomaster plugin add @clusterio/plugin-subspace_storage
 
-Change masterIP to something like 31.152.123.14 (provided by master server owner)
+This adds it to the default `plugin-list.json` file which in the shared folder setup is loaded by master, slave and ctl.
+If you have slaves or ctl installed on separate computers (or directories) then you need to repeat the plugin install process for all of them.
+The clusteriomaster, clusterioslave and clusterioctl commands has the plugin sub-command so you do not need to install clusteriomaster to add plugins, instead use the clusterio command you have available.
 
-Change masterPort to something like 8080 (provided by master server owner)
+For development purposes the `plugin add` command supports adding plugins by the absolute path to them, or a relative path that must start with either . or .. (which will then be resolved to an absolute path).
 
-Repeat step 3 for more servers on one machine. You should be able to find its port by looking at the slave section on master:8080 (the web interface)
 
-**GameClient**
+## Configure Master Server
 
-Fancy game client that does the following steps automatically: [clusterioClient](https://github.com/Danielv123/factorioClusterioClient)
+By default the master server will listen for HTTP on port 8080.
+You can change the port used with the command
 
-1. Download the same version of the mod as the slave is running from [the mod portal](https://mods.factorio.com/mods/Danielv123/clusterio) or [github](https://github.com/Danielv123/factorioClusterioMod
+    npx clusteriomaster config set master.http_port 1234
 
-2. Drop it into ./factorio/mods
+When changing the port you will also need to change the address slaves connect with.
+For the standalone installation mode you can use
 
-3. Run factorio and connect to slave as a normal MP game. You will find the port number to connect to at http://[masterAddress]:8080
+    npx clusterioslave config set slave.master_url http://localhost:1234/
 
-## Cheatsheet
+If you plan to make your cluster available externally set the address
+that it will be accessible under with, for example
 
-**To create a new instance/start it**
+    npx clusteriomaster config set master.external_address http://203.0.113.4:1234/
 
-    node client.js start [instanceName]
+Change the url to reflect the IP, protocol, and port the master server is accessible under, dns names are also supported.
+If you're planning on making the master server accessible on the internet it's recommended to set up TLS, see the [Setting Up TLS](/docs/setting-up-tls.md) document for more details.
 
-**Other instance management tools:**
-```
-node client.js delete [instanceName]
-node client.js list
-```
-**To update clusterio to the latest version:**
+You can list the config of the master server with the `npx clusteriomaster config list` command.
+See the [readme for @clusterio/master](/packages/master/README.md) for more information.
 
-1. Download the latest zip version of factorio for your platform manually from factorio.com. Place it in the project root folder and call it "factorio" (folder name is specified in config.json)
 
-2. Grab the latest version of the repo
+## Managing Factorio mods
 
-```
-git pull
+Clusterio currently only provides a manual method for running mods on servers by copying them either to each instance's individual `mods` folder, or by copying them into a slave installation's `sharedMods` folder which will link/copy them to the `mods` folder of each instance on that slave if the file doesn't already exist in the `mods` folder for that instance.
+Mods are copied from `sharedMods` on Windows and symlinked on Linux, this means that when mods are removed from `sharedMods` the mods will also be removed from the instance's `mods` folder on Linux if it got there by being linked by Clusterio, but not on Windows.
 
-npm install
-```
+For managing the mod settings the `mod-settings.dat` and `mod-list.json` files will also be linked/copied over if present in `sharedMods`, but since Factorio creates these files automatically it might be necessary to delete them from each instance's `mods` folder for changes to them in `sharedMods` to take effect.
 
-3. Download the latest version of the factorioClusterioMod from its github repo
-```
-node client.js download
-```
+Better remote management of mods is a planned feature.
+
+
+## Setting up shared storage
+
+The chests teleporting items to and from the shared storage on the master server has been moved into the Subspace Storage mod and plugin.
+To get this to work you will need to install the Subspace Storage plugin and copy the [Subspace Storage mod](https://mods.factorio.com/mod/subspace_storage) and the [Clusterio Lib mod](https://mods.factorio.com/mod/clusterio_lib) into the `sharedMods` folder on each slave installation.
+
+Do not install the [Clusterio mod](https://mods.factorio.com/mod/clusterio), this was for the old 1.2.x version of Clusterio and is not compatible with Clusterio 2.0.
+
+
+## Running Clusterio
+
+After completing the installation start up the master server and at least one slave separately.
+The installer provides the `run-master` and `run-slave` scripts to make this simple.
+Once the master process is running you can log into the web interface which is hosted by default on http://localhost:8080/ (adjust the port number if you changed it), use the admin authentication token provided from the installation to log in.
+
+The basics of setting up a Factorio server from the web interface is to create an instance, assign it to a slave and then click start.
+
+### Running via Systemd
+
+The install script creates systemd service scripts for clusteriomaster and clusterioslave (if applicable) to start up as the user than ran the installer.
+If you have copied these files over to `/etc/systemd/system/` then you can startup clusterio as a background service using:
+    
+#### To start as a service run:
+ 
+    sudo systemctl start clusteriomaster # for the master server
+    sudo systemctl start clusterioslave # for each server hosting a slave
+
+#### To automatically get it to start on boot:
+ 
+    sudo systemctl enable clusteriomaster # for the master server
+    sudo systemctl enable clusterioslave # for each server hosting a slave
+
+
+## Setting up remote slaves
+
+Run the installer as described in the installation section and choose "Slave only" as the operating mode to install, it'll ask for a master URL and an authentication token.
+The URL is the same as what is needed to connect to the web interface, and the athentication token can be generated on the Slaves page in the web interface.
+Once you start up the slave it should show up in the Slaves list and be available for assigning and running instances on.
+
+
+## Setting up clusterioctl
+
+There's a command line interface available for Clusterio which is installed separately with the same installer as for the master and slave.
+Run the installer as described in the installation section and choose "Ctl only" as the operating mode to install, you can do this in the same directory as you have installed other clusterio component(s) to.
+The installer will ask for a master URL and an authentication token, these are the same as you would use to connect to the web interface.
+If you want to use a different user for the command line interface you can generate an authentication token for an existing user with
+
+    npx clusteriomaster bootstrap generate-user-token <username>
+
+
+## Common problems
+
+### EACCESS [...] LISTEN 443
+
+Some systems don't let non root processes listen to ports below 1000.
+Either run with `sudo` or change config.json to use higher port numbers.
+
+According to [this link](https://askubuntu.com/questions/839520/open-port-443-for-a-node-web-app) if you manually installed node.js following the above instructions, you may need to run the following command to fix this issue:
+
+    sudo setcap 'cap_net_bind_service=+ep' $(readlink -f $(which node))
+
+### Portforwarding doesn't work on the master server when running under WSL
+
+If you follow the ubuntu guide on WSL (Windows Subsystem for Linux, Bash on Ubuntu on Windows specifically), you will find that the website works on localhost and on your local ip, but not on the global ip.
+This is also true when you correctly port-forwarded the correct ports.
+Even when routing this server through nginx in WSL, the issue persists.
+Then, on a hunch, I tried to run nginx from windows itself and found that this DID work.
+It came to me that the only usage difference between the 2 versions of nginx is that I got a Windows Firewall popup.
+
+TLDR: the tested fix is:
+
+- open your windows firewall and go to advanced settings
+
+- click on inbound rules and click on new rule...
+
+- select port and click next >
+
+- select TCP and select specific local ports and type in the ports that you want to open (comma separated) and click next > 3 times
+
+- give the rule a name (like 'web server' or something), give it a description (optionally) and click finish

client.js

@@ -1,945 +0,0 @@
-const fs = require('fs-extra');
-const https = require('follow-redirects').https;
-const needle = require("needle");
-const child_process = require('child_process');
-const path = require('path');
-const syncRequest = require('sync-request');
-const request = require("request");
-const ncp = require('ncp').ncp;
-const Rcon = require('simple-rcon');
-const hashFiles = require('hash-files');
-const _ = require('underscore');
-const deepmerge = require("deepmerge");
-const getMac = require('getmac').getMac;
-const rmdirSync = require('rmdir-sync');
-const ioClient = require("socket.io-client");
-
-// internal libraries
-const objectOps = require("./lib/objectOps.js");
-const fileOps = require("_app/fileOps");
-const stringUtils = require("./lib/stringUtils.js");
-const modManager = require("./lib/manager/modManager.js");
-const configManager = require("./lib/manager/configManager.js");
-
-// require config.json
-var config = require('./config');
-var global = {};
-
-if (!fs.existsSync("./instances/")) {
-	fs.mkdirSync("instances");
-}
-if (!fs.existsSync("./sharedPlugins/")) {
-	fs.mkdirSync("sharedPlugins");
-}
-if (!fs.existsSync("./sharedMods/")) {
-	fs.mkdirSync("sharedMods");
-}
-const instance = process.argv[3];
-const instancedirectory = './instances/' + instance;
-const command = process.argv[2];
-
-// Set the process title, shows up as the title of the CMD window on windows
-// and as the process name in ps/top on linux.
-process.title = "clusterioClient "+instance;
-
-var instanceInfo = {};
-
-// function to handle sending commands into the game
-function messageInterface(command, callback) {
-	// try to save us if you send a buffer instead of string
-	if(typeof command == "object") {
-		command = command.toString('utf8');
-	}
-	
-	if(process.platform == "linux" && typeof command == "string" && serverprocess) {
-		/*
-			to send to stdin, use:
-			serverprocess.stdin.write("/c command;\n")
-		*/
-		serverprocess.stdin.write(command+"\n");
-		if(typeof callback == "function"){
-			callback();
-		}
-	} else if(typeof command == "string" && client && client.exec && typeof client.exec == "function") {
-		try {
-			client.exec(command+"\n", callback);
-		} catch (err) {
-			console.log(err);
-		}
-		if(typeof callback == "function"){
-			callback();
-		}
-	}
-}
-
-// handle commandline parameters
-if (!command || command == "help" || command == "--help") {
-	console.error("Usage: ");
-	console.error("node client.js start [instance name]");
-	console.error("node client.js list");
-	console.error("node client.js delete [instance]");
-	console.error("To download the latest version of the Clusterio lua mod, do");
-	console.error("node client.js manage shared mods download clusterio");
-	console.error("For more management options, do");
-	console.error("node client.js manage");
-	process.exit(1);
-} else if (command == "list") {
-	let instanceNames = fileOps.getDirectoriesSync("./instances/");
-	instanceNames.unshift("Name:");
-	let longestInstanceName = 0;
-	// determine longest instance name
-	instanceNames.forEach(function(instance){
-		if(instance.length > longestInstanceName) longestInstanceName = instance.length;
-	});
-	let displayLines = [];
-	// push name coloumn to array
-	instanceNames.forEach(function(instance){
-		while(instance.length < longestInstanceName+1){
-			instance += " ";
-		}
-		displayLines.push("| "+ instance + "|");
-	});
-	// create port colloumn
-	let factorioPorts = [];
-	instanceNames.forEach(function(instance){
-		let factorioPort
-		
-		if(instance.includes("Name:")){
-			factorioPort = "Port:"
-		} else {
-			factorioPort = require("./instances/"+instance+"/config").factorioPort;
-		}
-		factorioPorts.push(factorioPort);
-	});
-	factorioPorts.forEach((port, index) => {
-		let longestPort = 0;
-		factorioPorts.forEach((port, index) => {
-			if(port.toString().length > longestPort) longestPort = port.toString().length;
-		});
-		while(port.toString().length < longestPort){
-			port += " ";
-		}
-		factorioPorts[index] = port;
-	});
-	instanceNames.forEach(function(instance, index){
-		displayLines[index] += " " + factorioPorts[index] + " |";
-	});
-	
-	displayLines.forEach(line => console.log(line));
-	process.exit(1);
-} else if (command == "manage"){
-	// console.log("Launching mod manager");
-	//const fullUsage = 'node client.js manage [instance, "shared"] ["mods", "config"] ...';
-	function usage(instance, tool, action){
-		if(tool && tool == "mods"){
-			console.log('node client.js manage '+instance+' '+tool+' ["list", "search", "add", "remove", "update"]');
-		} else if(tool && tool == "config") {
-			console.log('node client.js manage '+instance+' '+tool+' ["list", "edit"]');
-		} else {
-			console.log('node client.js manage '+(instance || '[instance, "shared"]') +' '+ (tool || '["mods", "config"]') + ' ...');
-		}
-	}
-	const tool = process.argv[4] || "";
-	const action = process.argv[5] || "";
-	if(instance){
-		if(tool == "mods"){
-			// allow managing mods
-			if(action == "list"){
-				modManager.listMods(instance);
-			} else if(action == "search"){
-				modManager.findMods(process.argv[6]);
-			} else if(action == "add" || action == "download"){
-				modManager.addMod(process.argv[6], instance);
-			} else if(action == "remove" || action == "rm" || action == "delete"){
-				modManager.removeMod(process.argv[6], instance);
-			} else if(action == "update"){
-				modManager.updateAllMods();
-			} else {
-				usage(instance, tool);
-			}
-		} else if(tool == "config"){
-			// allow managing the config
-			if(action == "list" || action == "show" || action == "display"){
-				configManager.displayConfig(instance);
-			} else if(action == "edit"){
-				let newConfigValue = "";
-				process.argv.forEach((arg, i)=>{
-					if(i >= 8){
-						newConfigValue += " "+arg;
-					} else if(i >= 7){
-						newConfigValue += arg;
-					}
-				});
-				configManager.editConfig(instance, process.argv[6], newConfigValue);
-			} else {
-				usage(instance, tool);
-			}
-		} else {
-			usage(instance);
-		}
-	} else {
-		console.log('Usage:');
-		usage(instance);
-	}
-	// process.exit(1);
-} else if (command == "delete") {
-	if (!process.argv[3]) {
-		console.error("Usage: node client.js delete [instance]");
-		process.exit(1);
-	} else if (typeof process.argv[3] == "string" && fs.existsSync("./instances/" + process.argv[3]) && process.argv[3] != "/" && process.argv[3] != "") {
-		fileOps.deleteFolderRecursiveSync("./instances/" + process.argv[3]);
-		console.log("Deleted instance " + process.argv[3]);
-		process.exit(1);
-	} else {
-		console.error("Instance not found: " + process.argv[3]);
-		process.exit(1);
-	}
-} else if (command == "download") {
-	console.log("Downloading mods...");
-	// get JSON data about releases
-	let res = syncRequest('GET', 'https://api.github.com/repos/Danielv123/factorioClusterioMod/releases', {"headers":{"User-Agent":"Fuck you for requiring user agents!"}});
-	let url = JSON.parse(res.getBody())[0].assets[0].browser_download_url;
-	let name = JSON.parse(res.getBody())[0].assets[0].name;
-	if(url) {
-		console.log(url);
-		let file = fs.createWriteStream("sharedMods/"+name);
-		https.get(url, function(response) {
-			response.pipe(file);
-			console.log("Downloaded "+name);
-		});
-	}
-} else if (command == "start" && instance === undefined) {
-	console.log("ERROR: No instanceName provided!");
-	console.log("Usage: node client.js start [instanceName]");
-	process.exit(0);
-} else if (command == "start" && typeof instance == "string" && instance != "/" && !fs.existsSync(instancedirectory)) {
-	// if instance does not exist, create it
-	console.log("Creating instance...");
-	fs.mkdirSync(instancedirectory);
-	fs.mkdirSync(instancedirectory + "/script-output/");
-	fs.mkdirSync(instancedirectory + "/saves/");
-	fs.writeFileSync(instancedirectory + "/script-output/output.txt", "");
-	fs.writeFileSync(instancedirectory + "/script-output/orders.txt", "");
-	fs.writeFileSync(instancedirectory + "/script-output/txbuffer.txt", "");
-	fs.mkdirSync(instancedirectory + "/mods/");
-	fs.mkdirSync(instancedirectory + "/instanceMods/");
-	// fs.symlinkSync('../../../sharedMods', instancedirectory + "/mods", 'junction') // This is broken because it can only take a file as first argument, not a folder
-	fs.writeFileSync(instancedirectory + "/config.ini", "[path]\r\n\
-read-data=__PATH__executable__/../../data\r\n\
-write-data=__PATH__executable__/../../../instances/" + instance + "\r\n\
-	");
-	
-	// this line is probably not needed anymore but Im not gonna remove it
-	fs.copySync('sharedMods', instancedirectory + "/mods");
-	let instconf = {
-		"factorioPort": process.env.FACTORIOPORT || Math.floor(Math.random() * 65535),
-		"clientPort": process.env.RCONPORT || Math.floor(Math.random() * 65535),
-		"clientPassword": Math.random().toString(36).replace(/[^a-z]+/g, '').substr(0, 8),
-	}
-	console.log("Clusterio | Created instance with settings:")
-	console.log(instconf);
-	
-	// create instance config
-	fs.writeFileSync(instancedirectory + "/config.json", JSON.stringify(instconf, null, 4));
-	
-	let name = "Clusterio instance: " + instance;
-	if (config.username) {
-		name = config.username + "'s clusterio " + instance;
-	}
-	let serversettings = {
-		"name": name,
-		"description": config.description,
-		"tags": ["clusterio"],
-		"max_players": "20",
-		"visibility": config.visibility,
-		"username": config.username,
-		"token": config.token,
-		"game_password": config.game_password,
-		"verify_user_identity": config.verify_user_identity,
-		"admins": [config.username],
-		"allow_commands": config.allow_commands,
-		"autosave_interval": 10,
-		"autosave_slots": 5,
-		"afk_autokick_interval": 0,
-		"auto_pause": config.auto_pause,
-	}
-	fs.writeFileSync(instancedirectory + "/server-settings.json", JSON.stringify(serversettings, null, 4));
-	let createSave = child_process.spawnSync(
-		'./' + config.factorioDirectory + '/bin/x64/factorio', [
-			'-c', instancedirectory + '/config.ini',
-			'--create', instancedirectory + '/saves/save.zip',
-		]
-	);
-	console.log("Instance created!");
-} else if (command == "start" && typeof instance == "string" && instance != "/" && fs.existsSync(instancedirectory)) {
-	// Exit if no instance specified (it should be, just a safeguard);
-	if(instancedirectory != "./instances/undefined"){
-		var instanceconfig = require(instancedirectory + '/config');
-		instanceconfig.unique = stringUtils.hashCode(instanceconfig.clientPassword);
-		if(process.env.FACTORIOPORT){
-			instanceconfig.factorioPort = process.env.FACTORIOPORT;
-		}
-		if(process.env.RCONPORT){
-			instanceconfig.rconPort = process.env.RCONPORT;
-		}
-	} else {
-		process.exit(1);
-	}
-	console.log("Deleting .tmp.zip files");
-	let savefiles = fs.readdirSync(instancedirectory + "/saves/");
-	for(i = 0; i < savefiles.length; i++){
-		if(savefiles[i].substr(savefiles[i].length - 8, 8) == ".tmp.zip") {
-			fs.unlinkSync(instancedirectory + "/saves/" + savefiles[i]);
-		}
-	}
-	console.log("Deleting logs");
-	// clean old log file to avoid crash
-	// file exists, delete so we don't get in trouble
-	try {
-		fs.unlinkSync(instancedirectory+'/factorio-current.log');
-	} catch (err){
-		if(err){
-			console.log(err);
-		} else {
-			console.log("Clusterio | Deleting old logs...");
-		}
-	}
-	
-	// move mods from ./sharedMods to the instances mod directory
-	try {
-		fs.mkdirSync(instancedirectory + "/instanceMods/");
-	} catch(e){}
-	try{rmdirSync(instancedirectory + "/mods");}catch(e){}
-	try {
-		// mods directory that will be emptied (deleted) when closing the server to facilitate seperation of instanceMods and sharedMods
-		fs.mkdirSync(instancedirectory + "/mods/");
-	} catch(e){}
-	console.log("Clusterio | Moving shared mods from sharedMods/ to instance/mods...");
-	fs.copySync('sharedMods', instancedirectory + "/mods");
-	console.log("Clusterio | Moving instance specific mods from instance/instanceMods to instance/mods...");
-	fs.copySync(instancedirectory + "/instanceMods", instancedirectory + "/mods");
-
-	process.on('SIGINT', function () {
-		console.log("Caught interrupt signal");
-		messageInterface("/quit");
-	});
-
-	// Spawn factorio server
-	//var serverprocess = child_process.exec(commandline);
-	fileOps.getNewestFile(instancedirectory + "/saves/", fs.readdirSync(instancedirectory + "/saves/"),function(err, latestSave) {
-		if(err) {
-			console.log("Your savefile seems to be missing. This might because you created an instance without having factorio\
-			installed and configured properly. Try installing factorio and adding your savefile to instances/[instancename]/saves/");
-			throw err;
-		}
-		// implicit global
-		serverprocess = child_process.spawn(
-			'./' + config.factorioDirectory + '/bin/x64/factorio', [
-				'-c', instancedirectory + '/config.ini',
-				'--start-server', latestSave.file,
-				'--rcon-port', Number(process.env.RCONPORT) || instanceconfig.clientPort,
-				'--rcon-password', instanceconfig.clientPassword,
-				'--server-settings', instancedirectory + '/server-settings.json',
-				'--port', Number(process.env.FACTORIOPORT) || instanceconfig.factorioPort
-			], {
-				'stdio': ['pipe', 'pipe', 'pipe']
-			}
-		);
-
-		serverprocess.on('close', (code) => {
-			console.log(`child process exited with code ${code}`);
-			process.exit();
-		});
-		serverprocess.stdout.on("data", (data) => {
-			// log("Stdout: " + data);
-			if(data.toString('utf8').includes("Couldn't parse RCON data: Maximum payload size exceeded")){
-				console.error("ERROR: RCON CONNECTION BROKE DUE TO TOO LARGE PACKET!");
-				console.error("Attempting reconnect...");
-				client.close();
-				client.connect();
-			}
-			if(process.platform == "linux"){
-				// we have to log on linux because linux only shows stdout of the first process launched
-				console.log('Factorio: ' + data);
-			}
-		});
-		serverprocess.stderr.on('data', (chunk) => {
-			console.log('ERR: ' + chunk);
-		});
-
-		// connect to the server with rcon
-		if(process.platform != "linux"){
-			// IP, port, password
-			client = new Rcon({
-				host: 'localhost',
-				port: Number(process.env.RCONPORT) || instanceconfig.clientPort,
-				password: instanceconfig.clientPassword,
-				timeout: 0
-			});
-			
-			// check the logfile to see if the RCON interface is running as there is no way to continue without it
-			// we read the log every 2 seconds and stop looping when we start connecting to factorio
-			function checkRcon() {
-				fs.readFile(instancedirectory+"/factorio-current.log", function (err, data) {
-					// if (err) console.log(err);
-					if(data && data.indexOf('Starting RCON interface') > 0){
-						client.connect();
-					} else {
-						setTimeout(function(){
-							checkRcon();
-						},2000);
-					}
-				});
-			}
-			setTimeout(checkRcon, 5000);
-		
-			client.on('authenticated', function () {
-				console.log('Clusterio | RCON Authenticated!');
-				instanceManagement(); // start using rcons
-			}).on('connected', function () {
-				console.log('Clusterio | RCON Connected!');
-				// getID();
-			}).on('disconnected', function () {
-				console.log('Clusterio | RCON Disconnected!');
-				process.exit(0); // exit because RCON disconnecting is undefined behaviour and we rather just wanna restart now
-			});
-		} else if(process.platform == "linux"){
-			// TODO: Check if this works fine on linux or if it has to be delayed until the server starts properly
-			instanceManagement();
-		}
-
-		// set some globals
-		confirmedOrders = [];
-		lastSignalCheck = Date.now();
-	});
-}
-
-// ensure instancemanagement only ever runs once
-_.once(instanceManagement);
-function instanceManagement() {
-	/* Open websocket connection to master */
-	var socket = ioClient("http://"+config.masterIP+":"+config.masterPort);
-	socket.on("hello", data => {
-		console.log("SOCKET | registering slave!");
-		socket.emit("registerSlave", {
-			instanceID: instanceconfig.unique,
-		});
-		setInterval(B=> socket.emit("heartbeat"), 10000);
-	});
-	
-	console.log("Started instanceManagement();");
-	// load plugins and execute onLoad event
-	let pluginDirectories = fileOps.getDirectoriesSync("./sharedPlugins/");
-	let plugins = [];
-	for(let i=0; i<pluginDirectories.length; i++) {
-		let I = i
-		let log = function(message) {
-			console.log("Clusterio | "+ pluginDirectories[I] + " | " + message);
-		}
-		// these are our two config files. We need to send these in case plugin
-		// wants to contact master or know something.
-		let combinedConfig = deepmerge(instanceconfig,config,{clone:true})
-		let pluginConfig = require("./sharedPlugins/" + pluginDirectories[i] + "/config.js");
-		
-		if(!global.subscribedFiles) {
-			global.subscribedFiles = {};
-		}
-		if(pluginConfig.binary == "nodePackage"){
-			// require index.js.main() of plugin and execute it as a class
-			let pluginClass = require("./sharedPlugins/" + pluginDirectories[I] + "/index.js");
-			plugins[I] = new pluginClass(combinedConfig, function(data){
-				if(data.toString('utf8')[0] != "/") {
-					log("Stdout: " + data.toString('utf8'));
-				} else {
-					messageInterface(data.toString('utf8'));
-				}
-			}, { // extra functions to pass in object. Should have done it like this from the start, but won't break backwards compat.
-				socket, // socket.io connection to master (and ES6 destructuring, yay)
-			});
-			if(pluginConfig.scriptOutputFileSubscription && typeof pluginConfig.scriptOutputFileSubscription == "string"){
-				if(global.subscribedFiles[pluginConfig.scriptOutputFileSubscription]) {
-					// please choose a unique file to subscribe to. If you need plugins to share this interface, set up a direct communication
-					// between those plugins instead.
-					throw "FATAL ERROR IN " + pluginDirectories[i] + " FILE ALREADY SUBSCRIBED " + pluginConfig.scriptOutputFileSubscription;
-				}
-				
-				if (!fs.existsSync(instancedirectory + "/script-output/" + pluginConfig.scriptOutputFileSubscription)) {
-					// Do something
-					fs.writeFileSync(instancedirectory + "/script-output/" + pluginConfig.scriptOutputFileSubscription, "");
-				}
-				global.subscribedFiles[pluginConfig.scriptOutputFileSubscription] = true;
-				console.log("Clusterio | Registered file subscription on "+instancedirectory + "/script-output/" + pluginConfig.scriptOutputFileSubscription);
-				fs.watch(instancedirectory + "/script-output/" + pluginConfig.scriptOutputFileSubscription, fileChangeHandler);
-				// run once in case a plugin wrote out information before the plugin loaded fully
-				fileChangeHandler(false, pluginConfig.scriptOutputFileSubscription);
-				
-				// send file contents to plugin for processing
-				function fileChangeHandler(eventType, filename) {
-					if(filename != null){
-						setTimeout(
-							()=>{
-								// get array of lines in file
-								let stuff = fs.readFileSync(instancedirectory + "/script-output/" + filename, "utf8").split("\n");
-
-								// if you found anything, reset the file
-								if (stuff[0]) {
-									fs.writeFileSync(instancedirectory + "/script-output/" + filename, "");
-								}
-								for(let i = 0; i < stuff.length; i++) {
-									if(stuff[i] && !stuff[i].includes('\u0000\u0000')) {
-										plugins[I].scriptOutput(stuff[i]);
-									}
-								}
-							},
-							pluginConfig.fileReadDelay || 0
-						);
-					}
-				}
-			}
-			console.log("Clusterio | Loaded plugin " + pluginDirectories[i]);
-		} else if(pluginConfig.binary != "nodePackage"){
-			// handle as fragile executable plugin
-			let args = pluginConfig.args || [];
-			plugins[I]=child_process.spawn(pluginConfig.binary, args, {
-				cwd: "./sharedPlugins/"+pluginDirectories[i],
-				stdio: ['pipe', 'pipe', 'pipe'],
-			});
-			
-			/*
-				to send to stdin, use:
-				spawn.stdin.write("text\n");
-			*/
-			// If plugin has subscribed to a file, send any text appearing in that file to stdin
-			if(pluginConfig.scriptOutputFileSubscription && typeof pluginConfig.scriptOutputFileSubscription == "string") {
-				if(global.subscribedFiles[pluginConfig.scriptOutputFileSubscription]) {
-					// please choose a unique file to subscribe to. If you need plugins to share this interface, set up a direct communication
-					// between those plugins instead.
-					throw "FATAL ERROR IN " + pluginDirectories[i] + " FILE ALREADY SUBSCRIBED " + pluginConfig.scriptOutputFileSubscription;
-				}
-				
-				if (!fs.existsSync(instancedirectory + "/script-output/" + pluginConfig.scriptOutputFileSubscription)) {
-					// Do something
-					fs.writeFileSync(instancedirectory + "/script-output/" + pluginConfig.scriptOutputFileSubscription, "");
-				}
-				global.subscribedFiles[pluginConfig.scriptOutputFileSubscription] = true;
-				fs.watch(instancedirectory + "/script-output/" + pluginConfig.scriptOutputFileSubscription, function (eventType, filename) {
-					// get array of lines in file
-					// TODO async
-					let stuff = fs.readFileSync(instancedirectory + "/script-output/" + filename, "utf8").split("\n");
-					// if you found anything, reset the file
-					if (stuff[0]) {
-						fs.writeFileSync(instancedirectory + "/script-output/" + filename, "");
-					}
-					for (let i = 0; i < stuff.length; i++) {
-						if (stuff[i]) {
-							plugins[I].stdin.write(stuff[i]);
-						}
-					}
-				});
-			}
-			// these are our two config files. We need to send these in case plugin
-			// wants to contact master or know something.
-			// send through script-output file, maybe more compat?
-			fs.writeFileSync(instancedirectory + "/script-output/" + pluginConfig.scriptOutputFileSubscription, JSON.stringify(combinedConfig)+"\r\n");
-			// send directly through stdin
-			// plugins[i].stdin.write(JSON.stringify(combinedConfig)+"\n");
-			
-			console.log("Clusterio | Loaded plugin " + pluginDirectories[i]);
-			plugins[i].stdout.on("data", (data) => {
-				if(data.toString('utf8')[0] != "/") {
-					log("Stdout: " + data.toString('utf8'))
-				} else {
-					messageInterface(data.toString('utf8'));
-				}
-			});
-			plugins[i].stderr.on("data", (data) => {
-				log("STDERR: " + data);
-			});
-			plugins[i].on('close', (code) => {
-				log(`child process exited with code ${code}`);
-			});
-		}
-	}
-	
-	// world IDs ------------------------------------------------------------------
-	hashMods(instance, function(modHashes){
-		setInterval(getID, 10000);
-		getID();
-		function getID() {
-			messageInterface("/silent-command game.write_file('tempfile.txt', 'connected_players ' .. #game.connected_players .. '\\n', true, 0)", function(err) {setTimeout(function(){
-				// get array of lines in file
-				if(fs.existsSync(instancedirectory + "/script-output/tempfile.txt")) {
-					var data = fs.readFileSync(instancedirectory + "/script-output/tempfile.txt", "utf8").split("\n");
-					// delete when we are done
-					fs.unlink(instancedirectory + "/script-output/tempfile.txt", function(){});
-				}
-				// if we actually got anything from the file, proceed to categorize it
-				if (data && data[0]) {
-					while (data[0]) {
-						let q = data[0].split(" ");
-						// delete array element
-						data.splice(0,1);
-						if(q[0] == "connected_players" && Number(q[1]) != NaN) {
-							instanceInfo.playerCount = q[1];
-						}
-					}
-				} else {
-					instanceInfo.playerCount = 0;
-				}
-				var payload = {
-					time: Date.now(),
-					rconPort: instanceconfig.clientPort,
-					rconPassword: instanceconfig.clientPassword,
-					serverPort: instanceconfig.factorioPort,
-					unique: instanceconfig.unique,
-					publicIP: config.publicIP, // IP of the server should be global for all instances, so we pull that straight from the config
-					mods:modHashes,
-					playerCount: instanceInfo.playerCount || 0,
-					instanceName: instance,
-				}
-				
-				function callback(err, mac) {
-					if (err) {
-						console.log("##### getMac crashed, but we don't really give a shit because we are probably closing down #####");
-					} else {
-						payload.mac = mac
-						console.log("Registered our precense with master "+config.masterIP+" at " + payload.time);
-						needle.post(config.masterIP + ":" + config.masterPort + '/api/getID', payload, function (err, response, body) {
-							if (err && err.code != "ECONNRESET"){
-								console.error("We got problems, something went wrong when contacting master");
-								console.error(err);
-							} else if (response && response.body) {
-								// In the future we might be interested in whether or not we actually manage to send it, but honestly I don't care.
-								console.log(response.body);
-							}
-						});
-					}
-				}
-				if(global.mac){
-					callback(undefined, global.mac);
-				} else {
-					getMac(callback);
-				}
-			},1000)});
-		}
-	});
-	
-	
-	// Mod uploading and management -----------------------------------------------
-	// get mod names and hashes
-	// string: instance, function: callback
-	
-	setTimeout(function(){hashMods(instance, uploadMods)}, 5000);
-	function uploadMods(modHashes) {
-		// [{modName:string,hash:string}, ... ]
-		for(let i=0;i<modHashes.length;i++){
-			let payload = {
-				modName: modHashes[i].modName,
-				hash: modHashes[i].hash,
-			}
-			needle.post(config.masterIP + ":" + config.masterPort + '/api/checkMod', payload, function (err, response, body) {
-				if(err) console.log(new Error("Unable to contact master server! Please check your config.json."));
-				if(response && body && body == "found") {
-					console.log("master has mod");
-				} else if (response && body && typeof body == "string") {
-					let mod = response.body;
-					if(config.uploadModsToMaster){
-						console.log("Sending mod: " + mod);
-						// Send mods master says it wants
-						// response.body is a string which is a modName.zip
-						var req = request.post("http://"+config.masterIP + ":" + config.masterPort + '/api/uploadMod', function (err, resp, body) {
-							if (err) {
-								console.log(new Error("Unable to contact master server! Please check your config.json."));
-							} else {
-								console.log('URL: ' + body);
-							}
-						});
-						var form = req.form();
-						form.append('file', fs.createReadStream("./instances/"+instance+"/mods/"+mod));
-					} else {
-						console.log("Not sending mod: " + mod + " to master because config.uploadModsToMaster is not enabled")
-					}
-				}
-			});
-		}
-	}
-	
-	// flow/production statistics ------------------------------------------------------------
-	oldFlowStats = false
-	setInterval(function(){
-		fs.readFile(instancedirectory + "/script-output/flows.txt", {encoding: "utf8"}, function(err, data) {
-			if(!err && data) {
-				let timestamp = Date.now();
-				data = data.split("\n");
-				let flowStats = [];
-				for(let i = 0; i < data.length; i++) {
-					// try catch to remove any invalid json
-					try{
-						flowStats[flowStats.length] = JSON.parse(data[i]);
-					} catch (e) {
-						// console.log(" invalid json: " + i);
-						// some lines of JSON are invalid but don't worry, we just filter em out
-					}
-				}
-				// fluids
-				let flowStat1 = flowStats[flowStats.length-1].flows.player.input_counts
-				// items
-				let flowStat2 = flowStats[flowStats.length-2].flows.player.input_counts
-				// merge fluid and item flows
-				let totalFlows = {};
-				for(let key in flowStat1) totalFlows[key] = flowStat1[key];
-				for(let key in flowStat2) totalFlows[key] = flowStat2[key];
-				if(oldFlowStats && totalFlows && oldTimestamp) {
-					let payload = objectOps.deepclone(totalFlows);
-					// change from total reported to per time unit
-					for(let key in oldFlowStats) {
-						// get production per minute
-						payload[key] = Math.floor((payload[key] - oldFlowStats[key])/(timestamp - oldTimestamp)*60000);
-						if(payload[key] < 0) {
-							payload[key] = 0;
-						}
-					}
-					for(let key in payload) {
-						if(payload[key] == '0') {
-							delete payload[key];
-						}
-					}
-					console.log("Recorded flows, copper plate since last time: " + payload["copper-plate"]);
-					needle.post(config.masterIP + ":" + config.masterPort + '/api/logStats', {timestamp: timestamp, instanceID: instanceconfig.unique,data: payload}, function (err, response, body) {
-						// we did it, keep going
-					});
-				}
-				oldTimestamp = timestamp;
-				oldFlowStats = totalFlows;
-				fs.writeFileSync(instancedirectory + "/script-output/flows.txt", "");
-			}
-		});
-		// we don't need to update stats quickly as that could be expensive
-	}, 60000*5);
-	
-	// provide items --------------------------------------------------------------
-	// trigger when something happens to output.txt
-	fs.watch(instancedirectory + "/script-output/output.txt", function (eventType, filename) {
-		// get array of lines in file
-		let items = fs.readFileSync(instancedirectory + "/script-output/output.txt", "utf8").split("\n");
-		// if you found anything, reset the file
-		if (items[0]) {
-			fs.writeFileSync(instancedirectory + "/script-output/output.txt", "");
-		}
-		for (let i = 0; i < items.length; i++) {
-			if (items[i]) {
-				let g = items[i].split(" ");
-				g[0] = g[0].replace("\u0000", "");
-				// console.log("exporting " + JSON.stringify(g));
-				// send our entity and count to the master for him to keep track of
-				needle.post(config.masterIP + ":" + config.masterPort + '/api/place', {
-					name: g[0],
-					count: g[1],
-					instanceName: instance, // name of instance
-					instanceID: instanceconfig.unique, // a hash computed from the randomly generated rcon password
-				}, function (err, resp, body) {
-					if(body == "failure") console.error("#### Export failed! Lost: "+g[1]+" "+g[0]);
-					if(config.logItemTransfers){
-						if(body == "success") console.log(`Exported ${g[1]} ${g[0]} to master`);
-					}
-				});
-			}
-		}
-	});
-	// request items --------------------------------------------------------------
-	setInterval(function () {
-		// get array of lines in file
-		let items = fs.readFileSync(instancedirectory + "/script-output/orders.txt", "utf8").split("\n");
-		// if we actually got anything from the file, proceed and reset file
-		if (items[0]) {
-			fs.writeFileSync(instancedirectory + "/script-output/orders.txt", "");
-			// prepare a package of all our requested items in a more tranfer friendly format
-			var preparedPackage = {};
-			for (let i = 0; i < items.length; i++) {
-				(function (i) {
-					if (items[i]) {
-						items[i] = items[i].split(" ");
-						items[i][0] = items[i][0].replace("\u0000", "");
-						items[i][0] = items[i][0].replace(",", "");
-						if (preparedPackage[items[i][0]]) {
-							// if we have buffered some already, sum the new items
-							if (typeof Number(preparedPackage[items[i][0]].count) == "number" && typeof Number(items[i][1]) == "number") {
-								preparedPackage[items[i][0]] = {
-									"name": items[i][0],
-									"count": Number(preparedPackage[items[i][0]].count) + Number(items[i][1]),
-									"instanceName":instance,
-									"instanceID":instanceconfig.unique,
-								};
-							// else just add em in without summing
-							} else if (typeof Number(items[i][1]) == "number") {
-								preparedPackage[items[i][0]] = {
-									"name": items[i][0],
-									"count": Number(items[i][1]),
-									"instanceName":instance,
-									"instanceID":instanceconfig.unique,
-								};
-							}
-						// this condition will NEVER be triggered but we know how that goes
-						} else if (typeof Number(items[i][1]) == "number") {
-							preparedPackage[items[i][0]] = {
-								"name": items[i][0],
-								"count": Number(items[i][1]),
-								"instanceName":instance,
-								"instanceID":instanceconfig.unique,
-							};
-						}
-					}
-				})(i);
-			}
-			// request our items, one item at a time
-			for (let i = 0; i < Object.keys(preparedPackage).length; i++) {
-				// console.log(preparedPackage[Object.keys(preparedPackage)[i]]);
-				needle.post(config.masterIP + ":" + config.masterPort + '/api/remove', preparedPackage[Object.keys(preparedPackage)[i]], function (err, response, body) {
-					if (response && response.body && typeof response.body == "object") {
-						// buffer confirmed orders
-						confirmedOrders[confirmedOrders.length] = {
-							[response.body.name]: response.body.count,
-						}
-						if(config.logItemTransfers){
-							console.log(`Imported ${response.body.count} ${response.body.name} from master`);
-						}
-					}
-				});
-			}
-			// if we got some confirmed orders
-			// console.log("Importing " + confirmedOrders.length + " items! " + JSON.stringify(confirmedOrders));
-			sadas = JSON.stringify(confirmedOrders);
-			confirmedOrders = [];
-			// send our RCON command with whatever we got
-			messageInterface("/silent-command remote.call('clusterio', 'importMany', '" + sadas + "')");
-			sadas = null;
-		}
-	}, 1000);
-	// COMBINATOR SIGNALS ---------------------------------------------------------
-	// get inventory from Master and RCON it to our slave
-	setInterval(function () {
-		needle.get(config.masterIP + ":" + config.masterPort + '/api/inventory', function (err, response, body) {
-			if(err){
-				console.log("Unable to get JSON master/api/inventory, master might be unaccessible");
-			} else if (response && response.body) {
-				// Take the inventory we (hopefully) got and turn it into the format LUA accepts
-				if(Buffer.isBuffer(response.body)) {console.log(response.body.toString("utf-8")); throw new Error();} // We are probably contacting the wrong webserver
-				try {
-					var inventory = JSON.parse(response.body);
-				} catch (e){
-					console.log(e);
-				}
-				var inventoryFrame = {};
-				for (let i = 0; i < inventory.length; i++) {
-					inventoryFrame[inventory[i].name] = Number(inventory[i].count);
-					if(inventoryFrame[inventory[i].name] >= Math.pow(2, 31)){
-						inventoryFrame[inventory[i].name] = Math.pow(2, 30); // set it waaay lower, 31 -1 would probably suffice
-					}
-				}
-				inventoryFrame["signal-unixtime"] = Math.floor(Date.now()/1000);
-				// console.log("RCONing inventory! " + JSON.stringify(inventoryFrame));
-				messageInterface("/silent-command remote.call('clusterio', 'receiveInventory', '" + JSON.stringify(inventoryFrame) + "')");
-			}
-		});
-	}, 1000);
-	// Make sure world has its worldID
-	setTimeout(function(){
-		messageInterface("/silent-command remote.call('clusterio','setWorldID',"+instanceconfig.unique+")")
-	}, 20000);
-	/* REMOTE SIGNALLING
-	 * send any signals the slave has been told to send
-	 * Fetch combinator signals from the server
-	*/
-	socket.on("processCombinatorSignal", circuitFrameWithMeta => {
-		if(circuitFrameWithMeta && typeof circuitFrameWithMeta == "object" && circuitFrameWithMeta.frame && Array.isArray(circuitFrameWithMeta.frame)){
-			messageInterface("/silent-command remote.call('clusterio', 'receiveFrame', '"+JSON.stringify(circuitFrameWithMeta.frame)+"')");
-		}
-	});
-	// get outbound frames from file and send to master
-	// get array of lines in file, each line should correspond to a JSON encoded frame
-	let signals = fs.readFileSync(instancedirectory + "/script-output/txbuffer.txt", "utf8").split("\n");
-	// if we actually got anything from the file, proceed and reset file
-	let readingTxBufferSoon = false;
-	let txBufferClearCounter = 0;
-	fs.watch(instancedirectory + "/script-output/txbuffer.txt", "utf-8", (eventType, filename) => {
-		if(!readingTxBufferSoon){ // use a 100ms delay to avoid messing with rapid sequential writes from factorio (I think that might be a problem maybe?)
-			readingTxBufferSoon = true;
-			setTimeout(()=>{
-				txBufferClearCounter++;
-				fs.readFile(instancedirectory + "/script-output/txbuffer.txt", "utf-8", (err, signals) => {
-					signals = signals.split("\n");
-					if (signals[0]) {
-						//if(txBufferClearCounter > 500){
-							fs.writeFileSync(instancedirectory + "/script-output/txbuffer.txt", "");
-						//	txBufferClearCounter = 0;
-						//}
-						
-						// loop through all our frames
-						for (let i = 0; i < signals.length; i++) {
-							if (signals[i] && objectOps.isJSON(signals[i])) {
-								// signals[i] is a JSON array called a "frame" of signals. We timestamp it for storage on master
-								// then we unpack and RCON in this.frame to the game later.
-								let framepart = JSON.parse(signals[i]);
-								let doneframe = {
-									time: Date.now(),
-									frame: framepart, // thats our array of objects(single signals);
-								}
-								// send to master using socket.io, opened at the top of instanceManagement()
-								socket.emit("combinatorSignal", doneframe);
-							} else {
-								// console.log("Invalid jsony: "+typeof signals[i])
-							}
-						}
-					}
-				});
-				readingTxBufferSoon = false;
-			},100);
-		}
-	});
-} // END OF INSTANCE START ---------------------------------------------------------------------
-
-// string, function
-// returns [{modName:string,hash:string}, ... ]
-function hashMods(instanceName, callback) {
-	if(!callback) {
-		throw new Error("ERROR in function hashMods NO CALLBACK");
-	}
-	function callback2(hash, modName){
-		hashedMods[hashedMods.length] = {
-			modName: modName,
-			hash: hash,
-		}
-		// check if this callback has ran once for each mod
-		if(hashedMods.length == instanceMods.length) {
-			callback(hashedMods);
-		}
-		//console.log(modname);
-	}
-	let hashedMods = [];
-	/*let mods = fs.readdirSync("./sharedMods/")*/
-	let instanceMods = fs.readdirSync("./instances/"+instanceName+"/mods/");
-	if(instanceMods.length == 0){
-		callback({}); // there are no mods installed, return an empty object
-	}
-	for(let o=0;o<instanceMods.length;o++) {
-		if(path.extname(instanceMods[o]) != ".zip") {
-			instanceMods.splice(instanceMods.indexOf(instanceMods[o]), 1); // remove element from array, we can't hash unzipped mods
-		}
-	}
-	for(let i=0; i<instanceMods.length; i++){
-		let path = "./instances/"+instanceName+"/mods/"+instanceMods[i];
-		let name = instanceMods[i];
-		let options = {
-			files:path,
-		}
-		// options {files:[array of paths]}
-		hashFiles(options, function(error, hash) {
-			// hash will be a string if no error occurred
-			if(!error){
-				callback2(hash, name);
-			} else {
-				throw error;
-			}
-		});
-	}
-}

config.json

@@ -1,39 +0,0 @@
-{
-	"__comment": "Where factorio folder. Should be in the same folder as this config file.",
-	"factorioDirectory": "factorio",
-	
-	"__comment1": "IP players should connect to to join your servers, should be portforwarded and stuff",
-	"publicIP": "localhost",
-	
-	"__comment2": "IP the master web server runs at, can be ignored on the master system",
-	"masterIP": "localhost",
-	"masterPort": 8080,
-	"masterAuthToken": "",
-	
-	"__commentAuthSecret": "This is a long random string generated by keyboard mashing. Please mash you own string for security.",
-	"masterAuthSecret": "anfeåpvunuennuusnvzunsrevunåzeufnewnufasiojfåqwoiuajknwkjfdabewfkjadfnewåfundjkcvnewmfqewrmn123",
-	
-	"__comment3": "Your factorio.com username for factorio MP services, also username will be admin",
-	"username": "",
-	"__comment4": "Token from your factorio.com profile page. Required for MP and mod manager services.",
-	"token": "",
-	
-	"__comment5": "General user settings",
-	"verify_user_identity": false,
-	"auto_pause": false,
-	"allow_commands": "admins-only",
-	"game_password": "",
-	"description": "This server runs Clusterio",
-	"visibility": {
-		"public": true,
-		"lan": true
-	},
-	"__comment6": "Statistic gathering statistics, may affect server performance (master memory usage especially)",
-	"itemStats": {
-		"maxEntries":60,
-		"entriesPerSecond": 0.01666666667
-	},
-	"logItemTransfers": false,
-	"uploadModsToMaster": true,
-	"allowRemoteCommandExecution": false
-}

docker-compose.test.yml

@@ -0,0 +1,7 @@
+version: '3'
+
+services:
+  unit_test:
+    image: clusterio
+    build: .
+    command: npm run test

docker-compose.yml

@@ -0,0 +1,9 @@
+version: '3'
+
+services:
+  master:
+    build: .
+    command: npx clusteriomaster run
+  slave:
+    build: .
+    command: npx clusterioslave run

docs/assets/WsClientConnector.svg

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="1000px" height="840px" viewBox="-0.5 -0.5 1000 840" style="background-color: rgb(238, 243, 250);"><defs/><g><rect x="40" y="550" width="320" height="250" fill="none" stroke="#000000" stroke-dasharray="3 3" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-end; justify-content: unsafe flex-start; width: 318px; height: 1px; padding-top: 547px; margin-left: 42px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">connected</div></div></div></foreignObject><text x="42" y="547" fill="#000000" font-family="Helvetica" font-size="12px">connected</text></switch></g><rect x="780" y="40" width="180" height="150" fill="#cedbee" stroke="none" pointer-events="all"/><path d="M 300 750 L 300 730 L 440 730 L 440 140 L 376.37 140" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 371.12 140 L 378.12 136.5 L 376.37 140 L 378.12 143.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 723px; margin-left: 346px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: nowrap; ">yes</div></div></div></foreignObject><text x="346" y="726" fill="#000000" font-family="Helvetica" font-size="11px" text-anchor="middle">yes</text></switch></g><rect x="520" y="490" width="440" height="310" fill="none" stroke="#000000" stroke-dasharray="3 3" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-end; justify-content: unsafe flex-start; width: 438px; height: 1px; padding-top: 487px; margin-left: 522px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">resuming</div></div></div></foreignObject><text x="522" y="487" fill="#000000" font-family="Helvetica" font-size="12px">resuming</text></switch></g><rect x="40" y="210" width="380" height="300" fill="none" stroke="#000000" stroke-dasharray="3 3" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-end; justify-content: unsafe flex-start; width: 378px; height: 1px; padding-top: 207px; margin-left: 42px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">connecting</div></div></div></foreignObject><text x="42" y="207" fill="#000000" font-family="Helvetica" font-size="12px">connecting</text></switch></g><path d="M 120 150 L 120 223.63" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 120 228.88 L 116.5 221.88 L 120 223.63 L 123.5 221.88 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 191px; margin-left: 151px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 11px; font-family: Helvetica; coLine truncated

docs/assets/WsServerConnector.svg

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="919px" height="620px" viewBox="-0.5 -0.5 919 620" style="background-color: rgb(238, 243, 250);"><defs/><g><rect x="40" y="260" width="320" height="300" fill="none" stroke="#000000" stroke-dasharray="3 3" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-end; justify-content: unsafe flex-start; width: 318px; height: 1px; padding-top: 257px; margin-left: 42px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">connected</div></div></div></foreignObject><text x="42" y="257" fill="#000000" font-family="Helvetica" font-size="12px">connected</text></switch></g><rect x="700" y="40" width="180" height="150" fill="#cedbee" stroke="none" pointer-events="all"/><path d="M 280 390 L 280 370 L 380 370 L 380 130 L 346.37 130" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 341.12 130 L 348.12 126.5 L 346.37 130 L 348.12 133.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 360px; margin-left: 291px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: nowrap; ">yes</div></div></div></foreignObject><text x="291" y="363" fill="#000000" font-family="Helvetica" font-size="11px" text-anchor="middle">yes</text></switch></g><rect x="420" y="190" width="160" height="160" fill="none" stroke="#000000" stroke-dasharray="3 3" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-end; justify-content: unsafe flex-start; width: 158px; height: 1px; padding-top: 187px; margin-left: 422px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">resuming</div></div></div></foreignObject><text x="422" y="187" fill="#000000" font-family="Helvetica" font-size="12px">resuming</text></switch></g><path d="M 120 140 L 120 273.63" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 120 278.88 L 116.5 271.88 L 120 273.63 L 123.5 271.88 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 194px; margin-left: 151px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: nowrap; ">ready()</div></div></div></foreignObject><text x="151" y="197" fill="#000000" font-family="Helvetica" font-size="11px" text-anchor="middle">ready()</text></switch></g><rect x="40" y="80" width="320" height="80" fill="none" stroke="#000000" stroke-dasharray="3 3" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-end; justify-content: unsafe flex-start; width: 318px; height: 1px; padding-top: 77px; margin-left: 42px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #00Line truncated

docs/assets/connection_flow.drawio

@@ -0,0 +1,321 @@
+<mxfile host="Electron" modified="2021-08-30T18:05:06.237Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.9.6 Chrome/89.0.4389.128 Electron/12.0.16 Safari/537.36" etag="uzcLt7Oh4qtDsMY9WSdT" compressed="false" version="14.9.6" type="device">
+  <diagram id="GSbHU_PhJe-l3NQpc0X3" name="Connection Flow">
+    <mxGraphModel dx="710" dy="734" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="760" pageHeight="630" background="#EEF3FA" math="0" shadow="0">
+      <root>
+        <mxCell id="GTJXd52-XhRZD3rAr2nm-0" />
+        <mxCell id="GTJXd52-XhRZD3rAr2nm-1" parent="GTJXd52-XhRZD3rAr2nm-0" />
+        <mxCell id="2r3fOvGVNr9_K5ZBoRis-18" value="Client" style="text;html=1;align=left;verticalAlign=middle;resizable=1;points=[];autosize=0;strokeColor=none;fontStyle=1" parent="GTJXd52-XhRZD3rAr2nm-1" vertex="1">
+          <mxGeometry x="440" y="80" width="145" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-1" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="2r3fOvGVNr9_K5ZBoRis-28" target="IKjVovVhkWe_WipwIJL3-0">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="260" y="320.02" />
+              <mxPoint x="260" y="320.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-5" value="receive&lt;br&gt;resume" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;spacingRight=4;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-1">
+          <mxGeometry x="0.086" relative="1" as="geometry">
+            <mxPoint x="-20" y="-6" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-3" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="2r3fOvGVNr9_K5ZBoRis-28" target="IKjVovVhkWe_WipwIJL3-2">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="180" y="320.02" />
+              <mxPoint x="180" y="320.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-26" value="receive&lt;br&gt;register" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;spacingRight=4;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-3">
+          <mxGeometry x="-0.2268" relative="1" as="geometry">
+            <mxPoint x="-20" y="2" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-14" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="2r3fOvGVNr9_K5ZBoRis-28" target="IKjVovVhkWe_WipwIJL3-13">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="40" y="285.02" />
+              <mxPoint x="40" y="580.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-27" value="bad handshake&lt;br&gt;timeout" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-14">
+          <mxGeometry x="-0.6341" y="-2" relative="1" as="geometry">
+            <mxPoint x="28" y="17" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="2r3fOvGVNr9_K5ZBoRis-28" value="Wait for handshake" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=2;" parent="GTJXd52-XhRZD3rAr2nm-1" vertex="1">
+          <mxGeometry x="160" y="270.02000000000004" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="HutjLCx0ygpoBEJLSh69-0" value="Server" style="text;html=1;align=left;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fontStyle=1" parent="GTJXd52-XhRZD3rAr2nm-1" vertex="1">
+          <mxGeometry x="40" y="80" width="50" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="_PUvpjEMIo1z1dIbIUzw-0" value="&lt;p&gt;&lt;span&gt;Connection Flow&lt;/span&gt;&lt;br&gt;&lt;/p&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=left;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=0;fontSize=20;" parent="GTJXd52-XhRZD3rAr2nm-1" vertex="1">
+          <mxGeometry x="40" y="30" width="230" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="fGsjKHM69yN9R0Hf5M05-1" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="fGsjKHM69yN9R0Hf5M05-0" target="IKjVovVhkWe_WipwIJL3-7">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="220" y="180" />
+              <mxPoint x="180" y="180" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="fGsjKHM69yN9R0Hf5M05-0" value="WebSocket Open" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="160" y="119.98" width="120" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-4" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-0" target="IKjVovVhkWe_WipwIJL3-9">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="300" y="300.02" />
+              <mxPoint x="300" y="300.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-6" value="bad session" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;spacingLeft=4;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-4">
+          <mxGeometry x="-0.429" y="-1" relative="1" as="geometry">
+            <mxPoint x="29" y="-4" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-20" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-0" target="IKjVovVhkWe_WipwIJL3-19">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-29" value="valid" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-20">
+          <mxGeometry x="-0.1944" y="2" relative="1" as="geometry">
+            <mxPoint x="18" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-0" value="Validate resume" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="230" y="340.02" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-21" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-2" target="IKjVovVhkWe_WipwIJL3-18">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-28" value="valid" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-21">
+          <mxGeometry x="-0.2778" relative="1" as="geometry">
+            <mxPoint x="20" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-24" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-2" target="IKjVovVhkWe_WipwIJL3-13">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="60" y="355.02" />
+              <mxPoint x="60" y="560.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-30" value="bad token" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-24">
+          <mxGeometry x="-0.8093" y="1" relative="1" as="geometry">
+            <mxPoint x="29" y="23" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-2" value="Validate register" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="90" y="340.02" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-8" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-7" target="2r3fOvGVNr9_K5ZBoRis-28">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="180" y="260.02" />
+              <mxPoint x="180" y="260.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-7" value="Send hello" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="90" y="199.96" width="120" height="30.02" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-10" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-9" target="2r3fOvGVNr9_K5ZBoRis-28">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="260" y="260.02" />
+              <mxPoint x="260" y="260.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-9" value="Send invalidate" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="230" y="199.96" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-13" value="Close connection" style="rounded=1;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="160" y="550.02" width="120" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-15" value="Connected" style="rounded=1;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="160" y="480.02" width="120" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-22" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-18" target="IKjVovVhkWe_WipwIJL3-15">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="180" y="470" />
+              <mxPoint x="180" y="470" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-18" value="Send ready" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="90" y="410.02" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-23" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-19" target="IKjVovVhkWe_WipwIJL3-15">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="260" y="470" />
+              <mxPoint x="260" y="470" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-19" value="Send continue" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="230" y="410.02" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-31" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-37" target="IKjVovVhkWe_WipwIJL3-44">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="630" y="240.02" />
+              <mxPoint x="630" y="240.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-32" value="previous&lt;br&gt;session" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;spacingRight=8;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-31">
+          <mxGeometry x="0.086" relative="1" as="geometry">
+            <mxPoint x="-20" y="-2" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-33" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-37" target="IKjVovVhkWe_WipwIJL3-49">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="550" y="250.02" />
+              <mxPoint x="550" y="250.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-34" value="no&lt;br&gt;session" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;spacingRight=8;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-33">
+          <mxGeometry x="-0.2268" relative="1" as="geometry">
+            <mxPoint x="-20" y="5" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-35" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-37" target="IKjVovVhkWe_WipwIJL3-54">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="440" y="215.02" />
+              <mxPoint x="440" y="570.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-36" value="bad handshake&lt;br&gt;timeout" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-35">
+          <mxGeometry x="-0.6341" y="-2" relative="1" as="geometry">
+            <mxPoint x="35" y="-23" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-37" value="Wait for hello" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=2;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="530" y="199.96000000000006" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-60" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-39" target="IKjVovVhkWe_WipwIJL3-37">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-39" value="WebSocket Open" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="530" y="119.98" width="120" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-65" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-44" target="IKjVovVhkWe_WipwIJL3-61">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="660" y="360.02" />
+              <mxPoint x="660" y="360.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-44" value="Send resume" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="600" y="270.0199999999999" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-68" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-49" target="IKjVovVhkWe_WipwIJL3-67">
+          <mxGeometry relative="1" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-49" value="Send register" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="460" y="270.0199999999999" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-54" value="Close connection" style="rounded=1;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="530" y="550.02" width="120" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-55" value="Connected" style="rounded=1;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="530" y="480.0199999999999" width="120" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-64" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-61" target="IKjVovVhkWe_WipwIJL3-62">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="630" y="390.02" />
+              <mxPoint x="630" y="390.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-73" value="receive&lt;br&gt;invalidate" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-64">
+          <mxGeometry x="0.2133" relative="1" as="geometry">
+            <mxPoint x="-30" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-70" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-61" target="IKjVovVhkWe_WipwIJL3-54">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="700" y="570.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-74" value="bad handshake&lt;br&gt;timeout" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;rotation=90;spacingTop=7;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-70">
+          <mxGeometry x="-0.7644" y="2" relative="1" as="geometry">
+            <mxPoint x="-12" y="29" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-71" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-61" target="IKjVovVhkWe_WipwIJL3-55">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="630" y="450.02" />
+              <mxPoint x="630" y="450.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-75" value="receive&lt;br&gt;continue" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];spacingRight=4;labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-71">
+          <mxGeometry x="-0.3167" y="-1" relative="1" as="geometry">
+            <mxPoint x="-19" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-61" value="Wait for continue" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;strokeWidth=2;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="600" y="410.02" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-63" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-62" target="IKjVovVhkWe_WipwIJL3-49">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="550" y="320.02" />
+              <mxPoint x="550" y="320.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-62" value="Invalidate session" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="530" y="340.02" width="120" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-69" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-67" target="IKjVovVhkWe_WipwIJL3-54">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="470" y="560.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-77" value="bad handshake&lt;br&gt;timeout" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];rotation=90;labelBackgroundColor=none;spacingBottom=4;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-69">
+          <mxGeometry x="-0.8148" y="1" relative="1" as="geometry">
+            <mxPoint x="12" y="33" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-72" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="GTJXd52-XhRZD3rAr2nm-1" source="IKjVovVhkWe_WipwIJL3-67" target="IKjVovVhkWe_WipwIJL3-55">
+          <mxGeometry relative="1" as="geometry">
+            <Array as="points">
+              <mxPoint x="550" y="470.02" />
+              <mxPoint x="550" y="470.02" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-76" value="receive&lt;br&gt;ready" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];labelBackgroundColor=none;" vertex="1" connectable="0" parent="IKjVovVhkWe_WipwIJL3-72">
+          <mxGeometry x="-0.2389" y="2" relative="1" as="geometry">
+            <mxPoint x="-22" as="offset" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="IKjVovVhkWe_WipwIJL3-67" value="Wait for ready" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;strokeWidth=2;" vertex="1" parent="GTJXd52-XhRZD3rAr2nm-1">
+          <mxGeometry x="460" y="410.02" width="120" height="30" as="geometry" />
+        </mxCell>
+      </root>
+    </mxGraphModel>
+  </diagram>
+</mxfile>

docs/assets/connection_flow.svg

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="760px" height="630px" viewBox="-0.5 -0.5 760 630" style="background-color: rgb(238, 243, 250);"><defs/><g><rect x="440" y="80" width="145" height="20" fill="none" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe flex-start; width: 1px; height: 1px; padding-top: 90px; margin-left: 442px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; font-weight: bold; white-space: nowrap; ">Client</div></div></div></foreignObject><text x="442" y="94" fill="#000000" font-family="Helvetica" font-size="12px" font-weight="bold">Client</text></switch></g><path d="M 260 300.02 L 260 320 L 260 333.65" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 260 338.9 L 256.5 331.9 L 260 333.65 L 263.5 331.9 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 316px; margin-left: 238px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: nowrap; ">receive<br />resume</div></div></div></foreignObject><text x="238" y="319" fill="#000000" font-family="Helvetica" font-size="11px" text-anchor="middle">receive...</text></switch></g><path d="M 180 300.02 L 180 320 L 180 333.65" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 180 338.9 L 176.5 331.9 L 180 333.65 L 183.5 331.9 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 318px; margin-left: 158px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: nowrap; ">receive<br />register</div></div></div></foreignObject><text x="158" y="322" fill="#000000" font-family="Helvetica" font-size="11px" text-anchor="middle">receive...</text></switch></g><path d="M 160 285 L 40 285 L 40 580 L 153.63 580" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 158.88 580 L 151.88 583.5 L 153.63 580 L 151.88 576.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 300px; margin-left: 91px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: nowrap; ">bad handshake<br />timeout</div></div></div></foreignObject><text x="91" y="304" fill="#000000" font-family="Helvetica" font-size="11px" text-anchor="middle">bad handshake...</text></switch></g><rect x="160" y="270.02" width="120" height="30" fill="#ffffff" stroke="#000000" stroke-width="2" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 285px; margin-left: 161px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "Line truncated

docs/assets/connector_states.svg

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="800px" height="440px" viewBox="-0.5 -0.5 800 440" style="background-color: rgb(238, 243, 250);"><defs/><g><path d="M 170 365.02 L 170 385 L 290 385 L 290 371.39" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 290 366.14 L 293.5 373.14 L 290 371.39 L 286.5 373.14 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 110 350 L 40 350 L 40 130 L 103.63 130" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 108.88 130 L 101.88 133.5 L 103.63 130 L 101.88 126.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><rect x="110" y="335.02" width="100" height="30" fill="#ffffff" stroke="#000000" stroke-width="2" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 98px; height: 1px; padding-top: 350px; margin-left: 111px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">connected</div></div></div></foreignObject><text x="160" y="354" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">connected</text></switch></g><path d="M 290 335.02 L 290 315 L 180 315 L 180 328.65" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 180 333.9 L 176.5 326.9 L 180 328.65 L 183.5 326.9 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 350 335.02 L 350 135 L 216.37 135" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 211.12 135 L 218.12 131.5 L 216.37 135 L 218.12 138.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 320 335.02 L 320 235 L 216.37 235" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 211.12 235 L 218.12 231.5 L 216.37 235 L 218.12 238.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><rect x="270" y="335.02" width="100" height="30" fill="#ffffff" stroke="#000000" stroke-width="2" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 98px; height: 1px; padding-top: 350px; margin-left: 271px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">resuming</div></div></div></foreignObject><text x="320" y="354" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">resuming</text></switch></g><path d="M 500 149.96 L 500 223.59" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 500 228.84 L 496.5 221.84 L 500 223.59 L 503.5 221.84 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><rect x="460" y="119.96" width="80" height="30" fill="#ffffff" stroke="#000000" stroke-width="2" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 135px; margin-left: 461px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">closed</div></div></div></foreignObject><text x="500" y="139" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">closed</text></switch></g><path d="M 520 259.96 L 520 280 L 630 280 L 630 266.33" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 630 261.08 L 633.5 268.08 L 630 266.33 L 626.5 268.08 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 480 229.96 L 480 190 L 480 156.33" fill="noneLine truncated

docs/communication.md

@@ -0,0 +1,36 @@
+# Communication Layer
+
+<sub>This document describes the communication layer in Clusterio and unless you're developing Clusterio it's probably not going to be very useful for you.</sub>
+
+Communication is facilitated by the lib/link library and is based on three core abstractions: links, connectors and messages.
+Links represents one side of a two way communication pipe, connectors deal with connecting and establishing communication, and messages are the content sent over the link.
+
+
+## Link
+
+The Link class represents one side of a two way communication channel where the actual communication is done by a connector associated with the link.
+The link also knows what the endpoint types it's connected to are via the source and target attributes.
+
+The endpoint types currently implemented are master, slave, instance, and control.
+Although slave and instances run in the same Node.js program they use virtual links to communicate between them in order to simplify the communication architecture.
+
+Upon creation the link will register with the connector in order to receive and process messages from it.
+The messages received are validated using the validator registered for the type of the message.
+A message for which there is no validator for is considered an error.
+
+
+## Connector
+
+The connector used with a link is responsible for establishing and/or maintain the connection that messages are sent over.
+Reconnect logic is expected to be implemented in the connector, though this has not yet been done.
+
+There's also the virtual connector which lets two links in the same program be connected to each other without having to establish a network connection.
+
+
+## Message
+
+There's two types of messages currently implemented apart from the Link builtin close message and that's Request and Event.
+The builtin messages are defined in [packages/lib/link/messages.js](/packages/lib/link/messages.js) and are attached to links via the attachAllMessages function, which is usally called in the Link subclass constructor.
+
+The messages define which links they are valid on and only attaches handlers for those links.
+There's also a forwarding mechanism for when a request or event is to be forwarded another hop.

docs/config-system.md

@@ -0,0 +1,78 @@
+# Configuration System
+
+<sub>This document describes the implementation and inner working of the configuration system in Clusterio, and unless you're developing Clusterio it's probably not going to be very useful for you.</sub>
+
+Clusterio uses a group based configuration system to manage settings for the master server, instances, slaves, and the clusterioctl utility.
+Plugins get their own config group for the master server and instances which they can add their own fields to.
+The fields are defined early in the startup, and the groups and their fields for disabled plugins will still be created.
+
+The built-in config groups and their fields are defined in [packages/lib/config/definitions.js](/packages/lib/config/definitions.js) while plugins can add their own config groups to the `MasterConfigGroup` and `InstanceConfigGroup` properties of the `info.js` export using subclasses of `PluginConfigGroup`.
+The plugin group has the enabled field pre-defined on it, and it's used to enable/disable plugins.
+
+
+## Defing Fields
+
+Fields are defined using the `define` class method on group classes after the groupName have been set and before the class has been finalized.
+The `define` method takes an object as argument with the following properties:
+
+**access**:
+    The locations this config field can be read and modified from.
+    This is an array of strings which can contain the values `"master"`, `"slave"` and `"control"`.
+    If a party is missing in this array then that party will not receive the value of this field when the config is shared, and will be unable to modify the field.
+    Takes the value of `defaultAccess` set on the config group class if not passed.
+    Note that instance config groups should have both `"master"` and `"slave"` for all of its fields or unexpected behaviour may occur.
+
+**type**:
+    The type of config value this field will support.
+    The supported values are boolean, string, number, and object, and if an attept is made to set the field to a value that is not of the right type it will be reject unless it's a string that can be converted to the right type.
+
+**name**:
+    Name of the configuration field, this is the primary way the field is accessed, both in code and on the command line.
+    As such it should follow the lower\_case\_underscore style and not contain any spaces or dots.
+
+**title** (optional):
+    Text used to identify the config field in user interfaces.
+
+**description** (optional):
+    Text used to describe the config field in user interfaces.
+
+**enum** (optional):
+    Array of acceptable values this field can have.
+    Attempts to set a value not in this array will be rejected, which makes it useful for making enumareted list of choices.
+
+**optional** (optional):
+    True if this field can be set to null.
+    Defaults to false.
+
+**initial_value** (optional if optional is true):
+    Value this config field should take in a newly initialized config.
+    This can also be an async function returning the value to use.
+
+If the value for a field stored in on disk somehow ends up being invalid the field will take on the initial\_value instead when the config is loaded.
+
+
+## Accessing Fields
+
+On the Config instance there's two ways to access fields: through the set and get methods using dot notation.
+E.g.:
+
+    let value = configInstance.get("group.field");
+
+Or by getting the group first and then calling set or get on that.
+E.g.:
+
+    let value = configInstance.group("group").get("field")
+
+The set method takes an extra argument, which is the value to set the field to.
+If the value is not valid this will throw an InvalidValue exception, if the group or field doesn't exist it will throw an InvalidField exception.
+
+
+## Config Lifecycle
+
+Values for all config fields are created when the config is initialized, as well as for any fields with missing values when a config is loaded.
+Once a field has a value it is never automatically removed, even if the field or group it was part of no longer exists.
+This ensures that plugin configuration is not lost should the server be started up without the plugins that defined the configuration installed.
+
+For instance configs, they are kept on the master server and serialized and sent over to the relevant slaves on startup.
+This makes it possible to edit instance configs when the slave the instance is on is offline.
+A copy is also stored in the instance directory on the slave, and this config will be deliverd to the master server on slave startup, which enables instances to be copied between clusters as long as their IDs are unique.

docs/configuration.md

@@ -0,0 +1,408 @@
+# Configuration
+
+
+## Master Configuration
+
+### master.name
+
+Name of the cluster.
+Used to distinguish it from other clusters and is prepended to the name of servers in the server list.
+
+Defaluts to "Your Cluster".
+
+
+### master.database_directory
+
+Directory used to store cluster data to.
+Needs to be writeable by the master server.
+This is also used by plugins to store its data.
+
+Defaults to "database".
+
+
+### master.http_port
+
+Port to host HTTP server on.
+If set to null no HTTP server will be exposed.
+At least one of this and master.https_port needs to be set to a port.
+
+Defaults to 8080.
+
+
+### master.https_port
+
+Port to host HTTPS server on.
+Uses master.tls_certificate and master.tls_private_key as the certificate and private key for the HTTPS server.
+If set to null no HTTPS server will be exposed.
+At least one of this and master.http_port needs to be set to a port.
+
+See the [Setting up TLS](/docs/setting-up-tls.md) document for a guide to setting up HTTPS with Clusterio.
+
+Defaults to null.
+
+
+### master.bind_address
+
+IP address to bind the HTTP and HTTPS ports on.
+Useful to limit which interface to accept connections from.
+If set to null the unspecified IPv6 address will be used, which on most systems means it will also listen on the unspecified IPv4 address and accept connections from all
+interfaces.
+
+Defaults to null.
+
+
+### master.external_address
+
+External address the master server is accessible on.
+Currently only used for `clusteriomaster bootstrap create-ctl-config` in order to give the right url to connect to.
+This should be a full URL ending with a /.
+
+Defaults to null meaning assume localhost.
+
+
+### master.tls_certificate
+
+Path to TLS certificate to use for the HTTPS server when master.https_port is configured.
+
+Defaults to "database/certificates/cert.crt".
+
+
+### master.tls_private_key
+
+Path to TLS private key to use for the HTTPS server when master.https_port is configured.
+
+Defaults to "database/certificates/cert.key".
+
+
+### master.auth_secret
+
+Base64 encoded authentication secret used to verify tokens issued to slaves, users, and sessions.
+This should contain 256 bytes of random data, and if changed will cause all tokens become invalid.
+Keep this secret if leaked an attacker could easily compromise the cluster.
+
+Defaults to null which means generate a secure secret on startup.
+
+
+### master.heartbeat_interval
+
+Interval in seconds heartbeats are sent out at for WebSocket connections.
+If a WebSocket connection hasn't received a heartbeat in 2 times the heartbeat interval it will be considered stale and closed.
+A lower value means less time between connections going stale and them being closed.
+
+Defaults to 15.
+
+
+### master.session_timeout
+
+Time in seconds from the connection is closed following a heartbeat timeout until the session is invalidated and data loss occurs.
+A higher timeout gives more time for a client to recconect and resume an active session over a connection that was dropped, but also leads to stale connections taking longer to clear out.
+In the case of the master or client crashing the data loss is unavoidable.
+
+Value should not be less than the configured `max_reconnect_delay` of the clients and it should be greater than 2 times `master.heartbeat_interval`.
+Defaults to 60.
+
+
+### master.metrics_timeout
+
+Timeout in seconds before a call to gather metrics from a slave times out.
+This should be less than both the timeout and collection interval configured for the collection job in Prometheus.
+
+Defaults to 8.
+
+
+### master.stream_timeout
+
+Timeout in seconds for proxy streams through the master that has been created but is not yet sending data to be automatically closed.
+Streams that have started sending data before this timeout is not affected.
+
+Defaults to 15.
+
+
+### master.default_role_id
+
+Role to automatically grant to new users.
+If null no role is granted.
+
+Defaults to 1 which correspond to the default Player role.
+
+
+### <plugin_name>.load_plugin
+
+Whether to load the plugin on the master server.
+Plugins not loaded on the master server will not be loaded on instances.
+
+Defaults to true.
+
+
+## Slave Configuration
+
+### slave.name
+
+Name of the slave.
+Shows up in slave lists and is used to reference this slave in the clusterioctl command line interface.
+
+Defaults to "New Slave".
+
+
+### slave.id
+
+Immutable numeric id of the slave which uniquely identifies this slave in the cluster.
+
+Defaults to a random 31 bit number.
+
+
+### slave.factorio_directory
+
+Directory to look for the Factorio server(s) in.
+This can either point to a Factorio server directory, or to a directory containing multiple versions of the Factorio server.
+
+Defaults to "factorio".
+
+
+### slave.instances_directory
+
+Directory to store instances in.
+One sub-directory will be created in it for each instance assigned to this slave and these sub-directories will contain logs, saves, and various auto generated configuration files for the instances.
+
+Defaults to "instances".
+
+
+### slave.master_url
+
+URL to connect to the master server to.
+
+Defaults to "http://localhost:8080/".
+
+
+### slave.master_token
+
+Access token used for authenticating with the master server.
+You can generate an access token with `clusterioctl slave generate-token --id <slave-id>`, or use the `clusterioctl slave create-config` to create a new slave config with the correct url and token in it.
+
+Defaults to "enter token here".
+
+
+### slave.tls_ca
+
+Path to certificate in PEM format to use for validating a TLS connection to the master server.
+If you have a self signed certificate on the master server you will need to copy the certificate to your slaves and set it as the certificate authority with this option.
+
+Defaults to null meaning use Node.js's default set of trusted certificate authorities.
+
+
+### slave.public_address
+
+External address instances hosted on this slave can be accessed on.
+This is used by plugins like Server Select to give the correct address to switch between instances in-game.
+
+Defaults to "localhost".
+
+
+### slave.max_reconnect_delay
+
+Maximum delay in seconds to wait after connection to the master server is dropped before attempting to reconnect to it.
+The actual delay on each reconnect will be a random number between 0 and this configured value to avoid all clients trying to reconnect at the same time.
+
+Defaults to 60.
+
+
+## Instance Configuration
+
+### instance.name
+
+Name of the instance, shown in instance lists and used to reference to this instance in the clusterioctl command line interface.
+
+Defaults to "New Instance".
+
+
+### instance.id
+
+Imutable numeric id of the instance which uniquely identifies this instance in the cluster.
+
+Defaluts to a random 31 bit integer.
+
+
+### instance.assigned_slave
+
+Slave this instance is assigned to.
+To change this you need to use the separate assign instance interface.
+After being assigned to a slave the directory for the instance is created on the slave.
+
+Defaults to null meaning not assigned.
+
+
+### instance.auto_start
+
+If enabled start this instance when the slave it is assigned to is started up.
+Does not affect start or stop of the instance while the slave is running.
+
+Defaults to false.
+
+
+### factorio.version
+
+Version of Factorio to use for this instance.
+Can be a version like "1.0.0" or special string "latest" meaning the latest version of Factorio found on the slave.
+
+Defaults to "latest".
+
+
+### factorio.game_port
+
+UDP port to run the Factorio server on.
+If null a random port in the dynamyc range assigned each time the instance starts.
+
+Defaults to null.
+
+
+### factorio.rcon_port
+
+TCP port to start the RCON interface on the Factorio server on.
+If null a random port in the dynamic range is assigned each time the instance starts.
+
+Defaults to null.
+
+
+### factorio.rcon_password
+
+Password to use for the RCON interafec.
+If null a random secure password is generated and used each time the instance starts.
+
+Defaults to null.
+
+
+### factorio.enable_save_patching
+
+Whether to use save patching or not.
+When enabled lua code is patched into the game save before starting it.
+Most plugins require the use of save patching to function.
+Turning it off makes it possible to use Clusterio to run and manage regular vanilla games and scenarios not compatible with Clusterio.
+
+Defaults to true.
+
+
+### factorio.enable_whitelist
+
+Turn on the whitelist on the server.
+
+Defaults to false.
+
+
+### factorio.settings
+
+Object with the settings to put into `server-settings.json` for the Factorio server.
+The settings in `data/server-settings.example.json` of the Factorio installation is used as the base and properties specified here overrides the properties there.
+
+Changes to the following properties will be applied live if the instance is running while it is changed: `afk_autokick_interval`, `allow_commands`, `autosave_interval`, `autosave_only_on_server`, `description`, `ignore_player_limit_for_returning_players`, `max_players`, `max_upload_slots`, `max_upload_in_kilobytes_per_second`, `name`, `only_admins_can_pause_the_game`, `game_password`, `require_user_verification`, `tags`, `visibility`.
+
+Defaults to {"tags":["clusterio"],"auto_pause":false}.
+
+
+### factorio.verbose_logging
+
+Pass the `--verbose` flag to Factorio when starting the server.
+This prints more messages to the log.
+
+Defaults to false.
+
+
+### factorio.strip_paths
+
+Strip down absolute paths in the server log going to files inside the instance directory such that they are relative to the instance directory.
+This improves the signal to noise ratio of the log.
+
+Sample output when disabled:
+
+    0.487 Loading map /srv/clusterio/instances/test/saves/world.zip: 2615888 bytes.
+    0.614 Checksum for script /srv/clusterio/instances/test/temp/currently-playing/control.lua: 2390553941
+    1.277 Script @/srv/clusterio/instances/test/temp/currently-playing/modules/example/test.lua:7: Example log line.
+
+Sample output when enabled:
+
+    0.487 Loading map saves/world.zip: 2615888 bytes.
+    0.614 Checksum for script temp/currently-playing/control.lua: 2390553941
+    1.277 Script @modules/example/test.lua:7: Example log line.
+
+Defaults to true.
+
+### factorio.sync_adminlist
+
+Synchronize in-game admin list with admin status of the users in cluster.
+If enabled Clusterio will generate a new `server-adminlist.json` on instance startup based on the users in the cluster with admin status set to true, and keep the admins in sync with the users that have admin status while the instance is running.
+
+Defaults to true.
+
+
+### factorio.sync_whitelist
+
+Synchronize in-game whitelist with the whitelisted status of the users in the cluster.
+If enabled Clusterio will generate a new `server-whitelist.json` on instance startup based on the users in the cluster with whitelisted status set to true, and keep the whitelisted users in sync with the users that have whitelisted status while the instance in running.
+
+Defaults to true.
+
+
+### factorio.sync_banlist
+
+Synchronize in-game banlist with the banned status of users in the cluster.
+If enabled Clusterio will generate a new `server-banlist.json` on instance startup based on users in the cluster with banned status set to true, and keep the banned users in sync with the users that have the banned status while the instance is running.
+
+Defaults to true.
+
+
+### factorio.max_concurrent_commands
+
+Maximum number of commands being transmitted into the game in parallel.
+Since the rate at which long commands are streamed into the game is by default limeted to 100 bytes/tick and scales down to 25 bytes/tick when there's 20 players connected, long commands can hold up the command interface and cause large latencies in getting data pushed into the game.
+(The rates are controlled by the `segment_size` options in the server settings.)
+To counteract this Clusterio sends up to this configured value number of commands in parallel over the RCON interface.
+This causes the game updates sent to clients to have this many command streams in parallel contained in them, drastically increasing the maxiumum size they can become.
+Since commands are only processed so ofter the maximum rate of commands that can be sustained is roughly 30 times this configured value per second, though note that large commands will lower this value.
+
+The game updates sent by the server is split into roughly 500 byte packets, and if any one of those parts are lost the entire update is resent.
+This means a high number of concurrent commands can amplify resends due to packet loss and degrade the player experience up to the point of becomming completely unplayable.
+
+Prior to 0.18.7 the maximum practical size of game update sent where arround 8 kB due to the UDP receive buffer on windows defaulting to this value, larger updates would not get through the receive buffer and cause the connection to drop.
+To stay below the 8 kB limit the maximum safe value for this option would be around 7000 / (3 * game_speed * maximum_segment_size), which is around 20 in normal circumstances.
+
+Defaults to 5.
+
+
+### <plugin_name>.load_plugin
+
+Whether to load the given plugin on the instance.
+Note that plugins need to be loaded on the master server in order for them to be loaded on instances.
+
+Defaults to true.
+
+
+## Control Configuration
+
+### control.master_url
+
+URL to connect to the master server to.
+
+Defaults to null meaning complain about it not being set and exit.
+
+
+### control.master_token
+
+Access token used for authenticating with the master server.
+You can generate an access token with `clusteriomaster bootstrap generate-user-token <username>`, or use the `clusteriomaster bootstrap create-ctl-config <username>` to create a new ctl config with the correct url and token in it.
+
+Defaults to null meaning complain about it not being set and exit.
+
+
+### control.tls_ca
+
+Path to certificate in PEM format to use for validating a TLS connection to the master server.
+If you have a self signed certificate on the master server you will need to copy the certificate to the computer you run clusterctl from and set it as the certificate authority with this option.
+
+Defaults to null meaning use Node.js's default set of trusted certificate authorities.
+
+
+### control.max_reconnect_delay
+
+Max duration in seconds to wait before attempting to reconnect with the master server after the connection is dropped.
+The actual delay on each reconnect will be a random number between 0 and this configured value to avoid all clients trying to reconnect at the same time.
+
+Defaults to 60.

docs/contributing.md

@@ -0,0 +1,304 @@
+# Contributing to Clusterio
+
+You are probably reading this because you want to contribute code to Clusterio.
+Great!  We need people like you.
+Though we have some conventions and workflows that we kindly ask you to follow.
+
+
+## Contents
+
+- [Workflow](#workflow)
+    - [Starting a Feature Branch](#starting-a-feature-branch)
+    - [Setting up the Development Environment](#setting-up-the-development-environment)
+    - [Checking your code for errors](#checking-your-code-for-errors)
+    - [Submitting a Pull Request](#submitting-a-pull-request)
+    - [Editing your Feature Branch](#editing-your-feature-branch)
+    - [Resolving Merge Conflicts](#resolving-merge-conflicts)
+    - [Updating Your GitHub Fork](#updating-your-github-fork)
+- [Changelog](#changelog)
+- [Supported Node.js and Factorio Version](#supported-node.js-and-factorio-version)
+- [Code Style](#code-style)
+    - [Naming Style](#naming-style)
+    - [Indenting](#indenting)
+    - [Line Length](#line-length)
+    - [Markdown](#markdown)
+- [Pushing releases to npm](#pushing-releases-to-npm)
+
+
+## Workflow
+
+While we don't require you to follow this workflow, it makes things much simpler for both you and us if you choose to do so.
+Especially when it comes to making the commit history reflect what happened and not be a giant ball of mess.
+GitHub's git workflow is less than ideal for dealing with small feature-branches so you might see things being done here a little diffrent than the usual.
+
+It is recommended that you use the command line git version for doing the operations described here.
+GUI wrappers tend to have different ideas of what is what and you might find it difficult to make it do the things described here.
+For doing the actual commits though, your faviorit git GUI should work just fine.
+
+If you pressed the fork button on GitHub and used `git clone` _on your own fork_ you can skip to the next paragraph.
+Otherwise you will have to click the fork button and clone your fork.
+If you already cloned the main GitHub repository you can change your clone to point at your own fork using the `git remote` command, but it's probably easier to delete your local clone and clone it again.
+
+To keep your local repository up to to date with the main repository add the main repository as a remote.
+
+    git remote add upstream https://github.com/clusterio/clusterio
+
+After this running `git fetch upstream` will get the updated branches from the main repository.
+Do not run `git pull upstream` it will mess thing up!
+
+
+### Setting up the Development Environment
+
+The project is organized into several packages that are all managed through Lerna.
+In order to get the development environment up and running you will need to run the following commands:
+
+    npm install
+    npx lerna bootstrap --hoist
+    npx lerna run build
+
+This installs dependencies needed by tests and links the packages up so they work from the git work tree.
+To start a cluster from the repo you will first need to initialize it, this can be done using the installer:
+
+    node packages/create --dev
+
+To add plugins to use in the development environment use
+
+    node packages/ctl plugin add ./path/to/plugin
+
+It's important that the path starts with `./`.
+The `plugins/` directory contains the core plugins for the project and can be added using the above mentioned command.
+
+The documentation uses the binaries provided by the packages, but for the development environment you will need to call the packages directly:
+
+    npx clusteriomaster -> node packages/master
+    npx clusterioslave -> node packages/slave
+    npx clusterioctl -> node packages/ctl
+
+Note that to use `clusterioctl` you will have to create a control config first:
+
+    node packages/master bootstrap create-ctl-config [admin-user]
+
+Once you've set up the cluster you can use `node packages/master run` to run the master server and `node packages/slave run` to run the slave which connects to the master server.
+
+For web development on the master there are also the following flags.
+
+`--dev` - Recompile the `web_ui` package on the fly providing live reloading of it.
+
+`--dev-plugin [name]` - Recompile the web module for the given plugin on the fly proving live reloading of it.
+
+These options can be combined and multiple plugins can be actived for dev mode.
+Note that webpack is configured to delete the web interface build when using these options, so you will have to run `npx lerna run build` before you start the master without these flags again.
+
+
+### Starting a Feature Branch
+
+Development is done exclusively in feature branches.
+This means the first thing to do before starting any development at all is to make a new branch starting from the master branch of the main repository.
+To do this check out that branch from the main repository.
+
+    git fetch upstream
+    git checkout upstream/master
+
+This will give a warning about detached HEAD which means you did it correctly.
+Now you can make a feature branch based on this with.
+
+    git checkout -b my-feature-branch
+
+The name of the branch is not important, as long as it's not a name you've used before.
+But it's nice to have its name be somewhat descriptive of what it implements.
+
+
+### Checking your code for errors
+
+There's automated tests and linting setup for the project.
+Please do add tests for any code you add and run both:
+
+    npm run test
+    npm run lint
+
+To check that your changes pass the integration tests as well as the ESLint rules set up for the project.
+
+
+### Submitting a Pull Request
+
+Once you've commited changes to your feature branch that you want to have included into the main repository push it to you fork with
+
+    git push origin my-feature-branch
+
+and make a pull request through the GitHub web interface.
+You can also pass the `--set-upstream` (or `-u`) flag to make `git push` do the same thing for this branch.
+After your feature branch have been merged you should consider it final.
+If there are more changes you want to have merged or mistakes you need to fix you must start a new feature branch and submit a new pull request.
+
+
+### Editing your Feature Branch
+
+Until your feature branch is merged you can edit it as you see fit by using the rebase tool.
+If your feature branch has been merged however it's final and you will have to start a new feature branch and submit that in a new pull request.
+The base usage of rebase assuming you are checked out on your feature branch is the following command
+
+    git rebase -i upstream/master
+
+This will open up an editor with the commits of your feature branch and let you reorder, edit, and remove commits as you see fit.
+
+If the main repository has been updated and you have fetched down those updates with `git fetch upstream` this will also move your feature branch so that it is based on the latest commit from the main repository.
+
+If you have already pushed your feature branch to your fork a simple `git push origin my-feature-branch` will no longer work as the histories are different, instead you will have to run
+
+    git push origin +my-feature-branch
+
+The + sign signifies a force push and should be used with care.
+If you have a pull request that has not yet been merged submitted for this feature branch this will update the pull request too.
+
+
+### Resolving Merge Conflicts
+
+The best way to resolve merge conflicts in feature braches is to rebase it on top of the updated upstream.
+Run the following commands
+
+    git fetch upstream
+    git rebase upstream/master
+
+This will stop on the commit(s) that caused the merge conflict and let you resolve them manually before continuing.
+Once you're done force push your updated feature branch with
+
+    git push origin +my-feature-branch
+
+
+### Updating Your GitHub Fork
+
+No.
+This is pointless busywork that accomplishes nothing.
+Fetch the main repository directly as described above and base your feature branches on the refs from it.
+GitHub has no interface or functionality for keeping the branches in your fork up to date with the branches in the main repository and there is no point in doing this for our feature branch based workflow.
+
+
+## Changelog
+
+There's a [Changelog](../CHANGELOG.md) in the root of the project.
+If you make changes that are visible to users of this project you should add an entry to the changelog describing what has changed.
+The format of this log should be self explanatory, please follow it carefully.
+
+
+## Supported Node.js and Factorio Versions
+
+Clusterio run on Node.js v12 and up, make sure to check that the Node builtin API's and npm packages you use are supported on these versions.
+The Travis CI tests are runned on whatever version of Node.js v12 is the default.
+
+For Factorio Clusterio 2.0 aims to support version 0.17.69 and up, including the latest experimental release.
+It's recommended that you use the lua API reference for 0.17.69, as there's no information on what version Factorio API's were introduced in.
+The Travis CI tests are runned against latest experimental release.
+
+
+## Code Style
+
+The style of the code is a bit of a mixed bag at the moment.
+But there are at least a few things that have been agreed upon.
+
+
+### Naming style
+
+JavaScript variables in general uses camelCase.
+The exception is for classes/constructors which use PascalCase and variables destructured from over the wire objects.
+
+Fields in configs and messages sent over links uses lowercase_underscore.
+
+JavaScript files are named using lowercase_underscore for files that export multiple items.
+Files containing and exporting a single class should be named the same as the class in PascalCase.
+
+Imported modules from the lib package are prefixed with lib to make them easier to distinguish, as the names tend to be very generic.
+E.g.:
+
+    const libLink = require("@clusterio/lib/link");
+    const libLuaTools = require("@clusterio/lib/lua_tools");
+
+
+For lua code lowercase_underscore is used for everything.
+
+
+### Strings
+
+JavaScript and Lua code should use double quoted strings (`"string"`) for all strings with the only exception that strings that contain double quotes may use single quotes (i.e., `'String with "quotes"'`).
+JavaScript template literals may also be used where appropriate.
+
+
+### Indenting
+
+JavaScript and Lua code should be indented with tabs.
+
+Other files types should prefer tabs for indents where reasonable with the exception of Markdown.
+
+
+### Line Length
+
+Lines are limited to 120 characters where tabs count as 4 characters.
+If the argument list for a function or expressino for compound statement gets very long break them out on their own line(s).
+For example:
+
+    function foo(
+        really, long, argument, list,
+        over, multiple, lines
+    ) {
+        if (
+            really && long && expression
+            || over && multiple && lines
+        ) {
+            // code
+        }
+    })
+
+
+### Markdown
+
+Markdown files are formatted using one line per sentence to improve diff reports when making changes.
+Headings have two spaces before them and on space after them to make them stand out, the heading at the top of the file does not have any spaces before it, and heading immediadly followed by another heading have one space between them.
+For example:
+
+```md
+# A markdown File
+
+Sentence of text which end in a period.
+Each sentence is on it's own line.
+And there's two spaces before the next heading.
+
+
+## Subheading
+
+### Sub-subheading
+
+Headings use the `# heading` format.
+```
+
+
+## Pushing releases to npm
+
+The releases are done by creating a new release tag with lerna and then uploading that with lerna.
+You will need commit access to the repository as well publish access to the @clusterio org on npm to do this.
+
+1.  To do a release switch to the master branch and make sure it's up to date with the repository before proceeding.
+
+    ```sh
+    git switch master
+    git pull --ff-only upstream master
+    ```
+
+    Check and make sure there are no untracked files with `git status`, otherwise they will be auto commited!
+
+2.  Run a lerna version to create and tag a new version.
+    This will push a commit to the master branch.
+
+    ```sh
+    npx lerna version prerelease --git-remote upstream --no-granular-pathspec
+    ```
+
+3.  Run a full build in every package to update the dist/ files.
+
+    ```sh
+    npx lerna run build
+    ```
+
+4.  Publish the packages with lerna.
+
+    ```sh
+    npx lerna publish from-package
+    ```

docs/developing-for-clusterio.md

@@ -0,0 +1,297 @@
+# Developing for Clusterio
+
+This document describes the various different types of content that can be created for Factorio and/or Clusterio and how this is made compatible with Clusterio.
+
+
+## Contents
+
+- [Factorio Mods](#factorio-mods)
+- [Factorio Scenarios](#factorio-scenarios)
+    - [event_handler interface](#event_handler-interface)
+- [Communicating with Clusterio](#communicating-with-clusterio)
+- [Clusterio Modules](#clusterio-modules)
+- [Clusterio Lua API](#clusterio-lua-api)
+- [Clusterio Plugins](#clusterio-plugins)
+
+
+## Factorio Mods
+
+Factorio mods that do not interact with Clusterio should not have any considerations that need to be taken into account for them to work with Clusterio.
+
+
+## Factorio Scenarios
+
+Clusterio patches saves and because of this scenarios have a few limitations and must explicitly mark themselves as compatible with Clusterio to work.
+The main limitation is that the [event_handler](https://github.com/wube/factorio-data/blob/master/core/lualib/event_handler.lua) lib must be used, and control.lua cannot contain any code other than calls to event_handler loading the relevant libs of the scenario.
+This is because the control.lua file will be overwritten by the save patcher.
+Scenarios also cannot use the event registering functions exposed by `script` such as `script.on_event` or `script.on_nth_tick` as using these will overwrite the handlers registered by the event_handler lib.
+
+A brief description of the usage of the event_handler library is provided in the [event_handler interface](#event_handler-interface) section.
+
+Once a scenario is made using the event_handler it should have a control.lua file that looks something like this:
+
+```lua
+-- control.lua
+local event_handler = require("event_handler")
+event_handler.add_lib(require("module_foo"))
+event_handler.add_lib(require("module_bar"))
+```
+
+To make Clusterio recognize and correctly handle this scenario it needs to include a clusterio.json file with following content:
+
+```json
+{
+    "scenario": {
+        "name": "example-scenario",
+        "modules": [
+            "module_foo",
+            "module_bar"
+        ]
+    }
+}
+```
+
+This tells Clusterio that it should load both module_foo and module_bar by passing the result of requiring them to the `add_lib` function when writing a new control.lua file to the save.
+
+
+### event_handler interface
+
+<sub>**Note:** At the time of writing the event_handler lib has been a part of Factorio since at least 0.17.4, and was moved from base to core in 0.17.63 but is still not documented anywhere.
+A brief description is provided here for this reason.</sub>
+
+The event_handler lib provides a simple interface for registering multiple callbacks to the same events without having to be concerned with callback chaining or overwriting callbacks defined elsewhere.
+It works by taking over the task of registering the actual callbacks with Factorio, providing its own interface for the rest of the code to use.
+
+The sole function of interest exported by event_handler is `add_lib` which accepts a table with event handler callbacks definitions that it will register.
+The following entries are recognized by `add_lib`, all of which are optional:
+
+- `on_init`:
+    Callback called when the callback of `script.on_init` is invoked.
+- `on_load`:
+    Callback called when the callback of `script.on_load` is invoked.
+- `on_configuration_changed`:
+    Callback called when the callback of `script.on_configuration_changed` is invoked.
+- `events`:
+    Table mapping event ids as defined in `defines.events` to callbacks.
+    For example the table `{ [defines.events.on_player_died] = foo }` will call bar with the usual `event` table as argument every time a player dies.
+- `on_nth_tick`:
+    Table mapping the nth tick number to a callback.
+    For example the table `{ [30] = bar }` will call bar every 30th tick.
+- `add_remote_interface`:
+    Callback called before on_init/on_load callbacks<sup>[1]</sup>.
+    It has no special meaning and receives no arguments but should be used for registering remote interfaces.
+- `add_commands`:
+    Callback called before on_init/on_load callbacks<sup>[1]</sup>.
+    It has no special meaning and receives no arguments but should be used for registering commands.
+
+<sub>1: Before 0.17.69 these callbacks were called after on_init/on_load.</sub>
+
+The usual way to use `add_lib` is to define the table of events to register in a separate file and return it, then load it in control.lua via `require` before passing it to `add_lib`.
+For example a module could be defined as
+
+```lua
+-- example.lua
+local function my_handler(event)
+    local name = game.player[event.player_index].name
+    game.print("It appears that " .. name .. " has died")
+end
+
+return {
+    on_init = function() game.print("example_lib init") end,
+    events = {
+        [defines.events.on_player_died] = my_handler,
+    },
+}
+```
+
+And then in control.lua the following used to load it with `add_lib`:
+
+```lua
+-- control.lua
+local event_handler = require("event_handler")
+event_handler.add_lib(require("example"))
+```
+
+Because the event_handler lib registers events itself you may not use `script.on_load` or `script.on_init` at all in your code and any usage of `script.on_configuration_changed`, `script.on_nth_tick` and/or `script.on_event` will cause the corresponding events registered with event_handler to break and should therefore not be used.
+
+There's also the `add_libraries` function exported by event_handler, which accepts a table and calls `add_lib` for each value in the table.
+
+
+## Communicating with Clusterio
+
+Clusterio uses a homebrew protocol based on sending JSON payloads over a WebSocket connection.
+See [socket.md](socket.md) for the implementation details of it.
+
+It's also possible to write a plugin for Clusterio that exposes a custom interface over HTTP, WebSocket or any other technology supported by Node.js.
+
+
+## Clusterio Modules
+
+Modules are primarily used by plugins to inject code into Factorio games with the save patcher, though it's also possible to make stand alone modules that are loaded into the game if you don't need the capabilites of the plugin system.
+The save patcher puts modules into the `modules` folder of the Factorio save and adds code to `control.lua` to load the module according to the `load` and `require` options to the module.json file.
+Like with scenarios for Clusterio the [event_handler interface](#event_handler-interface) has to be used for any event subscriptions in modules.
+
+Stand alone modules are placed into the modules folder of Clusterio, plugin modules are located in the module folder of the plugin.
+In either case a `module.json` file is required and has the following structure:
+
+```json
+{
+    "name": "my_module",
+    "version": "1.2.0",
+    "dependencies": {
+        "clusterio": "*",
+        "foo": ">=0.4.2"
+    },
+    "require": ["bar.lua"],
+    "load": ["foo.lua"]
+}
+```
+
+The following entries are supported in the module.json file:
+
+- `name`:
+    Name of the module, must match the folder the module is located in for stand alone modules or the name of the plugin the module is located in.
+- `version`:
+    Version of the module.
+    Must be compatible with [Semantic Versioning 2.0.0](https://semver.org/).
+    In plugin modules this defaults to the version of the plugin otherwise it's required.
+- `dependencies`:
+    Optional mapping of modules this module depends on and their version.
+    In the example `>=0.4.2` means that the foo module must be at least version 0.4.2.
+    See the [Ranges syntax](https://www.npmjs.com/package/semver#ranges) of the node-semver package for a full description of what operators are supported.
+    The events for dependencies is invoked before the events of the dependent, and starting an instance will fail if the dependencies cannot be satisfied.
+    If not specified it will default to depending on `clusterio`.
+    Make sure to add `clusterio` to your dependencies if you add other dependencies and depend on the Lua API.
+- `require`:
+    Lua files to require in `control.lua`.
+    This should only really be needed if you want to make a global function available for use in Lua commands.
+    The paths are relative to the module's own folder and should be specified using forward slashes as directory sepparators if it's located in a sub directory in the module.
+- `load`:
+    Lua files to load with the `event_handler` lib, the result of requiring the file will be passed to the `add_lib` function of the `event_handler` lib in `control.lua`.
+    See the section on the [event_handler interface](#event_handler-interface) for a detailed description on how the `event_handler` lib works.
+    The paths are relative to the module's own folder and should be specified using forward slashes as directory sepparators if it's located in a sub directory in the module.
+
+It's recommended to use the new style of defining modules in Lua, as well as avoid the use of global variables as much as possible.
+This means always declearing your top level variables and functions local and exporting only the things you need in other files.
+You can require other files in your module by prefixing your require paths with `modules/your_module_name/`.
+It's also possible to require files from other modules this way too.
+
+The global variables and data stored in the global table is shared by all Clusterio modules as well as the scenario, so it's important that you use unique names.
+It's recommended to prefix the global variables and data in the global table that your module has with the name of your module.
+
+Because modules can be patched into an existing game you cannot rely on the `on_init` callback to be called in Clusterio Modules.
+Nor can you rely on the `on_configuration_changed` callback, as this is not called when level code changes.
+The Clusterio Lua API provides the custom `on_server_startup` event that can be used as a substitute, see the next section.
+
+
+## Clusterio Lua API
+
+Clusterio provides a save patched module as well as a regular Factorio mod for interfacing with Clusterio.
+This includes tools sending data to plugins, script events to listen for, and an item serialization module.
+
+
+### clusterio_api library
+
+**require path**  
+From a module  
+`local clusterio_api = require("modules/clusterio/api")`  
+From a mod  
+`local clusterio_api = require("__clusterio_lib__/api")`
+
+Provides the main interface to Clusterio from within the game.
+When using the mod version you must call `init` before it'll function properly.
+
+#### init
+
+<sub>Mod version only</sub>
+
+Initialize the API.
+This should be called from both the `on_init` and `on_load` events in your mod, and before this is called certain features will not be available, most notably the events table.
+
+#### clusterio_api.events
+
+Table of events raised by clusterio.
+If the game is started outside of Clusterio then none of these events will be raised.
+
+In the mod version this table does not exist before the `init` function is called.
+
+##### on_instance_updated
+
+Raised after the name and id of an instance has been updated.
+This may occur even if the id and name didn't change.
+
+Event data:
+- `instance_id`: the id of the instance.
+- `instance_name`: the name of the instance.
+
+##### on_server_startup
+
+Raised when Clusterio is starting up the server.
+It can be used to initialize clusterio related features in a mod, and as a stand-in for the `on_init` and `on_configuration_changed` event for modules.
+It is invoked on the first tick the server runs after the save has been patched, before most other events.
+
+Use this event to initialize and/or migrate the data structures you need.
+Keep in mind that both mods and Clusterio modules can switch from any version to any version so it should be able to handle both forwards and backwards migrations gracefully.
+
+#### clusterio_api.send_json(channel, data)
+
+Send JSON data to Clusterio over the given channel.
+The `data` argument should be table that can be serialized with `game.table_to_json`.
+Clusterio plugins can listen to channels and will receive an event with the data sent here.
+See the [Communicating with Factorio section](writing-plugins.md#communicating-with-factorio) in the Writing Plugins document for more information.
+
+If the game is started outside of Clusterio the data will be sent, but since there's no code following stdout to pick it up it will be lost.
+
+**Note**: Payloads greater than 4 MB will cause stuttering in the game.
+
+**Note**: This is not a binary safe way of sending data.
+Strings embedded into the tables sent must be valid UTF-8 text.
+
+Parameters:
+- `channel`: string identifying which channel to send it on.
+- `data`: table that can be converted to JSON with game.table_to_json
+
+
+### serialize library
+
+**require path**  
+From a module  
+`local serialize = require("modules/clusterio/serialize")`  
+From a mod  
+`local serialize = require("__clusterio_lib__/serialize")`
+
+Serializes inventories and item stacks into a table that in turn can be converted into JSON with `game.table_to_json`.
+Properly handles the extra data for most items.
+
+#### serialize.serialize_equipment_grid(LuaEquipmentGrid)
+
+Returns a table containing a serialized representation of the equipment grid passed.
+
+#### serialize.deserialize_equipment_grid(LuaEquipmentGrid, serialized_grid)
+
+Deserialize a previously serialized equipment grid into the target LuaEquipmentGrid.
+Overwrites all content in the target.
+
+#### serialize.serialize_item_stack(LuaItemStack, destination_table)
+
+Serialize the LuaItemStack passed into the target destination_table.
+The destination_table should be a new empty table.
+
+#### serialize.deserialize_item_stack(LuaItemStack, serialized_stack)
+
+Deserialize a previously serialized item stack into the target LuaItemStack.
+Overwrites the content of the item stack.
+
+#### serialize.serialize_inventory(LuaInventory)
+
+Returns a table containing a serialized representation of the inventory passed.
+
+#### serialize.deserialize_inventory(LuaInventory, serialized_inventory)
+
+Deserialize a previously serialized inventory into the target LuaInventory.
+Overwrites slots that have content in the serialized inventory.
+
+
+## Clusterio Plugins
+
+See the [Writing Plugins](writing-plugins.md) document for details on the plugin interface and how to write plugins for Clusterio.

docs/devs/protocol.md

@@ -0,0 +1,268 @@
+# Protocol
+
+Clusterio communicates using a simple homebrew message passing protocol based on JSON over WebSocket with limited support for reliable transport of messages.
+The protocol is implemented in [packages/lib/link](/packages/lib/link) and uses the `ws` library to handle the WebSocket connections on the Node.js side and the native WebSocket API on the browser side.
+
+Two general kinds of messages are supported: events and requests.
+Events are messages sent by one party and received by the other and offer no notification for the sender on whether it was actually received.
+Requests are pairs of request-response messages where one side sends the requests and the other side replies with a response.
+Apart from the handshake used to establish connections the protocol is directionless, and either party can send or receive both requests and events.
+
+Events and requests are defined as instances of the `Request` and `Event` classes, and specify a unique type string, who can send and receive the message, optional forwarding of the message and the format of the data payload as a JSON schema.
+All messages sent and received are validated with JSON schemas to catch potential errors in sending messages and avoid having to write lots of validation code in message handlers.
+
+Messages are sent by calling the `.send()` method of the message instance and passing a `Link` instance to send it over and the data to send.
+For the master server there's a `Link` instance for each slave and control connection stored in the `WsServer` class.
+For slaves the `Slave` instance is a link to the master server, and each `Instance` instance is an in-memory link to the `Slave` instance and has a corresponding `InstanceConnection` link stored on the `Slave` instance.
+For ctl and web_ui there's a `Control` instance that acts as the link to the master server.
+
+Messages received invokes message handlers that were registered when the link was brought up.
+These handlers are named after the name of the property the message is stored under with `EventHandler` appended for events and `RequestHandler` appended for requests.
+The handlers are defined on the link class itself for core messages, and on the plugin class in the case of plugin defined messages.
+
+
+## Connection flow
+
+Clients connect via WebSocket to the `/api/socket` endpoint and upon establishing connection to the server the connection is in the handshake phase and the server will send a `hello` message to the client.
+If the client has no previous session with the server it sends a `register_slave` or `register_control` message depending on what kind of client it is to the server.
+If the register is valid then the server will respond with a `ready` message with a session token and the connection has left the handshake phase, otherwise the server will close the connection with a WebSocket close code indicating the kind of failure.
+
+Upon leaving the handshake phase both parties should start sending heartbeat messages with the sequence number of the last received message.
+Messages sent over the link should be stored in a send buffer and only cleared from the send buffer when a heartbeat with a `last_seq` equal or or higher is received or the session is invalidated.
+
+If the connection goes stale or is unexpectedly closed the client can reastablish the same session by connecting to the server again and sending a `resume` message after received the `hello` from the server.
+If the session resume is successful then the server will respond with a `continue` message and the connection is active again.
+The client should then re-send all messages it has in its send buffer that is greater than the `last_seq` number in the `continue` message.
+Otherwise the server will respond with `invalidate` and the client is expected to drop its send buffer start a new session with `register_slave` or `register_control`.
+
+![Connection flow](../assets/connection_flow.svg)
+
+
+## Connector flow
+
+To manage the complexity of connecting, reconnecting, resuming or invalidating dropped sessions the WebSocket connection for a `Link` class is managed by a connector.
+There's three kinds of connectors defined: `WebSocketClientConnector`, `WebSocketServerConnector` and `VirtualConnector`.
+The virtual connector is for in-memory connections and doesn't have any connection state logic.
+
+For the WebSocket connectors there's four states they can exist in:
+- `closed` - The connector has just been created or has been explicitly closed.
+- `connecting` (client only) - The connector is in the process of trying to connect to the server.
+- `connected` - The connector is successfully connected.
+- `resuming` - The connection dropped and the connector is in the process of attempting to resume it.
+
+Along with the following events emitted when transition between states:
+- `connect` From `connecting` (client) or `closed` (server) to `connected`
+- `drop` - From `connected` to `resuming`
+- `resume` - From `resuming` to `connected`
+- `invalidate` - From `resuming` to `connecting` or `closed`
+- `close` - From any state to `closed`
+
+![Conector States](../assets/connector_states.svg)
+
+
+### WsClientConnector
+
+The client connector will keep trying to establish and mantain a connection after `.connect()` is called on it, stopping only in the case of authentication failure or `.close()`/`.setClosing()` being called.
+Other than that, the logic is pretty straight forward.
+
+![WsClientConnector](../assets/WsClientConnector.svg)
+
+
+### WsServerConnector
+
+The server connector doesn't do the work of connecting or validating the handshake.
+Instead it's handed over a WebSocket connection from `WsServer` once there's only the step of sending the final message left to do.
+Because of this there's no `connecting` state, and once a session times out from the `resuming` state it goes directly to closed.
+
+![WsServerConnector](../assets/WsServerConnector.svg)
+
+
+## Wire format
+
+All communication in the protocol is done via WebSocket text frames containing a JSON payload with the following properties:
+
+- `seq: integer | null` - The sequence number of the message, can only be null for handshake and heartbeats.
+- `type: string` - The type of message
+- `data: object` - Message data
+
+Before a connection is established it's in the handshake phase and the `seq` property is `null`.
+The `type` property is used to distinguish which of handshake, heartbeat, events or requests this message is and determines the expected format of the `data` property.
+
+
+### Handshake Messages
+
+The following messages are the only valid messages that can be sent during the handshake phase.
+
+
+#### `hello`
+
+Sent by the master server when the WebSocket connection has been opened.
+
+- `version: string` - The version of the master, e.g. "2.0.0".
+- `plugins: Object<string, string>` -
+    Object mapping plugin names to plugin version for plugins that are loaded on the master server.
+
+#### `register_slave`
+
+Slave handshake for establishing a new connection session.
+
+- `token: string` - Authentication token.
+- `agent: string` - Human readable string of the software connecting.
+- `version: string` - The protocol version of the slave, e.g. "2.0.0".
+- `name: string` - Name of the slave.
+- `id: integer` - ID of the slave.
+- `plugins: Object<string, string>` -
+    Object mapping plugin names to plugin version for plugins that are available on the slave.
+
+#### `register_control`
+
+Control handshake for enstablishing a new connection session.
+
+- `token: string` - Authentication token.
+- `agent: string` - Human readable string of the software connecting.
+- `version: string` - The protocol version of the control, e.g. "2.0.0".
+
+#### `resume`
+
+Handshake for resuming an existing connection session where the connection had dropped unexpectedly.
+
+- `session_token: string` - Session token to resume session with.
+- `last_seq: integer | null` - Last message seq received by the client.
+
+#### `invalidate`
+
+Sent by the master server in reply to a resume for a session that cannot be resumed.
+The client should start a new session with a register\_\* message in response.
+
+#### `continue`
+
+Sent by the master server to signal resuming the session was successful.
+
+- `last_seq: integer | null` - Last message seq received by the server.
+- `session_timeout: integer` - Session timeout in seconds.
+- `heartbeat_interval: number` - Rate client should send heartbeats at.
+
+#### `ready`
+
+Sent by the master server to signal the connection has been established with a new session.
+
+- `session_token: string` - Token to resume the session with.
+- `session_timeout: integer` - Session timeout in seconds.
+- `heartbeat_interval: number` - Rate client should send heartbeats at.
+
+
+### Heartbeat message
+
+Once connected as indicated by the `ready` and `continue` messages both sides of the connection starts sending heartbeats at the inverval given in the `ready` and `continue` messages.
+The heartbeat should contain the `seq` of the last received message, and receiving a heartbeat with a given sequence number means that the other party of the link has received all messages up to that seq number.
+
+
+#### `heartbeat`
+
+Sent by both the master server and clients at the interval given in the continue/ready messages.
+
+- `last_seq: integer` - Last message seq received over the link.
+
+### Events
+
+Events are messages send in one direction over the link, that the receiver is expected to act upon, but not make any replies (for that there's [Requests](#requests).
+By convention message types ending in `*_event` are events.
+The data payload of an event consists solely of event specific properties.
+
+See [packages/lib/link/messages.js](/packages/lib/link/messages.js) for the recognized core events and their contents.
+Plugins may defined their own events as well.
+
+#### `*_event`
+
+- any properties defined by the event type.
+
+
+### Requests
+
+Requests are messages which expects a response in return.
+They function a lot like HTTP requests except that both parties of a connection can inniate a request that is expected to be responded to.
+By convention message types ending in `*_request` are requests, and is expected to be replied to with a corresponding `*_response` message.
+If an error occured while processing the request an error response containing an error property in the data payload is sent instead.
+
+See [packages/lib/link/messages.js](/packages/lib/link/messages.js) for the recognized core requests and their contents.
+Plugins may define their own requests as well.
+
+#### `*_request`
+
+- any properties defined by the request type.
+
+#### `*_response` success
+
+- `seq: integer` - The seq number of the request message.
+- any additional properties defined by the request type.
+
+#### `*_response` error
+
+- `seq: integer` - The seq number of the request message.
+- `error: string` - Human readable text message describing the error.
+
+
+### Graceful Disconnect
+
+To ensure no data is lost when closing the link it's important to send a prepare disconnect request and wait for it to complete before closing the WebSocket.
+Either party of the link can send this request and the party sending the request should be the one that initates the close of the WebSocket.
+
+#### `prepare_disconnect_request`
+
+Request graceful disconnect of the connection.
+The receiving party should stop tasks that send events and requests over the link and wait for pending requests it has over the link to complete, but it should not stop responding to requests sent to it.
+Only after this process is done should the response be sent.
+
+#### `prepare_disconnect_response`
+
+Signals the preparation for disconnect is complete and that the connection can be closed.
+The party that initiatied the prepare disconnect request may still send other requests/events over the link to finish its part of the disconnection proceedure.
+
+If the error response variant is received it should be logged if possible and treated as a success.
+
+
+### Example handshake
+
+Server hello after opening the WebSocket.
+
+```json
+{
+    "seq": null,
+    "type": "hello",
+    "data": {
+        "version": "2.0.0"
+    }
+}
+```
+
+Slave registering a new connection session.
+
+```json
+{
+    "seq": null,
+    "type": "register_slave",
+    "data": {
+        "token": "xyzabc123",
+        "agent": "Clusterio Slave",
+        "version": "2.0.0",
+        "name": "Foo",
+        "id": 123
+    }
+}
+```
+
+Master server reply signaling the session is established and ready.
+
+```json
+{
+    "seq": null,
+    "type": "ready",
+    "data": {
+        "session_token": "xyz.azy.bzy",
+        "session_timeout": 60,
+        "heartbeat_interval": 15
+    }
+}
+```
+
+Slave and master can now send events and requests over the connection.

docs/how-it-works.md

@@ -0,0 +1,16 @@
+## Save Patching
+
+In order to efficiently get data in and out of running Factorio servers and to provide custom interfaces Clusterio uses save patching<sup>[1]</sup> to add code to the game.
+The save patching is based on the built in [event_handler](https://github.com/wube/factorio-data/blob/master/core/lualib/event_handler.lua) library to Factorio and requires scenarios to be coded specifically for it.
+Mods on the other hand work without modifications.
+
+This can be disabled with the `factorio.enable_save_patching` config on a per instance basis, however disabling it means that modules are not loaded into the game and most plugins will not function.
+
+<sub>1: Before version 2.0 of Clusterio this was done at runtime with a patcher called Hotpatch, but due to the difficulty in supporting run time patching and the lack of documentation it was replace it with save patching instead.</sub>
+
+
+## User Accounts
+
+The master server creates and stores accounts for all Factorio users that log into instances under its control.
+These accounts are used to store per player data and authorize management of the cluster.
+By default users accounts are assigned a Player role that gives a limited read access to the cluster resources, and admins of the cluster can be assigned a Cluster Admin role to get access to manage it.

docs/jsdoc.json

@@ -0,0 +1,23 @@
+{
+	"plugins": [
+		"plugins/markdown"
+	],
+	"tags": {
+		"allowUnknownTags": false
+	},
+	"opts": {
+		"destination": "docs/api",
+		"recurse": true
+	},
+	"source": {
+		"include": [
+			"packages/master/src/",
+			"packages/master/master.js",
+			"packages/slave/slave.js",
+			"packages/ctl/ctl.js",
+			"packages/lib/",
+			"plugins/"
+		],
+		"excludePattern": "node_modules"
+	}
+}

docs/managing-a-cluster.md

@@ -0,0 +1,101 @@
+# Managing a Cluster
+
+Clusterio clusters are managed through the master server by using the `clusterioctl` command line interface which is invoked by running `npx clusterioctl <command>` in the clusterio directory.
+This document uses the shorthand `ctl> foo` to indicate `npx clusterioctl foo` should be executed.
+Mandatory parameters are shown in `<angles bracket>` and optional pameters are in `[square brackets]`.
+
+Before `clusterioctl` can be used it needs to be configured for the cluster it will connect to.
+The easiest way to do this is to run `npx clusteriomaster bootstrap create-ctl-config <username>` on the master server, which creates the necessary `config-control.json` for managing the cluster as the given user.
+
+
+## Slaves
+
+To be written.
+
+
+## Instances
+
+To be written.
+
+
+## Users
+
+Clusterio automatically creates user accounts for all players that join an instance when save patching is enabled.
+These accounts are used to store per player data shared between instances, like if the player should be whitelisted, admin or banned.
+
+### List users
+
+    ctl> user list
+
+Lists all user accounts in the cluster along with some data for each.
+
+
+### Create User
+
+    ctl> user create <name>
+
+Creates a new empty user account for the given Factorio player.
+Note that case matters here.
+This is usually not required as user accounts are created automatically for players that join instances with save patching enabled.
+
+
+### Promote User to Server Admin
+
+    ctl> user set-admin <name> [--revoke] [--create]
+
+Promotes the user given to in-game admin on instances with the `sync_adminlist` option enabled.
+If the `--revoke` switch is used the user is removed from the adminlist.
+
+Since admin status is a part of the account data the account must exist for this to succeed, passing `--create` will create the account if it does not exist.
+
+**Note:** Being a server admin does not grant any access to manage the cluster.
+See [set-roles](#set-cluster-roles) for adding roles which grant access to managing the clusetr.
+
+
+### Whitelist User
+
+    ctl> user set-whitelisted <name> [--remove] [--create]
+
+Add the user given to the whitelist on instances with the `sync_whitelist` option enabled.
+If the `--remove` switch is used the user is removed from the whitelist.
+
+Since whitelisted status is a part of the account data the account must exist for this to succeed, passing `--create` will create the account if it does not exist.
+
+
+### Ban User
+
+    ctl> user set-banned <name> [--reason <message>] [--pardon] [--create]
+
+Ban user in-game from instances with the `sync_banlist` option enabled.
+Reason is a message that will be shown to the user when attemption to log in.
+If the `--pardon` switch is used it removes the ban.
+
+Since ban status is a part of the account data the account must exist for this to succeed, passing `--create` will create the account if it does not exist.
+
+Note: This bans the user from logging in to Factorio servers in the cluster, it does not revoke access to any cluster management they might have, see next section on setting roles for revoking tha.
+
+
+### Set Cluster Roles
+
+    ctl> user set-roles <name> [roles...]
+
+Replaces the roles the user has in the cluster with a new list of roles.
+Calling with an empty roles argument will remove all roles from the user.
+
+By default there's a roled named Cluster Admin which grants access to everything and a role named Player which grants a limited read access to the cluster, see [the section on roles](#roles) for more information about setting up roles and permissions.
+
+
+### Delete user
+
+    ctl> user delete <name>
+
+Deletes everything stored on the master server for this user.
+
+Note: If the player is banned from the cluster this will effectively unban them, as the ban status is stored with the user account.
+
+Note: If the player joins the cluster again a new account will be made for them automatically.
+
+
+## Roles
+
+To be written.

docs/setting-up-tls.md

@@ -0,0 +1,72 @@
+# Setting up TLS
+
+By default Clusterio will listen for connections over HTTP which is fine for local networks but over the Internet it should idealy be over HTTPS as there are some credentials that could be exposed to eavesdroppers.
+The recommended setup is to have an ordinary HTTPS server software like Apache or Nginx to act as a reverse proxy in front of the Clusterio master server.
+The reverse proxy would then be set up with a TLS certificate from a Certificate Authoritiy like [Let's Encrypt](https://letsencrypt.org).
+Alternatively you can have Clusterio listen for connections over HTTPS directly by providing it with a TLS certificate and private key.
+
+Note that a TLS certificate signed by a recognized Certificate Authority in general requires that you own a domain.
+See the last section for how to create and use a self-signed certificate for an IP address if you don't have a domain.
+
+
+## Using a reverse proxy
+
+Configure the proxy to forward requests over HTTP to the port the master server is listening to so that for example a request to `https://example.com/instances/` is forwarded to `http://localhost:8080/instances/`.
+It is possible to host the interface under a sub-path, in that case a request under the sub-path should be mapped to the master server with the sub-path stripped out.
+For example `https://example.com/sub/path/instances/` would be mapped to `http://localhost:8080/instances`.
+
+Additianlly WebSocket connections to `/api/socket` also needs to be forwarded.
+Typically this requires explicit configuration and support for forwarding WebSocket connections.
+If the interface hosted under a sub-path the `/api/socket` address is relative to the sub-path and the sub-path also needs to be stripped out when forwarded.
+
+You can also optionally set the master server to listen only on the loopback interface to prevent it being directly connected to from the outside.
+
+    npx clusteriomaster config set master.bind_address 127.0.0.1
+
+
+### Apache Config
+
+To proxy with Apache make sure that `proxy_module`, `proxy_http_module` and `proxy_wstunnel_module` is loaded in the config, then add the following directives to wherever is the approriate place for your flavour of Apache config organization.
+
+```apache
+<Location /sub/path/>
+    ProxyPass "http://localhost:8080/"
+</location>
+<Location /sub/path/api/socket>
+    ProxyPass "ws://localhost:8080/api/socket"
+</Location>
+```
+
+Replace `/sub/path/` with the location on the proxy you want to host the Clusterio interface under.
+If the whole domain is to be dedicated to the Clusterio interface then `/sub/path/` should be just `/`.
+Pay attention to the use of trailing slashes, as they are important.
+
+
+## Hosting HTTPS directly from Node.js
+
+Listening on HTTPS is supported by the Clusterio master server via the `master.https_port` option provided paths to a certificate file and a private key file is configured for the `master.tls_certificate` and `master.tls_private_key` options.
+Both of these are expected to be unencrypted PEM files.
+
+
+## Creating and using a self-signed certificate
+
+Create a self-signed certificate with OpenSSL by running
+
+    openssl req -x509 -newkey rsa:2048 -nodes -keyout key.pem -out cert.pem -days 3650 -subj /CN=localhost -addext "subjectAltName=IP:<ip>"
+
+substituting `<ip>` with the IP address the server will be accessed under, for example `IP:203.0.113.4`.
+Multiple addresses can be given by supplying a comma sepparated list of `IP:address` pairs and DNS names can also be specified using the `DNS:example.com` format.
+You need to supply every name you want to connect to the server under the subjectAltName field, for example to connect to the HTTPS port locally via an address like `https://localhost:4443/` you need to add `DNS:localhost`.
+
+This creates a private key file named `key.pem` and a public certificate file named `cert.pem` and these are used for the `master.tls_certificate` and `master.tls_private_key` config options respectively on the master server:
+
+    npx clusteriomaster config set master.tls_certificate cert.pem
+    npx clusteriomaster config set master.tls_private_key key.pem
+
+Additionally you will need copy the `cert.pem` file to all of the computers you want to set up as slaves and configure it as the `slave.tls_ca` option:
+
+    npx clusterioslave config set slave.tls_ca cert.pem
+
+You will also need to copy the `cert.pem` file to all of the computers you want to remotely manage the cluster via clusterctl and configure it as `control.tls_ca` option:
+
+    npx clusterioctl control-config set control.tls_ca cert.pem

docs/writing-plugins.md

@@ -0,0 +1,619 @@
+# Writing Plugins
+
+Plugins for Clusterio are classes written in JavaScript that run under Node.js.
+The plugin classes have pre-defined hooks that are called during various stages and operations of Clusterio.
+
+
+## Contents
+
+- [Plugin Structure](#plugin-structure)
+- [Defining the plugin class](#defining-the-plugin-class)
+- [Logging Messages](#logging-messages)
+- [Plugin Configuration](#plugin-configuration)
+- [Communicating with Factorio](#communicating-with-factorio)
+- [Defining Link Messages](#defining-link-messages)
+    - [Defining Events](#defining-events)
+    - [Defining Requests](#defining-requests)
+- [Sending Link Messages](#sending-link-messages)
+    - [Handling connection events](#handling-connection-events)
+- [Collecting Statistics](#collecting-statistics)
+- [Adding Custom Commands to clusterioctl](#adding-custom-commands-to-clusterioctl)
+
+
+## Plugin Structure
+
+The basic file structure of a plugin is the following.
+
+    plugin_name/
+      +- info.js
+      +- package.json
+      +- master.js
+      +- instance.js
+      +- control.js
+      +- test/
+      |  +- plugin.js
+      +- module/
+         +- module.json
+         +- plugin.lua
+
+Clusterio plugins are Node.js packages that can be published on npm for ease of installation and distribution.
+The usual guides for creating such packages apply.
+At minimum the `package.json` file must contain a version entry.
+
+A possible workflow for developing plugins is to place the plugin in a sub-directory of where clusterio has been installed, and rely on Node.js searching up the folder heirarchy for it to find `@clusterio/lib`.
+To add it to `plugin-list.json` so that it gets loaded use the `plugin add <path>` sub-command to either clusteriomaster, clusterioslave or clusterioctl.
+Note that it's important that the path starts with ./ or ../ (use .\ or ..\ on Windows).
+
+For a plugin the most important file is the `info.js` file.
+Without it the plugin will not recognized by Clusterio.
+Here's an example of it:
+
+```js
+const { libLink } = require("@clusterio/lib"); // For messages
+
+module.exports = {
+    name: "foo_frobber",
+    title: "Foo Frobber",
+    description: "Does advanced frobnication",
+    instanceEntrypoint: "instance",
+    masterEntrypoint: "master",
+    messages: {
+        /* See below */
+    },
+};
+```
+
+The following properties are recognized:
+
+**name**:
+    Internal name of the plugin.
+    Must be the same as the plugin's directory name
+
+**title**:
+    Name of the plugin as shown to users.
+    Currently not used.
+
+**description**:
+    Brief description of what the plugin does.
+    Currently not used.
+
+**instanceEntrypoint**:
+    Path to a Node.js module relative to the plugin directory which contains the InstancePlugin class definition for this plugin.
+    This is an optional paramater.
+    A plugin may have code only for instances but it must still be loaded on the master in order for it to be possible to load it on an instance.
+
+**InstanceConfigGroup**:
+    Subclass of `PluginConfigGroup` for defining the per instance configuration fields for this plugin.
+    See [Plugin Configuration](#plugin-configuration)
+
+**masterEntrypoint**:
+    Path to a Node.js module relative to the plugin directory which contains the MasterPlugin class definiton for this plugin.
+    This is an optional parameter.
+    A plugin can be made that only runs on the master server.
+
+**MasterConfigGroup**:
+    Subclass of `PluginConfigGroup` for defining the master server configuration fields for this plugin.
+    See [Plugin Configuration](#plugin-configuration)
+
+**controlEntrypoint**:
+    Path to a Node.js module relative to the plugin directory which contains the ControlPlugin class definition for this plugin.
+    This is an optional paramater.
+    A plugin can be made that only runs on the clusterioctl side.
+
+**messages**:
+    Object with link messages definitions for this plugin.
+    See guide for [defining link messages](#defining-link-messages) below.
+
+The optional module folder contains a Clusterio module that will be patched into the save when the plugin is loaded.
+See the section on [Clusterio Modules](developing-for-clusterio.md) in the Developing for Clusterio document.
+The only restriction imposed on modules embedded into plugins is that they must be named the same as the plugin.
+
+While there is no standard for how to organize a plugin it's recommended to put the MasterPlugin class definition into master.js and the InstancePlugin class definition into instance.js.
+You can put them into whatever file you want (even the same one for both).
+
+For both instanceEntrypoint and masterEntrypoint the path should not end with .js and it should use forward slashes for directory separators if any.
+
+
+## Defining the plugin class
+
+The plugin class should derive from its respective base class defined in `lib/plugin`.
+For example, to define a MasterPlugin class the following code can be used:
+
+```js
+const libPlugin = require("@clusterio/lib/plugin");
+
+class MasterPlugin extends libPlugin.BaseMasterPlugin {
+    async init() {
+        this.foo = 42;
+        await this.startFrobnication();
+    }
+
+    // ...
+}
+
+module.exports = {
+    MasterPlugin,
+}
+```
+
+For the instance plugin it's exactly the same except "Master" is replaced with "Instance", and for the clusterioctl plugin "Control" is used.
+The available hooks that you can override are documented in the base class [in lib/plugin.js](/packages/lib/plugin.js).
+
+It's best to avoid defining a constructor, but if you insist on defining one, forward all arguments to the base class.
+E.g.:
+
+```js
+constructor(...args) {
+    super(...args);
+
+    // Code here
+}
+```
+
+The arguments passed may change, and attempting to modify them will result in unpredicatable behaviour.
+The async init method is always called immediatly after the constructor, so there's little reason to do this.
+
+
+## Logging Messages
+
+The base plugin classes provide a winston logger for logging messages to the shared cluster log.
+For instances a copy of the log is also stored on the slave the instance is on.
+To use it, pass a string to one of the log levels functions, for example:
+
+```js
+async init() {
+    this.logger.info("Initializing frobbing");
+}
+```
+
+Metadata covering which plugin and instance (for instance plugin classes) the log event happened on will automatically be attached to the log message.
+
+The available levels are fatal, error, warn, audit, info, and verbose.
+These levels have roughly the following meanings:
+
+- fatal: Unrecoverable error that prevents continuing execution of the Node.js process.
+  Note that Plugins shouldn't have fatal errors.
+- error: An unexpected error condition occured, usually an exception thrown when it wasn't expected.
+  Should be investigated and fixed.
+- warn: An potential error was detected, but operation continued gracefully.
+  These may indicate that something is running sub-optimally, or is not working as intedend.
+- audit: Record of actions performed by users of the cluster.
+  This is usually emitted in response to management requests by a control link.
+- info: A general log message.
+  May indicae a status or operation completed.
+  This should not be emitted by periodic tasks that run often.
+- verbose: A verbose log message which might be useful when investigating issues, does not show by default.
+  Note that logging messages is not a cheap operation even when the messages do not show up and spammy logging should be avoided for the verbose level.
+  If the logs are still valuable in certain cases consider putting them behind a config option.
+
+For guarding unexpected errors the best option is to log a short description along with the`stack` property of the Error:
+
+```js
+try {
+    // Operation that should not throw but may end up throwing
+} catch (err) {
+    this.logger.error(`Operation failed:\n${err.stack}`);
+)
+```
+
+For plugin hooks expections thrown are automatically catched and logged, but for event handlers registered on EventEmitters it's critical that exceptions are catched and handled appropriately.
+
+
+## Plugin Configuration
+
+Clusterio provides a configuration system that handles storing, distributing, editing and validating config fields for you.
+You can take advantage of it by subclassing `PluginConfigGroup`, setting `defaultAccess` to where config entries can be accessed from, setting the `groupName` to your plugin name, defining fields on it, finalizing it, and passing it as either `MasterConfigGroup` or `InstanceConfigGroup` in the `info.js` export.
+For example in info.js:
+
+```js
+const libConfig = require("@clusterio/lib/config");
+
+class MasterConfigGroup extends libConfig.PluginConfigGroup { }
+MasterConfigGroup.defaultAccess = ["master", "slave", "control"];
+MasterConfigGroup.groupName = "foo_frobber";
+MasterConfigGroup.define({
+    name: "level",
+    description: "Level of frobnication done",
+    type: "number",
+    initial_value: 2,
+});
+MasterConfigGroup.finalize();
+
+module.exports = {
+    ...
+    MasterConfigGroup: MasterConfigGroup,
+};
+```
+
+Code inside the `MasterPlugin` class will then be able to access the level config field through the `Config` object at `this.master.config`, for example in the MasterPluginClass:
+
+```js
+async init() {
+    let level = this.master.config.get("foo_frobber.level");
+    this.logger.info(`I got a frobnication level of ${level}`);
+}
+```
+
+The same applies for instance configs, replace "master" with "instance" where appropriate.
+See [Configuration System](config-system.md) for more details on how this system works.
+
+
+### Handling Invalid Configuration
+
+If the plugin requires a certain feature to be enabled to function it should throw an error during init if this is not the case.
+The most common such feature is the save patching, which can be disabled to run vanilla or scenarios not compatible with Clusterio.
+For example:
+
+```js
+async init() {
+    if (!this.instance.config.get("factorio.enable_save_patching")) {
+        throw new Error("foo_frobber plugin requires save patching.");
+    }
+}
+```
+
+
+## Communicating with Factorio
+
+For pushing data into Factorio there's RCON, which lets you send arbitrary Lua commands to invoke whatever code you want in the game.
+This is done by calling the `sendRcon` method on the plugin object.
+For example:
+
+```js
+async onStart() {
+    let response = await this.sendRcon(
+        "/sc rcon.print('data')"
+    );
+
+    // Do stuff with response.
+}
+```
+
+Because data into Factorio is streamed at a rate of 3-6 kB/s by default, it is recommended to avoid sending large commands as much as possible, and to strip down the data on the ones you send to only what's strictly necessary.
+You can have lua code injected into the game via the module system and call that from RCON to avoid having to send code through the commands.
+
+For getting data out from Factorio there's both RCON and the `send_json` API of the Clusterio module.
+Returning data via RCON is prefered if the action is initiated from the Node.js side.
+The `send_json` API allows sending JSON payloads on channels that plugins can listen to.
+From a plugin you listen for an event named `ipc-channel_name` in order to get data sent by `send_json`.
+For example in the plugin code:
+
+```js
+async init() {
+    this.instance.server.on("ipc-my_plugin_foo", content =>
+        this.handleFoo(content).catch(err => this.logger.error(
+            `Error handling foo:\n${err.stack}`
+        ))
+    );
+}
+
+async handleFoo(content) {
+    // Do stuff with content
+}
+```
+
+And then in the module for the plugin:
+
+```lua
+local clusterio_api = require("modules/clusterio/api")
+
+-- inside some event handler
+clusterio_api.send_json("my_plugin_foo", { data = 123 })
+```
+
+It's recommended to either use the plugin name as the channel name or to prefix the channel name with the name of the plugin if you need multiple channels.
+It's also important to catch any errors that might occur as they will otherwise be propogated to the instance code and kill the server.
+
+Data out from Factorio does not have the same limits as data into Factorio, RCON responses can be in 100kB range without causing issues, and payloads to the `send_json` API can be in the 4MB range provided the server has a fast enough storage system.
+
+**Note:** both `send_json` and RCON can operate out of order.
+For `send_json` it's possible that payloads greater than 4kB are received after payloads that were sent at a later point in time.
+For RCON, commands longer than 50 characters may end up being executed after shorter commands sent after it.
+
+
+## Defining Link Messages
+
+You will most likely have to communicate with the master or other instances in your plugin for it to do anything useful.
+For this there's a WebSocket communication channel established between the slaves and the master server that plugins can define their own messages to send over it.
+This channel is bi-directional and all messages sent over it are validated with a JSON schema (see [this guide][guide] for an introduction to writing JSON schema).
+
+[guide]: https://json-schema.org/learn/getting-started-step-by-step.html
+
+There are currently two kinds of messages that can be defined: events and requests.
+Events are simple one-way notifications that invoke a handler on the target it's sent to.
+Requests are pairs of request and response messages where the request is sent to the target and the response is the reply back from the target.
+The requests are similar to HTTP requests, except both parties of a link may initiate one.
+
+
+### Defining Events
+
+Events are defined as properties of the messages object exported by `info.js` that map to instances of the `Event` class from `lib/link`.
+The name of the property correspond to the handler invoked on the plugin class.
+The Event constructor takes an object of properties that define the event, for example the following could be defined in `info.js`:
+
+```js
+messages: {
+    startFrobnication: new libLink.Event({
+        type: "foo_frobber:start_frobnication",
+        links: ["master-slave", "slave-instance"],
+        forwardTo: "instance",
+        eventRequired: ["frobnication_type"],
+        eventProperties: {
+            "frobnication_type": { type: "string" },
+            "urgent": { type: "boolean" },
+        },
+    }),
+},
+```
+
+This specifies an event that can be sent from the master to a slave, and from a slave to an instance.
+It also specifies that the event must contain the property `frobnication_type`, with a string value in the data payload and that it may optionally contain a boolean `urgent` property.
+It will also be forwarded by slaves to a specific instance.
+
+The following properties are recognized by the Event constructor:
+
+#### type
+
+The message type sent over the wire.
+This must start with the name of the plugin followed by colon and and be unique for the plugin.
+The type of the message sent over the socket will have the suffix `_event` appended to it.
+
+#### links
+
+An array of strings describing which links this event can be sent over.
+Direction matters, `"master-slave"` means the event can be sent from the master to the slave, but can't be sent back the other way, unless `"slave-master"` is also present in the links array.
+
+The available endpoints are `master`, `slave`, `instance`, and `control`.
+Master talks with slave and control, and slave talks to instance.
+The full chain must be specified as the individual links in order for a message to travers multiple hops, (i.e., for a message to go from master to instance it must have both `"master-slave"` and `"slave-instance"` in the links array).
+See `forwardTo` and `broadcastTo` for ways to forward an event to the next link in a chain.
+
+#### forwardTo
+
+Target to forward an event to.
+Can either be `"master"`, to indicate a slave should forward it to the master server, or `"instance"`, to indicate it should be forwarded to the instances specified by the `instance_id` event property.
+This works by using a default handler for the event at the links that forward it.
+
+#### broadcastTo
+
+Target to broadcast this message towards.
+A value of "instance" means the event will be broadcast to all instances downstream of the target it's sent to, but not back from where it came from.
+Currently, only "instance" is supported.
+This means that sending the event to a slave from an instance will cause it to be broadcast to all instances of that slave except for the instance it came from.
+
+#### eventRequired
+
+By default all properties defined in `eventProperties` are required to be present in the payload for the event.
+This can be overriden by specifying an array of properties which are required here.
+This is equivalent to using the `required` keyword in JSON schema.
+
+#### eventProperties
+
+Object with properties mapping to a JSON schema of that property that specifies what's valid to send in the event.
+This is equivalent to using the `properties` keyword in JSON schema, except that the properties specified are by default required and additional properties are not allowed.
+See [this guide][guide] for an introduction to writing JSON schemas.
+
+The forwardTo and broadcastTo can be combined such that specifying `"master"` as the forwardTo value and `"instance"` as the broadcastTo value will cause the event to be broadcast to all instances in the cluster.
+For this to work, you will need to specify `instance-slave`, `slave-master`, `master-slave`, and `slave-instance` as the links.
+
+Keep in mind when forwarding events that if the target an event is being forwarded to is not online, the event will be dropped.
+Use a request if you need a confirmation that the message was received.
+
+### Definining Requests
+
+Requests are defined as properties of the messages object exported by `info.js` that map to instances of the `Request` class from `lib/link`.
+The name of the property corresponds to the handler invoked on the plugin class.
+The Request constructor takes an object of properties that define the event.
+For example, the following could be defined in `info.js`:
+
+```js
+messages: {
+    reportFrobnication: new libLink.Request({
+        type: "foo_frobber:report_frobnication",
+        links: ["master-slave", "slave-instance"],
+        forwardTo: "instance",
+        requestRequired: ["verbosity"],
+        requestProperties: {
+            "verbosity": { type: "integer" },
+            "special": { type: "boolean" },
+        },
+        responseProperties: {
+            "report": {
+                type: "array",
+                items: { type: "string" },
+            },
+        },
+    }),
+},
+```
+
+This specifies a request that can be sent from the master to a slave, and from a slave to an instance.
+The request data must contain the property `verbosity` with an integer number as the value, as well as the `instance_id` property (implied by `forwardTo: "instance"`) and it may also contain a boolean `special` property.
+It also defines that the response sent must contain a `report` property mapping to an array of strings.
+When received by a slave, it will also be forwarded to the instance specified by `instance_id`.
+
+The following properties are recognized by the Request constructor:
+
+#### type
+
+The message type sent over the wire.
+This must start with the name of the plugin followed by colon and and be unique for the plugin.
+The type of the message sent over the socket will have the suffix `_request` appended to it for the request and `_response` appended to it for the response.
+
+#### links
+
+An array of strings describing which links this request can be sent over.
+Direction matters; `"master-slave"` means the request can be sent from the master to the slave and the slave can reply to the master, but the slave can't send a request to the master unless `"slave-master"` is also present in the links array.
+
+The available endpoints are `master`, `slave`, `instance`, and `control`.
+Master talks with slave and control, and slave talks to instance.
+The full chain must be specified as the individual links in order for a message to travers multiple hops, (i.e., for a message to go from master to instance it must have both `"master-slave"` and `"slave-instance"` in the links array).
+See `forwardTo` for ways to forward a request to the next link in a chain.
+
+#### forwardTo
+
+Target to forward the request to.
+Can either be `"master"` to indicate a slave should forward it to the master server when receiving it from an instance, or `"instance"` to indicate it should be forwarded to the instances specified by the `instance_id` request property.
+This works by using a default handler for the request by the links that forward it.
+
+#### requestRequired
+
+By default all properties defined in `requestProperties` are required to be present in the payload for the request.
+This can be overriden by specifying an array of properties which are required here.
+This is equivalent to using the `required` keyword in JSON schema.
+
+#### requestProperties
+
+Object with properties mapping to a JSON schema of that property that specifies what's valid to send in the request.
+This is equivalent to using the `properties` keyword in JSON schema, except that the properties specified are by default required and additional properties are not allowed.
+See [this guide][guide] for an introduction to writing JSON schemas
+
+#### responseRequired
+
+Same as the requestRequired only for the response sent back by the target.
+
+#### responseProperties
+
+Same as the requestProperties only for the response sent back by the target.
+
+
+## Sending Link Messages
+
+Link messages are sent by calling the `.send()` method on the Event/Request instance with the link you want to send it over and the data to send.
+For `InstancePlugin` code the link to the slave is the `instance` itself, which is accessible through the `.instance` property of the `InstancePlugin`.
+The `.info` property of the plugin class exposes the data exported from the plugin's `info.js` module.
+In other words:
+
+```js
+// In an InstancePlugin class
+async frobnicate() {
+    this.info.messages.exampleEvent.send(this.instance, { foo: "bar" });
+}
+```
+
+For the Request class the send method is async and returns the response data received from the target it was sent to, or throws an error if the request failed.
+
+
+### Handling connection events
+
+There are a few connection related events that plugins neeed to repsond to in order to avoid data loss and connection problems.
+The most important is the prepare disconnect for the link between master and slave.
+This is signaled to `MasterPlugin` classes via the `onPrepareSlaveDisconnect` hook and to `InstancePlugin` classes via the `onPrepareMasterDisconnect` hook.
+
+After the prepare disconnect the connection will be closed, which will result in pending requests and events being dropped.
+Plugins must respond to the prepare disconnect by stopping any processess it does that send events or requests over the link in question.
+This can be accomplished either through listening for the prepare disconnect hook, or by checking the `connected` property of the `SlaveConnection` class and `Slave` class on the master and slave respectively.
+For example the sending of an event from an `InstancePlugin` class can be stopped while the connection is not connected, not in the dropped state, and not in the process of discunnecting by using the following code:
+
+```js
+if (this.slave.connected) {
+    this.info.messages.frobnicate.send(this.instance, { foo: "bar" });
+}
+```
+
+If the event or request needs to be sent to the master it can be put into a queue stored on the plugin instance and sent out when the connection is established again.
+The re-establishement of the connection is  notified to plugins via the `connect` event to the `onMasterConnectionEvent` and `onSlaveConnectionEvent` hooks.
+
+The second connection event which is of lesser importance to respond to is the `drop` connection event served through `onMasterConnectionEvent` for `InstancePlugin` classes and through `onSlaveConnectionEvent` for `MasterPlugin` classes.
+This is raised when the connection between the master and slave in question is lost, most likely due to networking issues.
+When in the dropped state the slave will keep trying to reconnect to the master server in order to re-establish it, and if successful no events or requests will be lost.
+However while in the dropped state any requests and events sent gets queued up in memory until the connection is either re-established or the session times out.
+This means that if your plugin sends a lot of events or requests, they can end up being queued up in a buffer and sent out all at once the connection is re-estabished.
+To avoid this you should be throtteling and/or stopping your requests/events after `drop` has been raised, and continue back as normal when `resume` is raised.
+
+
+## Collecting Statistics
+
+Clusterio comes with its own Prometheus client implementation, one part due to Not Invented Here and another part due to collectors in prom-client being difficult to get to work nicely with collecting data from plugins optionally loaded at runtime on different computers.
+
+In its simplest form collecting data from plugins consists of defining the metric and updating it somewhere in the plugin code.
+For example:
+
+```js
+const { Counter } = require("@clusterio/lib/prometheus");
+
+const fooMetric = new Counter(
+    "clusterio_foo_frobber_foo_metric", "Measures the level of foo",
+);
+
+// Somewhere in the master plugin code
+fooMetric.inc();
+```
+
+This works for master plugins, and the metric will be automatically available through the /metric HTTP endpoint.
+It's recommended that plugin metrics follow `clusterio_<plugin_name>_<metric_name>` as the naming scheme.
+
+For metrics that are per-instance, you must define an `instance_id` label and set it accordingly, for example:
+
+```js
+const { Counter } = require("@clusterio/lib/prometheus");
+
+const barMetric = new Gauge(
+    "clusterio_foo_frobber_bar_metric", "Bar instance level",
+    { labels: ["instance_id"] }
+);
+
+// Somewhere in the instance plugin code
+barMetric.labels(String(this.instance.id)).set(someValue);
+```
+
+Metrics are automatically registered to the default registry, and this default registry is automatically polled by the master server on slaves.
+This means that it's important that you place the definition of the metric at module level so that it's not created more than once over the lifetime of a slave.
+Since the metrics remember their values and would continue to be exported after an instance is shutdown, there's code at instance shutdown that removes all the values where the `instance_id` label matches the id of the instance shut down.
+
+For statistics you need to update on collection there's an `onMetrics` hook on both master and instance plugins that is run before the metrics in the default registry are collected.
+
+
+## Adding Custom Commands to clusterioctl
+
+The control entrypoint for plugins allows you to extend clustectl with your own commands.
+The creation of custom commands typically starts with defining a command tree for the plugin:
+
+```js
+const { Command, CommandTree } = require("@clusterio/lib/command");
+const fooFrobberCommands = new CommandTree({
+    name: "foo-frobber", description: "Foo Frobber Plugin commands"
+});
+```
+
+Then commands are added to the the plugin's command tree:
+
+```js
+const info = require("./info");
+
+fooFrobberCommands.add(new Command({
+    definition: ["frobnicate <type>", "Do frobnications", (yargs) => {
+        yargs.positional("level", {
+            describe: "type of frobnication", type: "string"
+        });
+    }],
+    handler: async function(args, control) {
+        await info.messages.frobnicate.send(control, {
+            instance_name: "Console",
+            content: args.message,
+        });
+    },
+}));
+```
+
+For a command the `definition` is the arguments to pass to [yargs.command](http://yargs.js.org/docs/#api-reference-commandcmd-desc-builder-handler) (see also [yargs.positional](http://yargs.js.org/docs/#api-reference-positionalkey-opt) and [yargs.options](http://yargs.js.org/docs/#api-reference-optionskey-opt) for setting up positional and optional arguments to commands).
+The `handler` is an async function that's invoked when the command is executed and it's passed the parsed command line arguments and a reference to the `Control` class of clusterioctl.
+It's possible to optain a reference to the plugin class with `control.plugins.get(info.name)`.
+
+Note that messages sent from clusterioctl needs to have `"control-master"` as a part of the links array for it to be accepted by the master server, see [Defining Link Messages](#defining-link-messages) for how to define the messages that can be sent to the master.
+
+To have the command tree become part of clusterioctl it needs to be added to the rootCommand tree in `addCommands` callback of the Control plugin:
+
+```js
+const libPlugin = require("@clusterio/lib/plugin");
+
+class ControlPlugin extends libPlugin.BaseControlPlugin {
+    async addCommands(rootCommand) {
+        rootCommand.add(fooFrobberCommands);
+    }
+}
+
+module.exports = {
+    ControlPlugin,
+}
+```

documentation.yml

@@ -1,10 +0,0 @@
-toc:
- - name: Master Server API
- - clusterioMaster
- - name: Type declarations
- - itemStack
- - name: Internal modules
-   description: |
-     Here are some helper functions for navigation.
- - modManager
- - getFactorioLocale

lerna.json

@@ -0,0 +1,8 @@
+{
+  "packages": [
+    "packages/*",
+    "plugins/*",
+    "test"
+  ],
+  "version": "2.0.0-alpha.10"
+}

lib/generateSSLcert.js

@@ -1,49 +0,0 @@
-var forge = require("node-forge");
-forge.options.usePureJavaScript = true;
-var fs = require("fs");
-var mkdirp = require("mkdirp");
-
-var pki = forge.pki;
-var rsa = forge.pki.rsa;
-var startTime, endTime;
-
-
-
-module.exports = function({
-	bits = 2048,
-	certificatePath = "database/certificate",
-	doLogging = false,
-} = {}){
-	function log(t){
-		if(doLogging) console.log("lib/generateSSLcert.js | "+t);
-	}
-	log("Generating SSL certificate with "+bits+" bits at "+certificatePath);
-
-	startTime = Date.now();
-	var keypair = rsa.generateKeyPair({bits: bits, e: 0x10001});
-	endTime = Date.now();
-	log("Generated 2048bit keypair in: "+(endTime-startTime)+" ms");
-
-	startTime = Date.now();
-	var cert = pki.createCertificate();
-	cert.publicKey = keypair.publicKey;
-	cert.serialNumber = "01";
-
-	cert.validity.notBefore = new Date();
-	cert.validity.notAfter = new Date(Date.now()+(1000*60*60*24*365)); // valid for one year
-
-	// self-sign certificate
-	cert.sign(keypair.privateKey);
-
-	// Convert certificate to pem type and write it to a file
-	if(certificatePath[certificatePath.length-1] != "/") certificatePath += "/";
-	if(!fs.existsSync(certificatePath)) {
-		mkdirp.sync(certificatePath);
-		console.log("Created directory: "+certificatePath);
-	}
-	fs.writeFileSync(certificatePath+ "cert.key", pki.privateKeyToPem(keypair.privateKey));
-	fs.writeFileSync(certificatePath+ "cert.crt", pki.certificateToPem(cert));
-
-	endTime = Date.now();
-	log("Generated certificate in: "+(endTime-startTime)+" ms");
-}

lib/generateSSLcert.spec.js

@@ -1,25 +0,0 @@
-var assert = require("assert");
-var fs = require("fs");
-
-var fileOps = require("_app/fileOps");
-var generateSSLcert = require("./generateSSLcert.js")
-
-describe("generateSSLcert.js(options)", ()=>{
-	it("Creates a folder with a .crt and .key file in it", ()=>{
-		let certPath = "lib/certTestPlsDelete";
-		assert(!fs.existsSync(certPath)); // if it already exsits, the test might pass because of leftover data (which is bad)
-		
-		generateSSLcert({
-			// bits:512, // supported, but I just use the default of 2048 for this test
-			certificatePath:certPath,
-			doLogging: false,
-		});
-		
-		assert(fs.existsSync(certPath));
-		assert(fs.existsSync(certPath+"/cert.key")); // private key
-		assert(fs.existsSync(certPath+"/cert.crt")); // certificate file
-		
-		// remove certificates and data from the test
-		fileOps.deleteFolderRecursiveSync(certPath);
-	}).timeout(10000);
-});

lib/getFactorioLocale.js

@@ -1,45 +0,0 @@
-/**
-Module for grabbing factorio locale from a local factorio install
-@module getFactorioLocale
-*/
-
-const fs = require("fs");
-const ini = require("ini");
-
-/**
-Gets raw factorio locale from the .ini file.
-Not available outside of module through exports.
-
-@memberof getFactorioLocale
-@inner
-@param {string} factorioDirectory
-@param {string} languageCode
-@param {function} callback
-*/
-function getLocale(factorioDirectory, languageCode, callback){
-	var localeFile = factorioDirectory + '/data/base/locale/' + languageCode + '/base.cfg';
-	fs.readFile(localeFile, "utf8", (err, rawLocale) => {
-		callback(err, rawLocale);
-	});
-}
-
-/**
-Gets factorios locale as an object, does not respect mods.
-
-@param {string} factorioDirectory
-@param {string} languageCode
-@param {function} callback
-*/
-module.exports.asObject = function getLocaleAsObject(factorioDirectory, languageCode, callback){
-	if(typeof factorioDirectory != "string" || typeof languageCode != "string" || typeof callback != "function"){
-		throw "Error: wrong parameters provided";
-	}
-	getLocale(factorioDirectory, languageCode, (err, rawLocale) => {
-		if(err){
-			callback(err);
-		} else {
-			let processedLocale = ini.parse(rawLocale)
-			callback(undefined, processedLocale);
-		}
-	});
-}

lib/getFactorioLocale.spec.js

@@ -1,74 +0,0 @@
-const assert = require("assert");
-const getFactorioLocale = require("./getFactorioLocale");
-
-describe("getFactorioLocale.js", () => {
-	describe("asObject()", () => {
-		it("requires 2 strings and a function as parameters", () => {
-			let validate = (err) => {
-				return err == "Error: wrong parameters provided"
-			}
-			let message = "getFactorioLocale is responding incorrectly to invalid arguments"
-			let callback = (err,object) => true;
-			
-			assert.throws(() => getFactorioLocale.asObject(), validate, message);
-			assert.throws(() => getFactorioLocale.asObject("hello", "I forgot my callback"), validate, message);
-			assert.throws(() => getFactorioLocale.asObject(undefined, undefined, callback), validate, message);
-			
-			// the proper way to do it
-			assert.doesNotThrow(() => getFactorioLocale.asObject("factorio_0.15.27", "en", callback), validate, message);
-		});
-		it("returns a nested object with base game locale information", (done) => {
-			getFactorioLocale.asObject("factorio", "en", callback);
-			
-			function callback(err, object){
-				assert.equal(typeof object, "object");
-				assert.equal(object["entity-name"]["fish"], "Fish");
-				assert.equal(object["entity-name"]["small-lamp"], "Lamp");
-				Object.keys(object).forEach(key => {
-					// first level of the nested object is always an object
-					assert.equal(typeof object[key], "object");
-					
-					Object.keys(object[key]).forEach(key2 => {
-						// second level of the nested object is always a string, nearly always truthy
-						if(key2 != "so-long-and-thanks-for-all-the-fish"){
-							assert.ok(object[key][key2]);
-							assert.equal(typeof object[key][key2], "string");
-						}
-					});
-				});
-				done();
-			}
-		});
-		it("has some duplicate keys", (done) => {
-			getFactorioLocale.asObject("factorio", "en", callback);
-			
-			function callback(err, object){
-				let arrayOfKeys = [];
-				// collect all keys in a single array
-				Object.keys(object).forEach(key => {
-					arrayOfKeys.push(key);
-					Object.keys(object[key]).forEach(key2 => {
-						arrayOfKeys.push(key2);
-					});
-				});
-				
-				// check for duplicates
-				let duplicateKeys = [];
-				let i = 0;
-				arrayOfKeys.forEach(key => {
-					let o = 0;
-					arrayOfKeys.forEach(key2 => {
-						if(i != o && key == key2){
-							duplicateKeys.push(key);
-						}
-						o++
-					});
-					i++;
-				});
-				// we got 704 but this is a very unexact number
-				assert(duplicateKeys.length > 10)
-				done();
-			}
-		});
-	});
-});

lib/getInstances.js

@@ -1,14 +0,0 @@
-const fileOps = require("_app/fileOps");
-
-module.exports = {
-	sync: function(){
-		let instances;
-		try {
-			instances = fileOps.getDirectoriesSync("./instances/");
-		} catch (e) {
-			// there are no instances created yet, probably missing the folder
-			instances = [];
-		}
-		return instances;
-	}
-}

lib/manager/configManager.js

@@ -1,48 +0,0 @@
-/**
-Provides tools for managing both masters and slaves config files.
-@module configManager
-*/
-// require modules
-const asTable = require("as-table").configure({delimiter: ' | '});
-const fs = require("fs");
-
-// internal requires
-var config = require("./../../config");
-const objectOps = require("./../objectOps.js");
-/**
-console.log()s each entry in the config
-
-@param {string} instance Either undefined, "shared" or the instance to show the config for.
-*/
-module.exports.displayConfig = function(instance){
-	if(!instance || instance == "shared"){
-		let configArray = [];
-		Object.keys(config).forEach(key=>{
-			if(key != "__comment"){
-				if(typeof config[key] == "object"){
-					configArray.push({entry: key, value: JSON.stringify(config[key])});
-				} else configArray.push({entry: key, value: config[key]});
-			}
-		});
-		console.log(asTable(configArray));
-	}
-}
-module.exports.editConfig = function(instance, entry, newValue){
-	if(!instance || instance == "shared"){
-		if(config[entry] && newValue){
-			if(objectOps.isJSON(newValue)){
-				config[entry] = JSON.parse(newValue);
-				console.log("Changed config entry "+entry+" from "+JSON.stringify(config[entry])+" to "+JSON.stringify(newValue));
-				console.log("new config file:");
-				console.log(JSON.stringify(config, null, "	"))
-				fs.writeFileSync("config.json", JSON.stringify(config, null, 4));
-			} else {
-				config[entry] = newValue;
-				console.log("Changed config entry "+entry+" from "+config[entry]+" to '"+newValue+"'");
-				console.log("new config file:");
-				console.log(JSON.stringify(config, null, "	"))
-				fs.writeFileSync("config.json", JSON.stringify(config, null, 4));
-			}
-		}
-	}
-};

lib/manager/modManager.js

@@ -1,238 +0,0 @@
-/**
-Provides tools to manage mods in a clusterio install
-@module modManager
-*/
-
-const rightpad = require("right-pad");
-const asTable = require("as-table").configure({delimiter: ' | '});
-const moment = require("moment");
-const syncRequest = require("sync-request");
-const fs = require("fs");
-const https = require('follow-redirects').https;
-const factorioAPI = require("node-factorio-api");
-const sLog = require("single-line-log").stdout;
-
-const fileOps = require("_app/fileOps");
-const config = require("./../../config");
-
-const instances = require("./../getInstances.js").sync();
-
-function ellipse(str, max){
-   return str.length > (max - 3) ? str.substring(0,max-3) + '...' : str;
-}
-// https://stackoverflow.com/questions/15900485/correct-way-to-convert-size-in-bytes-to-kb-mb-gb-in-javascript
-function formatBytes(a,b){if(0==a)return"0 Bytes";var c=1024,d=b||2,e=["Bytes","KB","MB","GB","TB","PB","EB","ZB","YB"],f=Math.floor(Math.log(a)/Math.log(c));return parseFloat((a/Math.pow(c,f)).toFixed(d))+" "+e[f]};
-
-/**
-Lists mods for an instance as a table. Warning, handles printing internally.
-@param {string} instance - Name of the instance or "shared"
-
-@example
-var modManager = require("modManager");
-modManager.listMods("testInstance");
-// console.logs table of mods installed on instance
-modManager.listMods("shared");
-// console.logs mods located in /sharedMods as a nice table
-*/
-module.exports.listMods = function(instance){
-	if(instance && instances.includes(instance)){
-		factorioAPI.init(false, 'instances/'+instance+'/instanceMods', 'instances/'+instance+'/saves', '0.16.15');
-		factorioAPI.authenticate({
-			username: config.username,
-			token: config.token,
-			require_ownership: false
-		}).then(token => {
-			console.log("* Currently installed:");
-			factorioAPI.readModZips().then(list => {
-				console.log(asTable(list.map(mod => {
-					return {
-						name:(mod.title || mod.name),
-						version:mod.version,
-						date:mod.date,
-						factorio_ver:mod.factorio_version,
-						author:mod.author,
-					}
-				})));
-			});
-			// Had issues earlier due to bug in node-factorio-api, see https://github.com/Danacus/node-factorio-api/issues/2
-			// bug is resolved, thanks to @Danacus and @brotherpot
-			factorioAPI.getModsFromSaves().then(list => {
-				console.log("* Mods used in save:");
-				console.log(asTable(list[0].mods))
-			});
-		}).catch(reason => {
-			console.log("Failed to authenticate to factorio.com! Please check your connection and the username+token used for authentication in config.json");
-		});
-	} else {
-		// list shared mods in /sharedMods/
-		factorioAPI.init(false, 'sharedMods/', '', '0.16.15');
-		factorioAPI.authenticate({
-			username: config.username,
-			token: config.token,
-			require_ownership: false
-		}).then(() => {
-			console.log("\r\n")
-			console.log("* Mods shared by all instances:")
-			factorioAPI.getInstalledMods().then(mods => {
-				console.log(asTable(mods));
-			});
-		});
-	}
-	
-	// get JSON data about GH releases
-	/*let res = syncRequest('GET', 'https://api.github.com/repos/Danielv123/factorioClusterioMod/releases', {"headers":{"User-Agent":"Fuck you for requiring user agents!"}});
-	let url = JSON.parse(res.getBody())[0].assets[0].browser_download_url;
-	let name = JSON.parse(res.getBody())[0].assets[0].name;
-	console.log(JSON.parse(res.getBody()))
-	*/
-}
-/**
-Searches mods.factorio.com for mods matching a search term and prints
-the results to console as a neat looking table
-
-@param {string} searchTerm What to search for
-*/
-module.exports.findMods = function(searchTerm){
-	factorioAPI.init(false);
-	factorioAPI.authenticate({
-		username: config.username,
-		token: config.token,
-		require_ownership: false
-	}).then(token => {
-		factorioAPI.searchMods(searchTerm).then(mods => {
-			console.log(asTable(mods.reverse().map(mod => {
-				return {
-					title:ellipse(mod.title, 50),
-					name:ellipse(mod.name, 30),
-					downloads:mod.downloads_count,
-					updated: moment(mod.updated_at).format("DD.MM.YY"),
-					owner:mod.owner,
-					//license: mod.license_name,
-				}
-			})))
-		})
-	});
-}
-
-module.exports.addMod = function(term, instance){
-	if(instance == "shared"){ // modDirectory has to end in /
-		var modDirectory = "sharedMods/";
-	} else {
-		var modDirectory = "instances/"+instance+"/instanceMods/";
-	}
-	if(term && term.length > 0){
-		if(term.includes("mods.factorio.com/mods/")){ // https://mods.factorio.com/mods/Danielv123/ChooChoo
-			// treat it as a link download
-			factorioAPI.init(false, modDirectory, "", "0.16.15");
-			factorioAPI.authenticate({
-				username: config.username,
-				token: config.token,
-				require_ownership: false
-			}).then(() => {
-				factorioAPI.searchMods(term.split("/")[term.split("/").length-1]).then(body => {
-					console.log("Im gonna download: "+body[0].name);
-					factorioAPI.downloadMod(body[0]).then(()=>{
-						console.log("Mod downloaded");
-					});
-				});
-			});
-		} else if(term.includes("github.com")){ // https://github.com/Danielv123/factorioClusterioMod
-			// treat it as a github releases download
-			let apiURL = "https://api.github.com/repos/" + term.split("/")[3] + "/" + term.split("/")[4] + "/releases"; // https://api.github.com/repos/Danielv123/factorioClusterioMod/releases
-			
-			let res = syncRequest('GET', apiURL, {"headers":{"User-Agent":"Fuck you for requiring user agents!"}});
-			let url = JSON.parse(res.getBody())[0].assets[0].browser_download_url;
-			let name = JSON.parse(res.getBody())[0].assets[0].name;
-			if(url) {
-				console.log("Downloading " + url);
-				let file = fs.createWriteStream(modDirectory + name);
-				let bytesDownloaded = 0;
-				let downloadStartTime = Date.now();
-				https.get(url, function(response) {
-					let bytesToDownload = response.headers['content-length'];
-					response.pipe(file);
-					response.on("data", chunk => {
-						bytesDownloaded += chunk.length;
-						let downloadTimeElapsed = Date.now() - downloadStartTime;
-						let bytesPerSecond = bytesDownloaded / (downloadTimeElapsed/1000);
-						let timeToComplete = Math.floor((bytesToDownload - bytesDownloaded)/bytesPerSecond);
-						sLog("Downloading "+name+" "+(bytesDownloaded/bytesToDownload*100).toPrecision(3)+"% ("+formatBytes(bytesDownloaded)+" / "+formatBytes(bytesToDownload)+")\r\n"+
-						"about "+timeToComplete+" seconds remaining ("+formatBytes(bytesPerSecond)+"/s)");
-					}).on("end", x => {
-						sLog.clear();
-						console.log(" Downloaded in "+moment.utc(moment.duration(Date.now()-downloadStartTime).as('milliseconds')).format('mm:ss')); // because sLog.clear() doesn't seem to do the job of ending the line properly
-					});
-				});
-			}
-		} else {
-			// treat it as a search and download the top result
-			factorioAPI.init(false, modDirectory, "", "0.16.15");
-			factorioAPI.authenticate({
-				username: config.username,
-				token: config.token,
-				require_ownership: false
-			}).then(() => {
-				factorioAPI.searchMods(term).then(body => {
-					console.log("Im gonna download: "+body[0].name);
-					factorioAPI.downloadMod(body[0]).then(()=>{
-						console.log("Mod downloaded");
-					});
-				});
-			});
-		}
-	}
-}
-module.exports.removeMod = function removeMod(term, instance, force = false){
-	if(instance == "shared"){ // modDirectory has to end in /
-		var modDirectory = "sharedMods/";
-	} else {
-		var modDirectory = "instances/"+instance+"/instanceMods/";
-	}
-	if(term && typeof term == "string" && term.length > 0){
-		let mods = fs.readdirSync(modDirectory);
-		let modsMatchingFilter = mods.filter(mod => mod.toLowerCase().includes(term.toLowerCase()));
-		if(modsMatchingFilter.length < 1){
-			console.log("No mods found matching search");
-		} else if(modsMatchingFilter.length == 1){
-			console.log("Deleting "+modsMatchingFilter[0]);
-			fs.unlinkSync(modDirectory+modsMatchingFilter[0]);
-			console.log("Deleted.");
-		} else if(modsMatchingFilter.length > 1){
-			console.log("Found multiple mods, not doing anything");
-			modsMatchingFilter.forEach(mod => console.log(mod));
-		}
-	}
-}
-
-// 'https://api.github.com/repos/Danielv123/factorioClusterioMod/releases'
-/**
-Download mod from github repo by looking for the first binary download in
-the latest release, saving it to /sharedMods
-
-@param {string} url a github repo  URL, for example https://api.github.com/repos/Danielv123/factorioClusterioMod/releases. Must link to /releases
-*/
-module.exports.downloadFromGitURL = function(url){
-	console.log("Downloading mod from "+url);
-	// get JSON data about releases
-	let res = syncRequest('GET', url, {"headers":{"User-Agent":"Please don't require setting a user agent"}});
-	let downloadUrl = JSON.parse(res.getBody())[0].assets[0].browser_download_url;
-	let name = JSON.parse(res.getBody())[0].assets[0].name;
-	console.log(JSON.parse(res.getBody()))
-	if(downloadUrl) {
-		console.log(downloadUrl);
-		let file = fs.createWriteStream("sharedMods/"+name);
-		https.get(downloadUrl, function(response) {
-			response.pipe(file);
-			console.log("Downloaded "+name);
-		});
-	}
-}
-/*
-module.exports.findUpdates = function(){
-	console.log("Downloading mods...");
-	// get JSON data about releases
-	let res = syncRequest('GET', 'https://api.github.com/repos/Danielv123/factorioClusterioMod/releases', {"headers":{"User-Agent":"Fuck you for requiring user agents!"}});
-	let url = JSON.parse(res.getBody())[0].assets[0].browser_download_url;
-	let name = JSON.parse(res.getBody())[0].assets[0].name;
-	console.log(JSON.parse(res.getBody()))
-}*/

lib/npmPostinstall.js

@@ -1,136 +0,0 @@
-var mkdirp = require("mkdirp");
-var http = require('http');
-var https = require('https');
-var fs = require('fs');
-
-var modManager = require("./manager/modManager.js");
-
-modManager.addMod("clusterio", "shared");
-
-function makeDirectory(path){
-	return new Promise((resolve, reject) => {
-		mkdirp(path, function(err){
-			if(err){
-				console.error("Unable to mkdirp "+path);
-				console.error(err);
-				resolve(false);
-			} else {
-				console.log("mkdirp "+path);
-				resolve(true);
-			}
-		});
-	});
-}
-function download(url, file, callback){
-	return new Promise((resolve, reject) => {
-		let pathArray = file.split("/");
-		pathArray.pop(); // remove filename from the end
-		if(pathArray.length >= 1){
-			// this might be an invalid path!
-			fs.stat(pathArray.join("/"), (err, stat) => {
-				if(err){
-					makeDirectory(pathArray.join("/")).then(()=>{
-						doDownload(url, file, callback);
-					});
-				} else {
-					doDownload(url, file, callback);
-				}
-			});
-		} else {
-			doDownload(url, file, callback);
-		}
-		function doDownload(url, file, callback){
-			var writeStream = fs.createWriteStream(file);
-			let protocol = http;
-			if(url.split(":")[0] == "https") protocol = https;
-			var request = protocol.get(url, function(response) {
-				response.pipe(writeStream);
-				response.on("end", () => {
-					if(callback && typeof callback == "function") callback(file);
-					console.log("Downloaded "+file+" from "+url);
-					resolve();
-				});
-			});
-		}
-	});
-}
-
-var directories = [
-	"database/linvodb",
-	"sharedMods",
-	"instances",
-];
-let downloadList = [
-	{
-		url: "http://fbpviewer.trakos.pl/images/spritesheet.json",
-		file: "static/pictures/spritesheet.js",
-		callback: function(file){
-			fs.writeFileSync("static/pictures/spritesheet.js", "export default\n"+fs.readFileSync("static/pictures/spritesheet.js"));
-		},
-	},
-	{
-		url: "http://fbpviewer.trakos.pl/images/spritesheet.png",
-		file: "static/pictures/spritesheet.png",
-	},
-	{
-		url: "https://code.jquery.com/jquery.js",
-		file: "static/external/jquery.js",
-	},
-	{
-		url: "https://code.jquery.com/ui/1.12.1/jquery-ui.js",
-		file: "static/external/jquery-ui.js",
-	},
-	{
-		url: "https://cdnjs.cloudflare.com/ajax/libs/canvasjs/1.7.0/canvasjs.js",
-		file: "static/external/canvasjs.js",
-	},
-	{
-		url: "https://momentjs.com/downloads/moment.min.js",
-		file: "static/external/moment.min.js",
-	},
-	{
-		url: "https://craig.global.ssl.fastly.net/js/mousetrap/mousetrap.min.js",
-		file: "static/external/mousetrap.min.js",
-	},
-	{
-		url: "https://fonts.googleapis.com/css?family=Roboto",
-		file: "static/external/css/Roboto.css",
-	},
-	{
-		url: "https://cdnjs.cloudflare.com/ajax/libs/socket.io/2.0.4/socket.io.js",
-		file: "static/external/socket.io.js",
-	},
-]
-
-// initiate folder creations and downloads
-processMkdirRecursive(processDownloadRecursive);
-function processMkdirRecursive(callback){
-	let item = directories.shift();
-	makeDirectory(item).then(()=>{
-		if(directories.length == 0){
-			if(callback) callback();
-		} else {
-			processMkdirRecursive(callback);
-		}
-	});
-}
-function processDownloadRecursive(callback){
-	let item = downloadList.shift();
-	download(item.url, item.file, item.callback).then(()=>{
-		if(downloadList.length == 0){
-			if(callback) callback();
-		} else {
-			processDownloadRecursive(callback);
-		}
-	});
-}
-
-// generate SSL certificates if they are missing
-if(!fs.existsSync("database/certificates") || !fs.existsSync("database/certificates/cert.crt") || !fs.existsSync("database/certificates/cert.key")){
-	var generateSSLcert = require("./generateSSLcert.js");
-	
-	generateSSLcert({
-		certificatePath: "database/certificates",
-		doLogging: true,
-	});
-}

lib/objectOps.js

@@ -1,44 +0,0 @@
-/**
-Helper functions related to objects
-@module objectOps
-*/
-
-/**
-Deep clones an object, is actually just JSON.parse(JSON.stringify()) but looks cleaner.
-@param {object} obj to clone
-@returns {object}
-
-@example
-a = {"thingy":"with a value"};
-b = a;
-a == b; // true
-c = objectOps.deepclone(a);
-a == c; // false
-*/
-module.exports.deepclone = function(obj){
-	return JSON.parse(JSON.stringify(obj));
-}
-/**
-Checks if a string is valid JSON using try/catch. If passed an object it will always return true.
-@param {string} string to verify
-@returns {boolean}
-
-@example
-objectOps.isJSON("99 bottles of beer"); // false
-objectOps.isJSON("99"); // true
-objectOps.isJSON({"thingy":"that is an object"}); // true
-objectOps.isJSON(JSON.stringify({"thingy":"that is an object"})); // true
-*/
-module.exports.isJSON = function(string){
-	let stringIsJson = false;
-	let x
-	try {
-		x = JSON.parse(string);
-	} catch (e){
-		return false;
-	}
-	if(typeof x == "object" || typeof string == "object"){
-		stringIsJson = true;
-	}
-	return stringIsJson;
-}

lib/objectOps.spec.js

@@ -1,40 +0,0 @@
-var assert = require('assert');
-var objectOps = require('./objectOps');
-
-describe("objectOps.js", function(){
-	/*describe("objectOps.clone()", function(){
-		it("clones javascript objects", function(){
-			var object1 = {hello:"world", cat:{legs:4, name:"Kitty", colors:["brown", "yellow", "purple"]}};
-			var object2 = {};
-			object2 = objectOps.clone(object1);
-			
-			assert.equal(object2.cat.name, object1.cat.name)
-			assert.equal(object1.hello, object2.hello)
-		});	
-		it("does not deep clone objects", function(){
-			var obj1 = {hello:"world", cat:{legs:4, name:"Kitty", colors:["brown", "yellow", "purple"]}};
-			var obj2 = {};
-			obj2 = objectOps.clone(obj1);
-			
-			obj1.cat.colors = "black";
-			assert.equal(obj1.cat.colors, "black");
-			assert.notEqual(obj2.cat.colors[1], "yellow");
-		});
-	});*/
-	describe("objectOps.deepclone()", function(){
-		it("deep clones javascript objects", function(){
-			var obj1 = {hello:"world", cat:{legs:4, name:"Kitty", colors:["brown", "yellow", "purple"]}};
-			var obj2 = {};
-			obj2 = objectOps.deepclone(obj1);
-			
-			obj1.cat.colors = "black";
-			assert.equal(obj1.cat.colors, "black");
-			assert.equal(obj2.cat.colors[1], "yellow");
-		});
-		it("throws on non JSON parameters", function(){
-			assert.throws(function(){
-				let y = objectOps.deepclone(objectOps.deepclone);
-			});
-		});
-	});
-});

lib/stringUtils.js

@@ -1,14 +0,0 @@
-function hashCode(string){
-	if(typeof string !== "string") throw "ERROR stringUtils: Not a string";
-	var hash = 0;
-	if (string.length == 0) return hash;
-	for (let i = 0; i < string.length; i++) {
-		char = string.charCodeAt(i);
-		hash = ((hash << 5) - hash) + char;
-		hash = hash & hash; // Convert to 32bit integer
-	}
-	return hash;
-}
-module.exports = {
-	hashCode: hashCode,
-}

lib/stringUtils.spec.js

@@ -1,48 +0,0 @@
-const assert = require("assert");
-const stringUtils = require("./stringUtils");
-
-describe("stringUtils.js", function(){
-	describe("hashCode", function(){
-		it("Produces a 32bit signed int hash from a string", function(){
-			let x = stringUtils.hashCode("whatever");
-			let y = stringUtils.hashCode(" a much longer string to prove this works for long strings as well and also special characters &!¤(#)¤");
-			
-			assert(typeof x == "number", "hashCode should be returning a 32 bit signed int");
-			assert(x.toString() == "1934383586");
-			assert(y.toString() == "1648886132");
-		});
-		let permutations = 1000;
-		it("Rarely produces same hash for different strings ("+permutations+" hashes with collision check)", function(){
-			let keyHashPairs = [];
-			for(let i = 0; i < permutations; i++){
-				let string = Math.random().toString();
-				keyHashPairs.push({
-					key:string,
-					hash:stringUtils.hashCode(string),
-				});
-			}
-			
-			for(let i = 0; i < permutations; i++){
-				for(let o = 0; o < permutations; o++){
-					assert(i == o || keyHashPairs[o].key != keyHashPairs[i].key, "Woha, Math.random() generated 2 equal numbers???");
-					assert(i == o || keyHashPairs[o].hash != keyHashPairs[i].hash, "Hash collision, as long at it doesn't happen again its fine.");
-				}
-			}
-		});
-		it("Returns 0 for 0 length strings", function(){
-			let x = stringUtils.hashCode("");
-			assert.deepEqual(x, 0);
-		});
-		it("Throws when supplied with anything other than a string", function(){
-			assert.throws(function(){
-				stringUtils.hashCode([]);
-			}, "ERROR: Not a string")
-			assert.throws(function(){
-				stringUtils.hashCode({});
-			}, "ERROR: Not a string")
-			assert.throws(function(){
-				stringUtils.hashCode(0);
-			}, "ERROR: Not a string")
-		});
-	});
-});

lib/typedef.js

@@ -1,11 +0,0 @@
-/**
-An item with a count specified
-
-@typedef {object} itemStack
-@property {string} name The name of the item in the stack
-@property {(number|string)} count The amount of items in the stack
-
-@example
-itemStack = {name:"iron-plate", count:"12"}
-itemStack = {name:"copper-plate", count:972}
-*/

logo.svg

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg width="100%" height="100%" viewBox="0 0 154 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.41421;"><path d="M105.009,19.309l-3.12,0l-1.68,-1.68l0,-10.293l2.64,-2.64c2.029,0 7.281,0 9.996,0l1.68,1.68l0,6.2l-0.96,0.96l-7.596,-0.003l0,4.816l-0.96,0.953l0,0.007Zm6.876,0l-3.12,0l0,-3.944l0.96,-0.96l4.8,0l0,2.212l-2.64,2.692Zm-63.405,0l-9.917,0l-1.68,-1.68l0,-10.293l2.64,-2.64l3.118,0l0.002,9.827l2.718,0l0.002,-8.867l0.96,-0.96l3.117,0l1.68,1.68l0,10.293l-2.64,2.64Zm-15.652,0l-9.918,0l-1.68,-1.68l0,-10.293l2.64,-2.64l3.118,0l0.002,9.827l8.478,0.009l0,2.137l-2.64,2.64Zm-15.712,0l-9.996,0l-1.68,-1.68l0,-10.293l2.64,-2.64c2.029,0 7.281,0 9.996,0l1.68,1.68c0,1.028 0,2.147 0,2.147l-0.96,0.942l0,0.018l-7.596,0l0,5.04l8.556,0l0,2.146l-2.64,2.64Zm47.185,0l-9.997,0l-1.68,-1.68l0,-2.142l0.96,-0.96l7.597,-0.002l0,-0.993l-8.557,0l0,-6.196l1.68,-1.68l0,0l0.96,-0.96c2.029,0 7.282,0 9.997,0l1.68,1.68c0,1.028 0,2.147 0,2.147l-0.96,0.96l-7.597,0.002l0,0.957l8.557,0l0,6.227l-0.96,0.96l0,0l-1.68,1.68Zm12.444,0l-3.12,0l-1.68,-1.68l0,-6.216l0.96,-0.96l6.48,0l0,6.216l-2.64,2.64Zm19.325,0l-9.996,0l-1.68,-1.68l0,-10.293l2.64,-2.64c2.029,0 7.281,0 9.996,0l1.68,1.68c0,1.028 0,2.147 0,2.147l-1.086,0.96l-7.47,0l0,0.959l5.841,0l0,2.13l-0.96,0.96l-4.881,0l0,0.991l8.556,0l0,2.146l-2.64,2.64Zm20.065,-7.896l0.96,-0.96l6.481,0l0,5.953l-2.64,2.903l-3.121,0l-1.68,-1.943l0,-5.953Zm21.411,7.896l-2.872,0l0,-1.178c-1.382,-0.123 -2.749,-0.431 -4.028,-0.977l-0.056,-0.024l-1.307,0.804l-2.03,-1.25l1.277,-0.786c-0.81,-0.666 -1.487,-1.522 -1.761,-2.534l-1.749,0l0,-1.768l0.96,-0.96l1.141,0c0.332,-0.616 0.809,-1.156 1.35,-1.61l-1.198,-0.78l0.94,-0.93l2.03,-1.25l1.227,0.755c0.949,-0.424 2.033,-0.741 3.204,-0.922l0,-0.248l0.013,0l0.947,-0.96l2.872,0l0,1.116c1.505,0.156 2.889,0.535 4.059,1.079l1.332,-0.82l2.03,1.25l-1.12,1.059c0.701,0.671 1.181,1.437 1.377,2.261l1.976,0l0,1.768l-0.96,0.962l-0.002,-0.002l-1.327,0c-0.228,0.624 -0.547,1.236 -1.053,1.681l1.109,0.679l-0.968,0.978l-0.015,-0.004l-2.007,1.236l-1.411,-0.868c-0.958,0.432 -1.978,0.728 -3.02,0.908l0,0.375l-0.96,0.93l0,0.03Zm-15.17,-7.656l-6.001,0l0,5.624l1.55,1.792l2.901,0l1.55,-1.792l0,-5.624Zm-44.191,0l-6,0l0,5.877l1.54,1.539l2.921,0l1.539,-1.539l0,-5.877Zm35.14,3.952l-4.32,0l0,3.464l2.778,0l1.542,-1.59l0,-1.874Zm-96.308,-9.709l-9.798,0l-1.539,1.54l0,10.094l1.539,1.539l9.798,0l1.539,-1.539l0,-1.807l-8.556,0l0,-6.48l8.556,0l0,-1.807l-1.539,-1.54Zm8.771,0l-2.778,0l-1.54,1.54l0,10.094l1.54,1.539l9.719,0l1.539,-1.539l0,-1.799l-8.478,-0.008l-0.002,-9.827Zm15.653,0l-2.779,0l-1.539,1.54l0,10.094l1.539,1.539l9.719,0l1.539,-1.539l0,-10.094l-1.539,-1.54l-2.778,0l-0.003,9.827l-4.157,0l-0.002,-9.827Zm54.53,0l-9.798,0l-1.539,1.54l0,10.094l1.539,1.539l9.798,0l1.539,-1.539l0,-1.807l-8.556,0l0,-2.431l5.841,0l0,-1.65l-5.841,0l0,-2.399l8.556,0l0,-1.807l-1.539,-1.54Zm-31.77,0l-9.797,0l-0.82,0.82l-0.72,0.72l0,5.856l8.557,0l0,2.432l-8.557,0.003l0,1.803l1.54,1.539l9.797,0l1.54,-1.539l0,-5.888l-8.557,0l0,-2.396l8.557,-0.003l0,-1.807l-1.54,-1.54Zm47.585,0l-9.798,0l-1.539,1.54l0,10.094l1.539,1.539l2.781,0l0,-5.777l8.556,0.004l0,-5.86l-1.539,-1.54Zm28.324,7.453c0.327,-0.363 0.421,-0.95 0.212,-1.53c-0.459,-1.279 -2.339,-2.021 -4.278,-2.122c-0.058,0 -0.058,0 -0.115,0c-2.792,0.201 -3.386,1.31 -3.433,1.781c-0.151,1.505 1.994,2.74 4.45,2.74c1.269,0 2.7,-0.357 3.164,-0.869Zm-31.101,-1.707l0,-2.398l-4.24,0.002l0,2.396l4.24,0Zm-3.04,-2.157l0,0.957l2.8,0l0,-0.958l-2.8,0.001Zm-24.048,0.012l-13.471,0l0,-2.161l2.64,-2.64l10.111,0l1.68,1.68c0,1.034 0,2.161 0,2.161l-0.96,0.96Zm40.606,-0.048l-6.392,0l0,-2.113l2.64,-2.64l4.801,-0.005l0,3.798l-1.049,0.96Zm-42.386,-3.553l-9.912,0l-1.539,1.54l0,1.821l12.991,0l0,-1.821l-1.54,-1.54Zm37.774,0l-1.54,1.54l0,1.773l6.001,0l0,-3.318c-1.487,0.002 -2.974,0.003 -4.461,0.005Z" style="fill:#141414;"/><path d="M73.625,19.309l3.12,0l-3.12,0Zm47.201,-0.24l-2.901,0l-1.55,-1.792l0,-5.624l6.001,0l0,5.624l-1.55,1.792Zm-44.18,0l-2.921,0l-1.54,-1.539l0,-5.877l6,0l0,5.877l-1.539,1.539Zm60.66,0l-2.392,0l0,-1.157l-0.288,-0.026c-1.392,-0.131 -2.761,-0.465 -4.055,-1.026l-1.288,0.792l-1.572,-0.968l1.175,-0.724l0.005,-0.076l-0.25,-0.205c-0.598,-0.5 -1.12,-1.098 -1.438,-1.808c-0.159,-0.355 -0.249,-0.743 -0.25,-0.747l-1.693,0l0,-1.288l1.676,0l0.056,-0.226c0.27,-1.047 1.011,-1.878 1.84,-2.574l-0.005,-0.072l-1.116,-0.688l1.572,-0.968l1.208,0.743l0.228,-0.1c1.335,-0.574 2.76,-0.86 4.195,-0.988l0,-1.072l2.392,0l0,1.092l0.284,0.03c1.394,0.155 2.76,0.518 4.031,1.105l1.316,-0.81l1.572,0.968l-1.259,0.776l0.236,0.276c0.559,0.497 1.039,1.085 1.324,1.77c0.148,0.356 0.225,0.734 0.226,0.738l1.924,0l0,1.288l-1.941,0l-0.059,0.219c-0.367,1.3 -1.768,2.53 -1.768,2.53l1.317,0.811l-1.572,0.968l-1.394,-0.858lLine truncated

master.js

@@ -1,990 +0,0 @@
-/**
-Clusterio master server. Facilitates communication between slaves through
-a webserver, storing data related to slaves like production graphs and
-combinator signals.
-
-@module clusterioMaster
-@author Danielv123
-
-@example
-node master.js
-*/
-
-// Set the process title, shows up as the title of the CMD window on windows
-// and as the process name in ps/top on linux.
-process.title = "clusterioMaster";
-
-// add better stack traces on promise rejection
-process.on('unhandledRejection', r => console.log(r));
-
-// configgy stuff
-debug = false;
-
-// constants
-const masterModFolder = "./database/masterMods/";
-var config = require('./config');
-
-// homebrew modules
-const getFactorioLocale = require("./lib/getFactorioLocale");
-const stringUtils = require("./lib/stringUtils");
-
-// Library for create folder recursively if it does not exist
-const mkdirp = require("mkdirp");
-mkdirp.sync("./database");
-mkdirp.sync(masterModFolder);
-const averagedTimeSeries = require("averaged-timeseries");
-const deepmerge = require("deepmerge");
-const path = require("path");
-const fs = require("fs");
-const nedb = require("nedb");
-const jwt = require('jsonwebtoken');
-const bcrypt = require('bcryptjs');
-
-const express = require("express");
-const ejs = require("ejs");
-// Required for express post requests
-const bodyParser = require("body-parser");
-const fileUpload = require('express-fileupload');
-var app = express();
-
-app.use(bodyParser.json());
-app.use(bodyParser.urlencoded({ extended: true }));
-app.use(fileUpload());
-
-// dynamic HTML generations with EJS
-app.set('views', path.join(__dirname, 'static'));
-app.set('view engine', 'html');
-app.engine('html', ejs.renderFile);
-
-var routes = require("./routes.js");
-routes(app);
-
-
-// Set folder to serve static content from (the website)
-app.use(express.static('static'));
-// mod downloads
-app.use(express.static(masterModFolder));
-
-// set up logging software
-const prometheusPrefix = "clusterio_";
-const Prometheus = require('prom-client');
-Prometheus.collectDefaultMetrics({ timeout: 10000 }); // collects RAM usage etc every 10 s
-const httpRequestDurationMilliseconds = new Prometheus.Histogram({
-  name: prometheusPrefix+'http_request_duration_ms',
-  help: 'Duration of HTTP requests in ms',
-  labelNames: ['route'],
-  // buckets for response time from 0.1ms to 500ms
-  buckets: [0.10, 5, 15, 50, 100, 200, 300, 400, 500]
-});
-const endpointHitCounter = new Prometheus.Gauge({
-	name: prometheusPrefix+'endpoint_hit_gauge',
-	help: "How many requests a particular endpoint has gotten",
-	labelNames: ['route'],
-});
-const prometheusConnectedInstancesCounter = new Prometheus.Gauge({
-	name: prometheusPrefix+'connected_instaces_gauge',
-	help: "How many instances are currently connected to this master server",
-});
-const prometheusWsUsageCounter = new Prometheus.Counter({
-	name: prometheusPrefix+'websocket_usage_counter',
-	help: 'Websocket traffic',
-	labelNames: ["connectionType"],
-});
-const prometheusProductionGauge = new Prometheus.Gauge({
-	name: prometheusPrefix+'production_gauge',
-	help: 'Items produced by instance',
-	labelNames: ["instanceID", "itemName"],
-});
-const prometheusPlayerCountGauge = new Prometheus.Gauge({
-	name: prometheusPrefix+'player_count_gauge',
-	help: 'Amount of players connected to this cluster',
-	labelNames: ["instanceID", "instanceName"],
-});
-const prometheusMasterInventoryGauge = new Prometheus.Gauge({
-	name: prometheusPrefix+'master_inventory_gauge',
-	help: 'Amount of items stored on master',
-	labelNames: ["itemName"],
-});
-setInterval(()=>{
-	let numberOfActiveSlaves = 0;
-	for(let instance in slaves){
-		if(Date.now() - Number(slaves[instance].time) < 1000 * 30) numberOfActiveSlaves++;
-	}
-	prometheusConnectedInstancesCounter.set(numberOfActiveSlaves);
-},10000);
-/**
-GET Prometheus metrics endpoint. Returns performance and usage metrics in a prometheus readable format.
-@memberof clusterioMaster
-@instance
-@alias /metrics
-*/
-app.get('/metrics', (req, res) => {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	res.set('Content-Type', Prometheus.register.contentType);
-	
-	/// gather some static metrics
-	// playercount
-	for(let instanceID in slaves){try{
-		prometheusPlayerCountGauge.labels(instanceID, slaves[instanceID].instanceName).set(Number(slaves[instanceID].playerCount) || 0);
-	}catch(e){}}
-	// inventory
-	for(let key in db.items){
-		if(typeof db.items[key] == "number" || typeof db.items[key] == "string"){
-			prometheusMasterInventoryGauge.labels(key).set(Number(db.items[key]) || 0);
-		}
-	}
-	
-	res.end(Prometheus.register.metrics());
-	httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-});
-
-// set up database
-var Datastore = require('nedb');
-db = {};
-var LinvoDB = require("linvodb3");
-LinvoDB.dbPath = "./database/linvodb/";
-// database for items in system
-// db.items = new Datastore({ filename: 'database/items.db', autoload: true });
-
-// in memory database for combinator signals
-db.signals = new Datastore({ filename: 'database/signals.db', autoload: true, inMemoryOnly: true});
-db.signals.ensureIndex({ fieldName: 'time', expireAfterSeconds: 3600 }, function (err) {});
-
-// production chart database
-db.flows = new LinvoDB("flows", {}, {});
-
-
-(function(){
-	try{
-		let x = fs.statSync("database/slaves.json");
-		console.log("loading slaves from database/slaves.json");
-		slaves = JSON.parse(fs.readFileSync("database/slaves.json"));
-	} catch (e){
-		slaves = {};
-	}
-	try{
-		x = fs.statSync("database/items.json");
-		console.log("loading items from database/items.json");
-		db.items = JSON.parse(fs.readFileSync("database/items.json"));
-	} catch (e){
-		db.items = {};
-	}
-})()
-
-db.items.addItem = function(object) {
-	if(object.name == "addItem" || object.name == "removeItem") {
-		console.error("Fuck you, that would screw everything up if you named your item that.");
-		return false;
-	} else {
-		if(this[object.name] && Number(this[object.name]) != NaN){
-			this[object.name] = Number(this[object.name]) + Number(object.count);
-		} else {
-			this[object.name] = object.count;
-		}
-		return true;
-	}
-}
-db.items.removeItem = function(object) {
-	if(object.name == "addItem" || object.name == "removeItem") {
-		console.error("Fuck you, that would screw everything up if you named your item that.");
-		return false;
-	} else {
-		if(this[object.name] && Number(this[object.name]) != NaN){
-			this[object.name] = Number(this[object.name]) - Number(object.count);
-		} else {
-			this[object.name] = 0;
-		}
-		return true;
-	}
-}
-
-// store slaves and inventory in a .json full of JSON data
-process.on('SIGINT', function () {
-	console.log('Ctrl-C...');
-	// set insane limit to slave length, if its longer than this we are probably being ddosed or something
-	if(slaves && Object.keys(slaves).length < 2000000){
-		console.log("saving to slaves.json");
-		fs.writeFileSync("database/slaves.json", JSON.stringify(slaves));
-	} else if(slaves) {
-		console.log("Slave database too large, not saving ("+Object.keys(slaves).length+")");
-	}
-	if(db.items && Object.keys(db.items).length < 50000){
-		console.log("saving to items.json");
-		fs.writeFileSync("database/items.json", JSON.stringify(db.items));
-	} else if(slaves) {
-		console.log("Item database too large, not saving ("+Object.keys(slaves).length+")");
-	}
-	process.exit(2);
-});
-
-/**
-POST World ID management. Slaves post here to tell the server they exist
-@memberof clusterioMaster
-@instance
-@alias /api/getID
-*/
-app.post("/api/getID", function(req,res) {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	// request.body should be an object
-	// {rconPort, rconPassword, serverPort, mac, time}
-	// time us a unix timestamp we can use to check for how long the server has been unresponsive
-	// we should save that somewhere and give appropriate response
-	if(req.body){
-		if(debug){
-			console.log(req.body)
-		}
-		if(!slaves[req.body.unique]){
-			slaves[req.body.unique] = {};
-		}
-		for(k in req.body){
-			if(k != "meta" && req.body.hasOwnProperty(k)){
-				slaves[req.body.unique][k] = req.body[k];
-			}
-		}
-		console.log("Slave registered: " + slaves[req.body.unique].mac + " : " + slaves[req.body.unique].serverPort+" at " + slaves[req.body.unique].publicIP + " with name " + slaves[req.body.unique].instanceName);
-	}
-	httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-});
-/**
-POST Allows you to add metadata related to slaves for other tools, like owner data, descriptions or statistics.
-@memberof clusterioMaster
-@instance
-@alias /api/editSlaveMeta
-*/
-app.post("/api/editSlaveMeta", function(req,res) {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	// request.body should be an object
-	// {instanceID, pass, meta:{x,y,z}}
-	
-	if(req.body && req.body.instanceID && req.body.password && req.body.meta){
-		// check for editing permissions
-		if(slaves[req.body.instanceID] && slaves[req.body.instanceID].rconPassword == req.body.password){
-			if(!slaves[req.body.instanceID].meta){
-				slaves[req.body.instanceID].meta = {};
-			}
-			slaves[req.body.instanceID].meta = deepmerge(slaves[req.body.instanceID].meta, req.body.meta, {clone:true});
-			let metaPortion = JSON.stringify(req.body.meta);
-			if(metaPortion.length > 50) metaPortion = metaPortion.substring(0,20) + "...";
-			console.log("Updating slave "+slaves[req.body.instanceID].instanceName+": " + slaves[req.body.instanceID].mac + " : " + slaves[req.body.instanceID].serverPort+" at " + slaves[req.body.instanceID].publicIP, metaPortion);
-		} else {
-			res.send("ERROR: Invalid instanceID or password")
-		}
-	}
-	httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-});
-
-/**
-POST Get metadata from a single slave. For whenever you find the data returned by /api/slaves overkill.
-@memberof clusterioMaster
-@instance
-@alias /api/getSlaveMeta
-*/
-app.post("/api/getSlaveMeta", function (req, res) {
-	console.log("body", req.body);
-    if(req.body && req.body.instanceID && req.body.password){
-    	console.log("returning meta for ", req.body.instanceID);
-    	res.send(JSON.stringify(slaves[req.body.instanceID].meta))
-	} else {
-    	res.status(400);
-    	res.send('{"INVALID REQUEST":1}');
-	}
-});
-// TODO: Remove deprecated function, also update researchSync to not use it
-/**
-POST DEPRECATED Get metadata from all slaves. This is already covered by /api/slaves, please use that one instead.
-@memberof clusterioMaster
-@instance
-@alias /api/getSlavesMeta
-*/
-app.post("/api/getSlavesMeta", function (req, res) {
-    if(req.body.password){
-    	let metas = {};
-        res.send(JSON.stringify(Object.keys(slaves).map(key => metas[key] = slaves[key].meta)));
-    } else {
-        res.status(400);
-        res.send('{"INVALID REQUEST":1}');
-    }
-});
-// mod management
-// should handle uploading and checking if mods are uploaded
-/**
-POST Check if a mod has been uploaded to the master before. Only checks against filename, not hash.
-@memberof clusterioMaster
-@instance
-@alias /api/checkMod
-*/
-app.post("/api/checkMod", function(req,res) {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	let files = fs.readdirSync(masterModFolder);
-	let found = false;
-	files.forEach(file => {
-		if(file == req.body.modName) {
-			found = true;
-		}
-	});
-	if(!found) {
-		// we don't have mod, plz send
-		res.send(req.body.modName);
-	} else {
-		res.send("found");
-	}
-	res.end();
-	httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-});
-/**
-POST endpoint for uploading mods to the master server. Required for automatic mod downloads with factorioClusterioClient (electron app, see seperate repo)
-@memberof clusterioMaster
-@instance
-@alias /api/uploadMod
-*/
-app.post("/api/uploadMod", function(req,res) {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	if (!req.files) {
-        res.send('No files were uploaded.');
-        return;
-    } else {
-		console.log(req.files.file);
-		req.files.file.mv('./database/masterMods/'+req.files.file.name, function(err) {
-			if (err) {
-				res.status(500).send(err);
-			} else {
-				res.send('File uploaded!');
-				console.log("Uploaded mod: " + req.files.file.name);
-			}
-			httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-		});
-	}
-});
-/**
-GET endpoint for getting information about all our slaves
-@memberof clusterioMaster
-@instance
-@alias /api/slaves
-*/
-app.get("/api/slaves", function(req, res) {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	res.header("Access-Control-Allow-Origin", "*");
-	res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
-	let copyOfSlaves = JSON.parse(JSON.stringify(slaves));
-	// filter out the rcon password because thats kindof not a safe thing to share
-	for(key in copyOfSlaves){
-		copyOfSlaves[key].rconPassword = "hidden";
-	}
-	res.send(copyOfSlaves);
-	httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-});
-var recievedItemStatisticsBySlaveID = {};
-var sentItemStatisticsBySlaveID = {};
-/*
-var recievedItemStatistics = new averagedTimeSeries({
-	maxEntries: config.itemStats.maxEntries,
-	entriesPerSecond: config.itemStats.entriesPerSecond,
-}, console.log);*/
-// 
-/**
-POST endpoint for storing items in master's inventory.
-
-@memberof clusterioMaster
-@instance
-@alias api/place
-@param {itemStack} itemStack the number and type of items to store (see typedef)
-@param {string} [itemStack.instanceID="unknown"] the unique/instanceID which is a numerical value for an instance
-@param {string} [itemStack.instanceName="unknown"] the name of an instance for identification in statistics, as provided when launching it. ex node client.js start [name]
-@returns {string} status either "success" or "failure"
-*/
-app.post("/api/place", function(req, res) {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	res.header("Access-Control-Allow-Origin", "*");
-	res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
-	let x;
-	try {
-		x = JSON.parse(req.body);
-	} catch (e) {
-		x = req.body;
-	}
-	if(!x.instanceName) {
-		x.instanceName = "unknown";
-	}
-	if(!x.instanceID) {
-		x.instanceID = "unknown";
-		Object.keys(slaves).forEach(instanceID => {
-			if(slaves[instanceID].instanceName == req.body.instanceName) {
-				x.instanceID = instanceID;
-			}
-		});
-	}
-	if(	x.instanceID
-		&& x.instanceName
-		&& !isNaN(Number(x.count))// This is in no way a proper authentication or anything, its just to make sure everybody are registered as slaves before modifying the cluster (or not, to maintain backwards compat)
-		/*&& stringUtils.hashCode(slaves[x.unique].rconPassword) == x.unique*/){
-		if(config.logItemTransfers){
-			console.log("added: " + req.body.name + " " + req.body.count+" from "+x.instanceName+" ("+x.instanceID+")");
-		}
-		// gather statistics
-		let recievedItemStatistics = recievedItemStatisticsBySlaveID[x.instanceID];
-		if(recievedItemStatistics === undefined){
-			recievedItemStatistics = new averagedTimeSeries({
-				maxEntries: config.itemStats.maxEntries,
-				entriesPerSecond: config.itemStats.entriesPerSecond,
-				mergeMode: "add",
-			}, console.log);
-			recievedItemStatisticsBySlaveID[x.instanceID] = recievedItemStatistics;
-		}
-		recievedItemStatistics.add({
-			key:req.body.name,
-			value:req.body.count,
-		});
-		// save items we get
-		db.items.addItem({
-			name:req.body.name,
-			count:req.body.count
-		});
-		// Attempt confirming
-		res.send("success");
-	} else {
-		res.send("failure");
-	}
-	httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-});
-/**
-POST endpoint to remove items from DB when client orders items.
-
-@memberof clusterioMaster
-@instance
-@alias api/remove
-@param {itemStack} itemStack the name of and the number of items to remove (see typedef)
-@param {string} [itemStack.instanceID="unknown"] the unique/instanceID which is a numerical value for an instance
-@param {string} [itemStack.instanceName="unknown"] the name of an instance for identification in statistics, as provided when launching it. ex node client.js start [name]
-@returns {itemStack} the number of items actually removed, may be lower than what was asked for due to shortages.
-*/
-_doleDivisionFactor = {}; //If the server regularly can't fulfill requests, this number grows until it can. Then it slowly shrinks back down.
-app.post("/api/remove", function(req, res) {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	const doleDivisionRetardation = 10; //lower rates will equal more dramatic swings
-	const maxDoleDivision = 250; //a higher cap will divide the store more ways, but will take longer to recover as supplies increase
-	res.header("Access-Control-Allow-Origin", "*");
-	res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
-	// save items we get
-	var object = req.body;
-	if(!object.instanceID) {
-		object.instanceID = "unknown"
-	}
-	if(!object.instanceName) {
-		object.instanceName = "unknown";
-	}
-	if(slaves[object.instanceID]) object.instanceName = slaves[object.instanceID].instanceName;
-	let item = db.items[object.name]
-		// console.dir(doc);
-	if (!item) {
-		if(config.logItemTransfers){
-			console.log('failure could not find ' + object.name);
-		}
-		res.send({name:object.name, count:0});
-	} else {
-		const originalCount = Number(object.count) || 0;
-		object.count /= ((_doleDivisionFactor[object.name]||0)+doleDivisionRetardation)/doleDivisionRetardation;
-		object.count = Math.round(object.count);
-		if(item.length > 40) console.info(`Serving ${object.count}/${originalCount} ${object.name} from ${item} ${object.name} with dole division factor ${(_doleDivisionFactor[object.name]||0)} (real=${((_doleDivisionFactor[object.name]||0)+doleDivisionRetardation)/doleDivisionRetardation}), item is ${Number(item) > Number(object.count)?'stocked':'short'}.`);
-		
-		// Update existing items if item name already exists
-		if(Number(item) > Number(object.count)) {
-			//If successful, increase dole
-			_doleDivisionFactor[object.name] = Math.max((_doleDivisionFactor[object.name]||0)||1, 1) - 1;
-			if(config.logItemTransfers){
-				console.log("removed: " + object.name + " " + object.count + " . " + item + " and sent to " + object.instanceID + " | " + object.instanceName);
-			}
-			if(db.items.removeItem({count: object.count, name: object.name})){
-				let sentItemStatistics = sentItemStatisticsBySlaveID[object.instanceID];
-				if(sentItemStatistics === undefined){
-					sentItemStatistics = new averagedTimeSeries({
-						maxEntries: config.itemStats.maxEntries,
-						entriesPerSecond: config.itemStats.entriesPerSecond,
-						mergeMode: "add",
-					}, console.log);
-				}
-				sentItemStatistics.add({
-					key:object.name,
-					value:object.count,
-				});
-				//console.log(sentItemStatistics.data)
-				sentItemStatisticsBySlaveID[object.instanceID] = sentItemStatistics;
-			}
-			res.send({count: object.count, name: object.name});
-			httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-		} else {
-			// if we didn't have enough, attempt giving out a smaller amount next time
-			_doleDivisionFactor[object.name] = Math.min(maxDoleDivision, Math.max((_doleDivisionFactor[object.name]||0)||1, 1) * 2);
-			res.send({name:object.name, count:0});
-			httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-			//console.log('failure out of ' + object.name + " | " + object.count + " from " + object.instanceID + " ("+object.instanceName+")");
-		}
-	}
-});
-
-// circuit stuff
-/**
-POST endpoint to send and store circuit frames on the master.
-Gives no response
-
-@memberof clusterioMaster
-@instance
-@alias api/setSignal
-@param {object} circuitFrame
-@param {number} circuitFrame.time
-*/
-app.post("/api/setSignal", function(req,res) {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	if(typeof req.body == "object" && req.body.time){
-		db.signals.insert(req.body);
-		httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-		// console.log("signal set");
-	}
-});
-/**
-POST endpoint to read database of circuit signals sent to master
-
-@memberof clusterioMaster
-@instance
-@alias api/readSignal
-@returns {object} circuitFrame
-*/
-app.post("/api/readSignal", function(req,res) {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	// request.body should be an object
-	// {since:UNIXTIMESTAMP,}
-	// we should send an array of all signals since then
-	db.signals.find({time:{$gte: req.body.since}}, function (err, docs) {
-		// $gte means greater than or equal to, meaning we only get entries newer than the timestamp
-		res.send(docs);
-		httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-		// console.log(docs);
-	});
-});
-/**
-GET endpoint to read the masters current inventory of items.
-
-@memberof clusterioMaster
-@instance
-@alias api/inventory
-@returns {object[]} JSON [{name:"iron-plate", count:100},{name:"copper-plate",count:5}]
-*/
-// endpoint for getting an inventory of what we got
-app.get("/api/inventory", function(req, res) {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	res.header("Access-Control-Allow-Origin", "*");
-	res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
-	// Check it and send it
-	var inventory = [];
-	for(let key in db.items){
-		if(typeof db.items[key] == "number" || typeof db.items[key] == "string"){
-			inventory.push({name:key, count:db.items[key]});
-		}
-	}
-	res.send(JSON.stringify(inventory));
-	httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-});
-/**
-GET endpoint to read the masters inventory as an object with key:value pairs
-
-@memberof clusterioMaster
-@instance
-@alias api/inventoryAsObject
-@returns {object} JSON {"iron-plate":100, "copper-plate":5}
-*/
-app.get("/api/inventoryAsObject", function(req, res) {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	res.header("Access-Control-Allow-Origin", "*");
-	res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
-	// Check it and send it
-	res.send(JSON.stringify(db.items));
-	httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-});
-
-// post flowstats here for production graphs
-// {timestamp: Date, instanceID: string, data: {"item":number}}
-/**
-POST endpoint to log production graph statistics. Should contain a timestamp
-gathered from Date.now(), a instanceID (also reffered to as "unique") and of
-course the timeSeries data.
-
-@memberof clusterioMaster
-@instance
-@alias api/logStats
-@param {object} JSON {timestamp: Date.now(), instanceID: "string", data: {"item": number}}
-@returns {string} failure
-*/
-app.post("/api/logStats", function(req,res) {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	if(typeof req.body == "object" && req.body.instanceID && req.body.timestamp && req.body.data) {
-		if(Number(req.body.timestamp) != NaN){
-			req.body.timestamp = Number(req.body.timestamp);
-			db.flows.insert({
-				instanceID: req.body.instanceID,
-				timestamp: req.body.timestamp,
-				data: req.body.data,
-			});
-			try{
-			Object.keys(req.body.data).forEach(itemName => {
-				prometheusProductionGauge.labels(req.body.instanceID, itemName).inc(Number(req.body.data[itemName]) || 0);
-			});
-			}catch(e){console.log(e)};
-			console.log("inserted: " + req.body.instanceID + " | " + req.body.timestamp);
-		} else {
-			console.log("error invalid timestamp " + req.body.timestamp);
-			res.send("failure");
-		}
-	} else {
-		res.send("failure");
-	}
-	httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-});
-// {instanceID: string, fromTime: Date, toTime, Date}
-/**
-POST endpoint to get timeSeries statistics stored on the master. Can give production
-graphs and other IO statistics.
-
-@memberof clusterioMaster
-@instance
-@alias api/getStats
-@param {object} JSON
-@returns {object} - with statistics
-*/
-app.post("/api/getStats", function(req,res) {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	if(typeof req.body == "string"){
-		req.body = JSON.parse(req.body);
-	}
-	// console.log(req.body);
-	if(typeof req.body == "object" && req.body.instanceID && req.body.statistic === undefined) {
-		// if not specified, get stats for last 24 hours
-		if(!req.body.fromTime) {
-			req.body.fromTime = Date.now() - 86400000 // 24 hours in MS
-		}
-		if(!req.body.toTime) {
-			req.body.toTime = Date.now();
-		}
-		console.log("Looking... " + JSON.stringify(req.body));
-		db.flows.find({
-			instanceID: req.body.instanceID,
-		}, function(err, docs) {
-			let entries = docs.filter(function (el) {
-				return el.timestamp <= req.body.toTime && el.timestamp >= req.body.fromTime;
-			});
-			// console.log(entries);
-			res.send(entries);
-		});
-	} else if(typeof req.body == "object" && req.body.instanceID && typeof req.body.instanceID == "string" && req.body.itemName){
-		if(req.body.statistic == "place"){
-			console.log(`sending place data for instanceID ${req.body.instanceID} ${req.body.itemName}`);
-			// Gather data
-			//console.log(recievedItemStatisticsBySlaveID)
-			let itemStats = recievedItemStatisticsBySlaveID[req.body.instanceID];
-			if(itemStats === undefined){
-				res.send({statusForDebugging:"no data available"});
-				return false;
-			}
-			let data = itemStats.get(config.itemStats.maxEntries, req.body.itemName);
-			
-			res.send({
-				maxEntries:config.itemStats.maxEntries,
-				entriesPerSecond: config.itemStats.entriesPerSecond,
-				data: data,
-			});
-		} else if(req.body.statistic == "remove"){
-			console.log(`sending remove data for instanceID ${req.body.instanceID} ${req.body.itemName}`);
-			// Gather data
-			console.log(sentItemStatisticsBySlaveID)
-			let itemStats = sentItemStatisticsBySlaveID[req.body.instanceID];
-			console.log(itemStats)
-			if(typeof itemStats == "object"){
-				let data = itemStats.get(config.itemStats.maxEntries, req.body.itemName);
-				//console.log(itemStats.get(config.itemStats.maxEntries, req.body.itemName));
-				res.send({
-					maxEntries:config.itemStats.maxEntries,
-					entriesPerSecond: config.itemStats.entriesPerSecond,
-					data: data,
-				});
-			} else {
-				res.send({statusForDebugging:"no data available"});
-			}
-		}
-	}
-	httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-});
-
-/**
-POST endpoint. Modified version of api/getStats which feeds the web interface production graphs
-at /nodes. It is like getStats but it does not report items which were not
-produced at the moment of recording. (This is to save space, the 0-items were
-making up about 92% of the response body weight.)
-
-@memberof clusterioMaster
-@instance
-@alias api/getTimelineStats
-@param {object} JSON {instanceID:1941029, fromTime: ???, toTime: ???}
-@returns {object[]} timeseries where each entry is a set point in time.
-*/
-app.post("/api/getTimelineStats", function(req,res) {
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	console.log(req.body);
-	if(typeof req.body == "object" && req.body.instanceID) {
-		// if not specified, get stats for last 24 hours
-		if(!req.body.fromTime) {
-			req.body.fromTime = Date.now() - 86400000 // 24 hours in MS
-		}
-		if(!req.body.toTime) {
-			req.body.toTime = Date.now();
-		}
-		console.log("Looking... " + JSON.stringify(req.body));
-		db.flows.find({
-			instanceID: req.body.instanceID,
-		}, function(err, docs) {
-			if(err) { 
-				console.error(err);
-				return;
-			}
-			
-			//Filter out all the entries outside the time range.
-			docs = docs.filter(function (el) {
-				return el.timestamp <= req.body.toTime && el.timestamp >= req.body.fromTime;
-			});
-			
-			//Filter out all the elements that weren't produced.
-			docs.forEach(el => {
-				for(let key in el.data) {
-					if(el.data[key] === '0') {
-						// Set value to undefined instead of using the delete keyword.
-						// This is because the delete keyword is super duper slow.
-						// https://stackoverflow.com/questions/208105/how-do-i-remove-a-property-from-a-javascript-object
-						
-						//delete el.data[key];
-						el.data[key] = undefined;
-					}
-				}
-			});
-			
-			res.send(docs);
-			httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-		});
-	}
-});
-/**
-POST endpoint for running commands on slaves.
-Requires x-access-token header to be set. Find you api token in secret-api-token.txt on the master (after running it once)
-
-@memberof clusterioMaster
-@instance
-@alias api/runCommand
-@param {object} JSON {instanceID:19412312, command:"/c game.print('hello')"}
-@returns {object} Status {auth: bool, message: "Informative error", data:{}}
-*/
-// write an auth token to file
-fs.writeFileSync("secret-api-token.txt", jwt.sign({ id: "api" }, config.masterAuthSecret, {
-	expiresIn: 86400*365 // expires in 1 year
-}));
-app.post("/api/runCommand", (req,res) => {
-	var token = req.headers['x-access-token'];
-	if(!token) return res.status(401).send({ auth: false, message: 'No token provided.' });
-	
-	jwt.verify(token, config.masterAuthSecret, function(err, decoded) {
-		if(err) return res.status(500).send({ auth: false, message: 'Failed to authenticate token.' });
-		
-		// validate request.body
-		let body = req.body;
-		if(body.instanceID
-		&& Object.keys(wsSlaves).includes(body.instanceID)
-		&& body.command
-		&& typeof body.command == "string"
-		&& body.command[0] == "/"){
-			// execute command
-			wsSlaves[body.instanceID].runCommand(body.command, data => {
-				res.status(200).send({auth: true, message: "success", data});
-			});
-		} else {
-			res.status(400).send({auth: true, message: "Error: invalid request.body"});
-		}
-	});
-});
-/**
-GET endpoint. Returns factorio's base locale as a JSON object.
-
-@memberof clusterioMaster
-@instance
-@alias api/getFactorioLocale
-@returns {object{}} 2 deep nested object with base game factorio locale as key:value pairs
-*/
-app.get("/api/getFactorioLocale", function(req,res){
-	endpointHitCounter.labels(req.route.path).inc();
-	let reqStartTime = Date.now();
-	getFactorioLocale.asObject(config.factorioDirectory, "en", (err, factorioLocale) => {
-		res.send(factorioLocale);
-		httpRequestDurationMilliseconds.labels(req.route.path).observe(Date.now()-reqStartTime);
-	});
-});
-var server = require("http").Server(app);
-server.listen(config.masterPort || 8080, function () {
-	console.log("Listening on port %s...", server.address().port);
-});
-/* Websockets for remoteMap */
-var io = require("socket.io")(server);
-var slaveMappers = {};
-class slaveMapper {
-	constructor(instanceID, socket) {
-		this.instanceID = instanceID;
-		this.socket = socket;
-		this.lastBeat = Date.now();
-		
-		this.socket.on("heartbeat", () => {
-			// we aren't ready to die yet apparently
-			this.lastBeat = Date.now();
-		});
-		this.socket.on("sendChunk", function(data){
-			mapRequesters[data.requesterID].socket.emit("displayChunk", data);
-		});
-		// slaveMapper sent us an entity update, process
-		this.socket.on("sendEntity", entity => {
-			Object.keys(mapRequesters).forEach(requesterName => {
-				let requester = mapRequesters[requesterName];
-				
-				if(requester.instanceID == this.instanceID){
-					// this mapRequester is listening to this slaveMapper, so we send it updates
-					requester.socket.emit("displayEntity", entity);
-				}
-			});
-		});
-	}
-}
-var mapRequesters = {};
-class mapRequester {
-	constructor(requesterID, socket, instanceID){
-		this.requesterID = requesterID;
-		this.socket = socket;
-		this.instanceID = instanceID;
-		this.lastBeat = Date.now();
-		
-		this.socket.on("heartbeat", () => {
-			prometheusWsUsageCounter.labels('heartbeat').inc();
-			// we aren't ready to die yet apparently
-			this.lastBeat = Date.now();
-		});
-		this.socket.on("requestChunk", loc => {
-			prometheusWsUsageCounter.labels('requestChunk').inc();
-			loc.requesterID = this.requesterID;
-			let instanceID = loc.instanceID || this.instanceID;
-			if(slaveMappers[instanceID] && typeof loc.x == "number" && typeof loc.y == "number"){
-				slaveMappers[instanceID].socket.emit("getChunk", loc);
-			}
-		});
-		this.socket.on("requestEntity", req => {
-			prometheusWsUsageCounter.labels('requestEntity').inc();
-			req.requesterID = this.requesterID;
-			let instanceID = req.instanceID || this.instanceID;
-			if(slaveMappers[instanceID] && typeof req.x == "number" && typeof req.y == "number"){
-				slaveMappers[instanceID].socket.emit("getEntity", req);
-			}
-		});
-		this.socket.on("placeEntity", req => {
-			prometheusWsUsageCounter.labels('placeEntity').inc();
-			req.requesterID = this.requesterID;
-			let instanceID = req.instanceID || this.instanceID;
-			if(slaveMappers[instanceID]){
-				slaveMappers[instanceID].socket.emit("placeEntity", req);
-			}
-		});
-	}
-}
-/* Websockets for send and recieve combinators */
-var wsSlaves = {};
-class wsSlave {
-	constructor(instanceID, socket){
-		this.instanceID = instanceID;
-		this.socket = socket;
-		this.lastBeat = Date.now();
-		
-		this.socket.on("heartbeat", () => {
-			prometheusWsUsageCounter.labels('heartbeat').inc();
-			this.lastBeat = Date.now();
-		});
-		this.socket.on("combinatorSignal", circuitFrameWithMeta => {
-			prometheusWsUsageCounter.labels('combinatorSignal').inc();
-			if(circuitFrameWithMeta && typeof circuitFrameWithMeta == "object"){
-				Object.keys(wsSlaves).forEach(instanceID => {
-					wsSlaves[instanceID].socket.emit("processCombinatorSignal", circuitFrameWithMeta);
-				});
-			}
-		});
-		// handle command return values
-		this.commandsWaitingForReturn = {};
-		this.socket.on("runCommandReturnValue", resp => {
-			if(resp.commandID && resp.body && this.commandsWaitingForReturn[resp.commandID] && this.commandsWaitingForReturn[resp.commandID].callback && typeof this.commandsWaitingForReturn[resp.commandID].callback == "function"){
-				this.commandsWaitingForReturn[resp.commandID].callback(resp.body);
-				delete this.commandsWaitingForReturn[resp.commandID];
-			}
-		});
-	}
-	runCommand(command, callback){
-		let commandID = Math.random().toString();
-		this.socket.emit("runCommand", {command, commandID});
-		this.commandsWaitingForReturn[commandID] = {callback, timestamp: Date.now()};
-	}
-}
-io.on('connection', function (socket) {
-	// cleanup dead sockets from disconnected people
-	let terminatedConnections = 0;
-	let currentConnections = Object.keys(mapRequesters).length + Object.keys(slaveMappers).length + Object.keys(wsSlaves).length;
-	[mapRequesters, slaveMappers, wsSlaves].forEach(list => {
-		Object.keys(list).forEach(connectionID => {
-			let connection = list[connectionID];
-			if(connection.lastBeat < (Date.now() - 30000)){
-				terminatedConnections++;
-				delete list[connectionID];
-			}
-		});
-	});
-	if(terminatedConnections > 0) console.log("SOCKET | There are currently "+currentConnections+" websocket connections, deleting "+terminatedConnections+" on timeout");
-	
-	// tell our friend that we are listening
-	socket.emit('hello', { hello: 'world' });
-	
-	/* initial processing for remoteMap */
-	socket.on('registerSlaveMapper', function (data) {
-		prometheusWsUsageCounter.labels('registerSlaveMapper').inc();
-		slaveMappers[data.instanceID] = new slaveMapper(data.instanceID, socket);
-		console.log("remoteMap | SOCKET registered map provider for "+data.instanceID);
-	});
-	socket.on('registerMapRequester', function(data){
-		// data {instanceID:""}
-		prometheusWsUsageCounter.labels('registerMapRequester').inc();
-		let requesterID = Math.random().toString();
-		mapRequesters[requesterID] = new mapRequester(requesterID, socket, data.instanceID);
-		socket.emit("mapRequesterReady", true);
-		console.log("remoteMap | SOCKET registered map requester for "+data.instanceID);
-	});
-	
-	/* Websockets for send and recieve combinators */
-	socket.on("registerSlave", function(data) {
-		prometheusWsUsageCounter.labels('registerSlave').inc();
-		if(data && data.instanceID){
-			wsSlaves[data.instanceID] = new wsSlave(data.instanceID, socket);
-			console.log("SOCKET | Created new wsSlave: "+ data.instanceID);
-		}
-	});
-	
-});
-
-module.exports = app;

master.spec.js

@@ -1,184 +0,0 @@
-var app = require('./master.js'),
-  assert = require('assert'),
-  request = require('supertest');
-const validateHTML = require('html5-validator');
-var parallel = require('mocha.parallel');
-
-
-describe('Master server endpoint testing', function() {
-	describe('#GET /api/getFactorioLocale', function() { 
-		it('should get the basegame factorio locale', function(done) { 
-			request(app).get('/api/getFactorioLocale').end(function(err, res) {
-				assert.equal(res.statusCode, 200);
-				
-				let object = res.body;
-				
-				// test that it is actual factorio locale, copied from getFactorioLocale.spec.js
-				assert.equal(typeof object, "object");
-				assert.equal(object["entity-name"]["fish"], "Fish");
-				assert.equal(object["entity-name"]["small-lamp"], "Lamp");
-				Object.keys(object).forEach(key => {
-					// first level of the nested object is always an object
-					assert.equal(typeof object[key], "object");
-					
-					Object.keys(object[key]).forEach(key2 => {
-						// second level of the nested object is always a string, nearly always truthy
-						if(key2 != "so-long-and-thanks-for-all-the-fish"){
-							assert.ok(object[key][key2]);
-							assert.equal(typeof object[key][key2], "string");
-						}
-					});
-				});
-				done();
-			});
-		});
-	});
-	// describe("#GET /api/")
-	parallel("#GET static website data", function() {
-		this.timeout(6000);
-		it("sends some HTML when accessing /", function(done){
-			this.timeout(6000);
-			request(app).get("/").end(function(err,res){
-				assert.equal(res.statusCode, 200);
-				validateHTML(res.text).then(result => {
-					assert(result.messages.length === 1, "there are HTML errors on the page, please fix: "+JSON.stringify(result.messages));
-					done();
-				});
-			});
-		});
-		it("sends some HTML when accessing /nodes",function(done){
-			this.timeout(6000);
-			request(app).get("/nodes").end(function(err,res){
-				assert.equal(res.statusCode, 200);
-				validateHTML(res.text).then(result => {
-					assert(result.messages.length === 1, "there are HTML errors on the page, please fix: "+JSON.stringify(result.messages));
-					done();
-				});
-			});
-		});
-		it("sends some HTML when accessing /settings",function(done){
-			this.timeout(6000);
-			request(app).get("/settings").end(function(err,res){
-				assert.equal(res.statusCode, 200);
-				validateHTML(res.text).then(result => {
-					assert(result.messages.length === 1, "there are HTML errors on the page, please fix: "+JSON.stringify(result.messages));
-					done();
-				});
-			});
-		});
-		it("sends some HTML when accessing /nodeDetails",function(done){
-			this.timeout(6000);
-			request(app).get("/nodeDetails").end(function(err,res){
-				assert.equal(res.statusCode, 200);
-				validateHTML(res.text).then(result => {
-					assert(result.messages.length === 1, "there are HTML errors on the page, please fix: "+JSON.stringify(result.messages));
-					done();
-				});
-			});
-		});
-		it("sends some HTML when accessing /remoteMap",function(done){
-			this.timeout(6000);
-			request(app).get("/remoteMap").end(function(err,res){
-				assert.equal(res.statusCode, 200);
-				validateHTML(res.text).then(result => {
-					// there should be 1 error regarding complaining about me using ES6 modules before they are fully supported
-					assert(result.messages.length === 2, "there are HTML errors on the page, please fix: "+JSON.stringify(result.messages));
-					done();
-				});
-			});
-		});
-	});
-	let persistentMaster = request(app);
-	describe("#POST /api/place", function(){
-		it("adds an itemStack to the masters inventory", function(done){
-			persistentMaster.post("/api/place")
-			.send({
-				name:"steel-plate",
-				count:20,
-				instanceName:"unitTest"
-			})
-			.end(function(err,res){
-				assert(!err)
-				assert.equal(res.text, "success", "something went wrong with the request")
-				done();
-			});
-		});
-	});
-	describe("#GET /api/inventory", function(){
-		it("returns the masters current inventory", function(done){
-			persistentMaster.get("/api/inventory").end(function(err,res){
-				assert.equal(res.statusCode, 200);
-				let inventory = JSON.parse(res.text);
-				assert.equal(typeof inventory, "object", "Inventory should be an object");
-				assert(inventory.length >= 1, "There should be at least 1 entry in the inventory");
-				
-				let contains20SteelPlate = false;
-				inventory.forEach(itemStack => {
-					if(itemStack.name == "steel-plate" && itemStack.count >= 20) contains20SteelPlate = true;
-				});
-				assert(contains20SteelPlate, "Please ensure there are at least 20 steel plate in the inventory")
-				done();
-			});
-		});
-	});
-	parallel("#POST /api/remove", function(){
-		it("returns an itemStack of how many items were removed", function(done){
-			persistentMaster.post("/api/remove")
-			.send({
-				name:"steel-plate",
-				count:10
-			})
-			.end(function(err,res){
-				assert(!err);
-				assert.equal(res.body.count, 10, "Something is wrong with the response, maybe the format changed slightly or you didn't have enough steel?");
-				
-				done();
-			});
-		});
-		it("returns an empty itemStack if you try to request addItem or removeItem", function(done){
-			let casesRan = 0;
-			persistentMaster.post("/api/remove")
-			.send({
-				name:"addItem",
-				count:10
-			})
-			.end(function(err,res){
-				assert(!err);
-				assert.equal(res.text, '{"name":"addItem","count":0}', "When there are none of the item, you should get 0 back. addItem and removeItem should always return 0");
-				
-				isDone();
-			});
-			
-			persistentMaster.post("/api/remove")
-			.send({
-				name:"removeItem",
-				count:10
-			})
-			.end(function(err,res){
-				assert(!err);
-				assert.equal(res.text, '{"name":"removeItem","count":0}', "When there are none of the item, you should get 0 back. addItem and removeItem should always return 0");
-				
-				isDone();
-			});
-			
-			function isDone(){
-				if(++casesRan == 2) done();
-			}
-		});
-		it("returns an empty itemStack if you don't have any of the item you request", function(done){
-			persistentMaster.post("/api/remove")
-			.send({
-				name:"imaginaryItem",
-				count:999999
-			})
-			.end(function(err,res){
-				assert(!err);//{"name":"imaginaryItem","count":0}
-				assert.equal(res.body.name, "imaginaryItem", "Make sure body.name is the item we asked for");
-				assert.equal(res.body.count, 0, "Count should be 0 since we are asking for something that does not exist anywhere");
-				assert.equal(Object.keys(res.body).length, 2, "name and count should be the only keys on this object");
-				
-				done();
-			});
-		});
-	});
-});

node_modules/_app/factorioServer/index.js

@@ -1,168 +0,0 @@
-/**
-
-class factorioServer
-
-This class has the responsiblity of :
-
-* spawning a factorio server
-* Handling input via stdin or RCON
-
-
-*/
-
-const fs = require("fs");
-const child_process = require("child_process");
-const path = require("path");
-
-const mkdirp = require("mkdirp");
-const appRootPath = require("app-root-path");
-
-const fileOps = require("_app/fileOps");
-
-module.exports = class factorioServer {
-	constructor({
-		factorioDirectory = "factorio",
-		instanceDirectory = "instances/data",
-		instanceName = "Default server name",
-		factorioPort = Math.floor(Math.random() * 65535),
-		serversettings = {},
-		onProgress = function(type, a, b, c){
-			if(type == "progress") console.log("Progress: ",a," of ",b," unit: ",c);
-			if(type == "log") console.log(a);
-		},
-	} = {}){
-		this.factorioDirectory = factorioDirectory;
-		this.instanceDirectory = instanceDirectory;
-		this.instanceName = instanceName;
-		this.factorioPort = factorioPort;
-		this.serversettings = Object.assign({
-			"name": "Clusterio instance: " + this.instanceName,
-			"description": "Public factorio server running clusterio",
-			"tags": ["clusterio"],
-			"max_players": "20",
-			"visibility": "public",
-			"username": "",
-			"token": "",
-			"game_password": "",
-			"verify_user_identity": true,
-			"admins": ["Danielv123"],
-			"allow_commands": true,
-			"autosave_interval": 10,
-			"autosave_slots": 5,
-			"afk_autokick_interval": 0,
-			"auto_pause": false,
-		}, serversettings);
-		this.onProgress = (type, a, b, c) => {
-			if(typeof onProgress == "function") onProgress(type, a, b, c);
-		};
-	}
-	async initialize(){
-		if(!await this.isValidInstance()){
-			await this.createInstance();
-		}
-		return true;
-	}
-	async createInstance(path = this.instanceDirectory){
-		if(await this.isValidInstance(path)){
-			throw new Error("Instance already exists!");
-		}
-		
-		// create folders
-		let folders = [
-			"/script-output/",
-			"/saves/",
-			"/mods/",
-			"/instanceMods/",
-		];
-		mkdirp.sync(path);
-		folders.forEach(folder => mkdirp.sync(path + folder));
-		
-		// create files
-		let files = [
-			{name: "/script-output/output.txt", content: ""},
-			{name: "/script-output/orders.txt", content: ""},
-			{name: "/script-output/txbuffer.txt", content: ""},
-			{name: "/config.ini", content: "[path]\r\n\ read-data=__PATH__executable__/../../data\r\n\ write-data=__PATH__executable__/../../../" + this.instanceDirectory + "\r\n\ "},
-			{name: "/config.json", content: JSON.stringify({
-				factorioPort: this.factorioPort,
-				clientPassword: Math.random().toString(36).replace(/[^a-z]+/g, '').substr(0, 8),
-			}, null, 4)},
-			{name: "/server-settings.json", content: JSON.stringify(this.serversettings, null, 4)},
-		];
-		files.forEach(file => {
-			fs.writeFile(path + file.name, file.content, doneWritingHandler);
-			// console.log("Created: ",path+file.name);
-		});
-		
-		let filesToWrite = files.length;
-		function doneWritingHandler(){
-			if(!--filesToWrite){
-				return path;
-			}
-		}
-	}
-	async deleteInstance(path = this.instanceDirectory){
-		if(await this.isValidInstance(path)){
-			await fileOps.deleteFolderRecursive(path);
-			return true;
-		} else {
-			return false;
-		}
-	}
-	isValidInstance(path = this.instanceDirectory){
-		return new Promise((resolve, reject) => {
-			fs.stat(path, (err, stat) => {
-				if(err){
-					// console.log(err)
-					resolve(false);
-				} else {
-					// the instance folder exists, do some more checks
-					fs.readdir(path, (err, files) => {
-						if(files && Array.isArray(files)){
-							let foldersThatShouldBeThere = [
-								"script-output",
-								"saves",
-								"mods",
-								"instanceMods",
-							];
-							let instanceValidity = true;
-							foldersThatShouldBeThere.forEach(folder => {
-								if(!files.includes(folder)){
-									instanceValidity = false;
-								}
-							});
-							resolve(instanceValidity);
-						}
-					});
-				}
-			});
-		});
-	}
-	createMap(name = "map.zip"){
-		return new Promise((resolve, reject) => {
-			this.isValidInstance().then(isValid => {
-				if(!isValid){
-					return createInstance();
-				}
-			}).then(()=>{
-				this.onProgress("log", "Starting map creation");
-				// console.log(this.factorioDirectory + '/bin/x64/factorio')
-				let proc = child_process.spawn(
-					path.join(this.factorioDirectory, 'bin', 'x64', 'factorio'), [
-						'-c', path.join(this.instanceDirectory,'config.ini'),
-						'--create', path.join(this.instanceDirectory, 'saves',name),
-						'--server-settings', path.join(this.instanceDirectory, 'server-settings.json'),
-					],{
-						cwd:process.cwd(),
-					}
-				);
-				// console.log(proc.stdout.toString("utf8"));
-				proc.stdout.on("data", data => this.onProgress("log", data.toString("utf8")));
-				proc.on("close", code => {
-					this.onProgress("log", "Map created! "+code);
-					resolve();
-				});
-			});
-		});
-	}
-}

node_modules/_app/factorioServer/index.spec.js

@@ -1,114 +0,0 @@
-const assert = require("assert");
-const fs = require("fs");
-const path = require("path");
-
-const appRootPath = require("app-root-path");
-const parallel = require("mocha.parallel");
-const mkdirp = require("mkdirp");
-
-const factorioServer = require("./index.js");
-
-describe("class factorioServer/index.js", ()=>{
-	it("is a class (or at least a function)", ()=>{
-		assert.equal(typeof factorioServer, "function");
-	});
-	describe(".deleteInstance(instanceName)", ()=>{
-		it("deletes an instance, defaulting to the classes instanceDirectory", async () => {
-			let server = new factorioServer({
-				instanceDirectory: path.resolve(__dirname, "_testData_deleteInstance"),
-				instanceName: "Unit testing instance",
-			});
-			await server.initialize();
-			await server.deleteInstance();
-			assert.equal(await server.isValidInstance(), false);
-			return true;
-		});
-	});
-	describe(".isValidInstance(instanceName)", ()=>{
-		it("tells us whether an instance exists or not", async () => {
-			let server = new factorioServer({
-				instanceDirectory: path.join(__dirname, "_testData_isValidInstance"),
-				instanceName: "Unit testing instance",
-			});
-			await server.deleteInstance();
-			let status = await server.isValidInstance();
-			assert.equal(status, false);
-			let x = await server.initialize(); // creates our instance
-			let status2 = await server.isValidInstance();
-			assert.equal(status2, true);
-			
-			await server.deleteInstance(); // clean up folder
-			return true;
-		});
-		it("does not get tricked by an empty folder", async () => {
-			let server = new factorioServer({
-				instanceDirectory: path.join(__dirname, "_testData_isValidInstance_2"),
-				instanceName: "Unit testing instance",
-			});
-			assert.equal(await server.isValidInstance(), false);
-			
-			mkdirp.sync(path.join(__dirname, "_testData_isValidInstance_2")); // create empty folder simulating instance
-			assert.equal(await server.isValidInstance(), false);
-			
-			await server.initialize(); // create a proper instance
-			assert.equal(await server.isValidInstance(), true);
-			
-			await server.deleteInstance(); // delete the instance and ensure we see that it is in fact deleted
-			assert.equal(await server.isValidInstance(), false);
-			
-			return true;
-		}).timeout(5000);
-	});
-	describe(".initialize()", ()=>{
-		it("creates an instance", done => {
-			let server = new factorioServer({
-				instanceDirectory: path.resolve(__dirname, "_testData_initialize"),
-				instanceName: "Unit testing instance",
-			});
-			server.initialize().then(()=>{
-				return server.deleteInstance();
-			}).then(() => {
-				done();
-			}).catch(e => console.log(e));
-		});
-	});
-	describe(".createMap(mapName.zip)", ()=>{
-		it("creates a map file as instanceDirectory/saves/map.zip", async function(){
-			this.timeout(20000); // these test often takes a lot of time in the map creation step (4500 ms on i3 dev system)
-			let relativePath = __dirname.replace(appRootPath, "").substr(1);
-			let server = new factorioServer({
-				instanceDirectory: path.join(relativePath, "_testData_createMap"),
-				instanceName: "Unit testing instance",
-				onProgress: false,
-			});
-			await server.initialize();
-			let maps = fs.readdirSync(path.join(relativePath, "_testData_createMap", "saves"));
-			assert.equal(maps.length, 0);
-			await server.createMap();
-			let maps2 = fs.readdirSync(path.join(relativePath, "_testData_createMap", "saves"));
-			assert(maps2.includes("map.zip"));
-			
-			await server.deleteInstance();
-			return true;
-		});
-		it("supports custom filenames", async function(){
-			this.timeout(20000);
-			let relativePath = __dirname.replace(appRootPath, "").substr(1);
-			let server = new factorioServer({
-				instanceDirectory: path.join(relativePath, "_testData_createMap_2"),
-				instanceName: "Unit testing instance",
-				onProgress: false,
-			});
-			await server.initialize();
-			
-			let maps = fs.readdirSync(path.join(relativePath, "_testData_createMap_2", "saves"));
-			assert.equal(maps.length, 0);
-			await server.createMap("mapWithCustomName.zip");
-			let maps2 = fs.readdirSync(path.join(relativePath, "_testData_createMap_2", "saves"));
-			assert(maps2.includes("mapWithCustomName.zip"));
-			
-			await server.deleteInstance();
-			return true;
-		});
-	});
-});

node_modules/_app/fileOps/fileOps.js

@@ -1,120 +0,0 @@
-const fs = require("fs");
-const path = require("path");
-
-// gets newest file in a directory
-// dir is directory
-// files is array of filenames
-// callback(err, filename string);
-var getNewestFile = function(dir, files, callback) {
-	if (!callback) throw new Error("Missing callback");
-	if (!files || (files && files.length === 0)) {
-		callback(new Error("No files"));
-		return;
-	}
-	// we are appending the file name to the directory, without the
-	// "/" we would get paths like /folderfile.txt instead of /folder/file.txt
-	if(dir[dir.length-1] != "/"){
-		dir += "/";
-	}
-	var newest = { file: files[0] };
-	var checked = 0;
-	fs.stat(dir + newest.file, function(err, stats) {
-		if(err) {
-			callback(err);
-		} else {
-			newest.mtime = stats.mtime;
-			for (var i = 0; i < files.length; i++) {
-				var file = files[i];
-				(function(file) {
-					fs.stat(file, function(err, stats) {
-						++checked;
-						if (stats.mtime.getTime() > newest.mtime.getTime()) {
-							newest = { file : file, mtime : stats.mtime };
-						}
-						if (checked == files.length) {
-							callback(undefined,newest);
-						}
-					});
-				})(dir + file);
-			}
-		}
-	});
-}
-
-// get names of all directories in directory
-var getDirectoriesSync = function(srcpath) {
-	return fs.readdirSync(srcpath).filter(function (file) {
-		return fs.statSync(path.join(srcpath, file)).isDirectory();
-	});
-}
-// get names of all files in a directory
-var getFileNamesSync = function(srcpath) {
-	return fs.readdirSync(srcpath).filter(function (file) {
-		return !fs.statSync(path.join(srcpath, file)).isDirectory();
-	});
-}
-// does what it says on the tin
-var deleteFolderRecursiveSync = function(path) {
-	if (fs.existsSync(path)) {
-		fs.readdirSync(path).forEach(function (file, index) {
-			var curPath = path + "/" + file;
-			if (fs.lstatSync(curPath).isDirectory()) { // recurse
-				deleteFolderRecursiveSync(curPath);
-			} else { // delete file
-				fs.unlinkSync(curPath);
-			}
-		});
-		fs.rmdirSync(path);
-		return true;
-	} else {
-		return false;
-	}
-};
-var deleteFolderRecursive = function(path){
-	return new Promise((resolve, reject) => {
-		fs.readdir(path, (err, files) => {
-			if(err){
-				reject(err);
-			} else {
-				let thingsToDelete = files.length;
-				files.forEach(file => {
-					let curPath = path + "/" + file;
-					fs.stat(curPath, (err, stat) => {
-						if(!err){
-							if(stat.isDirectory()){
-								// recurse
-								deleteFolderRecursive(curPath).then(() => {
-									whenFilesDeleted();
-								}).catch(e => console.log(e));
-							} else {
-								fs.unlink(curPath, () => {
-									// console.log("Deleted "+curPath);
-									whenFilesDeleted();
-								});
-							}
-						} else {
-							resolve(false);
-						}
-					});
-				});
-				whenFilesDeleted();
-				function whenFilesDeleted(){
-					if(!thingsToDelete--){// var-- instead of --var because we are calling the function once too much and need the delay
-						fs.rmdir(path, () => {
-							resolve();
-							// console.log("Deleted "+path);
-						});
-					}
-				}
-			}
-		});
-	});
-}
-
-module.exports = {
-	getNewestFile,
-	getDirectoriesSync,
-	deleteFolderRecursiveSync,
-	deleteFolderRecursive,
-	getFileNamesSync,
-}

node_modules/_app/fileOps/fileOps.spec.js

@@ -1,135 +0,0 @@
-const assert = require('assert');
-const fs = require('fs');
-const path = require('path');
-
-const fileOps = require('./fileOps');
-
-// create folders for testing
-function setupTestingEnv(){
-	if (!fs.existsSync(path.resolve(__dirname, "database"))){
-		fs.mkdirSync(path.resolve(__dirname, "database"));
-	}
-	if (!fs.existsSync(path.resolve(__dirname, "test"))){
-		fs.mkdirSync(path.resolve(__dirname, "test"));
-	}
-	if (!fs.existsSync(path.resolve(__dirname, "test/folder"))){
-		fs.mkdirSync(path.resolve(__dirname, "test/folder"));
-	}
-	if (!fs.existsSync(path.resolve(__dirname, "test/another folder"))){
-		fs.mkdirSync(path.resolve(__dirname, "test/another folder"));
-	}
-	if (!fs.existsSync(path.resolve(__dirname, "test/file.txt"))){
-		fs.writeFileSync(path.resolve(__dirname, "test/file.txt"), "contents");
-	}
-	if (!fs.existsSync(path.resolve(__dirname, "test/another file.txt"))){
-		fs.writeFileSync(path.resolve(__dirname, "test/another file.txt"), "more contents");
-	}
-	// we need this xfile to test a branch in fileOps.getNewestFile()s propagation
-	if (!fs.existsSync(path.resolve(__dirname, "test/xfile.txt"))){
-		fs.writeFileSync(path.resolve(__dirname, "test/xfile.txt"), "contents");
-	}
-}
-setupTestingEnv();
-setupTestingEnv(); // run twice to get branch coverage
-describe("fileOps.js", function(){
-	describe("fileOps.getDirectoriesSync()", function(){
-		it("gets an array of directory names from a path", function(){
-			let directories = fileOps.getDirectoriesSync(path.resolve(__dirname, "test"));
-			
-			// because there are no arrays for some reason
-			assert(typeof directories == "object");
-			
-			// they are sorted alphabetically because thats the way it is
-			assert(directories[0] == "another folder" && directories[1] == "folder");
-		});
-		it("does not return any filenames", function(){
-			let directories = fileOps.getDirectoriesSync(path.resolve(__dirname, "test"));
-			
-			// this is a function to return directories, not files. So yeah.
-			assert(!directories.includes("file.txt") && !directories.includes("another file.txt"));
-		});
-		it("throws when lacking first argument", function(){
-			assert.throws(function(){
-				let files = fileOps.getDirectoriesSync();
-			}, Error);
-		});
-	});
-	describe("fileOps.getFileNamesSync(path)", function(){
-		it("gets names of files in directory", function(){
-			let files = fileOps.getFileNamesSync(path.resolve(__dirname, "test"));
-			assert(files.length > 0);
-			assert(files.includes("file.txt") && files.includes("another file.txt"));
-		});
-		it("throws when lacking first argument", function(){
-			assert.throws(function(){
-				let files = fileOps.getFileNamesSync();
-			}, Error);
-		});
-	});
-	describe("fileOps.getNewestFile()", function(){
-		it("gets the newest file in a directory async", function(done){
-			fileOps.getNewestFile(path.resolve(__dirname, "test/"), fileOps.getFileNamesSync(path.resolve(__dirname, "test")), function(err, newest){
-				assert(newest && typeof newest.file == "string");
-				done();
-			});
-		});
-		it("throws if callback is missing", function(){
-			assert.throws(function(){
-				fileOps.getNewestFile("test", fileOps.getFileNamesSync(path.resolve(__dirname, "test")));
-			}, Error);
-		});
-		it("executes callback(err) if no files are provided", function(done){
-			fileOps.getNewestFile(path.resolve(__dirname, "test"), [], function(err, newest){
-				assert(err && typeof err == "object");
-				done();
-			});
-		});
-		it("executes callback(err) if launched without a directory", function(done){
-			fileOps.getNewestFile("", fileOps.getFileNamesSync(path.resolve(__dirname, "test")), function(err, newest){
-				assert(err);
-				done();
-			});
-		});
-		it("executes callback(err) when you do stupid shit", function(done){
-			fileOps.getNewestFile({thisWontWork: "but not crash either"}, {lolz:"yeah..."}, function(err, newest){
-				assert(err);
-				// ENOENT: no such file or directory, stat 'C:\**\factorioClusterio\lib\test\undefined'
-				done();
-			});
-		});
-	});
-	describe("fileOps.deleteFolderRecursiveSync(path)", function(){
-		it("deletes a folder and all files and folders in it", function(){
-			let x = fileOps.deleteFolderRecursiveSync(path.resolve(__dirname, "test"));
-			assert.throws(function(){
-				fs.statSync(path.resolve(__dirname, "test"));
-			}, Error);
-			assert(x);
-			// give it some extra time because its sometimes very slow
-		}).timeout(5000);
-		it("returns false if you give it an invalid path", function(){
-			let x = fileOps.deleteFolderRecursiveSync("This isn't a real path");
-			assert(!x);
-		});
-	});
-	describe("fileOps.deleteFolderRecursive(path)", function(){
-		it("deletes a folder and all files and folders in it, just like sync version", async function(){
-			setupTestingEnv();
-			assert(fs.statSync(path.resolve(__dirname, "test")));
-			let x = await fileOps.deleteFolderRecursive(path.resolve(__dirname, "test"));
-			assert.throws(function(){
-				fs.statSync(path.resolve(__dirname, "test"));
-			}, Error);
-			assert(x === undefined, "Promise version of this function does not have a return value upon success");
-			return true;
-		}).timeout(5000);
-		it("throws like a promise does if you give it an invalid path", async function(){
-			let x = await fileOps.deleteFolderRecursive("Look this path is fake!")
-			.catch(e => {
-				assert(e);
-				assert.equal(e.code, "ENOENT");
-				return true;
-			});
-		});
-	});
-});

node_modules/_app/fileOps/index.js

@@ -1,2 +0,0 @@
-const fileOps = require("./fileOps");
-module.exports = fileOps;

node_modules/_app/isFactorioCommand/index.js

@@ -1 +0,0 @@
-module.exports = require("./isFactorioCommand.js");

node_modules/_app/isFactorioCommand/isFactorioCommand.js

@@ -1,23 +0,0 @@
-const luamin = require("luamin");
-function isFactorioCommand(command){
-	if(typeof command != "string"){
-		return false;
-	} else if(!command.includes("/silent-command ") && !command.includes("/c ")){
-		return false;
-	} else if(command[0] != "/"){
-		return false;
-	} else {
-		// check that what follows /c is valid LUA
-		let x = command.replace("/silent-command ", "").replace("/c ","");
-		let y
-		try{
-			y = luamin.minify(x);
-		} catch (e) {
-			return false;
-		}
-		
-		// by this point it is surely a LUA command
-		return true;
-	}
-}
-module.exports = isFactorioCommand;

node_modules/_app/isFactorioCommand/isFactorioCommand.spec.js

@@ -1,18 +0,0 @@
-const isFactorioCommand = require("./isFactorioCommand");
-const assert = require("assert");
-
-describe("inventoryImports/isFactorioCommand.js()", function(){
-	it("Returns false if input is not a factorio command", function(){
-		assert(isFactorioCommand({}) == false, "This is not even a string so should return false");
-		assert(isFactorioCommand("Howdy boys!") == false, "This is not a command so should return false");
-		assert(isFactorioCommand("/c this ain't a command because its invalid LUA") == false, "This is not valid LUA so it should return false");
-		assert(isFactorioCommand("Trying to trick the system /c game.print('Hello world!')") == false, "this is still not a command");
-		
-	});
-	it("Returns true if it is a valid command", function(){
-		assert(isFactorioCommand("/c game.print('hello world')"), "This is a valid command, should output true not false")
-	});
-	it("Fails to understand that leading spaces are valid", function(){
-		assert(isFactorioCommand("  /c game.print('Hello world!')") == false, "This should be true but often returns false unintentionally. If you see this you probably fixed the bug so change this test, OK?")
-	});
-});

package.json

@@ -1,70 +1,31 @@
 {
-  "name": "clusterio",
-  "version": "1.7.0",
-  "description": "Interserver communication for factorio",
-  "repository": "https://github.com/Danielv123/factorioClusterio",
-  "main": "master.js",
+  "name": "root",
+  "private": true,
   "scripts": {
-    "test": "./node_modules/.bin/istanbul cover ./node_modules/mocha/bin/_mocha -- \"./{{,node_modules/_app/**/},!(node_modules)/**/}*.spec.js\" -R spec || echo .",
-    "start": "echo Run node client.js start [instance] to start slaves && node master.js",
-    "cover": "./node_modules/.bin/istanbul cover ./node_modules/mocha/bin/_mocha -- \"./{{,node_modules/_app/**/},!(node_modules)/**/}*.spec.js\" -R spec || echo . && codecov -t f7b38085-36eb-4d72-84e6-64721910171e",
-    "docs": "documentation build index.js --config documentation.yml -f html -o docs",
-    "livedocs": "documentation serve --watch *.js lib/** --config documentation.yml",
-    "install": "node lib/npmPostinstall.js"
+    "test": "mocha --check-leaks -R spec --exclude \"**/node_modules/**\" --recursive test plugins/global_chat/test plugins/research_sync/test plugins/statistics_exporter/test plugins/subspace_storage/test plugins/player_auth/test",
+    "fast-test": "FAST_TEST=y npm test",
+    "cover": "nyc npm test",
+    "fast-cover": "FAST_TEST=y nyc npm test",
+    "ci-cover": "nyc --reporter=lcovonly npm run-script test",
+    "lint": "eslint \"*.js\" packages plugins test",
+    "docs": "jsdoc --configure docs/jsdoc.json",
+    "bundle-dependencies": "bundle-dependencies"
   },
-  "keywords": [
-    "factorio"
-  ],
-  "author": "Danielv123",
-  "license": "ISC",
-  "dependencies": {
-    "app-root-path": "^2.0.1",
-    "as-table": "^1.0.31",
-    "averaged-timeseries": "^1.4.0",
-    "bcryptjs": "^2.4.3",
-    "body-parser": "^1.18.2",
-    "codecov": "^2.3.1",
-    "deepmerge": "^1.5.2",
-    "ejs": "^2.5.7",
-    "express": "^4.16.2",
-    "express-fileupload": "0.0.6",
-    "follow-redirects": "^1.4.1",
-    "fs-extra": "^1.0.0",
-    "getmac": "^1.4.0",
-    "hash-files": "^1.1.1",
-    "html5-validator": "^1.0.7",
-    "ini": "^1.3.5",
-    "jsonwebtoken": "^8.2.1",
-    "leveldown": "^1.9.0",
-    "linvodb3": "^3.25.1",
-    "luamin": "^1.0.4",
-    "mkdirp": "^0.5.1",
-    "mkdirp-promise": "^5.0.1",
-    "moment": "^2.20.1",
-    "ncp": "^2.0.0",
-    "nedb": "^1.8.0",
-    "needle": "^1.1.0",
-    "node-factorio-api": "^0.3.1-alpha",
-    "node-forge": "^0.7.1",
-    "prom-client": "^10.2.3",
-    "request": "^2.83.0",
-    "right-pad": "^1.0.1",
-    "rmdir-sync": "^1.0.1",
-    "simple-rcon": "^0.3.1",
-    "single-line-log": "^1.1.2",
-    "socket.io": "^2.0.4",
-    "socket.io-client": "^2.0.4",
-    "sync-request": "^4.0.1",
-    "underscore": "^1.8.3"
+  "nyc": {
+    "exclude": [
+      "test/**",
+      "plugins/*/test/**"
+    ]
+  },
+  "engines": {
+    "node": ">=12"
   },
   "devDependencies": {
-    "documentation": "^5.4.0",
-    "istanbul": "^0.4.5",
-    "mocha": "^3.5.3",
-    "mocha-sinon": "^2.0.0",
-    "mocha.parallel": "^0.15.5",
-    "nock": "^9.1.6",
-    "sinon": "^2.4.1",
-    "supertest": "^3.0.0"
+    "eslint": "^7.25.0",
+    "eslint-plugin-node": "^11.1.0",
+    "jsdoc": "^3.6.6",
+    "lerna": "^4.0.0",
+    "mocha": "^8.4.0",
+    "nyc": "^15.1.0"
   }
 }

packages/create/README.md

@@ -0,0 +1,5 @@
+# Clusterio installer
+
+Installer for Clusterio.
+
+See [the Clusterio README.md](https://github.com/clusterio/clusterio#readme) the for installation guide.

packages/create/create.js

@@ -0,0 +1,609 @@
+#!/usr/bin/env node
+
+"use strict";
+const child_process = require("child_process");
+const events = require("events");
+const fs = require("fs-extra");
+const inquirer = require("inquirer");
+const os = require("os");
+const path = require("path");
+const phin = require("phin");
+const stream = require("stream");
+const util = require("util");
+const yargs = require("yargs");
+
+const { levels, logger, setLogLevel } = require("./logging");
+let dev = false;
+const scriptExt = process.platform === "win32" ? ".cmd" : "";
+
+
+const availablePlugins = [
+	{ name: "Global Chat", value: "@clusterio/plugin-global_chat" },
+	{ name: "Inventory Sync", value: "@clusterio/plugin-inventory_sync" },
+	{ name: "Player Auth", value: "@clusterio/plugin-player_auth" },
+	{ name: "Research Sync", value: "@clusterio/plugin-research_sync" },
+	{ name: "Statistics Exporter", value: "@clusterio/plugin-statistics_exporter" },
+	{ name: "Subspace Storage", value: "@clusterio/plugin-subspace_storage" },
+
+	// Comunity plugins
+	{ name: "Discord Bridge", value: "@hornwitser/discord_bridge" },
+	{ name: "Server Select", value: "@hornwitser/server_select" },
+];
+
+const factorioLocations = {
+	win32: [
+		"C:\\Program Files\\Factorio",
+		"C:\\Program Files (x86)\\Steam\\steamapps\\common\\Factorio",
+	],
+	darwin: [
+		"/Applications/factorio.app/Contents",
+	],
+};
+
+
+class LineSplitter extends stream.Transform {
+	constructor(options) {
+		super(options);
+		this._partial = null;
+	}
+
+	_transform(chunk, encoding, callback) {
+		if (this._partial) {
+			chunk = Buffer.concat([this._partial, chunk]);
+			this._partial = null;
+		}
+
+		while (chunk.length) {
+			let end = chunk.indexOf("\n");
+			if (end === -1) {
+				this._partial = chunk;
+				break;
+			}
+
+			let next = end + 1;
+			// Eat carriage return as well if present
+			if (end >= 1 && chunk[end-1] === "\r".charCodeAt(0)) {
+				end -= 1;
+			}
+
+			let line = chunk.slice(0, end);
+			chunk = chunk.slice(next);
+			this.push(line);
+		}
+		callback();
+	}
+
+	_flush(callback) {
+		if (this._partial) {
+			this.push(this._partial);
+			this._partial = null;
+		}
+		callback();
+	}
+}
+
+class InstallError extends Error { }
+
+
+async function execFile(cmd, args) {
+	logger.verbose(`executing ${cmd} ${args.join(" ")}`);
+	const asyncExec = util.promisify(child_process.execFile);
+	return new Promise((resolve, reject) => {
+		let child = child_process.execFile(cmd, args, (err, stdout, stderr) => {
+			if (err) {
+				reject(err);
+			} else {
+				resolve({ stdout, stderr });
+			}
+		});
+		let stdout = new LineSplitter({ readableObjectMode: true });
+		stdout.on("data", line => { logger.verbose(line.toString()); });
+		child.stdout.pipe(stdout);
+		let stderr = new LineSplitter({ readableObjectMode: true });
+		stderr.on("data", line => { logger.verbose(`err: ${line.toString()}`); });
+		child.stderr.pipe(stderr);
+	});
+}
+
+async function execMaster(args) {
+	if (dev) {
+		return await execFile("node", [path.join("packages", "master"), ...args]);
+	}
+	return await execFile(path.join("node_modules", ".bin", `clusteriomaster${scriptExt}`), args);
+}
+
+async function execSlave(args) {
+	if (dev) {
+		return await execFile("node", [path.join("packages", "slave"), ...args]);
+	}
+	return await execFile(path.join("node_modules", ".bin", `clusterioslave${scriptExt}`), args);
+}
+
+function validateSlaveToken(token) {
+	let parts = token.split(".");
+	if (parts.length !== 3) {
+		throw new InstallError("Invalid token");
+	}
+
+	let parsed;
+	try {
+		parsed = JSON.parse(Buffer.from(parts[1], "base64"));
+	} catch (err) {
+		throw new InstallError("Invalid token");
+	}
+
+	if (parsed.aud !== "slave" || !Number.isInteger(parsed.slave)) {
+		throw new InstallError("Invalid token");
+	}
+}
+
+async function validateInstallDir() {
+	let entries = new Set(await fs.readdir("."));
+	if (entries.size) {
+		if (!entries.has("package.json")) {
+			throw new InstallError("Refusing to install to non-empty directory");
+		}
+
+		let packageData;
+		try {
+			packageData = JSON.parse(await fs.readFile("package.json"));
+		} catch (err) {
+			throw new InstallError(`Failed to read package.json: ${err.message}`);
+		}
+		if (packageData.name !== "clusterio-install" || !packageData.private) {
+			throw new InstallError("Refusing to run on non-clusterio installation");
+		}
+	}
+}
+
+async function installClusterio(mode, plugins) {
+	try {
+		await fs.writeFile("package.json", JSON.stringify({
+			name: "clusterio-install",
+			private: true,
+		}, null, 2), { flag: "wx" });
+	} catch (err) {
+		if (err.code !== "EEXIST") {
+			throw new InstallError(`Failed to write package.json: ${err.message}`);
+		}
+	}
+
+	let components = [];
+	if (["standalone", "master"].includes(mode)) {
+		components.push("@clusterio/master");
+	}
+	if (["standalone", "slave"].includes(mode)) {
+		components.push("@clusterio/slave");
+	}
+	if (mode === "ctl") {
+		components.push("@clusterio/ctl");
+	}
+
+	logger.info(`Please wait, installing ${mode}`);
+	try {
+		await execFile(`npm${scriptExt}`, ["install", ...components, ...plugins]);
+	} catch (err) {
+		throw new InstallError(`Failed to install: ${err.message}`);
+	}
+
+	if (plugins.length) {
+		logger.info("Setting up plugins");
+		let pluginList;
+		try {
+			pluginList = new Map(JSON.parse(await fs.readFile("plugin-list.json")));
+		} catch (err) {
+			if (err.code === "ENOENT") {
+				pluginList = new Map();
+			} else {
+				throw new InstallError(`Error loading plugin-list.json: ${err.message}`);
+			}
+		}
+		for (let plugin of plugins) {
+			if (!pluginList.has(plugin)) {
+				// eslint-disable-next-line node/global-require
+				let pluginInfo = require(require.resolve(path.posix.join(plugin, "info"), { paths: [process.cwd()] }));
+				pluginList.set(pluginInfo.name, plugin);
+			}
+		}
+		try {
+			await fs.writeFile("plugin-list.json", JSON.stringify([...pluginList], null, 4));
+		} catch (err) {
+			throw new InstallError(`Error writing plugin-list.json: ${err.message}`);
+		}
+	}
+}
+
+async function writeScripts(mode) {
+	if (["standalone", "master"].includes(mode)) {
+		if (process.platform === "win32") {
+			await fs.writeFile(
+				"run-master.cmd",
+				"@echo off\n.\\node_modules\\.bin\\clusteriomaster.cmd run\n"
+			);
+		} else {
+			await fs.writeFile(
+				"run-master.sh",
+				"#!/bin/sh\nexec ./node_modules/.bin/clusteriomaster run\n",
+				{ mode: 0o755 },
+			);
+			await fs.outputFile(
+				"systemd/clusteriomaster.service",
+				`[Unit]
+Description=Clusterio Master
+
+[Service]
+User=${os.userInfo().username}
+Group=nogroup
+WorkingDirectory=${process.cwd()}
+KillMode=mixed
+KillSignal=SIGINT
+ExecStart=${process.cwd()}/node_modules/.bin/clusteriomaster run --log-level=warn
+
+[Install]
+WantedBy=multi-user.target
+`);
+		}
+	}
+
+	if (["standalone", "slave"].includes(mode)) {
+		if (process.platform === "win32") {
+			await fs.writeFile(
+				"run-slave.cmd",
+				"@echo off\n.\\node_modules\\.bin\\clusterioslave.cmd run\n"
+			);
+		} else {
+			await fs.writeFile(
+				"run-slave.sh",
+				"#!/bin/sh\nexec ./node_modules/.bin/clusterioslave run\n",
+				{ mode: 0o755 },
+			);
+			await fs.outputFile(
+				"systemd/clusterioslave.service",
+				`[Unit]
+Description=Clusterio Slave
+
+[Service]
+User=${os.userInfo().username}
+Group=nogroup
+WorkingDirectory=${process.cwd()}
+KillMode=mixed
+KillSignal=SIGINT
+ExecStart=${process.cwd()}/node_modules/.bin/clusterioslave run --log-level=warn
+
+[Install]
+WantedBy=multi-user.target
+`);
+		}
+	}
+}
+
+// eslint-disable-next-line complexity
+async function inquirerMissingArgs(args) {
+	let answers = {};
+	if (args.mode) { answers.mode = args.mode; }
+	answers = await inquirer.prompt([
+		{
+			type: "list",
+			name: "mode",
+			message: "Operating mode to install",
+			default: "standalone",
+			choices: [
+				{ name: "Standalone (install both master and slave on this computer)", value: "standalone" },
+				{ name: "Master only", value: "master" },
+				{ name: "Slave only", value: "slave" },
+				{ name: "Ctl only", value: "ctl" },
+				{ name: "Plugins only", value: "plugins" },
+			],
+		},
+	], answers);
+
+	if (["standalone", "master"].includes(answers.mode)) {
+		if (args.admin) { answers.admin = args.admin; }
+		answers = await inquirer.prompt([
+			{
+				type: "input",
+				name: "admin",
+				message: "Admin account name",
+				validate: input => {
+					if (!input) {
+						return "May not be empty";
+					}
+					return true;
+				},
+			},
+		], answers);
+	}
+
+	if (answers.mode === "slave") {
+		if (args.slaveName) { answers.slaveName = args.slaveName; }
+		answers = await inquirer.prompt([
+			{
+				type: "input",
+				name: "slaveName",
+				message: "Name of slave",
+			},
+		], answers);
+	}
+
+	if (["slave", "ctl"].includes(answers.mode)) {
+		if (args.masterUrl) { answers.masterUrl = args.masterUrl; }
+		answers = await inquirer.prompt([
+			{
+				type: "input",
+				name: "masterUrl",
+				message: "Master server URL",
+			},
+		], answers);
+
+		if (args.masterToken) { answers.masterToken = args.masterToken; }
+		answers = await inquirer.prompt([
+			{
+				type: "input",
+				name: "masterToken",
+				message: "Master authentication Token",
+			},
+		], answers);
+	}
+
+	if (answers.mode === "slave") {
+		validateSlaveToken(answers.masterToken);
+	}
+
+	if (["standalone", "slave"].includes(answers.mode)) {
+		let myIp;
+		if (args.publicAddress) {
+			answers.publicAddress = args.publicAddress;
+		} else {
+			try {
+				let result = await phin("https://api.ipify.org/");
+				myIp = result.body.toString();
+			} catch (err) { /* ignore */ }
+		}
+		answers = await inquirer.prompt([
+			{
+				type: "input",
+				name: "publicAddress",
+				message: "Public DNS/IP address of this server",
+				default: myIp,
+			},
+		], answers);
+
+		if (args.factorioDir) { answers.factorioDir = args.factorioDir; }
+		let locations = factorioLocations[process.platform] || [];
+		let foundLocations = [];
+		for (let location of locations) {
+			if (await fs.pathExists(path.join(location, "data", "changelog.txt"))) {
+				foundLocations.push(location);
+			}
+		}
+		if (process.platform === "linux") {
+			if (args.hasOwnProperty("downloadHeadless")) { answers.downloadHeadless = args.downloadHeadless; }
+
+			answers = await inquirer.prompt([
+				{
+					type: "confirm",
+					name: "downloadHeadless",
+					message: "(Linux only) Automatically download latest factorio release?",
+					default: true,
+				},
+			], answers);
+
+			if (answers.downloadHeadless) {
+				answers.factorioDir = "factorio";
+			}
+		}
+
+		answers = await inquirer.prompt([
+			{
+				type: "list",
+				name: "factorioDir",
+				message: "Path to Factorio installation",
+				choices: [
+					...foundLocations.map(location => ({ name: `${location} (auto detected)`, value: location })),
+					{ name: "Use local factorio directory, you must copy an installation to it", value: "factorio" },
+					{ name: "Provide path manually", value: null },
+				],
+			},
+		], answers);
+
+		if (answers.factorioDir === null) {
+			answers = await inquirer.prompt([
+				{
+					type: "input",
+					name: "factorioDir",
+					message: "Path to Factorio installation",
+					askAnswered: true,
+				},
+			], answers);
+		} else if (answers.factorioDir === "factorio") {
+			await fs.ensureDir("factorio");
+		}
+	}
+
+	if (dev) { answers.plugins = []; }
+	answers = await inquirer.prompt([
+		{
+			type: "checkbox",
+			name: "plugins",
+			message: "Plugins to install",
+			choices: availablePlugins,
+			pageSize: 20,
+		},
+	], answers);
+
+	return answers;
+}
+
+async function downloadLinuxServer() {
+	let res = await phin("https://factorio.com/get-download/stable/headless/linux64");
+
+	const url = new URL(res.headers.location);
+	// get the filename of the latest factorio archive from redirected url
+	const filename = path.posix.basename(url.pathname);
+	const version = filename.match(/(?<=factorio_headless_x64_).*(?=\.tar\.xz)/)[0];
+
+	const tmpDir = "temp/create-temp/";
+	const archivePath = tmpDir + filename;
+	const tmpArchivePath = `${archivePath}.tmp`;
+	const factorioDir = `factorio/${version}/`;
+	const tmpFactorioDir = tmpDir + version;
+
+	if (await fs.pathExists(factorioDir)) {
+		logger.warn(`setting downloadDir to ${factorioDir}, but not downloading because already existing`);
+	} else {
+		await fs.ensureDir(tmpDir);
+
+		// follow the redirect
+		res = await phin({
+			url: url.href,
+			stream: true,
+		});
+
+		logger.info("Downloading latest Factorio server release. This may take a while.");
+		const writeStream = fs.createWriteStream(tmpArchivePath);
+		res.pipe(writeStream);
+
+		await events.once(res, "end");
+
+		await fs.rename(tmpArchivePath, archivePath);
+		try {
+			await fs.ensureDir(tmpFactorioDir);
+			await execFile("tar", [
+				"xf", archivePath, "-C", tmpFactorioDir, "--strip-components", "1",
+			]);
+		} catch (e) {
+			logger.error("error executing command- do you have 'xz-utils' installed?");
+			throw e;
+		}
+
+		await fs.unlink(archivePath);
+		await fs.rename(tmpFactorioDir, factorioDir);
+	}
+}
+
+async function main() {
+	let args = yargs
+		.option("log-level", {
+			nargs: 1, describe: "Log level to print to stdout", default: "info",
+			choices: ["none"].concat(Object.keys(levels)), type: "string",
+		})
+		.option("dev", {
+			nargs: 0, describe: "Initialize development repository", hidden: true, default: false, type: "boolean",
+		})
+		.option("mode", {
+			nargs: 1, describe: "Operating mode to install",
+			choices: ["standalone", "master", "slave", "ctl", "plugins"],
+		})
+		.option("admin", {
+			nargs: 1, describe: "Admin account name [standalone/master]", type: "string",
+		})
+		.option("slave-name", {
+			nargs: 1, describe: "Slave name [slave]", type: "string",
+		})
+		.option("master-url", {
+			nargs: 1, describe: "Master URL [slave/ctl]", type: "string",
+		})
+		.option("master-token", {
+			nargs: 1, describe: "Master authentication token [slave/ctl]", type: "string",
+		})
+		.option("public-address", {
+			nargs: 1, describe: "DNS/IP Address to connect to this server [standalone/slave]", type: "string",
+		})
+		.option("factorio-dir", {
+			nargs: 1, describe: "Path to Factorio installation [standalone/slave]", type: "string",
+		})
+		.option("plugins", {
+			array: true, describe: "Plugins to install", type: "string",
+		});
+
+	if (process.platform === "linux") {
+		args = args
+			.option("download-headless", {
+				nargs: 0,
+				describe: "(Linux only) Automatically download and unpack the latest factorio release. " +
+					"Can be set to false using --no-download-headless.",
+				type: "boolean",
+			})
+			.conflicts("factorio-dir", "download-headless");
+	}
+
+	args = args.argv;
+
+	setLogLevel(args.logLevel === "none" ? -1 : levels[args.logLevel]);
+	dev = args.dev;
+
+	if (!dev) {
+		await validateInstallDir();
+	}
+
+	let answers = await inquirerMissingArgs(args);
+	if (answers.downloadHeadless) {
+		await downloadLinuxServer();
+	}
+
+	logger.verbose(JSON.stringify(answers));
+
+	if (!dev) {
+		await installClusterio(answers.mode, answers.plugins);
+	}
+
+	let adminToken = null;
+	if (["standalone", "master"].includes(answers.mode)) {
+		logger.info("Setting up master");
+		await execMaster(["bootstrap", "create-admin", answers.admin]);
+		let result = await execMaster(["bootstrap", "generate-user-token", answers.admin]);
+		adminToken = result.stdout.split("\n").slice(-2)[0];
+	}
+
+	if (answers.mode === "standalone") {
+		logger.info("Setting up slave");
+		await execSlave(["config", "set", "slave.name", "local"]);
+
+		let result = await execSlave(["config", "show", "slave.id"]);
+		let slaveId = Number.parseInt(result.stdout.split("\n").slice(-2)[0], 10);
+
+		result = await execMaster(["bootstrap", "generate-slave-token", slaveId]);
+		let slaveToken = result.stdout.split("\n").slice(-2)[0];
+
+		await execSlave(["config", "set", "slave.master_token", slaveToken]);
+		await execSlave(["config", "set", "slave.factorio_directory", answers.factorioDir]);
+	}
+
+	if (answers.mode === "slave") {
+		logger.info("Setting up slave");
+		let slaveId = JSON.parse(Buffer.from(answers.masterToken.split(".")[1], "base64")).slave;
+		await execSlave(["config", "set", "slave.id", slaveId]);
+		await execSlave(["config", "set", "slave.name", answers.slaveName]);
+		await execSlave(["config", "set", "slave.master_url", answers.masterUrl]);
+		await execSlave(["config", "set", "slave.master_token", answers.masterToken]);
+		await execSlave(["config", "set", "slave.factorio_directory", answers.factorioDir]);
+	}
+
+	if (!dev && ["standalone", "master", "slave"].includes(answers.mode)) {
+		logger.info("Writing run scripts");
+		await writeScripts(answers.mode);
+	}
+
+	/* eslint-disable no-console */
+	console.log(`Successfully installed ${answers.mode}`);
+	if (adminToken) {
+		console.log(`Admin authentication token: ${adminToken}`);
+	}
+	/* eslint-enable no-console */
+}
+
+if (module === require.main) {
+	main().catch(err => {
+		if (err instanceof InstallError) {
+			logger.error(err.message);
+		} else {
+			logger.fatal(`
++------------------------------------------------------------+
+| Unexpected error occured installing clusterio, please      |
+| report it to https://github.com/clusterio/clusterio/issues |
++------------------------------------------------------------+
+${err.stack}`
+			);
+		}
+	});
+}

packages/create/logging.js

@@ -0,0 +1,51 @@
+/* eslint-disable no-console */
+"use strict";
+const chalk = require("chalk");
+
+const levels = Object.freeze({
+	fatal: 0,
+	error: 1,
+	warn: 2,
+	audit: 3,
+	info: 4,
+	verbose: 6,
+});
+
+const colors = {
+	fatal: "inverse red",
+	error: "bold redBright",
+	warn: "bold yellowBright",
+	audit: "bold greenBright",
+	info: "bold blueBright",
+	verbose: "bold grey",
+};
+
+let maxLogLevel = levels.info;
+const logger = {};
+for (let [name, level] of Object.entries(levels)) {
+	// eslint-disable-next-line no-loop-func
+	logger[name] = message => {
+		if (level > maxLogLevel) {
+			return;
+		}
+		let style = chalk;
+		for (let part of colors[name].split(" ")) {
+			style = style[part];
+		}
+		if (["fatal", "error"].includes(name)) {
+			console.error(`${style(name)} ${message}`);
+		} else if (["warn"].includes(name)) {
+			console.warn(`${style(name)} ${message}`);
+		} else {
+			console.log(`${style(name)} ${message}`);
+		}
+	};
+}
+
+module.exports = {
+	colors,
+	levels,
+	setLogLevel: (level) => { maxLogLevel = level; },
+	logger,
+};
+

packages/create/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@clusterio/create",
+  "description": "Installer for clusterio",
+  "author": "Hornwitser",
+  "license": "MIT",
+  "version": "2.0.0-alpha.9",
+  "main": "create.js",
+  "bin": {
+    "clusteriocreate": "./create.js"
+  },
+  "keywords": [
+    "factorio",
+    "clusterio"
+  ],
+  "engines": {
+    "node": ">=12"
+  },
+  "dependencies": {
+    "chalk": "^4.1.0",
+    "fs-extra": "^8.1.0",
+    "inquirer": "^8.1.0",
+    "phin": "^3.5.1",
+    "yargs": "^14.2.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/ctl/README.md

@@ -0,0 +1,91 @@
+# Clusterio Command Line Interface
+
+
+Provides a command line interface for managing a Clusterio cluster.
+
+Note that this document only describes the options and commands for managing clusterioctl itself, see [Managing a cluster](/docs/managing-a-cluster.md) for the available commands used for managing a cluster.
+
+
+## Usage
+
+    npx clusterioctl <command>
+
+Common options:
+
+ * `--plugin-list <file>` JSON file to use for storing the list of plugins that are available to ctl.
+   Defaults to `plugin-list.json` and will be created if it does not exist.
+   See the `plugin` command for managing this list.
+
+ * `--config <file>` JSON file to use for storing configuration for ctl.
+   Defaults to `config-control.json` and will be created if it does not exist.
+   See the `config` command for inspecting and modifying the configuration.
+
+
+### `plugin <command>`
+
+Configure plugins available to be loaded by ctl.
+The available plugins will be automatically loaded and the commands they provide will be added to the ctl utility.
+
+
+#### `plugin add <path>`
+
+Add plugin either by require path or relative/absolute path to the plugin directory.
+A relative path must start with ./ or ../ (or .\ and ..\ on Windows) otherwise it will be assumed to be a require path for an installed package in node_modules.
+
+For example, installing the Subspace Storage plugin:
+
+    npm install @clusterio/plugin-subspace_storage
+    npx clusterioctl plugin add @clusterio/plugin-subspace_storage
+
+Since the `plugin-list.json` is shared between master, slave and ctl you usually only need to do this once per machine.
+
+
+#### `plugin remove <name>`
+
+Remove a plugin by its name.
+This should be done before uninstalling the plugin, otherwise there will be an error when Clusterio tries to load the info from the plugin.
+Removing and unistalling a plugin is usually not neccessary as the functions provided by the plugin can be disabled in the config.
+
+For example, uninstalling the Subspace Storage plugin:
+
+    npx clusterioctl plugin remove subspace_storage
+    npm uninstall @clusterio/plugin-subspace_storage
+
+Since the `plugin-list.json` is shared between master, slave and ctl you usually only need to do this once per machine.
+
+
+#### `plugin list`
+
+Lists the plugins set up to be available by name followed by path.
+
+
+### `config-control`
+
+Manage the ctl configuration.
+This allows setting the url and token to the master server to manage.
+
+
+#### `config-control set <config-entry> [value]`
+
+Set a config entry to the given value.
+If value is not provided the entry is set to null.
+If the config entry is of type object the value must be a valid JSON serialization of an object.
+
+See docs/configuration.md in the main repositiory for the available configuration.
+
+
+#### `config-control show <config-entry>`
+
+Shows the value for a single config entry.
+
+
+#### `config-control list`
+
+Lists up all configuration entries with their currently configured values.
+
+
+## See Also
+
+[Managing a cluster](/docs/managing-a-cluster.md) for the available commands used for managing a cluster.
+
+[The Clusterio repository](https://github.com/clusterio/clusterio) for instructions on how to set up a cluster.

packages/ctl/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@clusterio/ctl",
+  "description": "Clusterio command line management tool",
+  "author": "Hornwitser",
+  "license": "MIT",
+  "version": "2.0.0-alpha.10",
+  "main": "ctl.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "bin": {
+    "clusterioctl": "./ctl.js"
+  },
+  "keywords": [
+    "factorio"
+  ],
+  "engines": {
+    "node": ">=12"
+  },
+  "dependencies": {
+    "@clusterio/lib": "^2.0.0-alpha.10",
+    "as-table": "^1.0.31",
+    "fs-extra": "^8.1.0",
+    "phin": "^3.5.1",
+    "set-blocking": "^2.0.0",
+    "winston": "^3.3.3",
+    "yargs": "^14.2.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/lib/ExponentialBackoff.js

@@ -0,0 +1,85 @@
+"use strict";
+
+
+/**
+ * Helper class for implementing the exponential backoff algorithm
+ *
+ * Provides a convenient interface for implementing an exponential backoff
+ * when reconnecting or resending in a distributed network.
+ *
+ * Once instantiated the delay method will return the next interval to wait
+ * for in milliseconds before making another attempt.  For each attempt the
+ * delay chosen is a random value between 0 and the current maximum delay
+ * wwhich starts at a value of 2 * `base` and doubles for ever attempt up to
+ * the passed value of `max`.  The value for the delay will reset back to
+ * `base` if more time than the value for `reset` has passed between two
+ * invocations of delay.
+ *
+ * @alias module:lib/ExponentialBackoff
+ */
+class ExponentialBackoff {
+	/**
+	 * Construct ExponentialBackoff helper
+	 *
+	 * The options passed may also be modified on the instance at runtime.
+	 *
+	 * @param {object=} options -
+	 *     Options for this exponential backoff helper
+	 * @param {number=} [options.base=1] -
+	 *     Base delay in seconds.  The first delay will on average be this
+	 *     long, but can be anywhere between 0 and 2 times this value.
+	 * @param {number=} [options.max=60] -
+	 *     Maximum delay in seconds.  A delay will not take more than this
+	 *     value.
+	 * @param {number=} [options.reset=2*max] -
+	 *     Time in seconds between two invocations of delay which will cause
+	 *     it to start over with `base` instead of doubling.
+	 */
+	constructor(options = {}) {
+		/**
+		 * Base delay in seconds.  The first delay will on average be this
+		 * long, but can be anywhere between 0 and 2 times this value.
+		 * @type {number}
+		 */
+		this.base = options.base || 1;
+		/**
+		 * Maximum delay in seconds.  A delay will not take more than this
+		 * value.
+		 * @type {number}
+		 */
+		this.max = options.max || 60;
+		/**
+		 * Time in seconds between two invocations of delay which will cause
+		 * it to start over with `base` instead of doubling.
+		 * @type {number}
+		 */
+		this.reset = options.reset || 2 * this.max;
+
+		this._exp = 0;
+		this._lastInvocationTime = Date.now();
+	}
+
+	/**
+	 * Compute the next delay to wait
+	 *
+	 * Returns the next delay to wait according to the exponential backoff
+	 * algorithm.  This is a value between 0 and min(2 * options.base *
+	 * 2<sup>retries</sup>, optinos.max).
+	 *
+	 * @returns {number} time in milliseconds to wait.
+	 */
+	delay() {
+		let invocationTime = Date.now();
+		let interval = (invocationTime - this._lastInvocationTime) / 1000;
+		this._lastInvocationTime = invocationTime;
+
+		if (interval > this.reset) {
+			this._exp = 0;
+		}
+
+		this._exp = Math.min(this._exp + 1, Math.log2(this.max));
+		return Math.random() * this.base * 2 ** this._exp * 1000;
+	}
+}
+
+module.exports = ExponentialBackoff;

packages/lib/README.md

@@ -0,0 +1,5 @@
+# Common Library for Clusterio
+
+This package contains functionality shared between master, slave, ctl and/or plugins of Clusterio.
+
+See [the Clusterio repository](https://github.com/clusterio/clusterio) for more information on Clusterio.

packages/lib/RateLimiter.js

@@ -0,0 +1,104 @@
+"use strict";
+
+
+/**
+ * Helper class for rate limiting actions
+ *
+ * Provides a simple interface for implementing actions that are rate
+ * limited on invocations.
+ *
+ * @example
+ * const rateLimiter = RateLimiter({
+ *     action: () => { console.log("action"); },
+ *     maxRate: 1,
+ * });
+ *
+ * for (let i = 0; i < 100; i++) {
+ *     rateLimiter.activate();
+ *     // Prints action twice to the console, once for the first activation
+ *     // and one more time 1 second later for 99 other activations that were
+ *     // exceeding the rate limit.
+ * }
+ * @alias module:lib/RateLimiter
+ */
+class RateLimiter {
+	/**
+	 * Construct RateLimiter helper
+	 *
+	 * The options passed may also be modified on the instance at runtime.
+	 *
+	 * @param {object=} options - Options for this rate limiter
+	 * @param {number=} options.maxRate -
+	 *     Maximum rate of activations per second.
+	 * @param {function()=} options.action -
+	 *     Callback invoked at maste `maxRate` per second on activation.
+	 */
+	constructor(options = {}) {
+		/**
+		 * Maximum rate of activations per second.
+		 * @type {number}
+		 */
+		this.maxRate = options.maxRate || 1;
+
+		/**
+		 * Callback invoked at most `maxRate` per second on activation.
+		 * @type {function()}
+		 */
+		this.action = options.action || null;
+
+		this._lastRun = 0;
+		this._runTimeout = null;
+		this.lastProgressBroadcast = Date.now();
+	}
+
+	/**
+	 * Activate the rate limited action
+	 *
+	 * Checks if the invocation of the rate limited action now would fall
+	 * within the rate limit.  If it is within the limit then the action is
+	 * invoked immediatly, otherwise a timeout is registered to invoke the
+	 * action at next point in time where it will be within the rate limit.
+	 *
+	 * @returns {boolean} true if activation was within the rate limit.
+	 */
+	activate() {
+		let now = Date.now();
+		if (now < this._lastRun + 1000 / this.maxRate) {
+			if (!this._runTimeout && this.action !== null) {
+				this._runTimeout = setTimeout(() => {
+					this._runTimeout = null;
+					this._lastRun = Date.now();
+					this.action();
+				}, this._lastRun + 1000 / this.maxRate - now);
+			}
+			return false;
+		}
+
+		// We may end up activating before the timeout does.
+		if (this._runTimeout) {
+			clearTimeout(this._runTimeout);
+			this._runTimeout = null;
+		}
+
+		this._lastRun = now;
+		if (this.action !== null) {
+			this.action();
+		}
+		return true;
+	}
+
+	/**
+	 * Cancel pending action
+	 *
+	 * Cancel pending action invocation.  This is necessary when shutting
+	 * down the use of the rate limit as a timeout is registered to invoke
+	 * the next action when activated faster than the rate limit allows.
+	 */
+	cancel() {
+		if (this._runTimeout) {
+			clearTimeout(this._runTimeout);
+		}
+	}
+}
+
+module.exports = RateLimiter;

packages/lib/browser.js

@@ -0,0 +1,12 @@
+export { default as libConfig } from "./config";
+export { default as libErrors } from "./errors";
+export { default as libFactorio } from "./factorio/exchange_string";
+export { default as libHelpers } from "./helpers";
+export { default as libLink } from "./link";
+export { default as libLogging } from "./logging";
+export { default as libPlugin } from "./plugin";
+export { default as libSchema } from "./schema";
+export { default as libUsers } from "./users";
+
+export { default as ExponentialBackoff } from "./ExponentialBackoff";
+export { default as RateLimiter } from "./RateLimiter";

packages/lib/build_mod.js

@@ -0,0 +1,131 @@
+/* eslint-disable no-console */
+"use strict";
+const events = require("events");
+const fs = require("fs-extra");
+const JSZip = require("jszip");
+const klaw = require("klaw");
+const path = require("path");
+const yargs = require("yargs");
+
+
+async function buildMod(args, info) {
+	if (args.build) {
+		await fs.ensureDir(args.outputDir);
+		let modName = `${info.name}_${info.version}`;
+
+		if (args.pack) {
+			let zip = new JSZip();
+			let walker = klaw(args.sourceDir)
+				.on("data", item => {
+					if (item.stats.isFile()) {
+						// On Windows the path created uses backslashes as the directory sepparator
+						// but the zip file needs to use forward slashes.  We can't use the posix
+						// version of relative here as it doesn't work with Windows style paths.
+						let basePath = path.relative(args.sourceDir, item.path).replace(/\\/g, "/");
+						zip.file(path.posix.join(modName, basePath), fs.createReadStream(item.path));
+					}
+				})
+			;
+			await events.once(walker, "end");
+
+			for (let [fileName, pathParts] of Object.entries(info.additional_files || {})) {
+				let filePath = path.join(args.sourceDir, ...pathParts);
+				if (!await fs.pathExists(filePath)) {
+					throw new Error(`Additional file ${filePath} does not exist`);
+				}
+				zip.file(path.posix.join(modName, fileName), fs.createReadStream(filePath));
+			}
+			delete info.additional_files;
+
+			zip.file(path.posix.join(modName, "info.json"), JSON.stringify(info, null, 4));
+
+			let modPath = path.join(args.outputDir, `${modName}.zip`);
+			console.log(`Writing ${modPath}`);
+			let writeStream = zip.generateNodeStream().pipe(fs.createWriteStream(modPath));
+			await events.once(writeStream, "finish");
+
+		} else {
+			let modDir = path.join(args.outputDir, modName);
+			if (await fs.exists(modDir)) {
+				console.log(`Removing existing build ${modDir}`);
+				await fs.remove(modDir);
+			}
+			console.log(`Building ${modDir}`);
+			await fs.copy(args.sourceDir, modDir);
+			for (let [fileName, pathParts] of Object.entries(info.additional_files) || []) {
+				let filePath = path.join(...pathParts);
+				await fs.copy(filePath, path.join(modDir, fileName));
+			}
+			delete info.additional_files;
+
+			await fs.writeFile(path.join(modDir, "info.json"), JSON.stringify(info, null, 4));
+		}
+	}
+}
+
+async function build(args) {
+	let info = JSON.parse(await fs.readFile(path.join(args.sourceDir, "info.json")));
+
+	if (args.factorioVersion) {
+		info.factorio_version = args.factorioVersion;
+	}
+
+	if (args.dependencies) {
+		info.dependencies = args.dependencies;
+	}
+
+	if (args.clean) {
+		let splitter = /^(.*)_(\d+\.\d+\.\d+)(\.zip)?$/;
+		for (let entry of await fs.readdir(args.outputDir)) {
+			let match = splitter.exec(entry);
+			if (match) {
+				let [, name, version] = match;
+				if (name === info.name) {
+					let modPath = path.join(args.outputDir, entry);
+					console.log(`Removing ${modPath}`);
+					await fs.remove(modPath);
+				}
+			}
+		}
+	}
+
+	if (info.variants) {
+		for (let [variant, variantOverrides] of Object.entries(info.variants)) {
+			let variantInfo = {
+				...info,
+				...variantOverrides,
+			};
+			delete variantInfo.variants;
+			await buildMod(args, variantInfo);
+		}
+	} else {
+		await buildMod(args, info);
+	}
+}
+
+
+async function main() {
+	const args = yargs
+		.scriptName("build")
+		.options({
+			"clean": { describe: "Remove previous builds", type: "boolean", default: false },
+			"build": { describe: "Build mod(s)", type: "boolean", default: true },
+			"pack": { describe: "Pack into zip file", type: "boolean", default: true },
+			"source-dir": { describe: "Path to mod source files", nargs: 1, type: "string", demandOption: true },
+			"output-dir": { describe: "Path to output built mod(s)", nargs: 1, type: "string", default: "dist" },
+			"factorio-version": { describe: "Override factorio_version", type: "string" },
+		})
+		.strict()
+		.argv
+	;
+
+	await build(args);
+}
+
+if (module === require.main) {
+	main().catch(err => { console.log(err); });
+}
+
+module.exports = {
+	build,
+};

packages/lib/command.js

@@ -0,0 +1,248 @@
+/**
+ * Command library
+ *
+ * Data types and utilites for commands to clusterioctl's CLI.
+ *
+ * @author Hornwitser
+ * @module lib/command
+ */
+"use strict";
+const libLink = require("./link");
+const libErrors = require("./errors");
+
+/**
+ * Represents a command that can be runned by clusterioctl
+ * @static
+ */
+class Command {
+	/**
+	 * Define an executable command.
+	 *
+	 * @param {Object} cmd - Command definiton.
+	 * @param {Array} cmd.definiton -
+	 *     Arguments to pass to yargs .command method to define this
+	 *     command.
+	 * @param {function(args, control)} handler -
+	 *     Async function invoked when the command is executed.  Is given
+	 *     the parsed args and a reference to the {@link
+	 *     module:ctl/ctl.Control} instance.
+	 */
+	constructor({ definition, handler }) {
+		if (definition[0] instanceof Array) {
+			this.name = definition[0][0].split(" ")[0];
+			this.alias = definition[0].slice(1);
+		} else {
+			this.name = definition[0].split(" ")[0];
+			this.alias = [];
+		}
+		this._definition = definition;
+		this._handler = handler;
+	}
+
+	register(yargs) {
+		yargs.command(...this._definition);
+	}
+
+	async run(args, control) {
+		await this._handler(args, control);
+	}
+}
+
+/**
+ * A node in the command tree that can hold commands and sub trees
+ *
+ * Container which can contain {@link module:lib/command.Command}s and other
+ * CommandTrees.  This is used by clusterioctl to hold the full tree of
+ * available commands, you may extend this tree by using a control plugin,
+ * see {@link module:lib/plugin.BaseControlPlugin#addCommands}
+ *
+ * @static
+ */
+class CommandTree {
+	/**
+	 * Define a command containing sub commands.
+	 *
+	 * @param {Object} cmd - Command definition
+	 * @param {string} cmd.name - Name of the command.
+	 * @param {Array<string>} cmd.alias - Aliases for this tree.
+	 * @param {description} cmd.description -
+	 *     Descripton to provide for this command tree node.
+	 */
+	constructor({ name, alias, description }) {
+		if (typeof name !== "string") {
+			throw new Error("name must be a string");
+		}
+
+		this.name = name;
+		this.alias = alias || [];
+		this.description = description;
+		this.subCommands = new Map();
+	}
+
+	/**
+	 * Add a command or command tree to this tree
+	 *
+	 * @param {module:lib/command.Command|module:lib/command.CommandTree} command -
+	 *    The command to add to this command tree.
+	 */
+	add(command) {
+		if (this.subCommands.has(command.name)) {
+			throw new Error(`Command ${command.name} already exists`);
+		}
+		this.subCommands.set(command.name, command);
+		for (let alias of command.alias) {
+			if (this.subCommands.has(alias)) {
+				throw new Error(`Alias ${alias} for command ${command.name} already exists`);
+			}
+			this.subCommands.set(alias, command);
+		}
+	}
+
+	/**
+	 * Get a command or command tree from this tree
+	 *
+	 * @param {string} name -
+	 *     The name of the command or command tree to retrieve.
+	 * @return {?module:lib/command.Command|module:lib/command.CommandTree}
+	 *    The command to add to this command tree.
+	 */
+	get(name) {
+		return this.subCommands.get(name) || null;
+	}
+
+	/**
+	 * Insert the registered commands into the given yargs parser
+	 *
+	 * Traverses the the tree of sub-commands recursively and adds all of
+	 * them to the given yargs parser.
+	 *
+	 * @param {Object} yargs - yargs parser to register with.
+	 */
+	register(yargs) {
+		yargs.command([this.name].concat(this.alias), this.description, (yargs) => {
+			for (let [name, command] of this.subCommands) {
+				// Check if the entry is not an alias.
+				if (name === command.name) {
+					command.register(yargs);
+				}
+			}
+		}, () => {
+			yargs.showHelp();
+			yargs.exit();
+		});
+	}
+}
+
+
+/**
+ * Resolve a string into a slave ID
+ *
+ * Resolves a string with either an slave name or an id into an integer with
+ * the slave ID.
+ *
+ * @param {module:lib/link.Link} client - link to master server to query slave on.
+ * @param {string} slaveName - string with name or id of slave.
+ * @returns {number} slave ID.
+ * @static
+ */
+async function resolveSlave(client, slaveName) {
+	let slaveId;
+	if (/^-?\d+$/.test(slaveName)) {
+		slaveId = parseInt(slaveName, 10);
+	} else {
+		let response = await libLink.messages.listSlaves.send(client);
+		for (let slave of response.list) {
+			if (slave.name === slaveName) {
+				slaveId = slave.id;
+				break;
+			}
+		}
+
+		if (slaveId === undefined) {
+			throw new libErrors.CommandError(`No slave named ${slaveName}`);
+		}
+	}
+
+	return slaveId;
+}
+
+/**
+ * Resolve a string to an instance ID
+ *
+ * Resolves a string with either an instance name or an id into an integer
+ * with the instance ID.
+ *
+ * @param {module:lib/link.Link} client - link to master server to query instance on.
+ * @param {string} instanceName - string with name or id of instance.
+ * @returns {number} instance ID.
+ * @static
+ */
+async function resolveInstance(client, instanceName) {
+	let instanceId;
+	if (/^-?\d+$/.test(instanceName)) {
+		instanceId = parseInt(instanceName, 10);
+	} else {
+		let response = await libLink.messages.listInstances.send(client);
+		for (let instance of response.list) {
+			if (instance.name === instanceName) {
+				instanceId = instance.id;
+				break;
+			}
+		}
+
+		if (instanceId === undefined) {
+			throw new libErrors.CommandError(`No instance named ${instanceName}`);
+		}
+	}
+
+	return instanceId;
+}
+
+/**
+ * Retrieve role object from string
+ *
+ * Resolves a string with either a role name or an id into an object
+ * representing the role.
+ *
+ * @param {module:lib/link.Link} client - link to master server to query role on.
+ * @param {string} roleName - string with name or id of role.
+ * @returns {Object} Role info.
+ * @static
+ */
+async function retrieveRole(client, roleName) {
+	let response = await libLink.messages.listRoles.send(client);
+
+	let resolvedRole;
+	if (/^-?\d+$/.test(roleName)) {
+		let roleId = parseInt(roleName, 10);
+		for (let role of response.list) {
+			if (role.id === roleId) {
+				resolvedRole = role;
+				break;
+			}
+		}
+
+	} else {
+		for (let role of response.list) {
+			if (role.name === roleName) {
+				resolvedRole = role;
+				break;
+			}
+		}
+	}
+
+	if (!resolvedRole) {
+		throw new libErrors.CommandError(`No role named ${roleName}`);
+	}
+
+	return resolvedRole;
+}
+
+module.exports = {
+	Command,
+	CommandTree,
+
+	resolveSlave,
+	resolveInstance,
+	retrieveRole,
+};

packages/lib/config/classes.js

@@ -0,0 +1,834 @@
+// Configuration classes
+"use strict";
+
+const events = require("events");
+
+const isDeepStrictEqual = require("../is_deep_strict_equal");
+const { basicType } = require("../helpers");
+
+
+/**
+ * Invalid Access exception
+ *
+ * Exception class for when an access attempt is made to a field that
+ * does not permitt this access is done.
+ *
+ * @extends Error
+ * @memberof module:lib/config
+ */
+class InvalidAccess extends Error { };
+
+/**
+ * Invalid Value exception
+ *
+ * Exception class for when invalid values are attempted to be set on a
+ * field.
+ *
+ * @extends Error
+ * @memberof module:lib/config
+ */
+class InvalidValue extends Error { };
+
+/**
+ * Invalid Field exception
+ *
+ * Exception class for when a group or field that does not exist is
+ * attempted to be accessed.
+ *
+ * @extends Error
+ * @memberof module:lib/config
+ */
+class InvalidField extends Error { };
+
+/**
+ * Split the given string on the first instance of separator
+ *
+ * Splits `string` on the first instance of `separator` and returns an
+ * array consisting of the string up to the separator and the string
+ * after the separator.  Returns an array with the string and an empty
+ * string if the separator is not present.
+ *
+ * @param {string} separator - Separator to split string by.
+ * @param {string} string - String to split
+ * @returns {Array} string split on separator.
+ * @memberof module:lib/config
+ * @private
+ * @inner
+ */
+function splitOn(separator, string) {
+	let index = string.indexOf(separator);
+	if (index === -1) {
+		return [string, ""];
+	}
+	return [string.slice(0, index), string.slice(index + separator.length)];
+}
+
+/**
+ * Collection of config groups
+ *
+ * Represents a collection of ConfigGroup instances that can be
+ * managed as one.
+ *
+ * This is an EventEmitter with the following events:
+ * - fieldChanged -
+ *     invoked after a field has been updated in one of the config groups
+ *     belonging to this config.  Takes three parameters: group, field,
+ *     prev.
+ *
+ * @extends events.EventEmitter
+ *
+ * @memberof module:lib/config
+ */
+class Config extends events.EventEmitter {
+	/**
+	 * Create a new instance of the given config
+	 *
+	 * @param {string} location -
+	 *     Location to evaluate access for this instance from
+	 */
+	constructor(location) {
+		super();
+
+		if (!this.constructor._finalized) {
+			throw new Error(`Cannot instantiate incomplete Config class ${this.constructor.name}`);
+		}
+
+		if (typeof location !== "string") {
+			throw new Error("location must be a string");
+		}
+
+		this.location = location;
+		this._groups = new Map();
+		this._unknownGroups = new Map();
+	}
+
+	async init() {
+		for (let [name, GroupClass] of this.constructor._groups) {
+			if (!this._groups.has(name)) {
+				let group = new GroupClass(this);
+				await group.init();
+				this._groups.set(name, group);
+			}
+		}
+		this._initialized = true;
+	}
+
+	_validate(serializedConfig) {
+		if (basicType(serializedConfig) !== "object") {
+			throw new Error(`Expected object, not ${basicType(serializedConfig)} for config`);
+		}
+
+		if (basicType(serializedConfig.groups) !== "array") {
+			throw new Error(`Expected groups to be an array, not ${basicType(serializedConfig.groups)}`);
+		}
+	}
+
+	/**
+	 * Load config from a serialized object
+	 *
+	 * @param {object} serializedConfig - Serialized config to load.
+	 * @param {string=} location - Location used for access control.
+	 */
+	async load(serializedConfig, location = this.location) {
+		this._validate(serializedConfig);
+		for (let serializedGroup of serializedConfig.groups) {
+			let GroupClass = this.constructor._groups.get(serializedGroup.name);
+			if (!GroupClass) {
+				this._unknownGroups.set(serializedGroup.name, serializedGroup);
+				continue;
+			}
+
+			let group = new GroupClass(this);
+			await group.load(serializedGroup, location);
+			this._groups.set(group.name, group);
+		}
+
+		await this.init();
+	}
+
+	/**
+	 * Serialize the config to a plain JavaScript object
+	 *
+	 * @param {string=} location - Location used for access control.
+	 * @returns {Object} JSON serializable representation of the config.
+	 */
+	serialize(location = this.location) {
+		let groups = [...this._unknownGroups.values()];
+		for (let group of this._groups.values()) {
+			groups.push(group.serialize(location));
+		}
+
+		return { groups };
+	}
+
+	/**
+	 * Update the configuration based on a serialized config
+	 *
+	 * Updates all groups in the config with groups in the serialized
+	 * config passed.
+	 *
+	 * @param {Object} serializedConfig - Output from .serialize().
+	 * @param {boolean} notify - Invoke fieldChanged events if true.
+	 * @param {string=} location - Location used for access control.
+	 */
+	update(serializedConfig, notify, location = this.location) {
+		this._validate(serializedConfig);
+		for (let serializedGroup of serializedConfig.groups) {
+			let group = this._groups.get(serializedGroup.name);
+			if (group) {
+				group.update(serializedGroup, notify, location);
+			} else {
+				this._unknownGroups.set(serializedGroup.name, serializedGroup);
+			}
+		}
+	}
+
+	/**
+	 * Check if field can be accessed from the given location
+	 *
+	 * @param {string} name - Name of the field to check.
+	 * @param {string=} location - Location used for access control.
+	 * @returns {boolean} true if field is accessible
+	 */
+	canAccess(name, location = this.location) {
+		let [group, field] = splitOn(".", name);
+		return this.group(group).canAccess(field, location);
+	}
+
+	/**
+	 * Get the value for a config field
+	 *
+	 * @param {string} name - Name of field to get.
+	 * @param {string=} location - Location used for access control.
+	 * @returns {*} the value for the field.
+	 */
+	get(name, location = this.location) {
+		let [group, field] = splitOn(".", name);
+		return this.group(group).get(field, location);
+	}
+
+	/**
+	 * Set the value for a config field
+	 *
+	 * @param {string} name - Name of field to set.
+	 * @param {*} value - the value to set on field
+	 * @param {string=} location - Location used for access control.
+	 */
+	set(name, value, location = this.location) {
+		let [group, field] = splitOn(".", name);
+		this.group(group).set(field, value, location);
+	}
+
+	/**
+	 * Set property of an object value for a config field
+	 *
+	 * @param {string} name - Name of field to set property on.
+	 * @param {string} prop - Name of property to set on field.
+	 * @param {*} value - the value to set the property to.
+	 * @param {string=} location - Location used for access control.
+	 */
+	setProp(name, prop, value, location = this.location) {
+		let [group, field] = splitOn(".", name);
+		this.group(group).setProp(field, prop, value, location);
+	}
+
+	/**
+	 * Get the config group instance with the given name
+	 *
+	 * @param {string} name - Name of group to get.
+	 * @returns {module:lib/config.ConfigGroup} config group.
+	 */
+	group(name) {
+		if (!this._initialized) {
+			throw new Error(`${this.constructor.name} instance is uninitialized`);
+		}
+		let group = this._groups.get(name);
+		if (!group) {
+			throw new InvalidField(`No config group named '${name}'`);
+		}
+		return group;
+	}
+
+	static _initSubclass() {
+		// These properties are initialized here in order to ensure that
+		// they end up on the sub-class.
+		if (!this._initialized) {
+			this._initialized = true;
+			this._finalized = false;
+			this._groups = new Map();
+		}
+	}
+
+	/**
+	 * Mapping of group name to group class
+	 *
+	 * Returns the internal mapping of group names to group classes that
+	 * mave been registered with this config.  Note that mutating this
+	 * object will lead to unexpected behaviour.
+	 *
+	 * @returns {Map<string, GroupClass>} config groups
+	 */
+	static get groups() {
+		this._initSubclass();
+		return this._groups;
+	}
+
+	/**
+	 * Locks this Config class from adding more groups.
+	 */
+	static finalize() {
+		this._initSubclass();
+		this._finalized = true;
+	}
+
+	/**
+	 * Register a ConfigGroup with this Config
+	 *
+	 * Adds the ConfigGroup to this config as a group that will get
+	 * initialized, loaded and serialized with this config class.
+	 *
+	 * @param {module:lib/config.ConfigGroup} group - class to register.
+	 */
+	static registerGroup(group) {
+		this._initSubclass();
+
+		if (this._finalized) {
+			throw new Error("Cannot register group on finalized config");
+		}
+
+		if (!group._finalized) {
+			throw new Error("Group must be finalized before it can be registered");
+		}
+
+		if (this._groups.has(group.groupName)) {
+			throw new Error(`${group.groupName} has already been registered`);
+		}
+
+		this._groups.set(group.groupName, group);
+	}
+}
+
+
+/**
+ * Collection of related config entries
+ *
+ * Type checks and stores a collection of related config entries.  Attempt
+ * to set invalid values for fields will result in an error thrown while
+ * loading a config with invalid values will result in those being replaced
+ * by the innitial value for those fields.
+ *
+ * @memberof module:lib/config
+ */
+class ConfigGroup {
+	/**
+	 * Creates a new config group.
+	 *
+	 * After the creation of the new config group you have to call
+	 * either .init() or .load() on it in order to fully initialize it.
+	 *
+	 * @param {module:lib/config.Config} config -
+	 *     Parent config for this group instance.
+	 */
+	constructor(config) {
+		if (!this.constructor._finalized) {
+			throw new Error(`Cannot instantiate incomplete ConfigGroup class ${this.constructor.name}`);
+		}
+
+		this._fields = new Map();
+		this._unknownFields = new Map();
+		this.config = config;
+	}
+
+	/**
+	 * Check access for a field
+	 *
+	 * @param {object} def - definition for for the field to check.
+	 * @param {string} remote - location of remote access to check for.
+	 * @param {boolean} error - throw on failure to pass check.
+	 * @throws {module:lib/config.InvalidAccess}
+	 *     if access is not granted and error is true.
+	 * @returns {boolean} true if access is granted
+	 * @private
+	 */
+	_checkAccess(def, remote, error) {
+		for (let loc of [remote, this.config.location]) {
+			if (!def.access.includes(loc)) {
+				if (error) {
+					throw new InvalidAccess(`Field '${def.name}' is not accessible from ${loc}`);
+				} else {
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+	/**
+	 * Initialize new config group
+	 *
+	 * Computes and assigns the initial values for all fields of the
+	 * config group.
+	 */
+	async init() {
+		for (let [name, def] of this.constructor._definitions) {
+			if (this._fields.has(name)) {
+				continue;
+			}
+			if (!def.access.includes(this.config.location)) {
+				continue;
+			}
+
+			let value = null;
+			if (typeof def.initial_value === "function") {
+				value = await def.initial_value();
+
+			} else if (def.initial_value !== undefined) {
+				value = def.initial_value;
+			}
+
+			this._fields.set(name, value);
+		}
+	}
+
+	/**
+	 * Load from serialized group
+	 *
+	 * Loads all the values from the passed serialized version of the
+	 * group and then initializes any possible missing fields from it to
+	 * their default values.
+	 *
+	 * @param {Object} serializedGroup -
+	 *     Result from a previous call to .serialize().
+	 * @param {string=} location - Location used for access control.
+	 */
+	async load(serializedGroup, location = this.config.location) {
+		this.update(serializedGroup, false, location);
+		await this.init();
+	}
+
+	/**
+	 * Name of the group
+	 *
+	 * Shortcut for `group.constructor.groupName`
+	 */
+	get name() {
+		return this.constructor.groupName;
+	}
+
+	/**
+	 * Check if field can be accessed from the given location
+	 *
+	 * @param {string} name - Name of field to check.
+	 * @param {string=} location - Location used for access control.
+	 * @returns {boolean} true if field is accessible
+	 */
+	canAccess(name, location = this.config.location) {
+		let def = this.constructor._definitions.get(name);
+		if (!def) {
+			throw new InvalidField(`No field named '${name}'`);
+		}
+		return this._checkAccess(def, location, false);
+	}
+
+	/**
+	 * Get value for field
+	 *
+	 * @param {string} name - Name of field to get.
+	 * @param {string=} location - Location used for access control.
+	 * @returns {*} Value stored for the field.
+	 */
+	get(name, location = this.config.location) {
+		let def = this.constructor._definitions.get(name);
+		if (!def) {
+			throw new InvalidField(`No field named '${name}'`);
+		}
+		this._checkAccess(def, location, true);
+
+		return this._fields.get(name);
+	}
+
+	/**
+	 * Set value of field
+	 *
+	 * The field must be defined for the config group and the value is
+	 * type checked against the field definition.
+	 *
+	 * @param {string} name - Name of field to set.
+	 * @param {*} value - Value to set for field.
+	 * @param {string=} location - Location used for access control.
+	 * @throws {module:lib/config.InvalidField} if field is not defined.
+	 * @throws {module:lib/config.InvalidValue} if value is not allowed for the field.
+	 */
+	set(name, value, location = this.config.location) {
+		let def = this.constructor._definitions.get(name);
+		if (!def) {
+			throw new InvalidField(`No field named '${name}'`);
+		}
+		this._checkAccess(def, location, true);
+
+		// Empty strings are treates as null
+		if (value === "") {
+			value = null;
+		}
+
+		if (def.enum && !def.enum.includes(value)) {
+			throw new InvalidValue(`Expected one of [${def.enum.join(", ")}], not ${value}`);
+		}
+
+		if (basicType(value) === "string") {
+			if (def.type === "boolean") {
+				if (value === "true") {
+					value = true;
+				} else if (value === "false") {
+					value = false;
+				}
+
+			} else if (def.type === "number") {
+				let numberRegExp = /^[+-]?(Infinity|\d+\.(\d+)?([eE][+-]?\d+)?|\.?\d+([eE][+-]?\d+)?)$/;
+				if (numberRegExp.test(value.trim())) {
+					value = Number.parseFloat(value);
+				}
+
+			} else if (def.type === "object") {
+				try {
+					value = JSON.parse(value);
+				} catch (err) {
+					throw new InvalidValue(`Error parsing value for ${name}: ${err.message}`);
+				}
+			}
+		}
+
+		if (value === null) {
+			if (!def.optional) {
+				throw new InvalidValue(`Field ${name} cannot be null`);
+			}
+
+		} else if (basicType(value) !== def.type) {
+			throw new InvalidValue(`Expected type of ${name} to be ${def.type}, not ${basicType(value)}`);
+		}
+
+		let prev = this._fields.get(name);
+		this._fields.set(name, value);
+		if (this.config && !isDeepStrictEqual(value, prev)) {
+			this.config.emit("fieldChanged", this, name, prev);
+		}
+	}
+
+	/**
+	 * Set property of object field
+	 *
+	 * Update value of stored object field by setting the specified property
+	 * on it.  The field must be defined as an object for the config group.
+	 *
+	 * @param {string} name - Name of field to set property on.
+	 * @param {string} prop - Name of property to set on field.
+	 * @param {*} value - the value to set the property to.
+	 * @param {string=} location - Location used for access control.
+	 * @throws {module:lib/config.InvalidField} if field is not defined.
+	 * @throws {module:lib/config.InvalidValue} if field is not an object.
+	 */
+	setProp(name, prop, value, location = this.config.location) {
+		let def = this.constructor._definitions.get(name);
+		if (!def) {
+			throw new InvalidField(`No field named '${name}'`);
+		}
+		this._checkAccess(def, location, true);
+
+		if (def.type !== "object") {
+			throw new InvalidValue(`Cannot set property on non-object field '${name}'`);
+		}
+
+		let prev = this._fields.get(name);
+		let updated = {...prev || {}};
+
+		if (value !== undefined) {
+			updated[prop] = value;
+		} else {
+			delete updated[prop];
+		}
+		this._fields.set(name, updated);
+		if (this.config && !isDeepStrictEqual(updated, prev)) {
+			this.config.emit("fieldChanged", this, name, prev);
+		}
+	}
+
+	/**
+	 * Update a config group from a serialized group
+	 *
+	 * Overwrites the values of all the fields in this config group that
+	 * has a valid value in the passed serialized group with that value.
+	 *
+	 * @param {Object} serializedGroup -
+	 *     Result from a previous call to .serialize().
+	 * @param {boolean} notify - Invoke fieldChanged events if true.
+	 * @param {string=} location - Location used for access control.
+	 */
+	update(serializedGroup, notify, location = this.config.location) {
+		if (basicType(serializedGroup) !== "object") {
+			throw new Error(`Expected object, not ${basicType(serializedGroup)} for ConfigGroup`);
+		}
+
+		if (serializedGroup.name !== this.name) {
+			throw new Error(`Expected group name ${this.name}, not ${serializedGroup.name}`);
+		}
+
+		if (basicType(serializedGroup.fields) !== "object") {
+			throw new Error(`Expected fields to be an object, not ${basicType(serializedGroup.fields)}`);
+		}
+
+		for (let [name, value] of Object.entries(serializedGroup.fields)) {
+			let def = this.constructor._definitions.get(name);
+			if (!def) {
+				this._unknownFields.set(name, value);
+				continue;
+			}
+
+			if (!this._checkAccess(def, location, false)) {
+				continue;
+			}
+
+			if (def.optional) {
+				if (value !== null && basicType(value) !== def.type) {
+					continue;
+				}
+
+			} else if (basicType(value) !== def.type) {
+				continue;
+			}
+
+			if (def.enum && !def.enum.includes(value)) {
+				continue;
+			}
+
+			let prev = this._fields.get(name);
+			this._fields.set(name, value);
+			if (notify && this.config && !isDeepStrictEqual(value, prev)) {
+				this.config.emit("fieldChanged", this, name, prev);
+			}
+		}
+	}
+
+	/**
+	 * Serialize the config to a plain JavaScript object
+	 *
+	 * @param {string=} location - Location used for access control.
+	 * @returns {Object} JSON serializable representation of the group.
+	 */
+	serialize(location = this.config.location) {
+		let fields = {};
+		for (let [name, value] of this._fields) {
+			let def = this.constructor._definitions.get(name);
+			if (!this._checkAccess(def, location, false)) {
+				continue;
+			}
+
+			fields[name] = value;
+		}
+
+		for (let [name, value] of this._unknownFields) {
+			fields[name] = value;
+		}
+
+		return {
+			name: this.name,
+			fields,
+		};
+	}
+
+	static _initSubclass() {
+		// These properties are initialized here in order to ensure that
+		// they end up on the sub-class.
+		if (!this._initialized) {
+			this._initialized = true;
+			this._definitions = new Map();
+		}
+	}
+
+	/**
+	 * Mapping of config name to field meta data
+	 *
+	 * Returns the internal meta data for the fields of this class.
+	 * Note that mutating this object will lead to unexpected behaviour.
+	 *
+	 * @returns {Map<string, Object>} field meta data
+	 */
+	static get definitions() {
+		this._initSubclass();
+		return this._definitions;
+	}
+
+	/**
+	 * Define a new configuration field
+	 *
+	 * @param {Object} item - Field definition.
+	 * @param {Array<string>=} item.access -
+	 *     Array of strings declaring where this config entry can be read
+	 *     and modified from.
+	 * @param {string} item.type -
+	 *     string declaring the type of the config value, supports
+	 *     boolean, string, number and object.
+	 * @param {string} item.name -
+	 *     Name of the configuration field.  Should follow the
+	 *     lower_case_underscore style.
+	 * @param {string} item.title -
+	 *     Text used to identify the config field in user interfaces.
+	 * @param {string} item.description -
+	 *     Text used to describe the config field in user interfaces.
+	 * @param {Array=} item.enum -
+	 *     Array of all values that are acceptible.  Useful for making
+	 *     enumerated values.
+	 * @param {boolean=} item.optional -
+	 *     True if this field can be set to null.  Defaults to false.
+	 * @param {*=} item.initial_value -
+	 *     Value this config field should take in a newly initialized
+	 *     config.  This can also be an async function returning the
+	 *     value to use.
+	 */
+	static define(item) {
+		if (this._finalized) {
+			throw new Error(`Cannot define field for ConfigGroup class ${this.name} after it has been finalized`);
+		}
+
+		if (basicType(this.groupName) !== "string") {
+			throw new Error(`Expected ConfigGroup class ${this.name} to have the groupName property set to a string`);
+		}
+
+		this._initSubclass();
+
+		let itemKeys = Object.keys(item);
+
+		// Check for required properties
+		["name", "type"].forEach(prop => {
+			if (!itemKeys.includes(prop)) {
+				throw new Error(`${prop} is required when defining an field`);
+			}
+		});
+
+		// Validate properties
+		let validTypes = ["boolean", "string", "number", "object"];
+		Object.keys(item).forEach(key => {
+			let value = item[key];
+			let valueType = basicType(value);
+			switch (key) {
+				case "type":
+					if (!validTypes.includes(value)) {
+						throw new Error(`${value} is not a valid type`);
+					}
+					break;
+
+				case "access":
+					if (valueType !== "array") {
+						throw new Error("access must be an array");
+					}
+					break;
+
+				case "enum":
+					if (valueType !== "array") {
+						throw new Error("enum must be an array");
+					}
+					break;
+
+				case "name":
+					if (valueType !== "string") {
+						throw new Error("name must be a string");
+					}
+					break;
+
+				case "title":
+					if (valueType !== "string") {
+						throw new Error("title must be a string");
+					}
+					break;
+
+				case "description":
+					if (valueType !== "string") {
+						throw new Error("description must be a string");
+					}
+					break;
+
+				case "optional":
+					if (valueType !== "boolean") {
+						throw new Error("optional must be a boolean");
+					}
+					break;
+
+				case "initial_value":
+					if (valueType !== item.type && valueType !== "function") {
+						throw new Error("initial_value must match the type or be a function");
+					}
+					break;
+
+				default:
+					throw new Error(`Unknown property ${key}`);
+			}
+		});
+
+		if (this._definitions.has(item.name)) {
+			throw new Error(`Config field ${item.name} has already been defined`);
+		}
+
+		let computed = {
+			access: this.defaultAccess,
+			optional: false,
+			fullName: `${this.groupName}.${item.name}`,
+			...item,
+		};
+
+		if (!computed.access) {
+			throw new Error(`access not set and no defaultAccess defined for ${this.name}`);
+		}
+
+		if (!computed.optional && computed.initial_value === undefined) {
+			throw new Error(`Non-optional field ${item.name} needs an initial_value`);
+		}
+
+		this._definitions.set(item.name, computed);
+	}
+
+	/**
+	 * Locks this ConfigGroup class from adding more definitons.
+	 */
+	static finalize() {
+		if (basicType(this.groupName) !== "string") {
+			throw new Error(`Expected ConfigGroup class ${this.name} to have the groupName property set to a string`);
+		}
+
+		this._initSubclass();
+		this._finalized = true;
+	}
+}
+
+/**
+ * Config group for plugins
+ *
+ * Grouping that includes per plugin fields clusterio uses to manage
+ * plugins.  This is currently only the enabled field.  It is otherwise
+ * identical to the ConfigGroup class.
+ *
+ * @extends module:lib/config.ConfigGroup
+ * @memberof module:lib/config
+ */
+class PluginConfigGroup extends ConfigGroup {
+	static _initSubclass() {
+		if (!this._initialized) {
+			super._initSubclass();
+			this.define({
+				name: "load_plugin",
+				title: "Load Plugin",
+				type: "boolean",
+				initial_value: true,
+			});
+		}
+	}
+}
+
+
+module.exports = {
+	InvalidAccess,
+	InvalidField,
+	InvalidValue,
+
+	Config,
+	ConfigGroup,
+	PluginConfigGroup,
+};

packages/lib/config/definitions.js

@@ -0,0 +1,454 @@
+// Core definitions for the configuration system
+"use strict";
+
+const classes = require("./classes");
+
+
+/**
+ * Master config group for {@link module:lib/config.MasterConfig}
+ * @extends module:lib/config.ConfigGroup
+ * @memberof module:lib/config
+ */
+class MasterGroup extends classes.ConfigGroup { }
+MasterGroup.defaultAccess = ["master", "slave", "control"];
+MasterGroup.groupName = "master";
+MasterGroup.define({
+	name: "name",
+	title: "Name",
+	description: "Name of the cluster",
+	type: "string",
+	initial_value: "Your Cluster",
+});
+MasterGroup.define({
+	name: "database_directory",
+	title: "Database directory",
+	description: "Directory where item and configuration data is stored.",
+	type: "string",
+	initial_value: "database",
+});
+MasterGroup.define({
+	name: "http_port",
+	title: "HTTP Port",
+	description: "Port to listen for HTTP connections on, set to null to not listen for HTTP connections.",
+	type: "number",
+	optional: true,
+	initial_value: 8080,
+});
+MasterGroup.define({
+	name: "https_port",
+	title: "HTTPS Port",
+	description: "Port to listen for HTTPS connection on, set to null to not listen for HTTPS connections.",
+	type: "number",
+	optional: true,
+});
+MasterGroup.define({
+	name: "bind_address",
+	title: "Bind Address",
+	description: "IP address to bind the HTTP and HTTPS ports on.",
+	type: "string",
+	optional: true,
+});
+MasterGroup.define({
+	name: "external_address",
+	title: "External Address",
+	description: "Public facing address the master server is hosted on.",
+	type: "string",
+	optional: true,
+});
+MasterGroup.define({
+	name: "tls_certificate",
+	title: "TLS Certificate",
+	description: "Path to the certificate to use for HTTPS.",
+	type: "string",
+	optional: true,
+});
+MasterGroup.define({
+	name: "tls_private_key",
+	title: "TLS Private Key",
+	description: "Path to the private key to use for HTTPS.",
+	type: "string",
+	optional: true,
+});
+MasterGroup.define({
+	access: ["master"],
+	name: "auth_secret",
+	title: "Master Authentication Secret",
+	description:
+		"Secret used to generate and verify authentication tokens.  " +
+		"Should be a long string of random letters and numbers.  " +
+		"Do not share this.",
+	type: "string",
+	optional: true,
+});
+MasterGroup.define({
+	name: "heartbeat_interval",
+	title: "Heartbeat Interval",
+	description: "Interval heartbeats are sent out on WebSocket connections",
+	type: "number",
+	initial_value: 15,
+});
+MasterGroup.define({
+	name: "session_timeout",
+	title: "Session Timeout",
+	description: "Time in seconds before giving up resuming a dropped WebSocket session.",
+	type: "number",
+	initial_value: 60,
+});
+MasterGroup.define({
+	name: "metrics_timeout",
+	title: "Metrics Timeout",
+	description: "Timeout in seconds for metrics gathering from slaves",
+	type: "number",
+	initial_value: 8,
+});
+MasterGroup.define({
+	name: "proxy_stream_timeout",
+	title: "Proxy Stream Timeout",
+	description: "Timeout in seconds for proxy streams to start flowing",
+	type: "number",
+	initial_value: 15,
+});
+MasterGroup.define({
+	name: "default_role_id",
+	title: "Default role",
+	description: "ID of role assigned by default to new users",
+	type: "number",
+	optional: true,
+	initial_value: 1,
+});
+MasterGroup.finalize();
+
+/**
+ * Master Config class
+ * @extends module:lib/config.Config
+ * @memberof module:lib/config
+ */
+class MasterConfig extends classes.Config { }
+MasterConfig.registerGroup(MasterGroup);
+
+
+/**
+ * Slave config group for {@link module:lib/config.SlaveConfig}
+ * @extends module:lib/config.ConfigGroup
+ * @memberof module:lib/config
+ */
+class SlaveGroup extends classes.ConfigGroup {}
+SlaveGroup.defaultAccess = ["master", "slave", "control"];
+SlaveGroup.groupName = "slave";
+SlaveGroup.define({
+	name: "name",
+	description: "Name of the slave",
+	type: "string",
+	initial_value: "New Slave",
+});
+SlaveGroup.define({
+	name: "id",
+	description: "ID of the slave",
+	type: "number",
+	initial_value: () => Math.random() * 2**31 | 0,
+});
+SlaveGroup.define({
+	name: "factorio_directory",
+	description: "Path to directory to look for factorio installs",
+	type: "string",
+	initial_value: "factorio",
+});
+SlaveGroup.define({
+	name: "instances_directory",
+	description: "Path to directory to store instances in.",
+	type: "string",
+	initial_value: "instances",
+});
+SlaveGroup.define({
+	name: "master_url",
+	description: "URL to connect to the master server at",
+	type: "string",
+	initial_value: "http://localhost:8080/",
+});
+SlaveGroup.define({
+	name: "master_token",
+	description: "Token to authenticate to master server with.",
+	type: "string",
+	initial_value: "enter token here",
+});
+SlaveGroup.define({
+	name: "tls_ca",
+	description: "Path to Certificate Authority to validate TLS connection to master against.",
+	type: "string",
+	optional: true,
+});
+SlaveGroup.define({
+	name: "public_address",
+	description: "Public facing address players should connect to in order to join instances on this slave",
+	type: "string",
+	initial_value: "localhost",
+});
+SlaveGroup.define({
+	name: "max_reconnect_delay",
+	title: "Max Reconnect Delay",
+	description: "Maximum delay to wait before attempting to reconnect WebSocket",
+	type: "number",
+	initial_value: 60,
+});
+SlaveGroup.finalize();
+
+/**
+ * Slave Config class
+ * @extends module:lib/config.Config
+ * @memberof module:lib/config
+ */
+class SlaveConfig extends classes.Config { }
+SlaveConfig.registerGroup(SlaveGroup);
+
+
+/**
+ * Instance config group for {@link module:lib/config.InstanceConfig}
+ * @extends module:lib/config.ConfigGroup
+ * @memberof module:lib/config
+ */
+class InstanceGroup extends classes.ConfigGroup { }
+InstanceGroup.defaultAccess = ["master", "slave", "control"];
+InstanceGroup.groupName = "instance";
+InstanceGroup.define({
+	name: "name",
+	type: "string",
+	initial_value: "New Instance",
+});
+InstanceGroup.define({
+	name: "id",
+	description: "ID of the slave",
+	type: "number",
+	initial_value: () => Math.random() * 2**31 | 0,
+});
+InstanceGroup.define({
+	name: "assigned_slave",
+	type: "number",
+	optional: true,
+});
+InstanceGroup.define({
+	name: "auto_start",
+	description: "Automatically start this instance when the slave hosting it is started up",
+	type: "boolean",
+	initial_value: false,
+});
+InstanceGroup.finalize();
+
+/**
+ * Factorio config group for {@link module:lib/config.InstanceConfig}
+ * @extends module:lib/config.ConfigGroup
+ * @memberof module:lib/config
+ */
+class FactorioGroup extends classes.ConfigGroup { }
+FactorioGroup.defaultAccess = ["master", "slave", "control"];
+FactorioGroup.groupName = "factorio";
+FactorioGroup.define({
+	name: "version",
+	description: "Version of the game to run, use latest to run the latest installed version",
+	type: "string",
+	initial_value: "latest",
+});
+FactorioGroup.define({
+	name: "game_port",
+	description: "UDP port to run game on, uses a random port if null",
+	type: "number",
+	optional: true,
+});
+FactorioGroup.define({
+	name: "rcon_port",
+	description: "TCP port to run RCON on, uses a random port if null",
+	type: "number",
+	optional: true,
+});
+FactorioGroup.define({
+	name: "rcon_password",
+	description: "Password for RCON, randomly generated if null",
+	type: "string",
+	optional: true,
+});
+FactorioGroup.define({
+	name: "enable_save_patching",
+	description: "Patch saves with Lua code. Required for Clusterio integrations, lua modules, and most plugins.",
+	type: "boolean",
+	initial_value: true,
+});
+FactorioGroup.define({
+	name: "enable_whitelist",
+	description: "Turn on whitelist for joining the server.",
+	type: "boolean",
+	initial_value: false,
+});
+FactorioGroup.define({
+	name: "settings",
+	description: "Settings overridden in server-settings.json",
+	type: "object",
+	initial_value: {}, // See create instance handler in master.
+});
+FactorioGroup.define({
+	name: "verbose_logging",
+	description: "Enable verbose logging on the Factorio server",
+	type: "boolean",
+	initial_value: false,
+});
+FactorioGroup.define({
+	name: "strip_paths",
+	description: "Strip down instance paths in the log",
+	type: "boolean",
+	initial_value: true,
+});
+FactorioGroup.define({
+	name: "sync_adminlist",
+	description: "Synchronize adminlist with master server",
+	type: "boolean",
+	initial_value: true,
+});
+FactorioGroup.define({
+	name: "sync_whitelist",
+	description: "Synchronize whitelist with master server",
+	type: "boolean",
+	initial_value: true,
+});
+FactorioGroup.define({
+	name: "sync_banlist",
+	description: "Synchronize banlist with master server",
+	type: "boolean",
+	initial_value: true,
+});
+FactorioGroup.define({
+	name: "max_concurrent_commands",
+	description: "Maximum number of RCON commands trasmitted in parallel",
+	type: "number",
+	initial_value: 5,
+});
+FactorioGroup.finalize();
+
+/**
+ * Instance config class
+ * @extends module:lib/config.Config
+ * @memberof module:lib/config
+ */
+class InstanceConfig extends classes.Config { }
+InstanceConfig.registerGroup(InstanceGroup);
+InstanceConfig.registerGroup(FactorioGroup);
+
+
+/**
+ * Control config group for {@link module:lib/config.ControlConfig}
+ * @extends module:lib/config.ConfigGroup
+ * @memberof module:lib/config
+ */
+class ControlGroup extends classes.ConfigGroup {}
+ControlGroup.defaultAccess = ["control"];
+ControlGroup.groupName = "control";
+ControlGroup.define({
+	name: "master_url",
+	description: "URL to connect to the master server at",
+	type: "string",
+	optional: true,
+});
+ControlGroup.define({
+	name: "master_token",
+	description: "Token to authenticate to master server with.",
+	type: "string",
+	optional: true,
+});
+ControlGroup.define({
+	name: "tls_ca",
+	description: "Path to Certificate Authority to validate TLS connection to master against.",
+	type: "string",
+	optional: true,
+});
+ControlGroup.define({
+	name: "max_reconnect_delay",
+	title: "Max Reconnect Delay",
+	description: "Maximum delay to wait before attempting to reconnect WebSocket",
+	type: "number",
+	initial_value: 60,
+});
+ControlGroup.finalize();
+
+/**
+ * Control config class
+ * @extends module:lib/config.Config
+ * @memberof module:lib/config
+ */
+class ControlConfig extends classes.Config { }
+ControlConfig.registerGroup(ControlGroup);
+
+
+function validateGroup(pluginInfo, groupName) {
+	if (!pluginInfo[groupName] instanceof classes.PluginConfigGroup) {
+		throw new Error(
+			`Expected ${groupName} for ${pluginInfo.name} to be an instance of PluginConfigGroup`
+		);
+	}
+
+	if (pluginInfo[groupName].groupName !== pluginInfo.name) {
+		throw new Error(
+			`Expected ${groupName} for ${pluginInfo.name} to be named after the plugin`
+		);
+	}
+}
+
+/**
+ * Registers the config groups for the provided plugin infos
+ *
+ * @param {Array<Object>} pluginInfos - Array of plugin info objects.
+ * @memberof module:lib/config
+ */
+function registerPluginConfigGroups(pluginInfos) {
+	for (let pluginInfo of pluginInfos) {
+		if (pluginInfo.MasterConfigGroup) {
+			validateGroup(pluginInfo, "MasterConfigGroup");
+			MasterConfig.registerGroup(pluginInfo.MasterConfigGroup);
+
+		} else {
+			class MasterConfigGroup extends classes.PluginConfigGroup { }
+			MasterConfigGroup.defaultAccess = ["master", "slave", "control"];
+			MasterConfigGroup.groupName = pluginInfo.name;
+			MasterConfigGroup.finalize();
+			MasterConfig.registerGroup(MasterConfigGroup);
+		}
+
+		if (pluginInfo.instanceEntrypoint) {
+			if (pluginInfo.InstanceConfigGroup) {
+				validateGroup(pluginInfo, "InstanceConfigGroup");
+				InstanceConfig.registerGroup(pluginInfo.InstanceConfigGroup);
+
+			} else {
+				class InstanceConfigGroup extends classes.PluginConfigGroup { }
+				InstanceConfigGroup.defaultAccess = ["master", "slave", "control"];
+				InstanceConfigGroup.groupName = pluginInfo.name;
+				InstanceConfigGroup.finalize();
+				InstanceConfig.registerGroup(InstanceConfigGroup);
+			}
+		}
+	}
+}
+
+/**
+ * Lock configs from adding more groups and make them usable
+ *
+ * @memberof module:lib/config
+ */
+function finalizeConfigs() {
+	MasterConfig.finalize();
+	SlaveConfig.finalize();
+	InstanceConfig.finalize();
+	ControlConfig.finalize();
+}
+
+module.exports = {
+	MasterGroup,
+	SlaveGroup,
+	InstanceGroup,
+	FactorioGroup,
+	ControlGroup,
+
+	MasterConfig,
+	SlaveConfig,
+	InstanceConfig,
+	ControlConfig,
+
+	registerPluginConfigGroups,
+	finalizeConfigs,
+};

packages/lib/config/index.js

@@ -0,0 +1,13 @@
+/**
+ * Configuration System
+ * @author Hornwitser
+ * @module lib/config
+ */
+"use strict";
+const classes = require("./classes");
+const definitions = require("./definitions");
+
+module.exports = {
+	...classes,
+	...definitions,
+};

packages/lib/database.js

@@ -0,0 +1,287 @@
+/**
+ * Implementation of master databases
+ *
+ * @module lib/database
+ * @author Hornwitser
+ */
+
+"use strict";
+const fs = require("fs-extra");
+
+const { basicType } = require("./helpers");
+
+
+/**
+ * Converts a Map with only string keys to a JavaScript object.
+ *
+ * @param {Map} map - the Map to convert to an object.
+ * @return {object} - Object with the mapping's key-values as properties.
+ * @throws {Error} if there are non-string keys in map.
+ */
+function mapToObject(map) {
+	let obj = {};
+	for (let [key, value] of map) {
+		if (typeof key !== "string") {
+			throw new Error(
+				`Expected all keys to be string but got ${typeof key}`
+			);
+		}
+
+		obj[key] = value;
+	}
+	return obj;
+}
+
+/**
+ * Load JSON object file as a Map
+ *
+ * Loads the JSON file specified by path containing an object with
+ * properties as key value pairs and converts it into a JavaScript Map.
+ * Returns an empty Map if the file does not exist.
+ *
+ * @param {string} filePath - The path to the JSON file to load.
+ * @throws {Error} If JSON file did not contain an object.
+ * @throws {Error} If an error occured reading the file.
+ */
+async function loadJsonAsMap(filePath) {
+	try {
+		let content = await fs.readFile(filePath);
+		let parsed = JSON.parse(content);
+
+		if (basicType(parsed) !== "object") {
+			throw new Error(`Expected object but got ${basicType(parsed)}`);
+		}
+
+		return new Map(Object.entries(parsed));
+
+	} catch (err) {
+		if (err.code === "ENOENT") {
+			// File does not exist, return empty map
+			return new Map();
+
+		}
+		throw err;
+	}
+}
+
+/**
+ * Save a Map as a JSON object file
+ *
+ * Save the content of a key-value Map with only string keys as a JSON file.
+ * If the directory the file is to be saved into doesn't exist it will be
+ * created.
+ *
+ * @param {string} filePath - The path to the JSON file that will be saved.
+ * @param {Map} map - Map with only string keys to save.
+ * @throws {Error} if there are non-string keys in map.
+ * @throws {Error} if an error occured writing to the file.
+ */
+async function saveMapAsJson(filePath, map) {
+	let obj = mapToObject(map);
+	await fs.outputFile(filePath, JSON.stringify(obj, null, 4));
+}
+
+/**
+ * Load JSON array file as a Map
+ *
+ * Loads the JSON file specified by path containing an array of objects that
+ * each have an id property into a Map from the id to the object.
+ *
+ * @param {string} filePath - The path to the JSON file to load.
+ * @throws {Error} If JSON file did not contain an array.
+ * @throws {Error} If there are objects in the array without an id property.
+ * @throws {Error} If an error occured reading the file.
+ */
+async function loadJsonArrayAsMap(filePath) {
+	try {
+		let content = await fs.readFile(filePath);
+		let parsed = JSON.parse(content);
+
+		if (basicType(parsed) !== "array") {
+			throw new Error(`Expected array but got ${basicType(parsed)}`);
+		}
+
+		let map = new Map();
+		for (let element of parsed) {
+			if (basicType(element) !== "object") {
+				throw new Error("Expected all elements to be objects");
+			}
+
+			if (element.id === undefined) {
+				throw new Error("Expected all elements to have an id property");
+			}
+
+			map.set(element.id, element);
+		}
+		return map;
+
+	} catch (err) {
+		if (err.code === "ENOENT") {
+			// File does not exist, return empty map
+			return new Map();
+
+		}
+		throw err;
+	}
+}
+
+/**
+ * Save a Map as a JSON array file
+ *
+ * Save the values of a Map with objects containing an id property that is
+ * equal to the key the objects are stored at into a JSON file.
+ *
+ * @param {string} filePath - The path to the JSON file that will be saved.
+ * @param {Map} map -
+ *     Map with objects containing an id property equal to the key they are
+ *     stored under.
+ * @throws {Error} if an error occured writing to the file.
+ */
+async function saveMapAsJsonArray(filePath, map) {
+	await fs.outputFile(filePath, JSON.stringify([...map.values()], null, 4));
+}
+
+
+function checkName(name) {
+	if (typeof name !== "string") {
+		throw new Error("name must be a string");
+	}
+}
+
+function checkCount(count) {
+	if (typeof count !== "number" || isNaN(count)) {
+		throw new Error("count must be a number");
+	}
+}
+
+
+/**
+ * Item database
+ *
+ * Stores counts of items for the master server.  Items that have not been
+ * stored in the database are treated as having a stored count of zero.  When
+ * serialized the database discards entries with a zero counts, and when
+ * deserialized the content is verified.
+ */
+class ItemDatabase {
+
+	/**
+	 * Create a new item database
+	 *
+	 * @param {object|undefined} serialized - An object from a previous call to
+	 *     {@link module:lib/database~ItemDatabase#serialize} to restore the
+	 *     database from.  An empty database will be created if this parameter
+	 *     is left undefined.
+	 */
+	constructor(serialized) {
+		this._items = new Map();
+
+		// Verify the content of the serialized database
+		if (serialized !== undefined) {
+			for (let [name, count] of Object.entries(serialized)) {
+				checkName(name);
+				checkCount(count);
+
+				this._items.set(name, count);
+			}
+		}
+	}
+
+	/**
+	 * Serialize item database
+	 *
+	 * Serialize the item database into a plain JavaScript object that can be
+	 * turned inta a string with JSON.stringify().
+	 *
+	 * @returns {object} Serialized representation of the database
+	 */
+	serialize() {
+		let obj = {};
+		for (let [name, count] of this._items) {
+			if (count !== 0) {
+				obj[name] = count;
+			}
+		}
+		return obj;
+	}
+
+	/**
+	 * Approximate size of the items database.
+	 *
+	 * Does not account for entries being zero in the item database.
+	 */
+	get size() {
+		return this._items.size;
+	}
+
+
+	/**
+	 * Get the count of an item stored in the database
+	 *
+	 * Returns the count of a given item that has been stored in to the
+	 * database.  If the item has not been previously stored into the database
+	 * then 0 is returned.
+	 *
+	 * @param {string} name - The name of the item to get the count of.
+	 * @returns {number} The count of the item stored.
+	 */
+	getItemCount(name) {
+		checkName(name);
+
+		if (!this._items.has(name)) {
+			return 0;
+		}
+
+		return this._items.get(name);
+	}
+
+	/**
+	 * Adds count of an item to the database
+	 *
+	 * Add count copies of the item specified by name to the item database.
+	 *
+	 * @param {string} name - The name of the item to add.
+	 * @param {number} count - The count of item to remove.
+	 */
+	addItem(name, count) {
+		checkName(name);
+		checkCount(count);
+
+		if (this._items.has(name)) {
+			count += this._items.get(name);
+		}
+
+		this._items.set(name, count);
+	};
+
+	/**
+	 * Removes count of an item from the database.
+	 *
+	 * Remove count copies of the item specified by name from the item database
+	 * If count is greater than the currently stored count the stored item
+	 * count will become negative.
+	 *
+	 * @param {string} name - The name of the item to remove.
+	 * @param {number} count - The count of items to remove.
+	 */
+	removeItem(name, count) {
+		checkName(name);
+		checkCount(count);
+
+		count = -count;
+		if (this._items.has(name)) {
+			count += this._items.get(name);
+		}
+
+		this._items.set(name, count);
+	};
+}
+
+module.exports = {
+	mapToObject,
+	loadJsonAsMap,
+	saveMapAsJson,
+	loadJsonArrayAsMap,
+	saveMapAsJsonArray,
+	ItemDatabase,
+};

packages/lib/errors.js

@@ -0,0 +1,86 @@
+/**
+ * Errors thrown in Clusterio
+ * @module lib/errors
+ */
+"use strict";
+
+/**
+ * Thrown by commands when they fail
+ * @static
+ */
+class CommandError extends Error { }
+
+/**
+ * Thrown from requests sent when an error occured handling it
+ * @static
+ */
+class RequestError extends Error { }
+
+/**
+ * Thrown when a permission check fails.
+ *
+ * Is a subclass of RequestError to prevent logging stack traces when
+ * requests fail due to permission denied.
+ *
+ * @static
+ */
+class PermissionError extends RequestError { }
+
+/**
+ * Signal for messages that fail validation
+ * @static
+ */
+class InvalidMessage extends Error {
+	constructor(msg, errors) {
+		super(msg);
+		this.errors = errors || null;
+	}
+}
+
+/**
+ * Thrown from requests when the session it was sent on was lost
+ * @static
+ */
+class SessionLost extends Error { }
+
+/**
+ * Thrown when WebSocket authentication failed
+ * @static
+ */
+class AuthenticationFailed extends Error { }
+
+/**
+ * Errror class for known errors occuring during startup
+ * @static
+ */
+class StartupError extends Error { }
+
+/**
+ * Errors outside of our control
+ * @static
+ */
+class EnvironmentError extends Error { }
+
+/**
+ * Errors caused by plugins
+ * @static
+ */
+class PluginError extends Error {
+	constructor(pluginName, original) {
+		super(`PluginError: ${original.message}`);
+		this.pluginName = pluginName;
+		this.original = original;
+	}
+}
+
+module.exports = {
+	CommandError,
+	RequestError,
+	PermissionError,
+	InvalidMessage,
+	SessionLost,
+	AuthenticationFailed,
+	StartupError,
+	EnvironmentError,
+	PluginError,
+};

packages/lib/factorio/exchange_string.js

@@ -0,0 +1,393 @@
+"use strict";
+const zlib = require("zlib");
+
+
+class MapReaderState {
+	constructor(buf) {
+		this.pos = 0;
+		this.buf = buf;
+		this.last_position = { x: 0, y: 0 };
+	}
+}
+
+function readUInt8(state) {
+	let value = state.buf.readUInt8(state.pos);
+	state.pos += 1;
+	return value;
+}
+
+function readBool(state) {
+	let value = readUInt8(state) !== 0;
+	return value;
+}
+
+function readInt16(state) {
+	let value = state.buf.readInt16LE(state.pos);
+	state.pos += 2;
+	return value;
+}
+
+function readUInt16(state) {
+	let value = state.buf.readUInt16LE(state.pos);
+	state.pos += 2;
+	return value;
+}
+
+function readInt32(state) {
+	let value = state.buf.readInt32LE(state.pos);
+	state.pos += 4;
+	return value;
+}
+
+function readUInt32(state) {
+	let value = state.buf.readUInt32LE(state.pos);
+	state.pos += 4;
+	return value;
+}
+
+function readUInt32so(state) {
+	let value = readUInt8(state);
+	if (value === 0xff) {
+		return readUInt32(state);
+	}
+
+	return value;
+}
+
+function readFloat(state) {
+	let value = state.buf.readFloatLE(state.pos);
+	state.pos += 4;
+	return value;
+}
+
+function readDouble(state) {
+	let value = state.buf.readDoubleLE(state.pos);
+	state.pos += 8;
+	return value;
+}
+
+function readString(state) {
+	let size = readUInt32so(state);
+	let data = state.buf.slice(state.pos, state.pos + size).toString("utf-8");
+	state.pos += size;
+	return data;
+}
+
+function readOptional(state, readValue) {
+	let load = readUInt8(state) !== 0;
+	if (!load) {
+		return null;
+	}
+	return readValue(state);
+}
+
+function readArray(state, readItem) {
+	let size = readUInt32so(state);
+
+	let array = [];
+	for (let i = 0; i < size; i++) {
+		let item = readItem(state);
+		array.push(item);
+	}
+
+	return array;
+}
+
+function readDict(state, readKey, readValue) {
+	let size = readUInt32so(state);
+
+	let mapping = new Map();
+	for (let i = 0; i < size; i++) {
+		let key = readKey(state);
+		let value = readValue(state);
+		mapping.set(key, value);
+	}
+
+	return mapping;
+}
+
+function readVersion(state) {
+	let major = readUInt16(state);
+	let minor = readUInt16(state);
+	let patch = readUInt16(state);
+	let developer = readUInt16(state);
+	return [major, minor, patch, developer];
+}
+
+function readFrequencySizeRichness(state) {
+	return {
+		frequency: readFloat(state),
+		size: readFloat(state),
+		richness: readFloat(state),
+	};
+}
+
+function readAutoplaceSetting(state) {
+	return {
+		treat_missing_as_default: readBool(state),
+		settings: Object.fromEntries(readDict(state, readString, readFrequencySizeRichness)),
+	};
+}
+
+function readMapPosition(state) {
+	let x, y;
+	let x_diff = readInt16(state) / 256;
+	if (x_diff === 0x7fff / 256) {
+		x = readInt32(state) / 256;
+		y = readInt32(state) / 256;
+	} else {
+		let y_diff = readInt16(state) / 256;
+		x = state.last_position.x + x_diff;
+		y = state.last_position.y + y_diff;
+	}
+	state.last_position.x = x;
+	state.last_position.x = y;
+	return { x, y };
+}
+
+function readBoundingBox(state) {
+	return {
+		left_top: readMapPosition(state),
+		right_bottom: readMapPosition(state),
+		orientation: {
+			x: readInt16(state),
+			y: readInt16(state),
+		},
+	};
+}
+
+function readCliffSettings(state) {
+	return {
+		name: readString(state),
+		elevation_0: readFloat(state),
+		elevation_interval: readFloat(state),
+		richness: readFloat(state),
+	};
+}
+
+function readMapGenSettings(state) {
+	return {
+		terrain_segmentation: readFloat(state),
+		water: readFloat(state),
+		autoplace_controls: Object.fromEntries(readDict(state, readString, readFrequencySizeRichness)),
+		autoplace_settings: Object.fromEntries(readDict(state, readString, readAutoplaceSetting)),
+		default_enable_all_autoplace_controls: readBool(state),
+		seed: readUInt32(state),
+		width: readUInt32(state),
+		height: readUInt32(state),
+		area_to_generate_at_start: readBoundingBox(state),
+		starting_area: readFloat(state),
+		peaceful_mode: readBool(state),
+		starting_points: readArray(state, readMapPosition),
+		property_expression_names: Object.fromEntries(readDict(state, readString, readString)),
+		cliff_settings: readCliffSettings(state),
+	};
+}
+
+function readPollution(state) {
+	return {
+		enabled: readOptional(state, readBool),
+		diffusion_ratio: readOptional(state, readDouble),
+		min_to_diffuse: readOptional(state, readDouble),
+		ageing: readOptional(state, readDouble),
+		expected_max_per_chunk: readOptional(state, readDouble),
+		min_to_show_per_chunk: readOptional(state, readDouble),
+		min_pollution_to_damage_trees: readOptional(state, readDouble),
+		pollution_with_max_forest_damage: readOptional(state, readDouble),
+		pollution_per_tree_damage: readOptional(state, readDouble),
+		pollution_restored_per_tree_damage: readOptional(state, readDouble),
+		max_pollution_to_restore_trees: readOptional(state, readDouble),
+		enemy_attack_pollution_consumption_modifier: readOptional(state, readDouble),
+	};
+}
+
+function readSteeringValue(state) {
+	return {
+		radius: readOptional(state, readDouble),
+		separation_factor: readOptional(state, readDouble),
+		separation_force: readOptional(state, readDouble),
+		force_unit_fuzzy_goto_behavior: readOptional(state, readBool),
+	};
+
+}
+
+function readSteering(state) {
+	return {
+		default: readSteeringValue(state),
+		moving: readSteeringValue(state),
+	};
+}
+
+function readEnemyEvolution(state) {
+	return {
+		enabled: readOptional(state, readBool),
+		time_factor: readOptional(state, readDouble),
+		destroy_factor: readOptional(state, readDouble),
+		pollution_factor: readOptional(state, readDouble),
+	};
+}
+
+function readEnemyExpansion(state) {
+	return {
+		enabled: readOptional(state, readBool),
+		max_expansion_distance: readOptional(state, readUInt32),
+		friendly_base_influence_radius: readOptional(state, readUInt32),
+		enemy_building_influence_radius: readOptional(state, readUInt32),
+		building_coefficient: readOptional(state, readDouble),
+		other_base_coefficient: readOptional(state, readDouble),
+		neighbouring_chunk_coefficient: readOptional(state, readDouble),
+		neighbouring_base_chunk_coefficient: readOptional(state, readDouble),
+		max_colliding_tiles_coefficient: readOptional(state, readDouble),
+		settler_group_min_size: readOptional(state, readUInt32),
+		settler_group_max_size: readOptional(state, readUInt32),
+		min_expansion_cooldown: readOptional(state, readUInt32),
+		max_expansion_cooldown: readOptional(state, readUInt32),
+	};
+}
+
+function readUnitGroup(state) {
+	return {
+		min_group_gathering_time: readOptional(state, readUInt32),
+		max_group_gathering_time: readOptional(state, readUInt32),
+		max_wait_time_for_late_members: readOptional(state, readUInt32),
+		max_group_radius: readOptional(state, readDouble),
+		min_group_radius: readOptional(state, readDouble),
+		max_member_speedup_when_behind: readOptional(state, readDouble),
+		max_member_slowdown_when_ahead: readOptional(state, readDouble),
+		max_group_slowdown_factor: readOptional(state, readDouble),
+		max_group_member_fallback_factor: readOptional(state, readDouble),
+		member_disown_distance: readOptional(state, readDouble),
+		tick_tolerance_when_member_arrives: readOptional(state, readUInt32),
+		max_gathering_unit_groups: readOptional(state, readUInt32),
+		max_unit_group_size: readOptional(state, readUInt32),
+	};
+}
+
+function readPathFinder(state) {
+	return {
+		fwd2bwd_ratio: readOptional(state, readInt32),
+		goal_pressure_ratio: readOptional(state, readDouble),
+		use_path_cache: readOptional(state, readBool),
+		max_steps_worked_per_tick: readOptional(state, readDouble),
+		max_work_done_per_tick: readOptional(state, readUInt32),
+		short_cache_size: readOptional(state, readUInt32),
+		long_cache_size: readOptional(state, readUInt32),
+		short_cache_min_cacheable_distance: readOptional(state, readDouble),
+		short_cache_min_algo_steps_to_cache: readOptional(state, readUInt32),
+		long_cache_min_cacheable_distance: readOptional(state, readDouble),
+		cache_max_connect_to_cache_steps_multiplier: readOptional(state, readUInt32),
+		cache_accept_path_start_distance_ratio: readOptional(state, readDouble),
+		cache_accept_path_end_distance_ratio: readOptional(state, readDouble),
+		negative_cache_accept_path_start_distance_ratio: readOptional(state, readDouble),
+		negative_cache_accept_path_end_distance_ratio: readOptional(state, readDouble),
+		cache_path_start_distance_rating_multiplier: readOptional(state, readDouble),
+		cache_path_end_distance_rating_multiplier: readOptional(state, readDouble),
+		stale_enemy_with_same_destination_collision_penalty: readOptional(state, readDouble),
+		ignore_moving_enemy_collision_distance: readOptional(state, readDouble),
+		enemy_with_different_destination_collision_penalty: readOptional(state, readDouble),
+		general_entity_collision_penalty: readOptional(state, readDouble),
+		general_entity_subsequent_collision_penalty: readOptional(state, readDouble),
+		extended_collision_penalty: readOptional(state, readDouble),
+		max_clients_to_accept_any_new_request: readOptional(state, readUInt32),
+		max_clients_to_accept_short_new_request: readOptional(state, readUInt32),
+		direct_distance_to_consider_short_request: readOptional(state, readUInt32),
+		short_request_max_steps: readOptional(state, readUInt32),
+		short_request_ratio: readOptional(state, readDouble),
+		min_steps_to_check_path_find_termination: readOptional(state, readUInt32),
+		start_to_goal_cost_multiplier_to_terminate_path_find: readOptional(state, readDouble),
+		overload_levels: readOptional(state, (p) => readArray(p, readUInt32)),
+		overload_multipliers: readOptional(state, (p) => readArray(p, readDouble)),
+		negative_path_cache_delay_interval: readOptional(state, readUInt32),
+	};
+}
+
+function readDifficultySettings(state) {
+	return {
+		recipe_difficulty: readUInt8(state),
+		technology_difficulty: readUInt8(state),
+		technology_price_multiplier: readDouble(state),
+		research_queue_setting: ["always", "after-victory", "never"][readUInt8(state)],
+	};
+}
+
+function readMapSettings(state) {
+	return {
+		pollution: readPollution(state),
+		steering: readSteering(state),
+		enemy_evolution: readEnemyEvolution(state),
+		enemy_expansion: readEnemyExpansion(state),
+		unit_group: readUnitGroup(state),
+		path_finder: readPathFinder(state),
+		max_failed_behavior_count: readUInt32(state),
+		difficulty_settings: readDifficultySettings(state),
+	};
+}
+
+/**
+ * @typedef {object} module:lib/factorio.MapExchangeResult
+ * @property {array} version -
+ *     Version of Factorio the string was created with.
+ * @property {object} map_gen_settings -
+ *     Decoded map generator settings in the format the --map-gen-settings
+ *     command line option to Factorio expect.
+ * @property {object} map_settings -
+ *     Decoded map settings in the format the --map-settings command line option
+ *     to Factorio expects.
+ * @property {number} checksum - checksum for the exchange string.
+ */
+
+/**
+ * Parse a Map Exchange String
+ *
+ * Reads and decodes the data in the given map exchange string and returns
+ * data structures that can be fed into the Factorio server when creating a
+ * save to set the map gen settings and the map settings for the save.
+ *
+ * @param {string} exchangeString - Max Exchange String to parse.
+ * @returns {module:lib/factorio.MapExchangeResult} Parsed result.
+ * @memberof module:lib/factorio
+ */
+function readMapExchangeString(exchangeString) {
+	exchangeString = exchangeString.replace(/[ \t\n\r]+/g, "");
+	if (!/>>>[0-9a-zA-Z\/+]+={0,3}<<</.test(exchangeString)) {
+		throw new Error("Not a map exchange string");
+	}
+
+	let buf = Buffer.from(exchangeString.slice(3, -3), "base64");
+	try {
+		// eslint-disable-next-line node/no-sync
+		buf = zlib.inflateSync(buf);
+	} catch (err) {
+		if (err.code.startsWith("Z_")) {
+			throw new Error("Malformed map exchange string: zlib inflate failed");
+		}
+	}
+
+	let state = new MapReaderState(buf);
+	let data;
+
+	try {
+		data = {
+			version: readVersion(state),
+			unknown: readUInt8(state),
+			map_gen_settings: readMapGenSettings(state),
+			map_settings: readMapSettings(state),
+			checksum: readUInt32(state),
+		};
+	} catch (err) {
+		if (err.code === "ERR_OUT_OF_RANGE") {
+			throw new Error("Malformed map exchange string: reached end before finishing parsing");
+		}
+		throw err;
+	}
+
+	if (state.pos !== buf.length) {
+		throw new Error("Malformed map exchange string: data after end");
+	}
+
+	return data;
+}
+
+module.exports = {
+	readMapExchangeString,
+};

packages/lib/factorio/export.js

@@ -0,0 +1,418 @@
+// Export of item icons and locale
+"use strict";
+const fs = require("fs-extra");
+const path = require("path");
+const Jimp = require("jimp");
+const JSZip = require("jszip");
+
+const libIni = require("../ini");
+const libBuildMod = require("../build_mod");
+
+/**
+ * Generate the export mod needed for exportData
+ *
+ * Packs the lua export mod located in lua/export into the mods folder for
+ * the server given, with dependencies generated for all the mods present in
+ * the server's mods folder.
+ *
+ * @param {module:lib/factorio.FactorioServer} server -
+ *     The server to generate the export mod for.
+ * @memberof module:lib/factorio
+ */
+async function generateExportMod(server) {
+	let dependencies = [];
+	let splitter = /^(.*)_(\d+\.\d+\.\d+)(\.zip)?$/;
+	for (let entry of await fs.readdir(server.writePath("mods"))) {
+		let match = splitter.exec(entry);
+		if (match && match[1] !== "export") {
+			dependencies.push(`? ${match[1]}`);
+		}
+	}
+
+	await libBuildMod.build({
+		clean: false,
+		build: true,
+		pack: true,
+		// XXX fix path when moving lib/factorio to slave
+		sourceDir: path.join(__dirname, "..", "..", "slave", "lua", "export"),
+		outputDir: server.writePath("mods"),
+		bumpPatch: false,
+		factorioVersion: server.version.replace(/\.\d+$/, ""),
+		dependencies,
+	});
+}
+
+let zipCache = new Map();
+async function loadZip(server, modVersions, mod) {
+	let modVersion = modVersions.get(mod);
+	if (!modVersion) {
+		throw new Error(`Got path for unknown mod ${mod}`);
+	}
+
+	let zipPath = server.writePath("mods", `${mod}_${modVersion}.zip`);
+	let zip = zipCache.get(zipPath);
+	if (!zip) {
+		zip = await JSZip.loadAsync(await fs.readFile(zipPath));
+		zipCache.set(zipPath, zip);
+	}
+
+	return zip.folder(`${mod}_${modVersion}`);
+}
+
+/**
+ * Load the given Factorio file path into a Buffer
+ *
+ * @param {module:lib/factorio.FactorioServer} server -
+ *     The server to load the file from.
+ * @param {Map<string, string>} modVersions - Mapping of mod to version used.
+ * @param {string} modPath - Factorio style path to the file to load.
+ * @returns {?Buffer} The content of the file or null if not found.
+ * @memberof module:lib/factorio
+ * @private
+ * @inner
+ */
+async function loadFile(server, modVersions, modPath) {
+	let match = /^__([^\/]+)__\/(.*)$/.exec(modPath);
+	if (!match) {
+		throw new Error(`Bad mod path ${match}`);
+	}
+
+	let [, mod, filePath] = match;
+
+	if (["core", "base"].includes(mod)) {
+		try {
+			return await fs.readFile(server.dataPath(mod, filePath));
+		} catch (err) {
+			if (err.code === "ENOENT") {
+				return null;
+			}
+			throw err;
+		}
+	}
+
+	let zip;
+	try {
+		zip = await loadZip(server, modVersions, mod);
+	} catch (err) {
+		if (err.code === "ENOENT") {
+			return null;
+		}
+		throw err;
+	}
+
+	let file = zip.file(filePath);
+	if (!file) {
+		return null;
+	}
+
+	return await file.async("nodebuffer");
+}
+
+async function loadIcon(server, modVersions, iconPath, iconSize, iconMipmaps, iconCache) {
+	let icon = iconCache.get(iconPath);
+	if (icon === undefined) {
+		let fileContent = await loadFile(server, modVersions, iconPath);
+		if (fileContent) {
+			icon = await Jimp.read(fileContent);
+			icon.crop(0, 0, iconSize, iconSize);
+			iconCache.set(iconPath, icon);
+		} else {
+			icon = null;
+			server._logger.warn(`${iconPath} not found`);
+		}
+		iconCache.set(iconPath, icon);
+	}
+	return icon;
+}
+
+async function loadSimpleIcon(server, modVersions, item, size, iconCache) {
+	let icon = await loadIcon(server, modVersions, item.icon, item.icon_size, 0, iconCache);
+	if (icon) {
+		let iconScale = size / item.icon_size;
+		if (iconScale !== 1) {
+			icon = icon.clone();
+			icon.scale(iconScale);
+		}
+	}
+	return icon;
+}
+
+async function loadLayeredIcon(server, modVersions, item, size, iconCache) {
+	let baseLayerSize = item.icons[0].icon_size || item.icon_size;
+	let icon = await Jimp.create(size, size);
+
+	// The scaling factor of the base layer
+	let baseLayerScale = item.icons[0].scale || 32 / baseLayerSize;
+
+	// The size in pixels of one unit
+	let baseUnit = size / (baseLayerSize * baseLayerScale);
+
+	for (let layer of item.icons) {
+		let layerSize = layer.icon_size || item.icon_size;
+		let iconLayer = await loadIcon(server, modVersions, layer.icon, layerSize, layer.icon_mipmaps || 0, iconCache);
+
+		if (!iconLayer) {
+			continue;
+		}
+
+		iconLayer = iconLayer.clone();
+
+		let tint;
+		if (layer.tint) {
+			let divisor = (layer.tint.r > 1 || layer.tint.g > 1 || layer.tint.b > 1) ? 255 : 1;
+			tint = {
+				r: (layer.tint.r || 0) / divisor,
+				g: (layer.tint.g || 0) / divisor,
+				b: (layer.tint.b || 0) / divisor,
+				a: layer.tint.a || 1,
+			};
+		} else {
+			tint = { r: 1, b: 1, g: 1, a: 1 };
+		}
+
+		let layerScale = layer.scale || 32 / layerSize;
+		let [xs, ys] = layer.shift || [0, 0];
+		let realScale = layerScale * baseUnit;
+		let sizeShift = (size - layerSize * realScale) / 2;
+
+		xs = xs * baseUnit + sizeShift;
+		ys = ys * baseUnit + sizeShift;
+
+		if (realScale !== 1) {
+			iconLayer.scale(realScale);
+		}
+
+		// eslint-disable-next-line no-loop-func
+		iconLayer.scan(0, 0, iconLayer.bitmap.width, iconLayer.bitmap.height, (x, y, sidx) => {
+			x += xs;
+			y += ys;
+			if (x < 0 || x >= size || y < 0 || y >= size) {
+				return;
+			}
+			let sdata = iconLayer.bitmap.data;
+			let ddata = icon.bitmap.data;
+			let didx = icon.getPixelIndex(x, y);
+
+			let sa = sdata[sidx + 3] / 255;
+			let da = ddata[didx + 3] / 255;
+			let db = da * (1 - sa * tint.a);
+			let cb = sa + da * (1 - sa);
+			ddata[didx + 0] = Math.min(255, (sdata[sidx + 0] * sa * tint.r + ddata[didx + 0] * db) / cb);
+			ddata[didx + 1] = Math.min(255, (sdata[sidx + 1] * sa * tint.g + ddata[didx + 1] * db) / cb);
+			ddata[didx + 2] = Math.min(255, (sdata[sidx + 2] * sa * tint.b + ddata[didx + 2] * db) / cb);
+			ddata[didx + 3] = Math.min(255, sdata[sidx + 3] + ddata[didx + 3] * (1 - sa));
+		});
+	}
+
+	return icon;
+}
+
+/**
+ * Export item icons and data
+ *
+ * Assembles and packs the icons for the item prototypes given into a single
+ * spritesheet and json file with meta data.
+ *
+ * @param {module:lib/factorio.FactorioServer} server -
+ *     The server to generate the export mod for.
+ * @param {Map<string, string>} modVersions -
+ *     Mapping of mod name to versions to get icons from.
+ * @param {Array<Object>} items - Array of item prototypes.
+ * @return {{itemSheet: Jimp, itemData: Map<string,Object>}}
+ *     Item spritesheet and metadata.
+ * @memberof module:lib/factorio
+ * @private
+ * @inner
+ */
+async function exportItems(server, modVersions, items) {
+
+	// Size to render icons at
+	let size = 32;
+
+	// Width of spritesheet
+	let width = 1024;
+
+	let rows = Math.ceil(items.length / (width / size));
+	let iconSheet = await Jimp.create(width, rows * size);
+	let itemData = new Map();
+	let pos = 0;
+
+	let iconCache = new Map();
+	let simpleIcons = new Map();
+	for (let item of items) {
+		let icon;
+		let iconPos;
+		if (item.icons) {
+			icon = await loadLayeredIcon(server, modVersions, item, size, iconCache);
+			iconPos = pos;
+
+		} else {
+			iconPos = simpleIcons.get(item.icon);
+			if (iconPos === undefined) {
+				icon = await loadSimpleIcon(server, modVersions, item, size, iconCache);
+				if (icon) {
+					iconPos = pos;
+					simpleIcons.set(item.icon, pos);
+				}
+			}
+		}
+
+		if (iconPos !== undefined) {
+			itemData.set(item.name, {
+				x: iconPos * size % width,
+				y: Math.floor(iconPos / (width / size)) * size,
+				size,
+				localised_name: item.localised_name,
+				localised_description: item.localised_description,
+			});
+		}
+
+		if (icon) {
+			iconSheet.composite(icon, pos * size % width, Math.floor(pos / (width / size)) * size);
+			pos += 1;
+		}
+	}
+
+	iconSheet.crop(0, 0, width, Math.ceil(pos / (width / size)) * size);
+
+	return { iconSheet, itemData };
+}
+
+/**
+ * Exports the locale files for the base game and the given mods
+ *
+ * Parses and merges all the locales for the all the mods given through
+ * `modVersions` and `modOrder`.
+ *
+ * @param {module:lib/factorio.FactorioServer} server -
+ *     The server to export the locale from.
+ * @param {Map<string, string>} modVersions -
+ *     Mapping of mod name to version to export locale from.
+ * @param {Array<string>} modOrder - Load order of the mods.
+ * @param {string} languageCode - Language to export locale for.
+ * @returns {Map<string, string>} merged locale information
+ * @memberof module:lib/factorio
+ * @private
+ * @inner
+ */
+async function exportLocale(server, modVersions, modOrder, languageCode) {
+	let mergedLocales = new Map();
+
+	function mergeLocale(locale) {
+		for (let [category, entries] of Object.entries(locale)) {
+			if (typeof entries === "string") {
+				mergedLocales.set(category, entries);
+
+			} else {
+				for (let [key, value] of Object.entries(entries)) {
+					mergedLocales.set(`${category}.${key}`, value);
+				}
+			}
+		}
+	}
+
+	let baseLocaleFilePath = server.dataPath("base", "locale", languageCode, "base.cfg");
+	mergeLocale(libIni.parse(await fs.readFile(baseLocaleFilePath, "utf8")));
+
+	for (let mod of modOrder) {
+		if (["core", "base", "export"].includes(mod)) {
+			continue;
+		}
+
+		let zip;
+		try {
+			zip = await loadZip(server, modVersions, mod);
+		} catch (err) {
+			if (err.code === "ENOENT") {
+				continue;
+			}
+			throw err;
+		}
+		for (let file of zip.file(new RegExp(`locale\\/${languageCode}\\/.*\\.cfg`))) {
+			let content = await file.async("nodebuffer");
+			mergeLocale(libIni.parse(content.toString("utf8")));
+		}
+	}
+
+	return mergedLocales;
+}
+
+/**
+ * Export the locale and item icons for the given factorio server
+ *
+ * @param {module:lib/factorio.FactorioServer} server -
+ *     The server to export the data from.
+ * @returns {JSZip} zip file with exported data.
+ * @memberof module:lib/factorio
+ */
+async function exportData(server) {
+	await generateExportMod(server);
+
+	let items = [];
+	let modVersions = new Map();
+	let modOrder = [];
+
+	server.on("ipc-item_export", data => items.push(data));
+	server.on("ipc-mod_list", data => { modVersions = new Map(Object.entries(data)); });
+	server.on("output", parsed => {
+		if (parsed.format === "seconds" && parsed.type === "generic") {
+			let match = /^Checksum of (.*): \d+$/.exec(parsed.message);
+			if (match) {
+				modOrder.push(match[1]);
+			}
+		}
+	});
+
+	try {
+		await server.startScenario("base/freeplay");
+		await server.kill();
+	} finally {
+		await fs.unlink(server.writePath("mods", "export_0.0.0.zip"));
+	}
+
+	if (!items.length) {
+		throw new Error("No items got exported");
+	}
+
+	// Some mod authors put leading zeros into the versions of their zip files.
+	let splitter = /^(.*)_(\d+)\.(\d+)\.(\d+)\.zip?$/;
+	for (let entry of await fs.readdir(server.writePath("mods"))) {
+		let match = splitter.exec(entry);
+		if (!match) {
+			continue;
+		}
+
+		let modVersion = `${match[2]}.${match[3]}.${match[4]}`;
+		let normalizedVersion =
+			`${Number.parseInt(match[2], 10)}.${Number.parseInt(match[3], 10)}.${Number.parseInt(match[4], 10)}`
+		;
+
+		if (modVersion === normalizedVersion) {
+			continue;
+		}
+
+		if (modVersions.get(match[1]) === normalizedVersion) {
+			modVersions.set(match[1], modVersion);
+		}
+	}
+
+	let { iconSheet, itemData } = await exportItems(server, modVersions, items);
+	let locale = await exportLocale(server, modVersions, modOrder, "en");
+
+	// Free up the memory used by zip files loaded during the export.
+	zipCache.clear();
+
+	let zip = new JSZip();
+	zip.file("export/item-spritesheet.png", await iconSheet.getBufferAsync(Jimp.MIME_PNG));
+	zip.file("export/item-metadata.json", JSON.stringify([...itemData.entries()]));
+	zip.file("export/locale.json", JSON.stringify([...locale.entries()]));
+	return zip;
+}
+
+
+module.exports = {
+	exportData,
+
+	// For testing only
+	_exportLocale: exportLocale,
+};

packages/lib/factorio/index.js

@@ -0,0 +1,17 @@
+/**
+ * Library for interfacing with Factorio Servers and saves.
+ * @module lib/factorio
+ * @author Hornwitser
+ */
+"use strict";
+const exchange_string = require("./exchange_string");
+const export_ = require("./export");
+const patch = require("./patch");
+const server = require("./server");
+
+module.exports = {
+	...exchange_string,
+	...export_,
+	...patch,
+	...server,
+};

packages/lib/factorio/patch.js

@@ -0,0 +1,299 @@
+// Library for patching Factorio saves with scenario code.
+
+"use strict";
+const events = require("events");
+const fs = require("fs-extra");
+const JSZip = require("jszip");
+const path = require("path");
+const semver = require("semver");
+
+const libHash = require("../hash");
+
+
+const knownScenarios = {
+	// First seen in 0.17.63
+	"4e866186ebe297f1038fd325b09df1a1f5e2fdd1": {
+		"name": "freeplay",
+		"modules": [
+			"freeplay",
+			"silo-script",
+		],
+	},
+};
+
+/**
+ * Returns the root folder in the zip file
+ *
+ * Returns the name of the folder that all files in the zip file is
+ * contained in.  Throws an error if there are multiple such folders.
+ *
+ * @param {JSZip} zip - Zip to search through.
+ * @returns {string} name of the root folder.
+ * @memberof module:lib/factorio
+ * @private
+ * @inner
+ */
+function findRoot(zip) {
+	let root = null;
+	zip.forEach((relativePath, file) => {
+		let index = relativePath.indexOf("/");
+		if (index === -1) {
+			throw new Error(`Zip contains file '${relativePath}' in root dir`);
+		}
+
+		let pathRoot = relativePath.slice(0, index);
+		if (root === null) {
+			root = pathRoot;
+		} else if (root !== pathRoot) {
+			throw new Error("Zip contains multiple root folders");
+		}
+	});
+
+	if (root === null) {
+		throw new Error("Empty zip file");
+	}
+
+	return root;
+}
+
+
+/**
+ * Generates control.lua code for loading the Clusterio modules
+ *
+ * @param {Object} patchInfo - The patch info files's json content
+ * @returns {string} Generated control.lua code.
+ * @memberof module:lib/factorio
+ * @private
+ * @inner
+ */
+function generateLoader(patchInfo) {
+	let lines = [
+		"-- Auto generated scenario module loader created by Clusterio",
+		"-- Modifications to this file will be lost when loaded in Clusterio",
+		`clusterio_patch_number = ${patchInfo.patch_number}`,
+		"",
+		'local event_handler = require("event_handler")',
+		"",
+		"-- Scenario modules",
+	];
+
+	for (let moduleName of patchInfo["scenario"]["modules"]) {
+		lines.push(`event_handler.add_lib(require("${moduleName}"))`);
+	}
+
+	lines.push(...[
+		"",
+		"-- Clusterio modules",
+	]);
+
+	for (let module of patchInfo["modules"]) {
+		for (let file of module["files"]) {
+			let requirePath = `modules/${module.name}/${file["path"].slice(0, -4)}`;
+			if (file["load"]) {
+				lines.push(`event_handler.add_lib(require("${requirePath}"))`);
+			}
+			if (file["require"]) {
+				lines.push(`require("${requirePath}")`);
+			}
+		}
+	}
+
+	// End last line with a newline
+	lines.push("");
+
+	return lines.join("\n");
+}
+
+/**
+ * Reorders modules to satisfy their dependencies
+ *
+ * Looks through and reorders the array of module definitions in order to
+ * satisfy the property that dependencies are earlier in the array than
+ * their dependents.  Throws an error if this is not possible.
+ *
+ * @param {Array<Object>} modules - Array of modules to reorder
+ * @memberof module:lib/factorio
+ * @private
+ * @inner
+ */
+function reorderDependencies(modules) {
+	let index = 0;
+	let present = new Map();
+	let hold = new Map();
+	reorder: while (index < modules.length) {
+		let module = modules[index];
+		if (semver.valid(module.version) === null) {
+			throw new Error(`Invalid version '${module.version}' for module ${module.name}`);
+		}
+
+		for (let [dependency, requirement] of Object.entries(module.dependencies)) {
+			if (semver.validRange(requirement) === null) {
+				throw new Error(
+					`Invalid version range '${requirement}' for dependency ${dependency} on module ${module.name}`
+				);
+			}
+
+			if (present.has(dependency)) {
+				if (!semver.satisfies(present.get(dependency), requirement)) {
+					throw new Error(`Module ${module.name} requires ${dependency} ${requirement}`);
+				}
+
+			// We have an unmet dependency, take it out and continue
+			} else {
+				if (hold.has(dependency)) {
+					hold.get(dependency).push(module);
+				} else {
+					hold.set(dependency, [module]);
+				}
+				modules.splice(index, 1);
+				continue reorder;
+			}
+		}
+
+		// No unmet dependencies, record and continue
+		present.set(module.name, module.version);
+		index += 1;
+
+		if (hold.has(module.name)) {
+			modules.splice(index, 0, ...hold.get(module.name));
+			hold.delete(module.name);
+		}
+	}
+
+	if (!hold.size) {
+		return;
+	}
+
+	// There are three reasons for a module to end up being held: The module depends
+	// on a module that is missing, the module is part of a dependency loop, or the
+	// the module depends on a module that satisfy any of these conditions.
+
+	let remaining = new Map();
+	for (let heldModules of hold.values()) {
+		for (let module of heldModules) {
+			remaining.set(module.name, module);
+		}
+	}
+
+	// Start with a random module from the remaining modules
+	for (let module of remaining.values()) {
+		let cycle = [];
+		while (true) {
+			// Find an unmet dependency
+			let dependency = Object.keys(module.dependencies).find(name => !present.has(name));
+
+			if (!remaining.has(dependency)) {
+				// There's no module being held up by this dependency, the
+				// dependency is missing.
+				throw new Error(`Missing dependency ${dependency} for module ${module.name}`);
+			}
+
+			if (cycle.includes(module.name)) {
+				cycle.push(module.name);
+				cycle.splice(0, cycle.indexOf(module.name));
+				throw new Error(`Module dependency loop detected: ${cycle.join(" -> ")}`);
+			}
+
+			cycle.push(module.name);
+			module = remaining.get(dependency);
+		}
+	}
+}
+
+/**
+ * Patch a save with the given modules
+ *
+ * Adds the modules given by the modules parameter to the save located
+ * at savePath and rewrites the control.lua in the save to load the
+ * modules that were added.  Will also remove any previous module
+ * located in the save.
+ *
+ * @param {string} savePath - Path to the Factorio save to patch.
+ * @param {Array<Object>} modules - Description of the modules to patch.
+ * @memberof module:lib/factorio
+ */
+async function patch(savePath, modules) {
+	let zip = await JSZip.loadAsync(await fs.readFile(savePath));
+	let root = zip.folder(findRoot(zip));
+
+	let patchInfoFile = root.file("clusterio.json");
+	let patchInfo;
+	if (patchInfoFile !== null) {
+		let content = await patchInfoFile.async("string");
+		patchInfo = JSON.parse(content);
+
+	// No info file present, try to detect if it's a known compatible scenario.
+	} else {
+		let controlStream = root.file("control.lua").nodeStream("nodebuffer");
+		let controlHash = await libHash.hashStream(controlStream);
+
+		if (controlHash in knownScenarios) {
+			patchInfo = {
+				"scenario": knownScenarios[controlHash],
+			};
+		} else {
+			throw new Error(`Unable to patch save, unknown scenario (${controlHash})`);
+		}
+	}
+
+	// Increment patch number
+	patchInfo["patch_number"] = (patchInfo["patch_number"] || 0) + 1;
+
+	// Remove any existing modules from the save
+	patchInfo["modules"] = [];
+	for (let file of root.file(/^modules\//)) {
+		zip.remove(file.name);
+	}
+
+	reorderDependencies(modules);
+
+	// Add the modules to the save.
+	for (let module of modules) {
+		let moduleDir = root.folder(`modules/${module.name}`);
+		let moduleInfo = {
+			"name": module.name,
+			"files": [],
+		};
+
+		let dirs = [[module.path, ""]];
+		while (dirs.length) {
+			let [dir, relativeDir] = dirs.pop();
+			for (let entry of await fs.readdir(dir, { withFileTypes: true })) {
+				let fsPath = path.join(dir, entry.name);
+				let relativePath = path.posix.join(relativeDir, entry.name);
+
+				if (entry.isFile()) {
+					moduleDir.file(relativePath, await fs.readFile(fsPath));
+					moduleInfo["files"].push({
+						"path": relativePath,
+						"load": module.load.includes(relativePath),
+						"require": module.require.includes(relativePath),
+					});
+
+				} else if (entry.isDirectory()) {
+					dirs.push([fsPath, relativePath]);
+				}
+			}
+		}
+
+		patchInfo["modules"].push(moduleInfo);
+	}
+
+	// Add loading code and patch info
+	root.file("control.lua", generateLoader(patchInfo));
+	root.file("clusterio.json", JSON.stringify(patchInfo, null, 4));
+
+	// Write back the save
+	let stream = zip.generateNodeStream({ compression: "DEFLATE" });
+	let pipe = stream.pipe(fs.createWriteStream(savePath));
+	await events.once(pipe, "finish");
+}
+
+module.exports = {
+	patch,
+
+	// For testing only
+	_findRoot: findRoot,
+	_generateLoader: generateLoader,
+	_reorderDependencies: reorderDependencies,
+};

packages/lib/file_ops.js

@@ -0,0 +1,75 @@
+/**
+ * @module lib/file_ops
+ */
+"use strict";
+const fs = require("fs-extra");
+const path = require("path");
+
+/**
+ * Returns the newest file in a directory
+ *
+ * @param {string} directory - The directory to look for the newest file in.
+ * @param {function(string): boolean} filter -
+ *     Optional function to filter out files to ignore.  Should return true
+ *     if the file is to be considered.
+ * @returns {?string}
+ *     Name of the file with the newest timestamp or null if the
+ *     directory contains no files.
+ */
+async function getNewestFile(directory, filter = (name) => true) {
+	let newestTime = new Date(0);
+	let newestFile = null;
+	for (let entry of await fs.readdir(directory, { withFileTypes: true })) {
+		if (entry.isFile()) {
+			let stat = await fs.stat(path.join(directory, entry.name));
+			if (filter(entry.name) && stat.mtime > newestTime) {
+				newestTime = stat.mtime;
+				newestFile = entry.name;
+			}
+		}
+	}
+
+	return newestFile;
+}
+
+/**
+ * Modifies name in case it already exisist at the given directory
+ *
+ * Checks the directory passed if it already contains a file or folder with
+ * the given name, if it does not returns name unmodified, otherwise it
+ * returns a modified name that does not exist in the directory.
+ *
+ * Warning: this function should not be relied upon to be accurate for
+ * security sensitive applications.  The selection process is inherently
+ * racy and a file or folder may have been created in the folder by the time
+ * this function returns.
+ *
+ * @param {string} directory - directory to check in.
+ * @param {string} name - file name to check for, may have extension.
+ * @param {string} extension - dot extension used for the file name.
+ * @returns {string} modified name with extension that likely does not exist
+ *     in the folder
+ */
+async function findUnusedName(directory, name, extension = "") {
+	if (extension && name.endsWith(extension)) {
+		name = name.slice(0, -extension.length);
+	}
+
+	while (true) {
+		if (!await fs.pathExists(path.join(directory, `${name}${extension}`))) {
+			return `${name}${extension}`;
+		}
+
+		let match = /^(.*?)(-(\d+))?$/.exec(name);
+		if (!match[2]) {
+			name = `${match[1]}-2`;
+		} else {
+			name = `${match[1]}-${Number.parseInt(match[3], 10) + 1}`;
+		}
+	}
+}
+
+module.exports = {
+	getNewestFile,
+	findUnusedName,
+};

packages/lib/hash.js

@@ -0,0 +1,46 @@
+/**
+ * Hashing functions
+ * @module lib/hash
+ */
+"use strict";
+const crypto = require("crypto");
+const fs = require("fs");
+
+
+/**
+ * Returns a promise that resolves to the SHA1 hash of the stream given
+ *
+ * @param {Stream} stream - Node stream of the content to hash.
+ * @returns {Promise<string>} hash of the stream.
+ */
+function hashStream(stream) {
+	return new Promise((resolve, reject) => {
+		let hasher = crypto.createHash("sha1");
+		hasher.setEncoding("hex");
+		hasher.on("finish", () => {
+			resolve(hasher.read());
+		});
+
+		stream.on("error", (error) => {
+			// the docs doesn't say anything about what's passed on error
+			reject(error);
+		});
+
+		stream.pipe(hasher);
+	});
+}
+
+/**
+ * Returns a promise that resolves to the SHA1 hash of the file given by path
+ *
+ * @param {string} path - Path to the file to hash.
+ * @returns {Promise<string>} hash of the file given.
+ */
+function hashFile(path) {
+	return hashStream(fs.createReadStream(path));
+}
+
+module.exports = {
+	hashStream,
+	hashFile,
+};

packages/lib/helpers.js

@@ -0,0 +1,100 @@
+/**
+ * Collection of small utilites that are useful in multiple places.
+ * @module lib/helpers
+ */
+"use strict";
+
+/**
+ * Return a string describing the type of the value passed
+ *
+ * Works the same as typeof, excpet that null and array types get their
+ * own string.
+ *
+ * @param {*} value - value to return the type of.
+ * @returns {string} basic type of the value passed.
+ */
+function basicType(value) {
+	if (value === null) { return "null"; }
+	if (value instanceof Array) { return "array"; }
+	return typeof value;
+}
+
+
+/**
+ * Asynchronously wait for the given duration
+ *
+ * @param {number} duration - Time to wait for in milliseconds.
+ */
+async function wait(duration) {
+	await new Promise(resolve => { setTimeout(resolve, duration); });
+}
+
+
+/**
+ * Resolve a promise with a timeout.
+ *
+ * @param {Promise} promise - Promise to wait for.
+ * @param {number} time - Maximum time im milliseconds to wait for.
+ * @param {*=} timeoutResult - Value to return if the operation timed out.
+ */
+async function timeout(promise, time, timeoutResult) {
+	let timer;
+	try {
+		return await Promise.race([
+			promise,
+			new Promise(resolve => {
+				timer = setTimeout(() => resolve(timeoutResult), time);
+			}),
+		]);
+
+	} finally {
+		clearTimeout(timer);
+	}
+}
+
+
+/**
+ * Read stream to the end and return its content
+ *
+ * Reads the stream given asynchronously until the end is reached and
+ * returns all the data which was read from the stream.
+ *
+ * @param {Readable} stream - byte stream to read to the end.
+ * @returns {Buffer} content of the stream.
+ */
+async function readStream(stream) {
+	let chunks = [];
+	for await (let chunk of stream) {
+		// Support using ^Z to end input on Windows
+		if (process.platform === "win32" && stream.isTTY && chunk.toString() === "\x1a\r\n") {
+			break;
+		}
+		chunks.push(chunk);
+	}
+	return Buffer.concat(chunks);
+}
+
+
+/**
+ * Escapes text for inclusion in a RegExp
+ *
+ * Adds \ character in front of special meta characters in the passsed in
+ * text so that it can be embedded into a RegExp and only match the text.
+ *
+ * See https://stackoverflow.com/a/9310752
+ *
+ * @param {string} text - Text to escape RegExp meta chars in.
+ * @returns {string} escaped text.
+ */
+function escapeRegExp(text) {
+	return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
+}
+
+
+module.exports = {
+	basicType,
+	wait,
+	timeout,
+	readStream,
+	escapeRegExp,
+};

packages/lib/index.js

@@ -0,0 +1,49 @@
+"use strict";
+const libBuildMod = require("./build_mod");
+const libCommand = require("./command");
+const libConfig = require("./config");
+const libDatabase = require("./database");
+const libErrors = require("./errors");
+const libFactorio = require("./factorio");
+const libFileOps = require("./file_ops");
+const libHash = require("./hash");
+const libHelpers = require("./helpers");
+const libLink = require("./link");
+const libLogging = require("./logging");
+const libLoggingUtils = require("./logging_utils");
+const libLuaTools = require("./lua_tools");
+const libPlugin = require("./plugin");
+const libPluginLoader = require("./plugin_loader");
+const libPrometheus = require("./prometheus");
+const libSchema = require("./schema");
+const libSharedCommands = require("./shared_commands");
+const libUsers = require("./users");
+
+const ExponentialBackoff = require("./ExponentialBackoff");
+const RateLimiter = require("./RateLimiter");
+
+
+module.exports = {
+	libBuildMod,
+	libCommand,
+	libConfig,
+	libDatabase,
+	libErrors,
+	libFactorio,
+	libFileOps,
+	libHash,
+	libHelpers,
+	libLink,
+	libLogging,
+	libLoggingUtils,
+	libLuaTools,
+	libPlugin,
+	libPluginLoader,
+	libPrometheus,
+	libSchema,
+	libSharedCommands,
+	libUsers,
+
+	ExponentialBackoff,
+	RateLimiter,
+};

packages/lib/ini.js

@@ -0,0 +1,94 @@
+/**
+ * Factorio Compatible INI parser
+ *
+ * @module lib/ini
+ * @author Hornwitser
+ */
+
+"use strict";
+
+/**
+ * Parse INI file into object of sections
+ * @param {string} input - content of INI file to parse.
+ * @returns {object<string, object<string, string>>}
+ *     sections parsed from the ini file.
+ */
+function parse(input) {
+	const sections = {};
+	let currentSection = sections;
+	const lines = input.split(/\r\n|\n/);
+	for (let number = 1; number <= lines.length; number++) {
+		let line = lines[number - 1].replace(/^[\t ]+/, "");
+		if (!line || line[0] === "#" || line[0] === ";") {
+			continue;
+		}
+
+		// Read section header
+		if (line[0] === "[") {
+			line = line.replace(/[\t ]+$/, "");
+			if (line.slice(-1) !== "]") {
+				throw new Error(`Unterminated section header on line ${number}`);
+			}
+			const name = line.slice(1, -1);
+			if (Object.prototype.hasOwnProperty.call(sections, name)) {
+				throw new Error(`Duplicated section [${name}] on line ${number}`);
+			}
+			currentSection = {};
+			sections[name] = currentSection;
+			continue;
+		}
+
+		// Read key value
+		const equalIndex = line.indexOf("=");
+		if (equalIndex === -1) {
+			throw new Error(`Missing value for key ${line} on line ${number}`);
+		}
+		const key = line.slice(0, equalIndex);
+		if (Object.prototype.hasOwnProperty.call(currentSection, key)) {
+			throw new Error(`Duplicated key ${key} on line ${number}`);
+		}
+		const value = line.slice(equalIndex + 1);
+		currentSection[key] = value;
+	}
+
+	return sections;
+}
+
+/**
+ * Serialize an object of section definitions into an INI file
+ * @param {object<string, object<string, string>>} sections -
+ *     Sections to encode into ini format
+ * @returns {string} sections serialized into INI format
+ */
+function stringify(sections) {
+	let serialized = [];
+	let first = true;
+
+	for (let [key, value] of Object.entries(sections)) {
+		if (typeof value === "string") {
+			serialized.push(`${key}=${value}`);
+			first = false;
+		}
+	}
+
+	for (let [section, content] of Object.entries(sections)) {
+		if (typeof content === "object") {
+			if (!first) {
+				serialized.push("");
+			}
+			first = false;
+			serialized.push(`[${section}]`);
+			for (let [key, value] of Object.entries(content)) {
+				serialized.push(`${key}=${value}`);
+			}
+		}
+	}
+
+	if (serialized.length) { serialized.push(""); }
+	return serialized.join("\n");
+}
+
+module.exports = {
+	parse,
+	stringify,
+};

packages/lib/is_deep_strict_equal.js

@@ -0,0 +1,9 @@
+/* eslint-disable node/global-require */
+"use strict";
+// eslint-disable-next-line node/no-process-env
+if (process.env.APP_ENV === "browser") {
+	// eslint-disable-next-line node/no-extraneous-require
+	module.exports = require("fast-deep-equal/es6");
+} else {
+	module.exports = require("util").isDeepStrictEqual;
+}

packages/lib/link/connectors.js

@@ -0,0 +1,561 @@
+// Connection adapters for Links
+"use strict";
+const events = require("events");
+const WebSocket = require("isomorphic-ws");
+
+const libSchema = require("../schema");
+const libErrors = require("../errors");
+const { logger } = require("../logging");
+const ExponentialBackoff = require("../ExponentialBackoff");
+
+
+/**
+ * Base connector for links
+ *
+ * @extends events.EventEmitter
+ * @memberof module:lib/link
+ */
+class WebSocketBaseConnector extends events.EventEmitter {
+	constructor(sessionTimeout) {
+		super();
+
+		this._sessionTimeout = sessionTimeout;
+
+		// One of closed, connecting (client only), connected and resuming.
+		this._state = "closed";
+		this._closing = false;
+		this._socket = null;
+		this._seq = 1;
+		this._lastHeartbeat = null;
+		this._heartbeatId = null;
+		this._heartbeatInterval = null;
+		this._lastReceivedSeq = null;
+		this._sendBuffer = [];
+	}
+
+	_reset() {
+		this._state = "closed";
+		this._closing = false;
+		this._socket = null;
+		this._seq = 1;
+		this._lastHeartbeat = null;
+		this._heartbeatId = null;
+		this._heartbeatInterval = null;
+		this._lastReceivedSeq = null;
+		this._sendBuffer.length = 0;
+	}
+
+	_check(...expectedStates) {
+		if (!expectedStates.includes(this._state)) {
+			throw new Error(
+				`Expected state ${expectedStates} but state is ${this._state}`
+			);
+		}
+	}
+
+	_dropSendBufferSeq(seq) {
+		if (seq === null) {
+			return;
+		}
+
+		let dropCount = 0;
+		for (let index = 0; index < this._sendBuffer.length; index++) {
+			if (this._sendBuffer[index].seq <= seq) {
+				dropCount += 1;
+			} else {
+				break;
+			}
+		}
+		this._sendBuffer.splice(0, dropCount);
+	}
+
+	_doHeartbeat() {
+		this._check("connected");
+		if (Date.now() - this._lastHeartbeat > 2000 * this._heartbeatInterval) {
+			logger.verbose("Connector | closing after heartbeat timed out");
+			// eslint-disable-next-line node/no-process-env
+			if (process.env.APP_ENV === "browser") {
+				this._socket.close(4008, "Heartbeat timeout");
+			} else {
+				this._socket.terminate();
+			}
+
+		} else {
+			this._socket.send(JSON.stringify({
+				seq: null,
+				type: "heartbeat",
+				data: { seq: this._lastReceivedSeq },
+			}));
+		}
+	}
+
+	_processHeartbeat(message) {
+		if (!libSchema.heartbeat(message)) {
+			logger.warn("Connector | closing after received invalid heartbeat");
+			this._socket.close(1002, "Invalid heartbeat");
+			return;
+		}
+
+		this._lastHeartbeat = Date.now();
+		this._dropSendBufferSeq(message.data.seq);
+	}
+
+	/**
+	 * Start sending heartbeats
+	 */
+	startHeartbeat() {
+		if (this._heartbeatId) {
+			throw new Error("heartbeat is already running");
+		}
+		this._lastHeartbeat = Date.now();
+		this._heartbeatId = setInterval(() => {
+			this._doHeartbeat();
+		}, this._heartbeatInterval * 1000);
+	}
+
+	/**
+	 * Stop sending heartbeats
+	 */
+	stopHeartbeat() {
+		if (this._heartbeatId) {
+			clearInterval(this._heartbeatId);
+			this._heartbeatId = null;
+			this._lastHeartbeat = null;
+		}
+	}
+
+	/**
+	 * Send a message over the socket
+	 *
+	 * @param {string} type - Message type to send.
+	 * @param {Object} data - Data to send with message.
+	 * @returns {number} the sequence number of the message sent
+	 */
+	send(type, data) {
+		if (!["connected", "resuming"].includes(this._state)) {
+			throw new libErrors.SessionLost("No session");
+		}
+		let seq = this._seq;
+		this._seq += 1;
+		let message = { seq, type, data };
+		this._sendBuffer.push(message);
+		if (this._state === "connected") {
+			this._socket.send(JSON.stringify(message));
+		}
+		return seq;
+	}
+
+	/**
+	 * Set connection state to closing
+	 *
+	 * Signal the connection is about to close and that once the close
+	 * frame is received it should be considered finished.
+	 */
+	setClosing() {
+		throw new Error("Abstract function");
+	}
+
+	/**
+	 * True if the connection is established and active
+	 */
+	get connected() {
+		return this._state === "connected";
+	}
+
+	/**
+	 * True if the connection is closing down or closed
+	 */
+	get closing() {
+		return this._closing || this._state === "closed";
+	}
+
+	/**
+	 * True if the connector currently has a valid session that is either
+	 * connected or in the process of resuming.
+	 */
+	get hasSession() {
+		return ["connected", "resuming"].includes(this._state);
+	}
+}
+
+/**
+ * Connector for master server clients
+ *
+ * @extends module:lib/link.WebSocketBaseConnector
+ * @memberof module:lib/link
+ */
+class WebSocketClientConnector extends WebSocketBaseConnector {
+	constructor(url, maxReconnectDelay, tlsCa = null) {
+		super(null);
+
+		this._url = url;
+		this._backoff = new ExponentialBackoff({ max: maxReconnectDelay });
+		this._tlsCa = tlsCa;
+
+		// The following states are used in the client connector
+		// closed: Not connected
+		// connecting: Attempting to connect to server.
+		// resuming: Attempting to resume an existing connection to the server.
+		// connected: Connection is online
+		this._reconnectId = null;
+		this._sessionToken = null;
+		this._startedResuming = null;
+	}
+
+	_reset() {
+		clearTimeout(this._reconnectId);
+		this._reconnectId = null;
+		this._lastReceivedSeq = null;
+		this._sessionToken = null;
+		this._sessionTimeout = null;
+		this._sendBuffer.length = 0;
+		this._startedResuming = null;
+		super._reset();
+	}
+
+	/**
+	 * Send a handshake message over the socket
+	 *
+	 * Used in the register function in order to send the register handshake
+	 * message over the WebSocket.
+	 *
+	 * @param {string} type - Message type to send.
+	 * @param {Object} data - Data to send with message.
+	 */
+	sendHandshake(type, data) {
+		this._check("connecting", "resuming");
+		this._socket.send(JSON.stringify({ seq: null, type, data }));
+	}
+
+	/**
+	 * Close the connection with the given reason.
+	 *
+	 * Sends a close frame and disconnects the connector.
+	 *
+	 * @param {number} code - WebSocket close code.
+	 * @param {string} reason - WebSocket close reason.
+	 */
+	async close(code, reason) {
+		if (this._state === "closed") {
+			return;
+		}
+
+		this._closing = true;
+		if (this._state === "connected" || this._socket) {
+			this._socket.close(code, reason);
+			await events.once(this, "close");
+
+		} else {
+			this._reset();
+			this.emit("close");
+		}
+	}
+
+	/**
+	 * Notify the connection is expected to close
+	 *
+	 * Sets the internal flag to signal not to attempt to resume the
+	 * connection if the server closes it.  This will close the connection
+	 * if it's currently attempting to connect or resume.
+	 */
+	setClosing() {
+		if (this._state === "closed") {
+			return;
+		}
+
+		this._closing = true;
+		if (this._state === "connected") {
+			return;
+		}
+
+		if (this._socket) {
+			this._socket.close(1000, "Connector closing");
+
+		} else {
+			this._reset();
+			this.emit("close");
+		}
+	}
+
+	/**
+	 * Connect to the master server
+	 */
+	async connect() {
+		this._check("closed");
+		this._state = "connecting";
+
+		this._doConnect();
+
+		// Wait for the connection to be ready
+		await events.once(this, "connect");
+	}
+
+	_doConnect() {
+		let url = new URL(this._url);
+		url.pathname += "api/socket";
+
+		// Open WebSocket to master
+		logger.verbose(`Connector | connecting to ${url}`);
+
+		// eslint-disable-next-line node/no-process-env
+		if (process.env.APP_ENV === "browser") {
+			this._socket = new WebSocket(url);
+
+		} else {
+			let options = {};
+			if (this._tlsCa) { options.ca = this._tlsCa; }
+			this._socket = new WebSocket(url, options);
+		}
+
+		this._attachSocketHandlers();
+	}
+
+	/**
+	 * Attempt re-establishing the connecting again
+	 */
+	reconnect() {
+		if (this._socket) {
+			throw new Error("Cannot reconnect while socket is open");
+		}
+
+		if (this._reconnectId !== null) {
+			logger.error("Unexpected double call to reconnect");
+		}
+
+		let delay = this._backoff.delay();
+		if (
+			this._state === "resuming"
+			&& this._startedResuming + this._sessionTimeout * 1000 < Date.now() + delay
+		) {
+			logger.error("Connector | Session timed out trying to resume");
+			this._reset();
+			this._state = "connecting";
+			this.emit("invalidate");
+		}
+		logger.verbose(
+			`Connector | waiting ${(Math.round(delay / 10) / 100)} seconds for reconnect`
+		);
+		this._reconnectId = setTimeout(() => {
+			this._reconnectId = null;
+			this._doConnect();
+		}, delay);
+		this._reconnectTime = Date.now() + delay;
+	}
+
+	_attachSocketHandlers() {
+		this._socket.onclose = event => {
+			const previousState = this._state;
+
+			// Authentication failed
+			if (event.code === 4003) {
+				this.emit("error", new libErrors.AuthenticationFailed(event.reason));
+				this._closing = true;
+			}
+
+			this._socket = null;
+			if (this._state === "connected") {
+				this.stopHeartbeat();
+				if (this._closing) {
+					this._reset();
+					this.emit("close");
+
+				} else {
+					this._state = "resuming";
+					this._startedResuming = Date.now();
+					this.reconnect();
+					this.emit("drop");
+				}
+
+			} else {
+				// eslint-disable-next-line no-lonely-if
+				if (this._closing) {
+					this._reset();
+					this.emit("close");
+
+				} else {
+					this.reconnect();
+				}
+			}
+
+			// Log must be sent after state change is complete
+			let message = `Connector | Close (code: ${event.code}, reason: ${event.reason})`;
+			if (previousState === "connected" && event.code !== 1000) {
+				logger.info(message);
+			} else {
+				logger.verbose(message);
+			}
+		};
+
+		this._socket.onerror = event => {
+			// It's assumed that close is always called by ws
+			let code = !event.error ? "" : `, code: ${event.error.code}`;
+			let message = `Connector | Socket error: ${event.message || "unknown error"}${code}`;
+			if (this._state === "connected") {
+				logger.error(message);
+			} else {
+				// Don't log as error if not actually connected, prevents
+				// log spam during reconnecting attempts.
+				logger.verbose(message);
+			}
+			if (event.error) {
+				// Abort connection if certificate validation failed
+				if ([
+					"CERT_HAS_EXPIRED",
+					"DEPTH_ZERO_SELF_SIGNED_CERT",
+					"ERR_TLS_CERT_ALTNAME_INVALID",
+				].includes(event.error.code)) {
+					this.emit("error", new libErrors.AuthenticationFailed(event.error.message));
+					this._closing = true;
+				}
+			}
+		};
+
+		this._socket.onopen = () => {
+			logger.verbose("Connector | Open");
+		};
+
+		// Handle messages
+		this._socket.onmessage = event => {
+			let message = JSON.parse(event.data);
+			if (["connecting", "resuming"].includes(this._state)) {
+				this._processHandshake(message);
+
+			} else if (this._state === "connected") {
+				if (message.seq !== null) {
+					this._lastReceivedSeq = message.seq;
+				}
+
+				if (message.type === "heartbeat") {
+					this._processHeartbeat(message);
+
+				} else {
+					this.emit("message", message);
+				}
+
+			} else {
+				throw new Error(`Received message in unexpected state ${this._state}`);
+			}
+		};
+	}
+
+	_processHandshake(message) {
+		if (!libSchema.serverHandshake(message)) {
+			logger.warn("Connector | closing after received invalid handshake");
+			this._socket.close(1002, "Invalid handshake");
+			return;
+		}
+
+		let { seq, type, data } = message;
+		if (type === "hello") {
+			logger.verbose(`Connector | received hello from master version ${data.version}`);
+			this.emit("hello", data);
+			if (this._sessionToken) {
+				logger.verbose("Connector | Attempting resume");
+				this.sendHandshake("resume", {
+					session_token: this._sessionToken,
+					last_seq: this._lastReceivedSeq,
+				});
+			} else {
+				this.register();
+			}
+
+		} else if (type === "ready") {
+			logger.verbose("Connector | received ready from master");
+			this._state = "connected";
+			this._sessionToken = data.session_token;
+			this._sessionTimeout = data.session_timeout;
+			this._heartbeatInterval = data.heartbeat_interval;
+			this.startHeartbeat();
+			for (let bufferedMessage of this._sendBuffer) {
+				this._socket.send(JSON.stringify(bufferedMessage));
+			}
+			this.emit("connect", data);
+
+		} else if (type === "continue") {
+			logger.info("Connector | resuming existing session");
+			this._state = "connected";
+			this._heartbeatInterval = data.heartbeat_interval;
+			this._sessionTimeout = data.session_timeout;
+			this.startHeartbeat();
+			this._dropSendBufferSeq(data.last_seq);
+			for (let bufferedMessage of this._sendBuffer) {
+				this._socket.send(JSON.stringify(bufferedMessage));
+			}
+			this._startedResuming = null;
+			this.emit("resume");
+
+		} else if (type === "invalidate") {
+			logger.warn("Connector | session invalidated by master");
+			this._state = "connecting";
+			this._seq = 1;
+			this._lastReceivedSeq = null;
+			this._sessionToken = null;
+			this._sessionTimeout = null;
+			this._sendBuffer.length = 0;
+			this._startedResuming = null;
+			this.emit("invalidate");
+			this.register();
+		}
+	}
+
+	/**
+	 * Register the link with the server
+	 *
+	 * This function is expected to be overriden by sub-classes and send the
+	 * register message over the socket when invoked.
+	 */
+	register() {
+		throw Error("Abstract function");
+	}
+}
+
+/**
+ * Connector for in-memory local links
+ *
+ * @extends events.EventEmitter
+ * @memberof module:lib/link
+ */
+class VirtualConnector extends events.EventEmitter {
+	constructor() {
+		super();
+
+		this.other = this;
+		this._seq = 1;
+	}
+
+	/**
+	 * Create a pair of virtual connector hooked into each other
+	 *
+	 * Creates two virtual connectors that are liked to each othes such that
+	 * a message sent on one is received by the other.
+	 *
+	 * @returns {Array} two virtuarl connectors.
+	 */
+	static makePair() {
+		let first = new this();
+		let second = new this();
+		first.other = second;
+		second.other = first;
+		return [first, second];
+	}
+
+	/**
+	 * Send a message to the other end of the connector
+	 *
+	 * @param {string} type - Message type to send.
+	 * @param {Object} data - Data to send with message.
+	 * @returns {number} the sequence number of the message sent
+	 */
+	send(type, data) {
+		let seq = this._seq;
+		this._seq += 1;
+		this.other.emit("message", { seq, type, data });
+		return seq;
+	}
+}
+
+module.exports = {
+	WebSocketBaseConnector,
+	WebSocketClientConnector,
+	VirtualConnector,
+};

packages/lib/link/index.js

@@ -0,0 +1,15 @@
+/**
+ * Library for message based communication between nodes
+ * @module lib/link
+ * @author Hornwitser
+ */
+"use strict";
+const link = require("./link");
+const messages = require("./messages");
+const connectors = require("./connectors");
+
+module.exports = {
+	...link,
+	...messages,
+	...connectors,
+};

packages/lib/link/link.js

@@ -0,0 +1,264 @@
+// Implementation of Link class
+"use strict";
+
+const libSchema = require("../schema");
+const libErrors = require("../errors");
+const { logger } = require("../logging");
+const messages = require("./messages");
+
+// Some definitions for the terminology used here:
+// link: Either side of a master - client connection
+// connector: Adapter between a link and a socket connection
+// connection: the master server side of a link
+// client: the side that is not the master server of a link
+// message: the complete object sent using the 'message' event
+// data: the data property of a message, essentially the payload.
+// type: the type property of a message, identifies what to expect in data.
+
+/**
+ * Common interface for server and client connections
+ *
+ * @memberof module:lib/link
+ */
+class Link {
+	constructor(source, target, connector) {
+		this.source = source;
+		this.target = target;
+		this.connector = connector;
+
+		this._waiters = new Map();
+		this._handlers = new Map();
+		this._validators = new Map();
+
+		// Process messages received by the connector
+		connector.on("message", payload => {
+			try {
+				this.processMessage(payload);
+			} catch (err) {
+				if (err instanceof libErrors.InvalidMessage) {
+					logger.error(`Invalid message on ${this.source}-${this.target} link: ${err.message}`);
+					if (err.errors) {
+						logger.error(JSON.stringify(err.errors, null, 4));
+					}
+
+					// Send back an error response if this was a request.
+					if (
+						typeof payload.type === "string"
+						&& payload.type.endsWith("_request")
+						&& Number.isInteger(payload.seq)
+					) {
+						this.connector.send(
+							`${payload.type.slice(0, -8)}_response`,
+							{ seq: payload.seq, error: err.message }
+						);
+					}
+				} else {
+					this.connector.emit("error", err);
+				}
+			}
+		});
+
+		connector.on("invalidate", () => {
+			for (let waiterType of this._waiters.values()) {
+				for (let waiter of waiterType) {
+					waiter.reject(new libErrors.SessionLost("Session Lost"));
+				}
+			}
+
+			this._waiters.clear();
+		});
+
+		connector.on("close", () => {
+			for (let waiterType of this._waiters.values()) {
+				for (let waiter of waiterType) {
+					waiter.reject(new libErrors.SessionLost("Session Closed"));
+				}
+			}
+
+			this._waiters.clear();
+		});
+	}
+
+	/**
+	 * Process a received message on the link
+	 *
+	 * Validates and invokes the handler and/or waiters for a message that has
+	 * been received.  An unhandled message is considered to be an error.
+	 *
+	 * @param {Object} message - Message to process.
+	 * @throws {module:lib/errors.InvalidMessage}
+	 *     if validation failed, is missing, the message is invalid, or no
+	 *     handlers/waiters were invoked to handle the message.
+	 */
+	processMessage(message) {
+		if (!libSchema.message(message)) {
+			throw new libErrors.InvalidMessage("Malformed", libSchema.message.errors);
+		}
+
+		let validator = this._validators.get(message.type);
+		if (!validator) {
+			throw new libErrors.InvalidMessage(`No validator for ${message.type} on ${this.source}-${this.target}`);
+		}
+
+		if (!validator(message)) {
+			throw new libErrors.InvalidMessage(`Validation failed for ${message.type}`, validator.errors);
+		}
+
+		let hadHandlers = this._processHandler(message);
+		let hadWaiters = this._processWaiters(message);
+
+		if (!hadWaiters && !hadHandlers) {
+			// XXX console.error(`Unhandled message: ${JSON.stringify(message, null, 4)}`);
+			throw new libErrors.InvalidMessage(`Unhandled message ${message.type}`);
+		}
+	}
+
+	/**
+	 * Invoke the handler for this message if it exists
+	 *
+	 * @param {Object} message - Message to invoke handlers on.
+	 * @returns {Boolean} true if a handler was invoked.
+	 */
+	_processHandler(message) {
+		let handler = this._handlers.get(message.type);
+		if (handler) {
+			handler(message);
+			return true;
+		}
+		return false;
+	}
+
+	/**
+	 * Invokes the waiters for this message if any
+	 *
+	 * @param {Object} message - Message to invoke waiters on.
+	 * @returns {Boolean} true if a waiter was triggered.
+	 */
+	_processWaiters(message) {
+		let { seq, type, data } = message;
+		let waiters = this._waiters.get(type);
+		if (!waiters || !waiters.length) {
+			return false;
+		}
+
+		let matched = [];
+		waitersLoop: for (let index = 0; index < waiters.length; index++) {
+			let waiter = waiters[index];
+			for (let [key, value] of Object.entries(waiter.data)) {
+				if (data[key] !== value) {
+					continue waitersLoop;
+				}
+			}
+
+			waiter.resolve(message);
+			matched.push(index);
+		}
+
+		matched.reverse();
+		for (let index of matched) {
+			waiters.splice(index, 1);
+		}
+
+		return matched.length > 0;
+	}
+
+	/**
+	 * Set handler for a message type
+	 *
+	 * Set function called upon receiving a message of the given type.
+	 *
+	 * @param {string} type - Type of message to listen to
+	 * @param {function} handler -
+	 *     Callack to invoke on messages of the given type.
+	 * @param {function} validator -
+	 *     Function validating the message have the correct format.
+	 */
+	setHandler(type, handler, validator) {
+		if (this._handlers.has(type)) {
+			throw new Error(`${type} already has a handler`);
+		}
+
+		if (!validator) {
+			throw new Error("validator is required");
+		}
+
+		this.setValidator(type, validator);
+		this._handlers.set(type, handler);
+	}
+
+	/**
+	 * Set validator for a message type
+	 *
+	 * Set function called upon receiving a message of the given type in
+	 * order to validate the message.  The function should return true if
+	 * the message is valid and false otherwise.
+	 *
+	 * @param {string} type - Type of message to validate
+	 * @param {function} validator - Validation function.
+	 */
+	setValidator(type, validator) {
+		if (this._validators.has(type)) {
+			throw new Error(`${type} already has a validator`);
+		}
+
+		this._validators.set(type, validator);
+	}
+
+	/**
+	 * Wait for a message matching given type and data
+	 *
+	 * Waits for a message over the link that matches the type given as well
+	 * as any properties specified in data.  For example specifying { foo:
+	 * 21 } as the data will cause it to wait until a message with the right
+	 * type and a foo property value of 21 in the data payload.
+	 *
+	 * @param {string} type - Message type to wait for.
+	 * @param {Object} data - Properties to match in the message data.
+	 */
+	async waitFor(type, data) {
+		if (!this._validators.has(type)) {
+			throw new Error(`No validator for ${type} on ${this.source}-${this.target}`);
+		}
+
+		let waiter = { data };
+		waiter.promise = new Promise((resolve, reject) => {
+			waiter.resolve = resolve;
+			waiter.reject = reject;
+			if (!this._waiters.has(type)) {
+				this._waiters.set(type, [waiter]);
+			} else {
+				this._waiters.get(type).push(waiter);
+			}
+		});
+		return waiter.promise;
+	}
+
+	/**
+	 * Handle ping requests
+	 */
+	async pingRequestHandler() { }
+
+	/**
+	 * Prepare connection for disconnect
+	 *
+	 * Waits for all pending requests on the connection to resolve.
+	 * Sub-classes should implement this handler with code that prevents
+	 * additional requests to be sent out before calling the super class
+	 * method.
+	 */
+	async prepareDisconnectRequestHandler() {
+		let promises = [];
+		for (let waiterType of this._waiters.values()) {
+			for (let waiter of waiterType) {
+				promises.push(waiter.promise.then(() => {}, () => {}));
+			}
+		}
+
+		await Promise.all(promises);
+	}
+}
+
+
+module.exports = {
+	Link,
+};

packages/lib/logging.js

@@ -0,0 +1,94 @@
+"use strict";
+const winston = require("winston");
+const Transport = require("winston-transport");
+const { LEVEL, MESSAGE } = require("triple-beam");
+
+const levels = Object.freeze({
+	fatal: 0,
+	error: 1,
+	warn: 2,
+	audit: 3,
+	info: 4,
+	server: 5,
+	verbose: 6,
+});
+
+const colors = {
+	fatal: "inverse red",
+	error: "bold brightRed",
+	warn: "bold brightYellow",
+	audit: "bold brightGreen",
+	info: "bold brightBlue",
+	server: "bold",
+	verbose: "bold grey",
+};
+winston.addColors(colors);
+
+// The Console Transport is replicated here because it's overly complicated
+// in winston, writes to stdout/err instead of console and doesn't work in
+// the browser.
+class ConsoleTransport extends Transport {
+	constructor(options = {}) {
+		super(options);
+		this.errorLevels = new Set(options.errorLevels || ["fatal", "error"]);
+		this.warnLevels = new Set(options.warnLevels || ["warn"]);
+	}
+
+	log(info, callback) {
+		/* eslint-disable no-console */
+		if (this.errorLevels.has(info[LEVEL])) {
+			console.error(info[MESSAGE]);
+		} else if (this.warnLevels.has(info[LEVEL])) {
+			console.warn(info[MESSAGE]);
+		} else {
+			console.log(info[MESSAGE]);
+		}
+		/* eslint-enable no-console */
+		callback();
+	}
+}
+
+/**
+ * Formats winston log messages for the web console
+ */
+class WebConsoleFormat {
+	constructor(options = {}) {
+		this.options = options;
+	}
+
+	transform(info, options) {
+		let src = " ";
+		if (info.slave_id) {
+			let slaveName = info.slave_id;
+			src += `s:${slaveName} - `;
+		}
+		if (info.instance_id) {
+			let instanceName = info.instance_id;
+			src += `i:${instanceName}`;
+		}
+		if (info.plugin) {
+			src += `${info.plugin}: `;
+		}
+
+		if (info.stack) {
+			info[MESSAGE] = `[${info.level}]${src}${info.stack}`;
+		} else {
+			info[MESSAGE] = `[${info.level}]${src}${info.message}`;
+		}
+		return info;
+	}
+}
+
+const logger = winston.createLogger({
+	level: "verbose",
+	levels,
+	format: winston.format.timestamp(),
+});
+
+module.exports = {
+	ConsoleTransport,
+	WebConsoleFormat,
+	colors,
+	levels,
+	logger,
+};

packages/lib/logging_utils.js

@@ -0,0 +1,131 @@
+"use strict";
+const winston = require("winston");
+const Transport = require("winston-transport");
+const { LEVEL, MESSAGE } = require("triple-beam");
+const chalk = require("chalk");
+
+const libLink = require("./link");
+const libErrors = require("./errors");
+
+
+/**
+ * Format a parsed Factorio message with colors
+ *
+ * Formats a parsed Factorio output from lib/factorio into a readable
+ * colorized output using terminal escape codes that can be printed.
+ *
+ * @param {Object} parsed - Parsed Factorio server output.
+ * @returns {string} terminal colorized message.
+ * @private
+ */
+function formatServerOutput(parsed) {
+	let time = "";
+	if (parsed.format === "seconds") {
+		time = `${chalk.yellow(parsed.time.padStart(8))} `;
+	} else if (parsed.format === "date") {
+		time = `${chalk.yellow(parsed.time)} `;
+	}
+
+	let info = "";
+	if (parsed.type === "log") {
+		let level = parsed.level;
+		if (level === "Script") {
+			level = chalk.bold.greenBright(level);
+		} else if (level === "Verbose") {
+			level = chalk.bold.gray(level);
+		} else if (level === "Info") {
+			level = chalk.bold.blueBright(level);
+		} else if (parsed.level === "Warning") {
+			level = chalk.bold.yellowBright(level);
+		} else if (parsed.level === "Error") {
+			level = chalk.bold.redBright(level);
+		}
+
+		info = `${level} ${chalk.gray(parsed.file)}: `;
+
+	} else if (parsed.type === "action") {
+		info = `[${chalk.yellow(parsed.action)}] `;
+	}
+
+	return time + info + parsed.message;
+}
+
+// These are defined here to avoid circular dependencies and pulling them
+// into the web interface code.
+
+/**
+ * Formats winston log messages for a character terminal.
+ */
+class TerminalFormat {
+	constructor(options = {}) {
+		this.options = options;
+		this.colorize = winston.format.colorize(options);
+	}
+
+	transform(info, options) {
+		info = this.colorize.transform(info, this.colorize.options);
+		let ts = "";
+		if (options.showTimestamp && info.timestamp) {
+			ts = `${info.timestamp.replace("T", " ")} `;
+		}
+
+		let src = " ";
+		if (info.instance_name) {
+			src += `i:${info.instance_name} `;
+
+		} else if (info.slave_name) {
+			src += `s:${info.slave_name} `;
+		}
+		if (info.plugin) {
+			src += `${info.plugin}: `;
+		}
+
+		if (info[LEVEL] === "server" && info.parsed) {
+			info.message = formatServerOutput(info.parsed);
+		}
+
+		if (info.stack) {
+			info[MESSAGE] = `${ts}[${info.level}]${src}${info.stack}`;
+		} else {
+			info[MESSAGE] = `${ts}[${info.level}]${src}${info.message}`;
+		}
+		return info;
+	}
+}
+
+/**
+ * Sends logs over a lib/link connection.
+ */
+class LinkTransport extends Transport {
+	constructor(options) {
+		super(options);
+
+		this.link = options.link;
+		this.filter = options.filter || null;
+	}
+
+	log(info, callback) {
+		if (this.filter && !this.filter(info)) {
+			return callback();
+		}
+
+		try {
+			libLink.messages.logMessage.send(this.link, { info });
+		} catch (err) {
+			// Ignore session lost errors.
+			if (!(err instanceof libErrors.SessionLost)) {
+				throw err;
+			}
+		}
+		return callback();
+	}
+}
+
+
+module.exports = {
+	TerminalFormat,
+	LinkTransport,
+
+	// for testing only
+	_formatServerOutput: formatServerOutput,
+};

packages/lib/lua_tools.js

@@ -0,0 +1,26 @@
+/**
+ * Utilities for dealing with Lua
+ * @module lib/lua_tools
+ */
+"use strict";
+
+/**
+ * Escapes a string for inclusion into a lua string
+ *
+ * @param {string} content - String to escape.
+ * @returns {string} Escaped string.
+ */
+function escapeString(content) {
+	return content
+		.replace(/\\/g, "\\\\")
+		.replace(/"/g, '\\"')
+		.replace(/'/g, "\\'")
+		.replace(/\0/g, "\\0")
+		.replace(/\n/g, "\\n")
+		.replace(/\r/g, "\\r")
+	;
+}
+
+module.exports = {
+	escapeString,
+};

packages/lib/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@clusterio/lib",
+  "description": "Shared library for Clusterio",
+  "version": "2.0.0-alpha.10",
+  "repository": "https://github.com/clusterio/clusterio",
+  "license": "MIT",
+  "browser": "browser.js",
+  "keywords": [
+    "factorio"
+  ],
+  "engines": {
+    "node": ">=12"
+  },
+  "dependencies": {
+    "ajv": "^6.12.6",
+    "chalk": "^4.1.0",
+    "fs-extra": "^8.1.0",
+    "isomorphic-ws": "^4.0.1",
+    "jimp": "^0.12.1",
+    "jsonwebtoken": "^8.2.1",
+    "jszip": "^3.2.2",
+    "klaw": "^3.0.0",
+    "rcon-client": "^4.2.0",
+    "semver": "^7.1.1",
+    "set-blocking": "^2.0.0",
+    "triple-beam": "^1.3.0",
+    "winston": "^3.3.3",
+    "winston-transport": "^4.4.0",
+    "ws": "^7.2.3",
+    "yargs": "^14.2.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/lib/plugin.js

@@ -0,0 +1,756 @@
+/**
+ * Plugin interfaces and utilities.
+ * @module lib/plugin
+ */
+"use strict";
+
+
+/**
+ * Conceptual base for master and instance plugins.
+ * @typedef {
+ *     module:lib/plugin.BaseMasterPlugin
+ *     |module:lib/plugin.BaseInstancePlugin
+ *     |module:lib/plugin.BaseControlPlugin
+ * } module:lib/plugin.BasePlugin
+ */
+
+/**
+ * Base class for instance plugins
+ *
+ * Instance plugins are subclasses of this class which get instantiated by
+ * the slave when it brings up an instance with the plugin enabled in the
+ * config.  To be discovered the class must be exported under the name
+ * `InstancePlugin` in the module specified by the `instanceEntrypoint` in
+ * the plugin's info.js file.
+ *
+ * Instances may be started and stopped many times, and many instances may
+ * be running at the same time, each of which will have their own instance
+ * of the InstancePlugin class.
+ *
+ * @static
+ */
+class BaseInstancePlugin {
+	constructor(info, instance, slave) {
+		/**
+		 * The plugin's own info module
+		 */
+		this.info = info;
+
+		/**
+		 * Instance the plugin started for
+		 * @type {module:slave/slave~Instance}
+		 */
+		this.instance = instance;
+
+		/**
+		 * Slave running the instance
+		 *
+		 * With the exepction of accessing the slave's config you should
+		 * avoid ineracting with the slave object directly.
+		 *
+		 * @type {module:slave/slave~Slave}
+		 */
+		this.slave = slave;
+
+		/**
+		 * Logger for this plugin
+		 *
+		 * Instance of winston Logger for sending log messages from this
+		 * plugin.  Supported methods and their corresponding log levels are
+		 * `error`, `warn`, `audit`, `info` and `verbose`.
+		 */
+		this.logger = instance.logger.child({ plugin: this.info.name });
+
+		this._pendingRconMessages = [];
+		this._sendingRconMessages = false;
+	}
+
+	/**
+	 * Called immediately after the class is instantiated
+	 */
+	async init() { }
+
+	/**
+	 * Called when the value of a config field changed.
+	 *
+	 * Invoked after the value of the config field given by `field` has
+	 * changed.
+	 *
+	 * @param {module:lib/config.ConfigGroup} group -
+	 *     The group who's field got changed on.
+	 * @param {string} field - Name of the field that changed.
+	 * @param {*} prev - The previous value of the field.
+	 */
+	async onInstanceConfigFieldChanged(group, field, prev) { }
+
+	/**
+	 * Called before collecting Prometheus metrics
+	 *
+	 * Invoked before the default metrics of prometheus is collected.  Note
+	 * that since this is done while replying to /metrics this should not
+	 * take a long time, otherwise the requst will time out.
+	 *
+	 * Although you can return the results of collecting your prometheus
+	 * collectors directly, all gauges in the default registry is already
+	 * automatically collected.  It's therefore recommended to only update
+	 * the Gauges/Counters/etc in onMetric and let Clusterio deal will
+	 * collecting the values.
+	 *
+	 * @returns {*} an async iterator of prometheus metric results or undefined.
+	 */
+	async onMetrics() { }
+
+	/**
+	 * Called after the Factorio server is started
+	 */
+	async onStart() { }
+
+	/**
+	 * Called before the Factorio server is stopped
+	 *
+	 * This will not be called if for example the Factorio server crashes or
+	 * is killed.
+	 */
+	async onStop() { }
+
+	/**
+	 * Called when the instance exits
+	 *
+	 * Invoked when the instance is shut down.  This may occur after init
+	 * has been called if an error occurs during startup.  Note that if
+	 * the plugin's init() throws this method will still be invoked.
+	 */
+	onExit() { }
+
+	/**
+	 * Called when the Factorio outputs a line
+	 *
+	 * Called when the Factorio server outputs a line on either stdout or
+	 * stderr.  The output is a parsed form of the line and contains the
+	 * following properties:
+	 *
+	 * @param {Object} parsed - parsed server output.
+	 * @param {string} parsed.source -
+	 *     Where the message came from, one of "stdout" and "stderr".
+	 * @param {string} parsed.format -
+	 *     Timestamp format, one of "date", "seconds" and "none".
+	 * @param {string=} parsed.time -
+	 *     Timestamp of the message.  Not present if format is "none".
+	 * @param {string} parsed.type -
+	 *     Type of message, one of "log", "action" and "generic".
+	 * @param {string=} parsed.level -
+	 *     Log level for "log" type.  i.e "Info" normally.
+	 * @param {string=} parsed.file - File reported for "log" type.
+	 * @param {string=} parsed.action -
+	 *     Kind of action for "action" type. i.e "CHAT" for chat.
+	 * @param {string} parsed.message - Main content of the line.
+	 * @param {string} line - raw line of server output.
+	 */
+	async onOutput(parsed, line) { }
+
+	/**
+	 * Called when an event on the master connection happens
+	 *
+	 * The event param may be one of connect, drop, resume and close and has
+	 * the following meaning:
+	 *
+	 * ##### connect
+	 *
+	 * Invoked when a new connection to the master has been established.
+	 *
+	 * ##### drop
+	 *
+	 * Invoked when a connection loss is detected between the slave and the
+	 * master.  Plugins should respond to this event by throtteling messages
+	 * it is sending to the master to an absolute minimum.
+	 *
+	 * Messages sent over a dropped master connection will get queued up in
+	 * memory on the slave and sent all in one go when the connection is
+	 * re-established again.
+	 *
+	 * ##### resume
+	 *
+	 * Invoked when the connection that had previously dropped is
+	 * re-established.
+	 *
+	 * ##### close
+	 *
+	 * Invoked when the connection to the master has been closed.  This
+	 * typically means the master server has shut down.  Plugins should not
+	 * send any messages that goes to or via the master server after the
+	 * connection has been closed and before a new one is established.
+	 *
+	 * @param {string} event - one of connect, drop, resume and close
+	 */
+	onMasterConnectionEvent(event) { }
+
+	/**
+	 * Called when the master is preparing to disconnect from the slave
+	 *
+	 * Invoked when the master server has requested the disconnection from
+	 * the slave.  This typically happens when it is in the process of
+	 * shutting down.
+	 *
+	 * Plugins must stop sending messages to the master, or are forwarded
+	 * via the master server after the prepare disconnect has been handled.
+	 *
+	 * @param {module:master/src/SlaveConnection} connection -
+	 *     The connection to the slave preparing to disconnect.
+	 */
+	async onPrepareMasterDisconnect(connection) { }
+
+	/**
+	 * Called when a player joins or leaves the game
+	 *
+	 * Invoked when a player either joins or leaves the instance.
+	 *
+	 * @param {Object} event - Information about the event.
+	 * @param {string} event.type - Either "join" or "leave".
+	 * @param {string} event.name - Name of the player that joined/left.
+	 */
+	async onPlayerEvent(event) { }
+
+	/**
+	 * Send RCON message to instance
+	 *
+	 * Send a message or command to the server which can potentially be
+	 * executed out of order in relation to other RCON commands.
+	 *
+	 * This should not be called before onStart or after onStop.  A simple
+	 * way to achieve this is to check that the instance status is running
+	 * before sending commands. Note that the instance status is set to
+	 * running some time after `onStart` and some time before `onStop` is
+	 * invoked.
+	 *
+	 * @param {string} message - message to send to server over RCON.
+	 * @param {boolean=} [expectEmpty=false] -
+	 *     if true throw if the response is not empty.  Useful for detecting
+	 *     errors that might have been sent in response.
+	 * @returns {Promise<string>} response from server.
+	 */
+	async sendRcon(message, expectEmpty=false) {
+		return await this.instance.sendRcon(message, expectEmpty, this.info.name);
+	}
+
+	/**
+	 * Send serially ordered RCON message to instance
+	 *
+	 * Send a message or command to the server which will not be executed
+	 * out of order in relation to other RCON commands sent with this
+	 * method. The ordering applies per plugin, and two plugins sending
+	 * commands with this method may execute out of order in relation to
+	 * each other.
+	 *
+	 * This should not be called before onStart or after onStop.  A simple
+	 * way to achieve this is to check that the instance status is running
+	 * before sending commands. Note that the instance status is set to
+	 * running some time after `onStart` and some time before `onStop` is
+	 * invoked.
+	 *
+	 * @param {string} message - message to send to server over RCON.
+	 * @param {boolean=} [expectEmpty=false] -
+	 *     if true throw if the response is not empty.  Useful for detecting
+	 *     errors that might have been sent in response.
+	 * @returns {Promise<string>} response from server.
+	 */
+	async sendOrderedRcon(message, expectEmpty=false) {
+		let promise = new Promise((resolve, reject) => {
+			this._pendingRconMessages.push({resolve, reject, message, expectEmpty});
+		});
+		if (!this._sendingRconMessages) {
+			this._sendPendingRconMessages();
+		}
+		return await promise;
+	}
+
+	async _sendPendingRconMessages() {
+		this._sendingRconMessages = true;
+		while (this._pendingRconMessages.length) {
+			let task = this._pendingRconMessages.shift();
+			try {
+				let result = await this.sendRcon(task.message, task.expectEmpty);
+				task.resolve(result);
+			} catch (err) {
+				task.reject(err);
+			}
+		}
+		this._sendingRconMessages = false;
+	}
+}
+
+/**
+ * Base class for master plugins
+ *
+ * Master plugins are subclasses of this class which get instantiated by
+ * the master server on startup when the plugin is enabled in the config.
+ * To be discovered the class must be exported under the name `MasterPlugin`
+ * in the module specified by the `masterEntrypoint` in the plugin's info.js
+ * file.
+ *
+ * @static
+ */
+class BaseMasterPlugin {
+	constructor(info, master, metrics, logger) {
+		this.info = info;
+
+		/**
+		 * Master server
+		 * @type {module:master/src/Master}
+		 */
+		this.master = master;
+		this.metrics = metrics;
+
+		/**
+		 * Logger for this plugin
+		 *
+		 * Instance of winston Logger for sending log messages from this
+		 * plugin.  Supported methods and their corresponding log levels are
+		 * `error`, `warn`, `audit`, `info` and `verbose`.
+		 */
+		this.logger = logger.child({ plugin: this.info.name });
+	}
+
+	/**
+	 * Called immediately after the class is instantiated
+	 */
+	async init() { }
+
+	/**
+	 * Called when the status of an instance changes
+	 *
+	 * Invoked when the master server has changed the status of an instance
+	 * or received notice from a slave that the status of an instance has
+	 * changed.  The possible statuses that can be notified about are:
+	 * - `unassigned:`: Instance is no longer asssigned to a slave.
+	 * - `unknown`: Slave assigned to instance is offline.
+	 * - `stopped`: Instance is no longer running or was just assigned to a
+	 *   slave.
+	 * - `starting`: Instance is in the process of starting up.
+	 * - `running`: Instance startup completed and is now running.
+	 * - `stopping`: Instance is in the processing stopping.
+	 * - `creating_save`: Instance is in the process of creating a save.
+	 * - `exporting_data`: Instance is in the process of exporting item
+	 *   icons and locale data.
+	 * - `deleted`: Instance was deleted.
+	 *
+	 * On master startup all known instances gets the status `unknown` if
+	 * they are assigned to a slave, when the slave then connects to the
+	 * master and informs of the current status of its instances this hook
+	 * is invoked for all those instances.  You can detect this situation by
+	 * checking if prev equals `unknown`.  If the slave disconnects the
+	 * instances will again get the `unknown` status.
+	 *
+	 * When instances are created on the master they will notify of a status
+	 * change with prev set to null.  While the status of new instances is
+	 * in most cases `unassigned` it's possible for the created instance to
+	 * start with any state in some slave connection corner cases.
+	 *
+	 * Note that it's possible for status change notification to get lost in
+	 * the case of network outages if reconnect fails to re-establish the
+	 * session between the master server and the slave.
+	 *
+	 * @param {Object} instance - the instance that changed.
+	 * @param {?string} prev - the previous status of the instance.
+	 */
+	async onInstanceStatusChanged(instance, prev) { }
+
+	/**
+	 * Called when the value of an instance config field changed.
+	 *
+	 * Invoked after the value of the config field given by `field` has
+	 * changed on an instance.
+	 *
+	 * @param {Object} instance - The instance the config changed on.
+	 * @param {module:lib/config.ConfigGroup} group -
+	 *     The group who's field got changed on.
+	 * @param {string} field - Name of the field that changed.
+	 * @param {*} prev - The previous value of the field.
+	 */
+	async onInstanceConfigFieldChanged(instance, group, field, prev) { }
+
+	/**
+	 * Called before collecting Prometheus metrics
+	 *
+	 * Invoked before the default metrics of prometheus is collected.  Note
+	 * that since this is done while replying to /metrics this should not
+	 * take a long time, otherwise the requst will time out.
+	 *
+	 * Although you can return the results of collecting your prometheus
+	 * collectors directly, all gauges in the default registry is already
+	 * automatically collected.  It's therefore recommended to only update
+	 * the Gauges/Counters/etc in onMetric and let Clusterio deal will
+	 * collecting the values.
+	 *
+	 * @returns {*} an async iterator of prometheus metric results or undefined.
+	 */
+	async onMetrics() { }
+
+	/**
+	 * Called when the master server is shutting down
+	 */
+	async onShutdown() { }
+
+	/**
+	 * Called when an event on a slave connection happens
+	 *
+	 * The event param may be one of connect, drop, resume and close and has
+	 * the following meaning:
+	 *
+	 * ##### connect
+	 *
+	 * Invoked when a new connection to the slave has been established.
+	 *
+	 * ##### drop
+	 *
+	 * Invoked when a connection loss is detected between the master and a
+	 * slave.  Plugins should respond to this event by throtteling messages
+	 * it is sending to the given slave connection to an absolute minimum.
+	 *
+	 * Messages sent over a dropped slave connection will get queued up in
+	 * memory on the master and sent all in one go when the connection is
+	 * re-established again.
+	 *
+	 * ##### resume
+	 *
+	 * Invoked when a connection that had previously been dropped is
+	 * re-established
+	 *
+	 * ##### close
+	 *
+	 * Invoked when the connection to the slave has been closed.
+	 *
+	 * @param {module:master/src/SlaveConnection} connection -
+	 *     The connection the event occured on.
+	 * @param {string} event - one of connect, drop, resume and close
+	 */
+	onSlaveConnectionEvent(connection, event) { }
+
+	/**
+	 * Called when an avent on a control connection happens
+	 *
+	 * The event param may be one of connect, drop, resume and close and has
+	 * the following meaning:
+	 *
+	 * ##### connect
+	 *
+	 * Invoked when a new connection to the control has been established.
+	 *
+	 * ##### drop
+	 *
+	 * Invoked when a connection loss is detected between the master and a
+	 * control.  Plugins should respond to this event by throtteling
+	 * messages it is sending to the given control connection to an absolute
+	 * minimum.
+	 *
+	 * Messages sent over a dropped control connection will get queued up in
+	 * memory on the master and sent all in one go when the connection is
+	 * re-established again.
+	 *
+	 * ##### resume
+	 *
+	 * Invoked when a connection that had previously been dropped is
+	 * re-established.
+	 *
+	 * ##### close
+	 *
+	 * Invoked when the connection to the control has been closed.
+	 *
+	 * @param {module:master/src/ControlConnection} connection -
+	 *     The connection the event occured on.
+	 * @param {string} event - one of connect, drop, resume, and close.
+	 */
+	onControlConnectionEvent(connection, event) { }
+
+
+	/**
+	 * Called when a slave is preparing to disconnect from the master
+	 *
+	 * Invoked when a slave has requested the disconnection from the master.
+	 * This typically happens when it is in the process of shutting down.
+	 *
+	 * Plugins must stop sending messages to the slave in question after the
+	 * prepare disconnect has been handled.
+	 *
+	 * @param {module:master/src/SlaveConnection} connection -
+	 *     The connection to the slave preparing to disconnect.
+	 */
+	async onPrepareSlaveDisconnect(connection) { }
+
+	/**
+	 * Called when a player joins or leaves an instance
+	 *
+	 * Invoked when a player either joins or leaves an instance in the
+	 * cluster.
+	 *
+	 * @param {Object} instance - the instance it occured on.
+	 * @param {Object} event - Information about the event.
+	 * @param {string} event.type - Either "join" or "leave".
+	 * @param {string} event.name - Name of the player that joined/left.
+	 */
+	async onPlayerEvent(instance, event) { }
+
+	/**
+	 * Broadcast event to all connected slaves
+	 *
+	 * Sends the given event to all slaves connected to the master server.
+	 * This does not include slaves that are in the process of closing the
+	 * connection, which typically happens when they are shutting down.
+	 *
+	 * @param {module:lib/link.Event} event - Event to send
+	 * @param {Object} data - Data ta pass with the event.
+	 */
+	broadcastEventToSlaves(event, data={}) {
+		for (let slaveConnection of this.master.wsServer.slaveConnections.values()) {
+			if (
+				!slaveConnection.connector.closing
+				&& (!event.plugin || slaveConnection.plugins.has(event.plugin))
+			) {
+				event.send(slaveConnection, data);
+			}
+		}
+	}
+}
+
+/**
+ * Base class for clusterioctl plugins
+ *
+ * Control plugins are subclasses of this class which get instantiated by
+ * clusterioctl in order to extend its functionallity.  To be discovered the
+ * class must be exported under the name `ControlPlugin` in the module
+ * specified by the `controlEntrypoint` in the plugin's info.js file.
+ *
+ * @static
+ */
+class BaseControlPlugin {
+	constructor(info, logger) {
+		/**
+		 * The plugin's own info module
+		 */
+		this.info = info;
+
+		/**
+		 * Logger for this plugin
+		 *
+		 * Instance of winston Logger for sending log messages from this
+		 * plugin.  Supported methods and their corresponding log levels are
+		 * `error`, `warn`, `audit`, `info` and `verbose`.
+		 */
+		this.logger = logger.child({ plugin: this.info.name });
+	}
+
+	/**
+	 * Called immediately after the class is instantiated
+	 */
+	async init() { }
+
+	/**
+	 * Called to add commands to the command line interface.
+	 *
+	 * Invoked by clusterioctl to let plugins add commands.  `rootCommand` is
+	 * the top level command node which the plugin should add its own {@link
+	 * module:lib/command.CommandTree} to.
+	 *
+	 * @param {module:lib/command.CommandTree} rootCommand -
+	 *     Root of the clusterioctl command tree.
+	 */
+	async addCommands(rootCommand) { }
+}
+
+
+/**
+ * Plugin supplied login form
+ * @typedef {Object} module:lib/plugin~LoginForm
+ * @property {string} name -
+ *     Internal name of the login form, this should start with the
+ *     plugin name followed by a dot.
+ * @property {string} title -
+ *     Name displayed above this form in the login window.
+ * @property {React.Component} Component -
+ *     React component that's rendered for this login form.  This is
+ *     supplied the setToken function via its props which should be
+ *     called when an authentication token is aquired via this
+ *     form.
+ */
+
+/**
+ * Plugin supplied pages
+ * @typedef {Object} module:Lib/plugin~Page
+ * @property {string} path - URL path to this page.
+ * @property {string=} sidebarPath -
+ *     If present and this path matches one of the pages in the sidebar it
+ *     will cause that sidebar entry to be highlighted as active.
+ * @property {string=} sidebarName -
+ *     If present creates an entry in the sidebar for this page with the
+ *     given text.
+ * @property {ReactNode} content -
+ *     A react node which is rendered when this page is navigated to.
+ *     Should render a PageLayout.
+ */
+
+/**
+ * Base class for web interface plugins
+ *
+ * @static
+ */
+class BaseWebPlugin {
+	constructor(container, packageData, info, logger) {
+		/**
+		 * Webpack container for this plugin
+		 */
+		this.container = container;
+
+		/**
+		 * Contents of the plugin's package.json file
+		 * @type {Object}
+		 */
+		this.package = packageData;
+
+		/**
+		 * The plugin's own info module
+		 */
+		this.info = info;
+
+		/**
+		 * Control link to the master server, not available until the
+		 * connect event in onMasterConnectionEvent is signaled.
+		 * @type {?module:lib/link.Link}
+		 */
+		this.control = null;
+
+		/**
+		 * Logger for this plugin
+		 *
+		 * Instance of winston Logger for sending log messages from this
+		 * plugin.  Supported methods and their corresponding log levels are
+		 * `error`, `warn`, `audit`, `info` and `verbose`.
+		 */
+		this.logger = logger.child({ plugin: this.info.name });
+
+		/**
+		 * List of login forms provided by this plugin
+		 *
+		 * @type {Array<module:lib/plugin~LoginForm>}
+		 */
+		this.loginForms = [];
+
+		/**
+		 * List of pages provided by this plugin
+		 *
+		 * @type {Array<module:lib/plugin~Page>}
+		 */
+		this.pages = [];
+	}
+
+	/**
+	 * Called immediately after the class is instantiated.
+	 */
+	async init() { }
+
+	/**
+	 * Called when an event on the master connection happens
+	 *
+	 * The event param may be one of connect, drop, resume and close and has
+	 * the following meaning:
+	 *
+	 * ##### connect
+	 *
+	 * Invoked when a new connection to the master has been established.
+	 *
+	 * ##### drop
+	 *
+	 * Invoked when a connection loss is detected between the control link
+	 * and the master.  Plugins should respond to this event by throtteling
+	 * messages it is sending to the master to an absolute minimum.
+	 *
+	 * Messages sent over a dropped master connection will get queued up in
+	 * memory in the browser and sent all in one go when the connection is
+	 * re-established again.
+	 *
+	 * ##### resume
+	 *
+	 * Invoked when the connection that had previously dropped is
+	 * re-established.
+	 *
+	 * ##### close
+	 *
+	 * Invoked when the connection to the master has been closed.  This
+	 * typically means the master server has shut down.  Plugins should not
+	 * send any messages that goes to or via the master server after the
+	 * connection has been closed and before a new one is established.
+	 *
+	 * @param {string} event - one of connect, drop, resume and close
+	 */
+	onMasterConnectionEvent(event) { }
+}
+
+/**
+ * Attach plugin messages
+ *
+ * Attaches all messages defined in the `.info.message` property of the
+ * `plugin` passed with handlers taken from the `pluin`.
+ *
+ * @param {module:lib/link.Link} link - Link to attach handlers to.
+ * @param {module:lib/plugin.BasePlugin} plugin -
+ *     The instance of the plugin attach messages and handlers from.
+ */
+function attachPluginMessages(link, plugin) {
+	let messageDefinitions = plugin.info.messages || [];
+	for (let [name, messageFormat] of Object.entries(messageDefinitions)) {
+		if (messageFormat.plugin !== plugin.info.name) {
+			throw new Error(`Type of ${name} message must start with "${plugin.info.name}:"`);
+		}
+
+		let handler = name + messageFormat.handlerSuffix;
+		try {
+			if (plugin === null || !plugin[handler]) {
+				messageFormat.attach(link);
+
+			} else {
+				messageFormat.attach(link, async (message, format) => await plugin[handler](message, format, link));
+			}
+
+		} catch (err) {
+			if (err.code === "MISSING_LINK_HANDLER") {
+				err.plugin = plugin.info.name;
+				err.handler = handler;
+			}
+
+			throw err;
+		}
+	}
+}
+
+/**
+ * Invokes the given hook on all plugins
+ *
+ * @param {Map<string, Object>} plugins -
+ *     Mapping of plugin names to plugins to invoke the hook on.
+ * @param {string} hook - Name of hook to invoke.
+ * @param {...*} args - Arguments to pass on to the hook.
+ * @returns {Array} Non-empty return values from the hooks.
+ */
+async function invokeHook(plugins, hook, ...args) {
+	let results = [];
+	for (let [name, plugin] of plugins) {
+		try {
+			let result = await plugin[hook](...args);
+			if (result !== undefined) {
+				results.push(result);
+			}
+		} catch (err) {
+			plugin.logger.error(`Ignoring error from plugin ${name} in ${hook}:\n${err.stack}`);
+		}
+	}
+	return results;
+}
+
+
+module.exports = {
+	BaseInstancePlugin,
+	BaseMasterPlugin,
+	BaseControlPlugin,
+	BaseWebPlugin,
+
+	attachPluginMessages,
+	invokeHook,
+};

packages/lib/plugin_loader.js

@@ -0,0 +1,98 @@
+/* eslint-disable node/global-require */
+/**
+ * Helpers for loading plugins in Node.js
+ * @module lib/plugin_loader
+ */
+"use strict";
+
+const libErrors = require("./errors");
+const path = require("path");
+
+
+/**
+ * Load plugin information
+ *
+ * Loads plugin info modules for the paths to the given plugins.  Once
+ * loaded the info modules will not be reloaded should this function be
+ * called again.
+ *
+ * @param {Map<string, string>} pluginList -
+ *     Mapping of plugin name to require path for the plugins to load.
+ * @returns {Array<Object>} Array of plugin info modules.
+ * @static
+ */
+async function loadPluginInfos(pluginList) {
+	let plugins = [];
+	for (let [pluginName, pluginPath] of pluginList) {
+		let pluginInfo;
+		let pluginPackage;
+
+		try {
+			pluginInfo = require(path.posix.join(pluginPath, "info"));
+			pluginPackage = require(path.posix.join(pluginPath, "package.json"));
+
+		} catch (err) {
+			throw new libErrors.PluginError(pluginName, err);
+		}
+
+		if (pluginInfo.name !== pluginName) {
+			throw new libErrors.EnvironmentError(
+				`Expected plugin at ${pluginPath} to be named ${pluginName} but got ${pluginInfo.name}`
+			);
+		}
+
+		pluginInfo.requirePath = pluginPath;
+		pluginInfo.version = pluginPackage.version;
+		plugins.push(pluginInfo);
+	}
+	return plugins;
+}
+
+/**
+ * Load master plugin class of a plugin
+ *
+ * @param {Object} pluginInfo -
+ *     Plugin info object returned from {@link
+ *     module:lib/plugin_loader.loadPluginInfos} to load class from.
+ * @returns {function} plugin class
+ * @static
+ */
+async function loadMasterPluginClass(pluginInfo) {
+	let entrypoint = require(path.posix.join(pluginInfo.requirePath, pluginInfo.masterEntrypoint));
+	return entrypoint.MasterPlugin;
+}
+
+/**
+ * Load instance plugin class of a plugin
+ *
+ * @param {Object} pluginInfo -
+ *     Plugin info object returned from {@link
+ *     module:lib/plugin_loader.loadPluginInfos} to load class from.
+ * @returns {function} plugin class
+ * @static
+ */
+async function loadInstancePluginClass(pluginInfo) {
+	let entrypoint = require(path.posix.join(pluginInfo.requirePath, pluginInfo.instanceEntrypoint));
+	return entrypoint.InstancePlugin;
+}
+
+/**
+ * Load control plugin class of a plugin
+ *
+ * @param {Object} pluginInfo -
+ *     Plugin info object returned from {@link
+ *     module:lib/plugin_loader.loadPluginInfos} to load class from.
+ * @returns {function} plugin class
+ * @static
+ */
+async function loadControlPluginClass(pluginInfo) {
+	let entrypoint = require(path.posix.join(pluginInfo.requirePath, pluginInfo.controlEntrypoint));
+	return entrypoint.ControlPlugin;
+}
+
+module.exports = {
+	loadPluginInfos,
+	loadMasterPluginClass,
+	loadInstancePluginClass,
+	loadControlPluginClass,
+};