Merge pull request #186 from Zeroto/master

Fix notifying about the same research being finished

.gitignore

@@ -22,6 +22,7 @@ coverage
 
 # Compiled binary addons (http://nodejs.org/api/addons.html)
 build/Release
+dist/
 
 node_modules/*
 !node_modules/_app
@@ -39,6 +40,7 @@ mod_cache.json
 static/pictures/spritesheet.js
 static/pictures/spritesheet.png
 static/external
+saves
 
 # weird pattern to ignore sharedPlugins except not ignore some core modules
 !sharedPlugins/
@@ -48,3 +50,20 @@ sharedPlugins/*
 !sharedPlugins/remoteMap/
 !sharedPlugins/remoteCommands/
 !sharedPlugins/researchSync/
+!sharedPlugins/globalChat/
+!sharedPlugins/clusterioMod/
+!sharedPlugins/serverManager/
+sharedPlugins/serverManager/database/*
+sharedPlugins/serverManager/config.json
+sharedPlugins/serverManager/secret-api-token.txt
+!sharedPlugins/scenario_loader/
+sharedPlugins/scenario_loader/scenarios
+!sharedPlugins/statisticsExporter/
+
+# File used for marking plugins as disabled
+sharedPlugins/*/DISABLED
+
+\.cache-require-paths\.json
+
+# IDE
+.idea/

.snyk

@@ -0,0 +1,45 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.13.3
+ignore: {}
+# patches apply the minimum changes required to fix a vulnerability
+patch:
+  'npm:lodash:20180130':
+    - html5-validator > caporal > cli-table2 > lodash:
+        patched: '2018-07-03T06:07:55.532Z'
+  'npm:hawk:20160119':
+    - node-factorio-api > documentation > highlight.js > gear-lib > less > request > hawk:
+        patched: '2019-02-25T06:48:21.845Z'
+  'npm:http-signature:20150122':
+    - node-factorio-api > documentation > highlight.js > gear-lib > less > request > http-signature:
+        patched: '2019-02-25T06:48:21.845Z'
+  'npm:mime:20170907':
+    - node-factorio-api > documentation > highlight.js > gear-lib > mime:
+        patched: '2019-02-25T06:48:21.845Z'
+    - node-factorio-api > documentation > highlight.js > gear-lib > less > mime:
+        patched: '2019-02-25T06:48:21.845Z'
+    - node-factorio-api > documentation > highlight.js > gear-lib > less > request > form-data > mime:
+        patched: '2019-02-25T06:48:21.845Z'
+  'npm:minimatch:20160620':
+    - node-factorio-api > documentation > highlight.js > gear > liftoff > findup-sync > glob > minimatch:
+        patched: '2019-02-25T06:48:21.845Z'
+    - node-factorio-api > documentation > highlight.js > gear-lib > gear > liftoff > findup-sync > glob > minimatch:
+        patched: '2019-02-25T06:48:21.845Z'
+    - node-factorio-api > documentation > highlight.js > gear-lib > glob > minimatch:
+        patched: '2019-02-25T06:48:21.845Z'
+    - node-factorio-api > documentation > highlight.js > gear-lib > jslint > glob > minimatch:
+        patched: '2019-02-25T06:48:21.845Z'
+    - node-factorio-api > documentation > highlight.js > gear-lib > jshint > cli > glob > minimatch:
+        patched: '2019-02-25T06:48:21.845Z'
+    - node-factorio-api > documentation > highlight.js > gear-lib > jshint > minimatch:
+        patched: '2019-02-25T06:48:21.845Z'
+  'npm:request:20160119':
+    - node-factorio-api > documentation > highlight.js > gear-lib > less > request:
+        patched: '2019-02-25T06:48:21.845Z'
+  'npm:tunnel-agent:20170305':
+    - node-factorio-api > documentation > highlight.js > gear-lib > less > request > tunnel-agent:
+        patched: '2019-02-25T06:48:21.845Z'
+  'npm:uglify-js:20151024':
+    - node-factorio-api > documentation > highlight.js > gear-lib > handlebars > uglify-js:
+        patched: '2019-02-25T06:48:21.845Z'
+    - node-factorio-api > documentation > highlight.js > gear-lib > uglify-js:
+        patched: '2019-02-25T06:48:21.845Z'

.travis.yml

@@ -1,6 +1,6 @@
 language: node_js
 node_js:
-  - "node"
+  - "9"
 before_install:
   - sudo apt-get -qq update
   - sudo apt-get install -y curl git tar

.vs/ProjectSettings.json

@@ -0,0 +1,3 @@
+{
+  "CurrentProjectSetting": null
+}

.vs/VSWorkspaceState.json

@@ -0,0 +1,8 @@
+{
+  "ExpandedNodes": [
+    "",
+    "\\sharedPlugins"
+  ],
+  "SelectedNode": "\\.gitignore",
+  "PreviewInSolutionExplorer": false
+}

CLI tools/cluster_rcon.js

@@ -0,0 +1,41 @@
+const needle = require("needle");
+const cli = require("cli");
+const config = require("./../config.json");
+
+let options = cli.parse()
+cli.setUsage(`node cluster_rcon.js /c game.player.force = "player"`)
+if(process.argv.length < 3){
+	cli.getUsage()
+	process.exit(1)
+}
+
+const masterIP = `${config.masterIP}:${config.masterPort}`;
+const token = config.masterAuthToken
+let commandArray = process.argv;
+commandArray.shift();
+commandArray.shift();
+const needleOptionsWithTokenAuthHeader = {
+	headers: {
+		'x-access-token': token,
+	},
+};
+
+let command = commandArray.join(" ");
+let killBiters = `/silent-command local surface=game.surfaces[1] for key, entity in pairs(surface.find_entities_filtered({force="enemy"})) do entity.destroy() end`;
+
+(async ()=>{
+	needle.post(masterIP+"/api/runCommand", {
+		broadcast:true,
+		command,
+	}, needleOptionsWithTokenAuthHeader, (err, resp) => {
+		console.log(resp.body)
+	});
+	// setInterval(()=>{
+		// needle.post(masterIP+"/api/runCommand", {
+		// broadcast:true,
+		// command: killBiters,
+	// }, needleOptionsWithTokenAuthHeader, (err, resp) => {
+		// console.log(resp.body)
+	// });
+	// }, 1000*60*5);
+})();

CLI tools/delete_player.js

@@ -0,0 +1,19 @@
+const needle = require("needle")
+const config = require("./../config.json")
+const cli = require("cli")
+
+let options = cli.parse({
+	name: ["n", "Name of the player to delete, case sensitive", "string"],
+	token: [false, "Factorio auth token", "string", config.masterAuthToken]
+})
+if(!options.name){
+	cli.getUsage()
+	process.exit(1)
+}
+
+needle.post(config.masterIP+":"+config.masterPort+"/api/playerManager/deletePlayer", {
+	name: options.name,
+	token: options.token
+}, (err, resp) => {
+	console.log(resp.body)
+});

Dockerfile

@@ -1,19 +1,21 @@
-FROM node:latest
-RUN apt-get update && apt install git -y
-
+FROM node:9.11.2
+RUN apt-get update && apt install git curl tar -y
 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
+
+RUN git clone -b master https://github.com/Danielv123/factorioClusterio.git && cd factorioClusterio && npm install
+RUN cd factorioClusterio && curl -o factorio.tar.gz -L https://www.factorio.com/get-download/latest/headless/linux64 && tar -xf factorio.tar.gz
 
 WORKDIR factorioClusterio
-RUN mkdir instances sharedMods sharedPlugins
+RUN mkdir instances sharedMods
+RUN cp config.json.dist config.json
 
 RUN node client.js download
 
-LABEL maintainer "danielv@live.no"
+LABEL maintainer "Sir3lit@gmail.com"
 
 EXPOSE 8080 34167
 VOLUME /factorioClusterio/instances
 VOLUME /factorioClusterio/sharedMods
 VOLUME /factorioClusterio/sharedPlugins
 
-CMD RCONPORT="$RCONPORT" FACTORIOPORT="$FACTORIOPORT" MODE="$MODE" node $MODE\.js start $INSTANCE
+CMD RCONPORT="$RCONPORT" FACTORIOPORT="$FACTORIOPORT" MODE="$MODE" node $MODE\.js start $INSTANCE

LICENSE.md

@@ -1,4 +1,4 @@
-MIT License
+This product uses the MIT License
 
 Copyright (c) 2016 Daniel Vestøl
 
@@ -19,3 +19,8 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+The icons for angels modded items located in /static/pictures/ are licensed
+by https://mods.factorio.com/user/Arch666Angel under CC BY-NC-ND 4.0
+https://creativecommons.org/licenses/by-nc-nd/4.0/
+

README.md

@@ -1,12 +1,18 @@
+<img src="./logo.svg" width="100%" align="right">
+
+<br/>
+<br/>
+<br/>
+
 # 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)
 
-| 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) |
+Discord for development/support/play: https://discord.gg/5XuDkje
 
-If you want to connect to a clusterio cluster, please reffer to the [client](https://github.com/Danielv123/factorioClusterioClient)
+### Ways to support me/the project:
+
+* Contribute with code/documentation. 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
 
@@ -16,6 +22,10 @@ If you want to connect to a clusterio cluster, please reffer to the [client](htt
 
 * [Windows setup](#windows-setup)
 
+* [Optional plugins](#Plugins)
+
+* [Common problems](#Common-problems)
+
 * [Command cheatsheet](#cheatsheet)
 
 ## Introduction
@@ -32,7 +42,16 @@ Features:
 
 - Inventory combinator to display item levels in the cluster (and epoch time)
 
-- Reporting of graphs and UPS on master interface
+- Reporting of graphs and UPS on master interface (Also has extensive Prometheus reporting)
+
+Optional extras (see [Plugins](#Plugins))
+
+- Have your inventory synchronize across servers
+
+- Teleport trans from the border of one world to te next
+
+- Show in-game chat in discord
+
 
 Connection diagram:
 
@@ -59,10 +78,9 @@ Clusterio exploits one of the games logging features, game.write_file and RCON t
 
 7. client.js on server2: We were allowed to import x of item y, run command /c remote.call("clusterio", "importMany", "{'copper-plate':120}")
 
-This process works the same for both items and liquids, independant on what mods are used. Yes, modded items are fully supported.
+This process works the same for both items and liquids, independent on what mods are used. Yes, modded items are fully supported.
 
-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.
+Clusterio can also do a few other neat things, such as giving you access to epoch time, syncing player inventories between servers, keeping track of playtime (playerManager plugin), teleporting trains between servers (trainTeleports) and exporting tons of factorio related statistics to Prometheus for graphing in grafana.
 
 ## Ubuntu setup
 
@@ -70,26 +88,42 @@ NodeJS does not support EOL ubuntu releases. Make sure you are on the most recen
 
 Master and all slaves:
 
-    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 \
+    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
+    curl -o factorio.tar.gz -L https://www.factorio.com/get-download/latest/headless/linux64
     tar -xf factorio.tar.gz
+    npm install
+    cp config.json.dist config.json
+    node ./lib/npmPostinstall.js
+
 
 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.
 
+Now you need to edit the `config.json` file. If you skip this step nothing will work.
+Pretty much all the blank fields should be filled in, except on the master where a few can be omitted.
+
+* You get the `masterAuthToken` from `secret-api-token.txt` in the master install dir after running the master twice.
+
+* You get your factorio matchmaking token from factorio.com
+
+* The `masterAuthSecret` should never be touched unless you want to invalidate everyones authentication tokens
+
 **Master**
 
     pm2 start master.js --name master
-    
-**Server Host**
-    
-To download the mod for all its non vanilla features and items, (optional)
 
-    node client.js download
+OR
+
+    node master.js
+
+**Server Host**
+
+To download the mod for all its non vanilla features and items, (optional, but very recommended)
+
+    node client.js manage shared mods add clusterio
 
 To create a new instance (its own save, set of mods and config files)
 
@@ -97,18 +131,18 @@ To create a new instance (its own save, set of mods and config files)
 
 To launch an instance with pm2
 
-    pm2 start --name slave client.js -- start [instancename]
+    pm2 start --name [instancename] client.js -- start [instancename]
 
 use `nano config.json` to change settings.
 
 **Ubuntu with Docker**
 
-Clusterio has limited support for using docker.
+Clusterio has *very* limited support for using docker.
 
     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.
@@ -123,13 +157,9 @@ Server host (Slave) = client.js + factorio server
 
 Game Client = The people connecting to the server
 
-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.
-
-There are no requirements for other mods, they can be ran in any configuration allowed by the base game.
-
 **Requirements**
 
-download and install nodeJS 6+ from http://nodejs.org
+download and install nodeJS 8 or 9 from http://nodejs.org
 
 download and install git from https://git-scm.com/
 
@@ -139,29 +169,40 @@ reboot when you are done, then proceed to the next steps. *reboots matter*
 
 1. download and run https://puu.sh/toFHl/01eebbb333.bat
 
-2. You do not *need* to follow the given instructions, but you should
+2. Copy config.json.dist to config.json
 
-3. type `node master.js`
+3. Follow the instructions in the bat file
+3. Some of the instructions are outdated. If you get stuck somewhere, look at the Ubuntu section.
+
+4. Run `node client.js manage shared mods add clusterio`
+
+5. type `node master.js` to start the server
 
 **Server Host**
 
 1. download and run https://puu.sh/toFHl/01eebbb333.bat
 
-2. Follow the instructions given
+2. Copy config.json.dist to config.json
 
-3. Type `node client.js start [instancename]` to create a new instance.
+3. Follow the instructions given.
+
+3.5 Some of the instructions are outdated. If you get stuck somewhere, look at the Ubuntu section.
+
+4. Type `node client.js start [instancename]` to create a new instance.
 
 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.
 
-Change masterIP to something like 31.152.123.14 (provided by master server owner)
+Change `masterIP `to something like `31.152.123.14` (provided by master server owner)
 
-Change masterPort to something like 8080 (provided by master server owner)
+Change `masterPort` to something like `8080` (provided by master server owner)
 
-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)
+Change `masterAuthToken` to the value found in `secret-api-token.txt` on the master server
+
+Repeat step 4 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**
 
-Fancy game client that does the following steps automatically: [clusterioClient](https://github.com/Danielv123/factorioClusterioClient)
+Fancy game client that does the following steps automatically, but is really old so be warned: [clusterioClient](https://github.com/Danielv123/factorioClusterioClient)
 
 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
 
@@ -169,6 +210,59 @@ Fancy game client that does the following steps automatically: [clusterioClient]
 
 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
 
+## Plugins
+Here are the known Clusterio plugins in the wild:
+1. [Player Manager](https://github.com/Danielv123/playerManager) - Adds player management to the Web UI and shared inventory handling (beta)
+2. [DiscordChat](https://github.com/jakedraddy/ClusterioDiscordChat) - Logs in-game chat/joins/leave messages on all instances to a Discord webhook.
+3. [TrainTeleports](https://github.com/Godmave/clusterioTrainTeleports) - Allows you to teleport cargotrains between servers.
+
+## Common problems
+
+### Cannot find module: `/../../config`
+
+Copy your config.json.dist to config.json and configure it.
+
+### 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))
+
+### InitializationError: First argument must be an abstract-leveldown compliant store
+
+do:
+
+    npm install linvodb3@3.25.1
+
+if that does not suffice do
+
+    npm install levelup@1.3.9
+
+If it still doesn't work, come over to our support discord linked at the top of this readme.
+
+### 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
+
+### Other fixes for other potential problems:
+
+Sometimes the install fails. Try `node ./lib/npmPostinstall.js` to complete it.
+
+
 ## Cheatsheet
 
 **To create a new instance/start it**
@@ -194,5 +288,5 @@ npm install
 
 3. Download the latest version of the factorioClusterioMod from its github repo
 ```
-node client.js download
+node client.js manage shared mods add clusterio
 ```

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
-}

config.json.dist

@@ -0,0 +1,63 @@
+{
+	"__comment": "Where factorio folder. Should be in the same folder as this config file.",
+	"factorioDirectory": "./factorio",
+	"instanceDirectory": "./instances",
+	"databaseDirectory": "./database",
+	
+	"__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",
+	
+	"__commentMasterPort": "HTTP port for the master to listen to",
+	"masterPort": 8080,
+	
+	"__commentsslPort": "HTTPS port for the master to listen to. Set to 0 or an empty string to not listen for HTTPS.",
+	"sslPort": 443,
+	"sslCert": "database/certificates/cert.crt",
+	"sslPrivKey": "database/certificates/cert.key",
+	
+	"__commentMasterAuthToken": "Authentication token to connect to the master server. Find it in secret-api-token.txt on the master.",
+	"masterAuthToken": "",
+	
+	"__commentAuthSecret": "This is a long random string used for generating authentication tokens. Do not share. Regenerates when secret-api-token.txt is deleted.",
+	"masterAuthSecret": "",
+	
+	"__comment3": "Your factorio.com username for factorio MP services, also username will be admin on new instances",
+	"username": "",
+	"__comment4": "Token from your factorio.com profile page. Required for MP and mod manager services.",
+	"token": "",
+	"__comment7": "Used for communication with the mod portal, not needed if you manage mods by hand",
+	"factorio_version": "0.16.41",
+	
+	"__comment5": "General user settings",
+	"verify_user_identity": true,
+	"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,
+	"__comment6.5": "When the master is undersupplied, we have 3 different modes to 'fairly' distribute items. First to ask gets all, dole division using weird formula or experimental neural net tries to make stuff as fair as possible. Feel free to play around.",
+	"disableFairItemDistribution": false,
+	"useNeuralNetDoleDivider": true,
+	"uploadModsToMaster": true,
+	"msBetweenCommands": 10,
+	"allowRemoteCommandExecution": true,
+	"enableCrossServerShout": true,
+	"mirrorAllChat": false,
+	"__comment7": "Autosave interval for items in the master storage in milliseconds. Defaults to one minute when set to 0 or not set.",
+	"autosaveInterval": 600000,
+	"disablePrometheusPushgateway": false,
+	"__comment8": "This setting only affects the master. It makes every import for things that arent 'electricity' return a maximum of 0. Effectively disables teleport chests.",
+	"disableImportsOfEverythingExceptElectricity": false
+}

lib/Model/ClusterManager.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const NodeInstance_1 = require("./NodeInstance");
+const Point_1 = require("./Point");
+const Grid_1 = require("./Grid");
+/**
+ * Manages all nodes within the cluster
+ */
+class ClusterManager {
+    constructor() {
+        this.Grid = new Grid_1.Grid();
+    }
+    /**
+     * Generates a x*y grid of 1x1 nodes
+     * @param width How wide to make the node grid
+     * @param height How high to make the node grid
+     * @param nodeNamePrefix The prefix used for the initial node names. The name will be in the format <prefix>_x_y.
+     */
+    GenerateBasicGridOfNodes(width, height, nodeNamePrefix) {
+        for (let x = 0; x < width; x++) {
+            for (let y = 0; y < height; y++) {
+                let newNode = new NodeInstance_1.NodeInstance(nodeNamePrefix + "-" + (x + 1) + "-" + (y + 1), new Point_1.Point(x, y), 1, 1);
+                this.Grid.AddNodeToGrid(newNode);
+            }
+        }
+    }
+    /**
+     * Assigns all nodes that currently do not have a server assigned to the given server
+     * @param server Server to assign all unassigned nodes to
+     */
+    AssignAllUnassignedNodesToServer(server) {
+        this.CheckServerArray(server);
+        this.Grid.GetNodes()
+            .filter(node => { node.Server === null; })
+            .forEach(node => {
+            server.AddNodeInstance(node);
+            node.Server = server;
+        });
+    }
+    /**
+     * Assigns a node to a server
+     * @param x x co-ordinate of the node
+     * @param y y co-ordinate of the node
+     * @param serverName server name
+     */
+    AssignNodeToServer(x, y, server) {
+        this._nodeArray[x][y].Server = server;
+    }
+    CheckServerArray(server) {
+        let s = this._servers[server.Name];
+        if (s == null) {
+            this._servers[server.Name] = server;
+        }
+    }
+}
+exports.ClusterManager = ClusterManager;
+//# sourceMappingURL=ClusterManager.js.map

lib/Model/ClusterioMasterProxy.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process = require("child_process");
+const needle = require("needle");
+const Helpers_1 = require("./Helpers");
+const fs = require("fs");
+const util = require("util");
+/**
+ * Contains all interactions between the cluster model, the
+ * Clusterio master.js/client.js infrastructure and the operating system.
+ */
+class ClusterioMasterProxy {
+    constructor(masterIP, masterPort, masterAuthToken, serviceHostType) {
+        this._masterIP = `${masterIP}:${masterPort}`;
+        this._needleOptionsWithTokenAuthHeader = {
+            headers: {
+                'x-access-token': masterAuthToken,
+            },
+        };
+    }
+    async RunRconCommand(instanceId, command, logDescription) {
+        console.log("Running command: " + logDescription);
+        let request = { instanceID: instanceId, command };
+        let response = await needle("post", this._masterIP + "/api/runCommand", request, this._needleOptionsWithTokenAuthHeader);
+    }
+    async GetSlaves() {
+        let response = await needle("get", this._masterIP + "/api/slaves", this._needleOptionsWithTokenAuthHeader);
+        let body = response.body;
+        let slaves = new Array();
+        Object.entries(body).forEach((keyValuePair, index, array) => {
+            let slave = keyValuePair[1];
+            slave.id = keyValuePair[0];
+            slaves.push(slave);
+        });
+        return slaves;
+    }
+    async CreateNodeInstancesOnLocalServer(nodes) {
+        await Helpers_1.asyncForEach(nodes, async (node) => {
+            await this.CreateNodeInstanceOnLocalServer(node);
+        });
+        await Helpers_1.asyncForEach(nodes, async (node) => {
+            await this.CreateTeleportZonesForANodeInstance(node);
+        });
+        await this.sleep(1000);
+        await Helpers_1.asyncForEach(nodes, async (node) => {
+            await this.CreateTeleportRestrictionsForANodeInstance(node);
+            await this.sleep(100);
+        });
+    }
+    async CreateNodeInstanceOnLocalServer(node) {
+        console.log(`Creating instance ${node.Name}...`);
+        await this.CreateNodeInstanceOnLocalServerUsingPm2(node);
+        console.log("Waiting for node to connect to cluster master...");
+        while (true) {
+            await this.sleep(1000);
+            //TODO: Use /api/getSlaveMeta/
+            let slaves = await this.GetSlaves();
+            let slave = slaves.find((slave, index, array) => slave.instanceName === node.Name);
+            if (slave != null) {
+                node.ClusterioWorldId = slave.id;
+                break;
+            }
+        }
+    }
+    async CreateNodeInstanceOnLocalServerUsingPm2(node) {
+        let proc = child_process.spawn("pm2", ['start', '--name', node.Name, 'client.js', '--', 'start', node.Name]);
+        proc.stdout.on('data', (data) => { console.log(`stdout: ${data}`); });
+        proc.stderr.on('data', data => { console.log(`stderr: ${data}`); });
+        proc.on('error', error => { console.log(`error: ${error}`); });
+    }
+    async CreateNodeInstanceOnLocalServerUsingScreen(node) {
+        // first call of client.js start for a new node creates map from HotPatch scenario then exits.
+        let proc = child_process.spawn("screen", ['-dmS', node.Name, '-L', '-Logfile', node.Name + '.log', 'node', 'client.js', 'start', node.Name]);
+        proc.stdout.on('data', (data) => { console.log(`stdout: ${data}`); });
+        proc.stderr.on('data', data => { console.log(`stderr: ${data}`); });
+        proc.on('error', error => { console.log(`error: ${error}`); });
+        console.log("Waiting for creation of new map...");
+        // create awaiter for fs.readFile
+        const readFile = util.promisify(fs.readFile);
+        while (true) {
+            await this.sleep(1000);
+            let fileData = await readFile(node.Name + '.log');
+            if (fileData.includes('Instance created')) {
+                break;
+            }
+        }
+        // start node
+        proc = child_process.spawn("screen", ['-dmS', node.Name, '-L', '-Logfile', node.Name + '.log', 'node', 'client.js', 'start', node.Name]);
+        proc.stdout.on('data', data => { console.log(`stdout: ${data}`); });
+        proc.stderr.on('data', data => { console.log(`stderr: ${data}`); });
+        proc.on('error', error => { console.log(`error: ${error}`); });
+    }
+    async CreateTeleportZonesForANodeInstance(nodeInstance) {
+        await Helpers_1.asyncForEach(nodeInstance.TeleportZones.values(), async (zone) => {
+            let o = zone.GenerateTeleportZoneInFactorioCoordinates();
+            let cmd = `CreateZone('${o[0]}',${o[1]},${o[2]},${o[3]},${o[4]},${o[5]},true)`;
+            await this.RunRconCommand(nodeInstance.ClusterioWorldId, `/c remote.call('trainTeleports','runCode',\"${cmd}\")`, cmd);
+        });
+    }
+    async CreateTeleportRestrictionsForANodeInstance(nodeInstance) {
+        await Helpers_1.asyncForEach(nodeInstance.TeleportZones.values(), async (zone) => {
+            let o = zone.GenerateZoneRestriction();
+            let cmd = `CreateZoneRestriction(${o[0]},'${o[1]}','${o[2]}')`;
+            await this.RunRconCommand(nodeInstance.ClusterioWorldId, `/c remote.call('trainTeleports','runCode',\"${cmd}\")`, cmd);
+        });
+    }
+    sleep(ms) {
+        return new Promise(resolve => setTimeout(resolve, ms));
+    }
+}
+exports.ClusterioMasterProxy = ClusterioMasterProxy;
+//# sourceMappingURL=ClusterioMasterProxy.js.map

lib/Model/Config.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/** The multiplier used to convert from the grid's coordinate system to factorio's.
+ * 1000 means a 1x1 grid node will have a factorio map size of 1000x1000. */
+exports.GridToFactorioCoordinateSystemMultiplier = 1000;
+/** The width of teleport zones when they get created. */
+exports.TeleportZoneWidth = 50;
+//# sourceMappingURL=Config.js.map

lib/Model/Grid.js

@@ -0,0 +1,177 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const typescript_collections_1 = require("typescript-collections");
+const Point_1 = require("./Point");
+const TeleportZone_1 = require("./TeleportZone");
+const TeleportZoneDirection_1 = require("./TeleportZoneDirection");
+class Grid {
+    constructor() {
+        this._nodes = new typescript_collections_1.Dictionary();
+        this._minX = 0;
+        this._minY = 0;
+        this._maxX = 0;
+        this._maxY = 0;
+    }
+    GetNodes() {
+        return this._nodes.values();
+    }
+    /**
+     * Adds a node to the grid
+     * @param topLeftCoordinate The top left x,y coordinate of the node
+     * @param nodeInstance
+     */
+    AddNodeToGrid(nodeInstance) {
+        let topLeftCoordinate = nodeInstance.TopLeftCoordinate;
+        let pointsToSave = new Array();
+        // check all points that make up nodeInstance for existing nodes
+        for (let x = topLeftCoordinate.X; x < topLeftCoordinate.X + nodeInstance.Width; x++) {
+            for (let y = topLeftCoordinate.Y; y < topLeftCoordinate.Y + nodeInstance.Height; y++) {
+                let currentPoint = new Point_1.Point(x, y);
+                let existingNode = this._nodes.getValue(currentPoint);
+                if (existingNode != null) {
+                    throw new Error("Cannot add node to grid - collision detected with node '" + existingNode.Name + "'");
+                }
+                pointsToSave.push(currentPoint);
+            }
+        }
+        // no existing nodes found to assign node to these points
+        for (let i = 0; i < pointsToSave.length; i++) {
+            this._nodes.setValue(pointsToSave[i], nodeInstance);
+        }
+        //TODO: Refactor
+        //#region Set up teleport zones
+        // check surrounding points for nodes
+        // check north points
+        let y = topLeftCoordinate.Y - 1;
+        for (let x = topLeftCoordinate.X; x < topLeftCoordinate.X + nodeInstance.Width; x++) {
+            let currentPoint = new Point_1.Point(x, y);
+            let existingNode = this._nodes.getValue(currentPoint);
+            // found a node - set up teleport zone
+            if (existingNode != null) {
+                // Create/Update teleport node in existing node to new node
+                let teleportZoneFromExistingToNew = existingNode.TeleportZones.getValue(nodeInstance.Key);
+                if (teleportZoneFromExistingToNew == null) {
+                    teleportZoneFromExistingToNew = new TeleportZone_1.TeleportZone(existingNode, TeleportZoneDirection_1.TeleportZoneDirection.South, currentPoint, currentPoint, existingNode.TeleportZones.size(), nodeInstance);
+                    existingNode.TeleportZones.setValue(nodeInstance.Key, teleportZoneFromExistingToNew);
+                }
+                else {
+                    teleportZoneFromExistingToNew.BottomRightCoordinate = currentPoint;
+                }
+                // Create/Update teleport node in new node to existing node
+                let teleportZoneFromNewToExisting = nodeInstance.TeleportZones.getValue(existingNode.Key);
+                let pointInNewNode = new Point_1.Point(currentPoint.X, currentPoint.Y + 1);
+                if (teleportZoneFromNewToExisting == null) {
+                    teleportZoneFromNewToExisting = new TeleportZone_1.TeleportZone(nodeInstance, TeleportZoneDirection_1.TeleportZoneDirection.North, pointInNewNode, pointInNewNode, nodeInstance.TeleportZones.size(), existingNode);
+                    nodeInstance.TeleportZones.setValue(existingNode.Key, teleportZoneFromNewToExisting);
+                }
+                else {
+                    teleportZoneFromNewToExisting.BottomRightCoordinate = currentPoint;
+                }
+            }
+        }
+        // check south points
+        y = topLeftCoordinate.Y + nodeInstance.Height + 1;
+        for (let x = topLeftCoordinate.X; x < topLeftCoordinate.X + nodeInstance.Width; x++) {
+            let currentPoint = new Point_1.Point(x, y);
+            let existingNode = this._nodes.getValue(currentPoint);
+            // found a node - set up teleport zone
+            if (existingNode != null) {
+                // Create/Update teleport node in existing node to new node
+                let teleportZoneFromExistingToNew = existingNode.TeleportZones.getValue(nodeInstance.Key);
+                if (teleportZoneFromExistingToNew == null) {
+                    teleportZoneFromExistingToNew = new TeleportZone_1.TeleportZone(existingNode, TeleportZoneDirection_1.TeleportZoneDirection.North, currentPoint, currentPoint, existingNode.TeleportZones.size(), nodeInstance);
+                    existingNode.TeleportZones.setValue(nodeInstance.Key, teleportZoneFromExistingToNew);
+                }
+                else {
+                    teleportZoneFromExistingToNew.BottomRightCoordinate = currentPoint;
+                }
+                // Create/Update teleport node in new node to existing node
+                let teleportZoneFromNewToExisting = nodeInstance.TeleportZones.getValue(existingNode.Key);
+                let pointInNewNode = new Point_1.Point(currentPoint.X, currentPoint.Y - 1);
+                if (teleportZoneFromNewToExisting == null) {
+                    teleportZoneFromNewToExisting = new TeleportZone_1.TeleportZone(nodeInstance, TeleportZoneDirection_1.TeleportZoneDirection.South, pointInNewNode, pointInNewNode, nodeInstance.TeleportZones.size(), existingNode);
+                    nodeInstance.TeleportZones.setValue(existingNode.Key, teleportZoneFromNewToExisting);
+                }
+                else {
+                    teleportZoneFromNewToExisting.BottomRightCoordinate = currentPoint;
+                }
+            }
+        }
+        // check west points
+        let x = topLeftCoordinate.X - 1;
+        for (let y = topLeftCoordinate.Y; y < topLeftCoordinate.Y + nodeInstance.Height; y++) {
+            let currentPoint = new Point_1.Point(x, y);
+            let existingNode = this._nodes.getValue(currentPoint);
+            // found a node - set up teleport zone
+            if (existingNode != null) {
+                // Create/Update teleport node in existing node to new node
+                let teleportZoneFromExistingToNew = existingNode.TeleportZones.getValue(nodeInstance.Key);
+                if (teleportZoneFromExistingToNew == null) {
+                    teleportZoneFromExistingToNew = new TeleportZone_1.TeleportZone(existingNode, TeleportZoneDirection_1.TeleportZoneDirection.East, currentPoint, currentPoint, existingNode.TeleportZones.size(), nodeInstance);
+                    existingNode.TeleportZones.setValue(nodeInstance.Key, teleportZoneFromExistingToNew);
+                }
+                else {
+                    teleportZoneFromExistingToNew.BottomRightCoordinate = currentPoint;
+                }
+                // Create/Update teleport node in new node to existing node
+                let teleportZoneFromNewToExisting = nodeInstance.TeleportZones.getValue(existingNode.Key);
+                let pointInNewNode = new Point_1.Point(currentPoint.X + 1, currentPoint.Y);
+                if (teleportZoneFromNewToExisting == null) {
+                    teleportZoneFromNewToExisting = new TeleportZone_1.TeleportZone(nodeInstance, TeleportZoneDirection_1.TeleportZoneDirection.West, pointInNewNode, pointInNewNode, nodeInstance.TeleportZones.size(), existingNode);
+                    nodeInstance.TeleportZones.setValue(existingNode.Key, teleportZoneFromNewToExisting);
+                }
+                else {
+                    teleportZoneFromNewToExisting.BottomRightCoordinate = currentPoint;
+                }
+            }
+        }
+        // check east points        
+        x = topLeftCoordinate.X + nodeInstance.Width + 1;
+        for (let y = topLeftCoordinate.Y; y < topLeftCoordinate.Y + nodeInstance.Height; y++) {
+            let currentPoint = new Point_1.Point(x, y);
+            let existingNode = this._nodes.getValue(currentPoint);
+            // found a node - set up teleport zone
+            if (existingNode != null) {
+                // Create/Update teleport node in existing node to new node
+                let teleportZoneFromExistingToNew = existingNode.TeleportZones.getValue(nodeInstance.Key);
+                if (teleportZoneFromExistingToNew == null) {
+                    teleportZoneFromExistingToNew = new TeleportZone_1.TeleportZone(existingNode, TeleportZoneDirection_1.TeleportZoneDirection.West, currentPoint, currentPoint, existingNode.TeleportZones.size(), nodeInstance);
+                    existingNode.TeleportZones.setValue(nodeInstance.Key, teleportZoneFromExistingToNew);
+                }
+                else {
+                    teleportZoneFromExistingToNew.BottomRightCoordinate = currentPoint;
+                }
+                // Create/Update teleport node in new node to existing node
+                let teleportZoneFromNewToExisting = nodeInstance.TeleportZones.getValue(existingNode.Key);
+                let pointInNewNode = new Point_1.Point(currentPoint.X - 1, currentPoint.Y);
+                if (teleportZoneFromNewToExisting == null) {
+                    teleportZoneFromNewToExisting = new TeleportZone_1.TeleportZone(nodeInstance, TeleportZoneDirection_1.TeleportZoneDirection.East, pointInNewNode, pointInNewNode, nodeInstance.TeleportZones.size(), existingNode);
+                    nodeInstance.TeleportZones.setValue(existingNode.Key, teleportZoneFromNewToExisting);
+                }
+                else {
+                    teleportZoneFromNewToExisting.BottomRightCoordinate = currentPoint;
+                }
+            }
+        }
+        //#endregion
+        this._nodes.setValue(topLeftCoordinate, nodeInstance);
+        this._minX = Math.min(this._minX, topLeftCoordinate.X);
+        this._minY = Math.min(this._minY, topLeftCoordinate.Y);
+        this._maxX = Math.max(this._maxX, topLeftCoordinate.X + nodeInstance.Width);
+        this._maxY = Math.max(this._maxY, topLeftCoordinate.Y + nodeInstance.Height);
+    }
+    get Width() {
+        return this._maxX - this._minX;
+    }
+    get Height() {
+        return this._maxY - this._minY;
+    }
+    get TopLeftCoordinate() {
+        return new Point_1.Point(this._minX, this._minY);
+    }
+    get BottomRightCoordinate() {
+        return new Point_1.Point(this._maxX, this._maxY);
+    }
+}
+exports.Grid = Grid;
+//# sourceMappingURL=Grid.js.map

lib/Model/Helpers.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//TODO: Make generic
+async function asyncForEach(array, callback) {
+    for (let index = 0; index < array.length; index++) {
+        await callback(array[index], index, array);
+    }
+}
+exports.asyncForEach = asyncForEach;
+//# sourceMappingURL=Helpers.js.map

lib/Model/IApiSlaves.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IApiSlaves.js.map

lib/Model/IClusterioMasterProxy.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IClusterioMasterProxy.js.map

lib/Model/ModelController.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+console.log("started.");
+const ClusterioMasterProxy_1 = require("./ClusterioMasterProxy");
+const ClusterManager_1 = require("./ClusterManager");
+const argv = require('minimist')(process.argv.slice(2));
+let configPath = argv['configPath'];
+if (configPath === undefined || configPath === null || configPath === "") {
+    throw new Error("configPath is null.");
+}
+;
+let config = require(configPath);
+let proxy = new ClusterioMasterProxy_1.ClusterioMasterProxy(config.masterIP, config.masterPort, config.masterAuthToken);
+let manager = new ClusterManager_1.ClusterManager();
+manager.GenerateBasicGridOfNodes(2, 2, 'GridLockTest_');
+function sleep(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+// async function test() {
+//     await asyncForEach([1,2,3], async (v, i, a) => {
+//         console.log("test" + i);
+//         await sleep(5000);
+//     });
+// }
+// test();
+proxy.CreateNodeInstancesOnLocalServer(manager.Grid.GetNodes());
+//# sourceMappingURL=ModelController.js.map

lib/Model/ModelDemo.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+console.log("started.");
+const ClusterioMasterProxy_1 = require("./ClusterioMasterProxy");
+const ClusterManager_1 = require("./ClusterManager");
+const argv = require('minimist')(process.argv.slice(2));
+let configPath = argv['configPath'];
+if (configPath === undefined || configPath === null || configPath === "") {
+    throw new Error("configPath is null.");
+}
+;
+let config = require(configPath);
+let proxy = new ClusterioMasterProxy_1.ClusterioMasterProxy(config.masterIP, config.masterPort, config.masterAuthToken);
+function sleep(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+// main
+(async () => {
+    let manager = new ClusterManager_1.ClusterManager();
+    manager.GenerateBasicGridOfNodes(2, 2, 'GridLockTest');
+    await proxy.CreateNodeInstancesOnLocalServer(manager.Grid.GetNodes());
+    return;
+})();
+//# sourceMappingURL=ModelDemo.js.map

lib/Model/ModelRunner.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+console.log("Started.");
+const ClusterioMasterProxy_1 = require("./ClusterioMasterProxy");
+const ClusterManager_1 = require("./ClusterManager");
+const argv = require('minimist')(process.argv.slice(2));
+// arg: configPath
+// description: should point to the clusterio config.json file.
+let configPath = argv['configPath'];
+if (configPath === undefined || configPath === null || configPath === "") {
+    configPath = "../../config.json";
+}
+;
+let config = require(configPath);
+// arg: mode
+// description: should be GenerateBasicGridOfNodes for now. Can extend in future.
+let mode = argv['mode'];
+if (mode === undefined || mode === null || mode === "") {
+    throw new Error("mode is null. mode must be 'GenerateBasicGridOfNodes' (for now).");
+}
+;
+// arg: serviceHostType
+// description: what program to use to host the client.js instances.
+let serviceHostType = argv['serviceHostType'];
+if (serviceHostType === undefined || serviceHostType === null || serviceHostType === "") {
+    throw new Error("serviceHostType is null. serviceHostType must be either 'pm2' or 'screen'.");
+}
+;
+if (serviceHostType != "pm2" && serviceHostType != "screen") {
+    throw new Error("serviceHostType must be either 'pm2' or 'screen'.");
+}
+// arg: width
+// description: width of node grid
+let width = argv['width'];
+if (width === undefined || width === null || width === "") {
+    throw new Error("width is null. width must be an int > 0.");
+}
+;
+// arg: height
+// description: height of node grid
+let height = argv['height'];
+if (height === undefined || height === null || height === "") {
+    throw new Error("height is null. height must be an int > 0.");
+}
+;
+// arg: namePrefix
+// description: namePrefix of node grid
+let namePrefix = argv['namePrefix'];
+if (namePrefix === undefined || namePrefix === null || namePrefix === "") {
+    throw new Error("namePrefix is null.");
+}
+;
+let proxy = new ClusterioMasterProxy_1.ClusterioMasterProxy(config.masterIP, config.masterPort, config.masterAuthToken, serviceHostType);
+// main
+(async () => {
+    let manager = new ClusterManager_1.ClusterManager();
+    manager.GenerateBasicGridOfNodes(width, height, namePrefix);
+    await proxy.CreateNodeInstancesOnLocalServer(manager.Grid.GetNodes());
+    return;
+})();
+//# sourceMappingURL=ModelRunner.js.map

lib/Model/NodeInstance.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Point_1 = require("./Point");
+const typescript_collections_1 = require("typescript-collections");
+/**
+ * An instance of a Factorio server. Multiple nodes can run on the same server.
+ */
+class NodeInstance {
+    constructor(name, topLeftCoordinate, width, height) {
+        this.TeleportZones = new typescript_collections_1.Dictionary();
+        this.Name = name;
+        this.Width = width;
+        this.Height = height;
+        this.TopLeftCoordinate = topLeftCoordinate;
+    }
+    get BottomRightCoordinate() {
+        return new Point_1.Point(this.TopLeftCoordinate.X + this.Width, this.TopLeftCoordinate.Y + this.Height);
+    }
+    // public AddTeleportZone(name: string, topLeftCoordinate: Point, bottomRightCoordinate: Point) {
+    //     this.TeleportZones.push(new TeleportZone(this, topLeftCoordinate, bottomRightCoordinate, name));
+    // }
+    AddTeleportZonePoint() {
+    }
+    get Key() {
+        return this.Name;
+    }
+}
+exports.NodeInstance = NodeInstance;
+//# sourceMappingURL=NodeInstance.js.map

lib/Model/Point.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Point {
+    /**
+     * Constructs a Point. Will not accept NaNs.
+     * @param x A number. Cannot be NaN.
+     * @param y A number. Cannot be NaN.
+     */
+    constructor(x, y) {
+        this.toString = () => {
+            return "(" + this.X + "," + this.Y + ")";
+        };
+        if (Number.isNaN(x)) {
+            throw new Error("x is NaN. Will not construct Point.");
+        }
+        if (Number.isNaN(y)) {
+            throw new Error("y is NaN. Will not construct Point.");
+        }
+        this.X = x;
+        this.Y = y;
+    }
+    /**
+     * Constructs a Point from a string representation in the format (x,y). Will not accept NaNs.
+     * @param vectorAsString A string in the format (x,y). Will not accept NaNs.
+     */
+    static FromString(vectorAsString) {
+        this.CheckChar('(', vectorAsString[0], vectorAsString);
+        this.CheckChar(')', vectorAsString[vectorAsString.length - 1], vectorAsString);
+        if (vectorAsString.indexOf(',') === -1) {
+            throw new Error("vectorAsString is an invalid format. Cannot find ','. fullString: " + vectorAsString);
+        }
+        let splitStr = vectorAsString.substr(1, vectorAsString.length - 2).split(',');
+        if (splitStr.length != 2) {
+            throw new Error("vectorAsString is an invalid format. Expecting string in format (x,y). fullString: " + vectorAsString);
+        }
+        let x = parseInt(splitStr[0]);
+        let y = parseInt(splitStr[1]);
+        let v = new Point(x, y);
+        return v;
+    }
+    static CheckChar(expectedChar, actualChar, fullString) {
+        if (actualChar != expectedChar) {
+            throw new Error("vectorAsString is an invalid format. Expecting: '" + expectedChar + "'. Actual: '" + actualChar + "'. fullString: " + fullString);
+        }
+    }
+    equals(obj) {
+        return this.X === obj.X && this.Y === obj.Y;
+    }
+    Add(p) {
+        return new Point(this.X + p.X, this.Y + p.Y);
+    }
+    Subtract(p) {
+        return new Point(this.X - p.X, this.Y - p.Y);
+    }
+}
+exports.Point = Point;
+//# sourceMappingURL=Point.js.map

lib/Model/Server.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * A server. Can contain multiple nodes (Factorio server instances).
+ */
+class Server {
+    constructor(name) {
+        this.Nodes = new Array();
+        this.Name = name;
+    }
+    AddNodeInstance(node) {
+        this.Nodes.push(node);
+    }
+}
+exports.Server = Server;
+//# sourceMappingURL=Server.js.map

lib/Model/ServiceHostType.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var ServiceHostType;
+(function (ServiceHostType) {
+    ServiceHostType[ServiceHostType["pm2"] = 0] = "pm2";
+    ServiceHostType[ServiceHostType["screen"] = 1] = "screen";
+})(ServiceHostType = exports.ServiceHostType || (exports.ServiceHostType = {}));
+//# sourceMappingURL=ServiceHostType.js.map

lib/Model/TeleportZone.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Point_1 = require("./Point");
+const TeleportZoneDirection_1 = require("./TeleportZoneDirection");
+const Config = require("./Config");
+class TeleportZone {
+    constructor(parentNode, direction, topLeftCoordinate, bottomRightCoordinate, index, targetNode) {
+        this.TopLeftCoordinate = topLeftCoordinate;
+        this.BottomRightCoordinate = bottomRightCoordinate;
+        this.ParentNode = parentNode;
+        this.Direction = direction;
+        this.Index = index;
+        this.TargetNode = targetNode;
+    }
+    get Name() {
+        return TeleportZoneDirection_1.TeleportZoneDirection[this.Direction] + " to " + this.TargetNode.Name;
+    }
+    // public AddRestriction(restrictingTeleportZone: TeleportZone) {
+    //     this.Restrictions.push(new TeleportZoneRestriction(this, restrictingTeleportZone));
+    // }
+    /**
+     * Converts this teleport zone into Factorio map co-ordinates
+     * @returns [name, topleft.x, topleft.y, width, height, zoneIndex]
+     */
+    GenerateTeleportZoneInFactorioCoordinates() {
+        // get where this zone is relative to the node itself
+        let topLeftRelativeCoordinate = this.TopLeftCoordinate.Subtract(this.ParentNode.TopLeftCoordinate);
+        // a grid coordinate point is equivalent to a 1x1 node, so bottomright = topleft.
+        // add (1,1) to translate from area representation to coordinates representing actual points.
+        let bottomRightRelativeCoordinate = this.BottomRightCoordinate
+            .Subtract(this.ParentNode.TopLeftCoordinate)
+            .Add(new Point_1.Point(1, 1));
+        // Factorio map is e.g. (-500,-500) to (500, 500) for a 1000x1000 node.
+        // We therefore need to offset our co-ordinates so that (0,0) is the center and not (width/2, height/2)
+        let m = Config.GridToFactorioCoordinateSystemMultiplier;
+        let factorioTeleportZoneTopLeft = new Point_1.Point(topLeftRelativeCoordinate.X * m - m / 2, topLeftRelativeCoordinate.Y * m - m / 2);
+        let factorioTeleportZoneBottomRight = new Point_1.Point(bottomRightRelativeCoordinate.X * m - m / 2, bottomRightRelativeCoordinate.Y * m - m / 2);
+        let zoneWidth = factorioTeleportZoneBottomRight.X - factorioTeleportZoneTopLeft.X;
+        let zoneHeight = factorioTeleportZoneBottomRight.Y - factorioTeleportZoneTopLeft.Y;
+        let tl = factorioTeleportZoneTopLeft;
+        let br = factorioTeleportZoneBottomRight;
+        let zw = Config.TeleportZoneWidth;
+        switch (this.Direction) {
+            case TeleportZoneDirection_1.TeleportZoneDirection.North:
+                return [this.Name, tl.X, tl.Y, zoneWidth, zw, this.Index + 1];
+            case TeleportZoneDirection_1.TeleportZoneDirection.West:
+                return [this.Name, tl.X, tl.Y, zw, zoneHeight, this.Index + 1];
+            case TeleportZoneDirection_1.TeleportZoneDirection.South:
+                return [this.Name, tl.X, br.Y - zw, zoneWidth, zw, this.Index + 1];
+            case TeleportZoneDirection_1.TeleportZoneDirection.East:
+                return [this.Name, br.X - zw, tl.Y, zw, zoneHeight, this.Index + 1];
+        }
+    }
+    /**
+     * Generates a zone restriction from this teleport zone to target zone
+     * @returns [zoneIndex, targetNodeName, targetZoneName]
+     */
+    GenerateZoneRestriction() {
+        let targetZone = this.TargetNode.TeleportZones.getValue(this.ParentNode.Key);
+        return [this.Index + 1, this.TargetNode.Name, targetZone.Name];
+    }
+}
+exports.TeleportZone = TeleportZone;
+//# sourceMappingURL=TeleportZone.js.map

lib/Model/TeleportZoneDirection.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var TeleportZoneDirection;
+(function (TeleportZoneDirection) {
+    TeleportZoneDirection[TeleportZoneDirection["North"] = 0] = "North";
+    TeleportZoneDirection[TeleportZoneDirection["East"] = 1] = "East";
+    TeleportZoneDirection[TeleportZoneDirection["South"] = 2] = "South";
+    TeleportZoneDirection[TeleportZoneDirection["West"] = 3] = "West";
+})(TeleportZoneDirection = exports.TeleportZoneDirection || (exports.TeleportZoneDirection = {}));
+//# sourceMappingURL=TeleportZoneDirection.js.map

lib/Model/TeleportZoneRestriction.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class TeleportZoneRestriction {
+    constructor(parentTeleportZone, restrictingTeleportZone) {
+        this.ParentTeleportZone = parentTeleportZone;
+        this.RestrictingTeleportZone = restrictingTeleportZone;
+    }
+}
+exports.TeleportZoneRestriction = TeleportZoneRestriction;
+//# sourceMappingURL=TeleportZoneRestriction.js.map

lib/Model/index.js

@@ -0,0 +1,13 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./ClusterManager"));
+__export(require("./NodeInstance"));
+__export(require("./Server"));
+__export(require("./TeleportZone"));
+__export(require("./TeleportZoneRestriction"));
+__export(require("./Point"));
+__export(require("./Grid"));
+//# sourceMappingURL=index.js.map

lib/authenticate.js

@@ -0,0 +1,28 @@
+const jwt = require('jsonwebtoken');
+
+// const config = require("./../config");
+
+module.exports = function(config){
+	return {
+		middleware: function (req, res, next) {
+			var token = req.headers['x-access-token'];
+			if(!token) return res.status(401).send({ auth: false, message: 'No token provided.', endpoint: req.route.path});
+			
+			jwt.verify(token, config.masterAuthSecret, function(err, decoded) {
+				if(err) return res.status(500).send({ auth: false, message: 'Failed to authenticate token.', endpoint: req.route.path});
+				next();
+			});
+		},
+		check: async function(token){
+			return new Promise((resolve, reject) => {
+				jwt.verify(token, config.masterAuthSecret, function(err, decoded) {
+					if(err){
+						resolve({ok:false, msg:err})
+					} else {
+						resolve({ok:true, msg:"Successfully authenticated"});
+					}
+				});
+			});
+		}
+	}
+};

lib/dole_nn_base.js

@@ -0,0 +1,119 @@
+//Sigmoids...
+
+function sigmoid0(x)
+{
+	return x/(1+Math.abs(x));
+}
+function sigmoid1(x)
+{
+	if (x>=0.0) {
+		return 1.0
+	} else {
+		return 0.0
+	}
+}
+function sigmoid2(x)
+{
+	if (x>=0.0){
+		return x
+	} else {
+		return 0.0
+	}
+}
+function sigmoid3(x)
+{
+	return x;
+}
+
+//DOSE - Doses items for item X slave Y
+//Numreq - number of items that are requested for item X for slave Y
+//Instore - number of items for item X in master gauge (currently)
+//store_last_tick - Number of items for item X in master gauge at time of last tick
+//dole - Current dole for item X
+//carry - carry for item X slave Y
+//prev_req - Numreq for previous request for item X slave Y
+//* doleinfo_last - Object with 2 values for last "tick period": numreq - total number or requests for item, numslave - number of slaves requesting that item
+//debt - debt for item X slave Y
+
+//Returns: Array of 3 elements
+//0.Number of items to give in that dose
+//1.New dole for item X
+//2.New carry for item X slave Y
+//3.New debt
+function Dose(numreq,instore,store_last_tick,dole,carry,prev_req,numreq_total_adj,debt)
+{
+	numreq=Number(numreq);
+	instore=Number(instore);
+	var instore_adj=instore;
+	if (instore_adj==0) instore_adj=0.1;
+	
+	var b=Math.trunc(prev_req/instore_adj*numreq);
+	var inp1=[numreq,instore_adj,store_last_tick/numreq,dole,carry];//0..4
+	var inp2=[prev_req/numreq,numreq/numreq_total_adj,store_last_tick/numreq_total_adj,prev_req/instore_adj,b,numreq_total_adj,store_last_tick,debt];//5..12
+	var inputs=inp1.concat(inp2);
+	var internal=new Array(20).fill(0);
+	var outputs=[0,0,0,0];
+	//NN: Please don't touch :), code is generated
+	
+outputs[0]=inputs[7]*0.8058582544;
+outputs[0]=sigmoid2(outputs[0]);
+outputs[1]=sigmoid0(outputs[1]);
+outputs[2]=sigmoid0(outputs[2]);
+outputs[3]=inputs[6]*0.2294657379;
+outputs[3]=sigmoid0(outputs[3]);
+
+	debt=debt || 0;
+	if (outputs[0]>0.99) outputs[0]=1.0;
+	
+	var res1=Number(outputs[0])*numreq+outputs[3]+debt;
+	var res_capped=Math.round(res1);
+	
+	if (res_capped>numreq) res_capped=numreq;
+	if (res_capped>instore) res_capped=instore;
+	if (res_capped<0) res_capped=0;
+	
+	res1=res1 || 0;
+	res_capped=res_capped || 0;//Safeguard against wrong values
+	debt=res1-res_capped;
+	debt_cap=Math.round(numreq*1.5)+5;
+	if (debt>debt_cap) debt=debt_cap;
+	
+	carry=sigmoid0(outputs[2]*carry+outputs[0]) || 0;
+	return [res_capped,dole+outputs[1],carry,debt];
+}
+
+//TICK - Updates values for item X, should be called once for each item for each round of all slaves requesting that item
+//Instore - number of items for item X in master gauge (currently)
+//dole - Current dole for item X
+//store_last_tick - Number of items for item X in master gauge at time of last tick (not this one)
+//* doleinfo_last - Object with 2 values for last "tick period": numreq - total number or requests for item, numslave - number of slaves requesting that item
+//* doleinfo_new - Object with 2 values for new "tick period": numreq - total number or requests for item, numslave - number of slaves requesting that item
+
+
+//Returns: Array of 2 elements
+//0.New dole for item X
+//1.Guessed percentage average of items supplied in last 10 ticks
+function Tick(instore,dole,store_last_tick,numreq_total_adj)
+{
+	var instore_adj=instore;
+	if (instore_adj==0) instore_adj=0.1;
+	var inputs=[instore,dole,store_last_tick/instore_adj,store_last_tick/numreq_total_adj,store_last_tick,numreq_total_adj];
+	var internal=new Array(10).fill(0);
+	var outputs=[0,0];
+	//NN: Please don't touch :), code is generated
+	
+outputs[0]=inputs[3]*0.9364774823;
+outputs[0]=outputs[0]*1.0*0.4590721726;
+outputs[0]=sigmoid2(outputs[0]);
+outputs[1]=outputs[0]*1.828422785;
+outputs[1]=sigmoid3(outputs[1]);
+
+	avg=outputs[1];
+	if (numreq_total_adj<0.11) avg=1;//When no item's are requested, result is 0.1 ; In that case there is no deficit, so return 1 = 100% demand fulfilled
+	if (avg>1) avg=1;
+	if (avg<0) avg=0;
+	
+	return [sigmoid0(outputs[0]),avg];
+}
+
+module.exports = {Dose,Tick}

lib/getFactorioLocale.js

@@ -6,6 +6,8 @@ Module for grabbing factorio locale from a local factorio install
 const fs = require("fs");
 const ini = require("ini");
 
+const cache = {};
+
 /**
 Gets raw factorio locale from the .ini file.
 Not available outside of module through exports.
@@ -32,14 +34,20 @@ Gets factorios locale as an object, does not respect mods.
 */
 module.exports.asObject = function getLocaleAsObject(factorioDirectory, languageCode, callback){
 	if(typeof factorioDirectory != "string" || typeof languageCode != "string" || typeof callback != "function"){
-		throw "Error: wrong parameters provided";
+		throw new Error("Error: wrong parameters provided");
+	}
+	
+	if(!cache[languageCode]){
+		getLocale(factorioDirectory, languageCode, (err, rawLocale) => {
+			if(err){
+				callback(err);
+			} else {
+				let processedLocale = ini.parse(rawLocale);
+				cache[languageCode] = processedLocale;
+				callback(undefined, processedLocale);
+			}
+		});
+	} else {
+		callback(undefined, cache[languageCode]);
 	}
-	getLocale(factorioDirectory, languageCode, (err, rawLocale) => {
-		if(err){
-			callback(err);
-		} else {
-			let processedLocale = ini.parse(rawLocale)
-			callback(undefined, processedLocale);
-		}
-	});
 }

lib/getInstances.js

@@ -1,14 +1,17 @@
 const fileOps = require("_app/fileOps");
+// const config = require("./../config");
 
-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;
+module.exports = function(config) {
+	return {
+		sync: function(){
+			let instances;
+			try {
+				instances = fileOps.getDirectoriesSync(config.instanceDirectory);
+			} catch (e) {
+				// there are no instances created yet, probably missing the folder
+				instances = [];
+			}
+			return instances;
+		},
 	}
 }

lib/manager/configManager.js

@@ -15,6 +15,9 @@ 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){
+	console.log(asTable(this.getConfig(instance)));
+}
+module.exports.getConfig = async function(instance){
 	if(!instance || instance == "shared"){
 		let configArray = [];
 		Object.keys(config).forEach(key=>{
@@ -24,7 +27,7 @@ module.exports.displayConfig = function(instance){
 				} else configArray.push({entry: key, value: config[key]});
 			}
 		});
-		console.log(asTable(configArray));
+		return configArray;
 	}
 }
 module.exports.editConfig = function(instance, entry, newValue){
@@ -33,16 +36,34 @@ module.exports.editConfig = function(instance, 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, "	"))
+				// console.log("new config file:");
+				// console.log(JSON.stringify(config, null, "	"))
 				fs.writeFileSync("config.json", JSON.stringify(config, null, 4));
+				return {
+					ok:true,
+					msg:`Changed config entry ${entry} from Object to ${JSON.stringify(newValue)}`,
+				}
 			} 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, "	"))
+				// console.log("new config file:");
+				// console.log(JSON.stringify(config, null, "	"))
 				fs.writeFileSync("config.json", JSON.stringify(config, null, 4));
+				return {
+					ok:true,
+					msg:`Changed config entry ${entry} from ***** to '${newValue}'`,
+				};
 			}
+		} else {
+			return {
+				ok:false,
+				msg:`No such config parameter`,
+			}
+		}
+	} else {
+		return {
+			ok:false,
+			msg:`Editing config for single instances is not yet supported`,
 		}
 	}
 };

lib/manager/instanceManager.js

@@ -0,0 +1,2 @@
+const fs = require("fs-extra");
+const needle = require("needle");

lib/manager/modManager.js

@@ -7,15 +7,15 @@ 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 fs = require("fs-extra");
 const https = require('follow-redirects').https;
 const factorioAPI = require("node-factorio-api");
 const sLog = require("single-line-log").stdout;
+const query = require('cli-interact').getYesNo;
 
 const fileOps = require("_app/fileOps");
-const config = require("./../../config");
+// 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;
@@ -23,208 +23,248 @@ function ellipse(str, max){
 // 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
+module.exports = function(config){
+	if(!config) config = require("./../../config");
+	const instances = require("./../getInstances.js")(config).sync();
+	return {
+		/**
+		Lists mods for an instance as a table. Warning, handles printing internally.
+		@param {string} instance - Name of the instance or "shared"
 
-@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");
+		@example
+		var modManager = require("modManager")(config);
+		modManager.listMods("testInstance");
+		// console.logs table of mods installed on instance
+		modManager.listMods("shared");
+		// console.logs mods located in /sharedMods as a nice table
+		*/
+		listMods: function(instance){
+			return new Promise((resolve, reject) => {
+				if(instance && instances.includes(instance)){
+					factorioAPI.init(false, config.instanceDirectory+'/'+instance+'/instanceMods', config.instanceDirectory+'/'+instance+'/saves', config.factorio_version);
+					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");
+						resolve();
 					});
+				} else {
+					// list shared mods in /sharedMods/
+					factorioAPI.init(false, 'sharedMods/', '', config.factorio_version);
+					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));
+							resolve();
+						});
+					}).catch(e => {
+						reject(new Error(e));
+					});
+				}
+				
+				// 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
+		*/
+		findMods: function(searchTerm){
+			return new Promise((resolve, reject) => {
+				factorioAPI.init(false);
+				factorioAPI.authenticate({
+					username: config.username,
+					token: config.token,
+					require_ownership: false
+				}).then(token => {
+					factorioAPI.searchMods(searchTerm).then(mods => {
+						let result = 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"),
+								latest_version: mod.latest_release.version,
+								owner:mod.owner,
+								//license: mod.license_name,
+							}
+						}));
+						resolve(result);
+						// console.log(result);
+					});
+				}).catch(e => {
+					if(e.contains("Insufficient information")) console.log("We are missing some parameters required for logging in! Make sure your factorio username and token are specified in config.json.");
+					reject(new Error(e));
 				});
 			});
-		} 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;
+		},
+		addMod: function(term, instance){
+			return new Promise((resolve, reject) => {
+				if(instance == "shared"){ // modDirectory has to end in /
+					var modDirectory = "sharedMods/";
+				} else {
+				var modDirectory = config.instanceDirectory+"/"+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, "", config.factorio_version);
+						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 + " in version: " + body[0].latest_release.version);
+								factorioAPI.downloadMod( {name: body[0].name, version: body[0].latest_release.version}).then(()=>{
+									console.log("Mod downloaded");
+									resolve();
+								});
+							});
+						});
+					} 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
+									resolve();
+								});
+							});
+						}
+					} else {
+						// treat it as a search and download the top result
+						factorioAPI.init(false, modDirectory, "", config.factorio_version);
+						factorioAPI.authenticate({
+							username: config.username,
+							token: config.token,
+							require_ownership: false
+						}).then(() => {
+							factorioAPI.searchMods(term).then(body => {
+								console.log(body)
+								console.log("Im gonna download: "+body[0].name + " in version: " + body[0].latest_release.version);
+								factorioAPI.downloadMod( {name: body[0].name, version: body[0].latest_release.version}).then(()=>{
+									console.log("Mod downloaded");
+									resolve();
+								});
+							});
+						});
+					}
+				} else {
+					reject(new Error("Invalid search term"));
+				}
+			});
+		},
+		removeMod: function removeMod(term, instance, force = false){
+			return new Promise((resolve, reject) => {
+				if(instance == "shared"){ // modDirectory has to end in /
+					var modDirectory = "sharedMods/";
+				} else {
+				var modDirectory = config.instanceDirectory+"/"+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");
+						modsMatchingFilter.forEach(mod => console.log(mod));
+						if(query("Delete all mods matching filter?")){
+							let modsToDelete = modsMatchingFilter.length;
+							for(let i = 0; i < modsToDelete; i++){
+								fs.unlinkSync(modDirectory+modsMatchingFilter[i]);
+								console.log("Deleted "+modsMatchingFilter[i]);
+							}
+						} else console.log("Did not delete mods.")
+					}
+					resolve();
+				} else {
+					reject(new Error("Invalid search term"));
+				}
+			});
+		},
+
+		// '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
+		*/
+		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;
-			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'];
+			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);
-					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
-					});
+					console.log("Downloaded "+name);
 				});
 			}
-		} 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);
-		});
+		},
 	}
 }
 /*

lib/manager/pluginManager.js

@@ -0,0 +1,116 @@
+const fs = require("fs-extra");
+const path = require("path");
+const git = require("simple-git")("./sharedPlugins");
+
+
+module.exports = function(config){
+	if(!config) config = require("./../../config");
+	
+	return {
+		listPlugins: async function(){
+			let plugins = await this.getPlugins();
+			plugins.forEach(plug => {
+				console.log(`${plug.name}`.padEnd(22).substr(0,22)+` - ${plug.description}`.substr(0,80-22));
+			});
+		},
+		getPlugins: async function(){
+			let directories = await fs.readdir("./sharedPlugins");
+			let returnArray = [];
+			for(let i in directories){
+				let dir = directories[i];
+				let pluginContents = await fs.readdir(path.join("./sharedPlugins", dir));
+				// console.log(pluginContents)
+				if(pluginContents.includes("config.js") || pluginContents.includes("config.json")){
+					try{
+						var pluginConfig = require(path.join("./../../sharedPlugins", dir, "config"));
+						pluginConfig.pluginPath = path.join("./sharedPlugins", dir);
+					}catch(e){
+						console.log(e)
+					}	
+					
+					// check if plugin is enabled
+					try{
+						await fs.stat(path.join(pluginConfig.pluginPath, "DISABLED"))
+						pluginConfig.enabled = false;
+					}catch(e){
+						pluginConfig.enabled = true;
+					}
+					returnArray.push(pluginConfig);
+				}
+			}
+			return returnArray;
+		},
+		addPlugin: function(path){
+			return new Promise((resolve, reject) => {
+				if(path.includes("git")){ // we are decently sure this is a git repo
+					git.clone(path, data => resolve(data))
+				}
+			});
+		},
+		removePlugin: async function(name){
+			let plugins = await this.getPlugins();
+			for(let i in plugins){
+				let plug = plugins[i];
+				if(plug.name.includes(name)){
+					// console.log(`Removing plugin ${plug.name}`);
+					await fs.remove(plug.pluginPath);
+					return {
+						ok:true,
+						msg:`Deleted plugin ${plug.name}`
+					}
+				}
+			}
+			return {
+				ok:false,
+				msg:`Plugin matching "${name}" not found`,
+			}
+		},
+		enablePlugin: async function(name, instance){
+			let plugins = await this.getPlugins();
+			let plugin = plugins[findInArray("name", name, plugins)[0]];
+			if(plugin){
+				let files = await fs.readdir(plugin.pluginPath);
+				if(files.includes("DISABLED")){
+					await fs.unlink(path.join(plugin.pluginPath, "DISABLED"));
+					return {
+						ok:true,
+						msg:`Globally enabled plugin ${name}`,
+					}
+				} else {
+					return {
+						ok:true,
+						msg:`Plugin ${name} already enabled`,
+					}
+				}
+			} else {
+				return {
+					ok:false,
+					msg:`Found no excact match for plugin ${name}`,
+				}
+			}
+		},
+		disablePlugin: async function(name, instance){
+			let plugins = await this.getPlugins();
+			let plugin = plugins[findInArray("name", name, plugins)[0]];
+			if(plugin){
+				await fs.writeFile(path.join(plugin.pluginPath, "DISABLED"), "");
+				return {
+					ok:true,
+					msg:`Plugin ${name} is now disabled on this host`,
+				}
+			} else {
+				return {
+					ok:false,
+					msg:`Found no excact match for plugin ${name}`,
+				}
+			}
+		}
+	}
+}
+function findInArray(key, value, array){
+	let indexes = [];
+	for(let i in array){
+		if(array[i][key] && array[i][key] === value) indexes.push(i);
+	}
+	return indexes;
+}

lib/npmPostinstall.js

@@ -5,7 +5,7 @@ var fs = require('fs');
 
 var modManager = require("./manager/modManager.js");
 
-modManager.addMod("clusterio", "shared");
+// modManager.addMod("clusterio", "shared");
 
 function makeDirectory(path){
 	return new Promise((resolve, reject) => {
@@ -61,17 +61,17 @@ var directories = [
 	"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: "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",

lib/scenarios/Hotpatch/control.lua

@@ -0,0 +1,153 @@
+--[[
+
+Copyright 2018 Chrisgbk
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+]]
+-- MIT License, https://opensource.org/licenses/MIT
+
+-- Hotpatchable control.lua for scenarios
+-- Supports multiple simultaneously loaded softmods
+-- This is a WIP
+-- Version 1.1 alpha
+-- probably some performance improvements to be made
+
+_ENV.debug_settings = {
+    level = 'info',
+    log_to_console_only = false,
+    log_to_RCON = false,
+    log_on_tick = false,
+}
+
+local hotpatch_tools = require 'hotpatch.mod-tools'
+require 'hotpatch.remote-interface'
+require 'hotpatch.commands'
+require 'hotpatch.gui'
+
+-- mod code goes here
+
+-- This is the Factorio Freeplay scenario
+-- This code, and the freeplay locale files in the zip file, is the property of Wube
+-- As this is part of the base mod, the developers have given permission for modders to use/adapt the assets therein, for modding Factorio
+-- Any other use would require licensing/permission from Wube
+-- If you don't want to run this, either comment this out before creating your scenario, OR uninstall freeplay at runtime
+hotpatch_tools.static_mod('freeplay', '1.0.0', [===[
+local util = require("util")
+local silo_script = require("silo-script")
+
+local created_items = function()
+  return
+  {
+    ["iron-plate"] = 8,
+    ["wood"] = 1,
+    ["pistol"] = 1,
+    ["firearm-magazine"] = 10,
+    ["burner-mining-drill"] = 1,
+    ["stone-furnace"] = 1
+  }
+end
+
+local respawn_items = function()
+  return
+  {
+    ["pistol"] = 1,
+    ["firearm-magazine"] = 10
+  }
+end
+
+for k,v in pairs(silo_script.get_events()) do
+  script.on_event(k, v)
+end
+
+script.on_event(defines.events.on_player_created, function(event)
+  local player = game.players[event.player_index]
+  util.insert_safe(player, global.created_items)
+
+  local r = global.chart_distance or 200
+  player.force.chart(player.surface, {{player.position.x - r, player.position.y - r}, {player.position.x + r, player.position.y + r}})
+
+  if not global.skip_intro then
+    if game.is_multiplayer() then
+      player.print({"msg-intro"})
+    else
+      game.show_message_dialog{text = {"msg-intro"}}
+    end
+  end
+
+  silo_script.on_event(event)
+end)
+
+script.on_event(defines.events.on_player_respawned, function(event)
+  local player = game.players[event.player_index]
+  util.insert_safe(player, global.respawn_items)
+  silo_script.on_event(event)
+end)
+
+script.on_configuration_changed(function(event)
+  global.created_items = global.created_items or created_items()
+  global.respawn_items = global.respawn_items or respawn_items()
+  silo_script.on_configuration_changed(event)
+end)
+
+script.on_load(function()
+  silo_script.on_load()
+end)
+
+script.on_init(function()
+  global.created_items = created_items()
+  global.respawn_items = respawn_items()
+  silo_script.on_init()
+end)
+
+silo_script.add_remote_interface()
+silo_script.add_commands()
+
+remote.add_interface("freeplay",
+{
+  get_created_items = function()
+    return global.created_items
+  end,
+  set_created_items = function(map)
+    global.created_items = map
+  end,
+  get_respawn_items = function()
+    return global.respawn_items
+  end,
+  set_respawn_items = function(map)
+    global.respawn_items = map
+  end,
+  set_skip_intro = function(bool)
+    global.skip_intro = bool
+  end,
+  set_chart_distance = function(value)
+    global.chart_distance = tonumber(value)
+  end
+})
+]===])
+
+-- Multi-file test
+--[[
+local files = {}
+
+files['testfolder.anothertest.test'] = [===[
+    script.on_event(defines.events.on_player_changed_position, function(e) game.print('position changed') end)
+]===]
+
+files['testfolder.test'] = [===[
+    require 'anothertest.test'
+]===]
+
+files['test'] = [===[
+    require 'testfolder.test'
+]===]
+
+hotpatch_tools.static_mod('require-test', '1.0.0', [===[
+    require 'test'
+]===], files)
+--]]
+
+-- end of mod code

lib/scenarios/Hotpatch/hotpatch/commands.lua

@@ -0,0 +1,135 @@
+local hotpatch_tools = require 'hotpatch.mod-tools'
+hotpatch_tools.static_mod('hotpatch-commands', '1.0.1', [===[
+--[[
+
+Copyright 2018 Chrisgbk
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+]]
+-- MIT License, https://opensource.org/licenses/MIT
+
+local hotpatch_tools = require 'hotpatch.mod-tools'
+
+--load private API
+-- mod installation/uninstallation support functions
+-- These take a mod NAME as a first argument
+local install_mod = hotpatch_tools.install_mod
+local find_installed_mod = hotpatch_tools.find_installed_mod
+local install_mod_file = hotpatch_tools.install_mod_file
+local uninstall_mod = hotpatch_tools.uninstall_mod
+
+-- mod interaction functions
+-- These take a LOADED INDEX as a first argument, except load_mod, which takes an INSTALLED INDEX
+local load_mod = hotpatch_tools.load_mod
+local find_loaded_mod = hotpatch_tools.find_loaded_mod
+local run_mod = hotpatch_tools.run_mod
+local reset_mod = hotpatch_tools.reset_mod
+local reset_mod_events = hotpatch_tools.reset_mod_events
+local register_mod_events = hotpatch_tools.register_mod_events
+local unload_mod = hotpatch_tools.unload_mod
+
+-- internal callbacks when a mod registers events
+local register_event = hotpatch_tools.register_event
+local register_nth_tick = hotpatch_tools.register_nth_tick
+local register_on_tick = hotpatch_tools.register_on_tick
+
+-- mod bootstrap functions
+-- These take a LOADED INDEX as a first argument
+local mod_on_init = hotpatch_tools.mod_on_init
+local mod_on_load = hotpatch_tools.mod_on_load
+local mod_on_configuration_changed = hotpatch_tools.mod_on_configuration_changed
+
+local static_mods = hotpatch_tools.static_mods
+local console = hotpatch_tools.console
+local debug_log = hotpatch_tools.debug_log
+local loaded_mods = hotpatch_tools.loaded_mods
+local installed_mods = hotpatch_tools.installed_mods
+
+local help_commands = {
+    help = '/hotpatch help\nYou got this far, you probably know all you need to know',
+    list = '/hotpatch list [type]\nLists \'installed\', \'loaded\' or \'running\' mods',
+}
+
+local sub_commands
+sub_commands = {
+    help = function(player_index, param)
+        local caller = (player_index and game.players[player_index]) or console
+        if (not param) or (param == '') then
+            caller.print('Usage: /hotpatch [command] [parameters]')
+            caller.print('Available commands:')
+            for k, _ in pairs(sub_commands) do caller.print(k) end
+            caller.print('Use /hotpatch help [command] for help on a particular command')
+        else
+            local text = help_commands[param]
+            if text then
+                caller.print(text)
+            end
+        end
+    end,
+    list = function(player_index, param)
+        local caller = (player_index and game.players[player_index]) or console
+        if not param or (param == '') then
+            caller.print('Installed mods:')
+            for k, v in pairs(installed_mods) do
+                caller.print(table.concat{'[', k, '] ', v.name, ' ', v.version})
+            end
+            caller.print('Loaded/Running mods:')
+            for k, v in pairs(loaded_mods) do
+                caller.print(table.concat{'[', k, '] ', v.name, ' ', v.version, ' ', (v.loaded and 'loaded') or 'not loaded', ' ', (v.running and 'running') or 'not running'})
+            end
+        else
+
+        end
+    end,
+}
+
+local admin_commands = {
+    reinstall = function(player_index, param)
+        local caller = (player_index and game.players[player_index]) or console
+        local mod
+        local installed_index
+        local loaded_index
+        for i = 1, #static_mods do
+            mod = static_mods[i]
+            if mod.name:match('^hotpatch%-.*$') then
+                loaded_index = find_loaded_mod(mod.name)
+                if loaded_index then
+                    unload_mod(loaded_index)
+                end
+                install_mod(mod.name, mod.version, mod.code, mod.files)
+                installed_index = find_installed_mod(mod.name)
+                load_mod(installed_index)
+                loaded_index = find_loaded_mod(mod.name)
+                run_mod(loaded_index)
+                mod_on_init(loaded_index)
+            end
+        end
+    end,
+}
+
+_ENV.commands.add_command('hotpatch', 'Commands for hotpatch. Run /hotpatch help for details.', function(e)
+    local caller = (e.player_index and game.players[e.player_index]) or console
+    if (not e.parameter) or (e.parameter == '') then
+        sub_commands['help'](e.player_index)
+        return
+    end
+    local sub_command, rest = e.parameter:match('(.-)%s(.*)')
+    if not sub_command then
+        sub_command = e.parameter
+    end
+
+    local f = sub_commands[sub_command]
+    if f then f(e.player_index, rest) end
+    if caller.admin then
+        f = admin_commands[sub_command]
+        if f then f(e.player_index, rest) end
+    end
+end)
+
+--]===])
+
+return true

lib/scenarios/Hotpatch/hotpatch/gui.lua

@@ -0,0 +1,377 @@
+local hotpatch_tools = require 'hotpatch.mod-tools'
+hotpatch_tools.static_mod('hotpatch-gui', '1.0.4', [===[
+--[[
+
+Copyright 2018 Chrisgbk
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+]]
+-- MIT License, https://opensource.org/licenses/MIT
+
+local hotpatch_tools = require 'hotpatch.mod-tools'
+local mod_gui = require 'mod-gui'
+
+--load private API
+-- mod installation/uninstallation support functions
+-- These take a mod NAME as a first argument
+local install_mod = hotpatch_tools.install_mod
+local find_installed_mod = hotpatch_tools.find_installed_mod
+local install_mod_file = hotpatch_tools.install_mod_file
+local uninstall_mod = hotpatch_tools.uninstall_mod
+
+-- mod interaction functions
+-- These take a LOADED INDEX as a first argument, except load_mod, which takes an INSTALLED INDEX
+local load_mod = hotpatch_tools.load_mod
+local find_loaded_mod = hotpatch_tools.find_loaded_mod
+local run_mod = hotpatch_tools.run_mod
+local reset_mod = hotpatch_tools.reset_mod
+local reset_mod_events = hotpatch_tools.reset_mod_events
+local register_mod_events = hotpatch_tools.register_mod_events
+local unload_mod = hotpatch_tools.unload_mod
+
+-- internal callbacks when a mod registers events
+local register_event = hotpatch_tools.register_event
+local register_nth_tick = hotpatch_tools.register_nth_tick
+local register_on_tick = hotpatch_tools.register_on_tick
+
+-- mod bootstrap functions
+-- These take a LOADED INDEX as a first argument
+local mod_on_init = hotpatch_tools.mod_on_init
+local mod_on_load = hotpatch_tools.mod_on_load
+local mod_on_configuration_changed = hotpatch_tools.mod_on_configuration_changed
+
+local static_mods = hotpatch_tools.static_mods
+local console = hotpatch_tools.console
+local debug_log = hotpatch_tools.debug_log
+local loaded_mods = hotpatch_tools.loaded_mods
+local installed_mods = hotpatch_tools.installed_mods
+
+script.on_event(defines.events.on_player_joined_game, function(e)
+    local player = game.players[e.player_index]
+    local top = mod_gui.get_button_flow(player)
+    local left = mod_gui.get_frame_flow(player)
+    local center = player.gui.center
+
+    local button = top['hotpatch-button']
+    if button then
+        button.destroy()
+    end
+    local menu = left['hotpatch-menu']
+    if menu then
+        menu.destroy()
+    end
+
+    local IDE = center['hotpatch-IDE']
+    if IDE then
+        IDE.destroy()
+    end
+
+    local main = center['hotpatch-main']
+    if main then
+        main.destroy()
+    end
+
+    button = top.add{type = 'sprite-button', name = 'hotpatch-button', sprite='utility/heat_exchange_indication', tooltip = 'Hotpatch', style = mod_gui.button_style}
+end)
+
+local on_gui_click_handlers
+local on_gui_selection_state_changed_handlers
+
+on_gui_click_handlers = {
+    ['hotpatch-button'] = function(e)
+        --on_gui_click_handlers['hotpatch-menu.IDE'](e)
+        --do return end
+        local player = game.players[e.player_index]
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+
+        local menu = left['hotpatch-menu']
+        if not menu then
+            menu = left.add{type = 'frame', name = 'hotpatch-menu', direction = 'vertical'}
+            menu.add{type = 'button', name = 'hotpatch-menu.IDE', caption = 'Mod IDE', tooltip = 'Open debugging GUI'}
+            menu.add{type = 'button', name = 'hotpatch-menu.console', caption = 'Mod Console', tooltip = 'Open debugging console'}
+            menu.visible = true
+            return
+        end
+        menu.visible = not menu.visible
+    end,
+    ['hotpatch-menu'] = function(e)
+        local player = game.players[e.player_index]
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+
+        local menu = left['hotpatch-menu']
+        menu.visible = not menu.visible
+
+        on_gui_click_handlers[e.element.name](e)
+    end,
+    ['hotpatch-menu.IDE'] = function(e)
+        local player = game.players[e.player_index]
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+
+        local IDE = center['hotpatch-IDE']
+        if not IDE then
+            IDE = center.add{type = 'frame', name = 'hotpatch-IDE', direction = 'vertical', caption = 'Hotpatch IDE', style = mod_gui.frame_style}
+            local top_flow = IDE.add{type = 'flow', name = 'hotpatch-IDE-top', direction = 'horizontal'}
+            top_flow.add{type = 'label', name = 'hotpatch-IDE-mod-label', caption = 'Mod: '}
+            local IDE_dropdown = top_flow.add{type = 'drop-down', name = 'hotpatch-IDE-mod-selector'}
+            top_flow.add{type = 'label', name = 'hotpatch-IDE-mod-version', caption = 'Version: No mod selected'}
+            local IDE_table = IDE.add{type = 'table', name = 'hotpatch-IDE-table', column_count = 2}
+            local files = IDE_table.add{type = 'scroll-pane', name = 'hotpatch-IDE-files', direction='vertical'}
+            files.style.height = 600
+            files.vertical_scroll_policy = 'always'
+            files = files.add{type = 'table', name = 'hotpatch-IDE-files-table', column_count = 1}
+            local code = IDE_table.add{type = 'text-box', name = 'hotpatch-IDE-code'}
+            code.word_wrap = true
+            files.style.width = 400
+            files.style.cell_padding = 0
+            files.style.top_padding = 0
+            files.style.bottom_padding = 0
+            code.style.width = 600
+            code.style.height = 600
+            IDE.visible = false
+        end
+
+        local IDE_dropdown = IDE['hotpatch-IDE-top']['hotpatch-IDE-mod-selector']
+        IDE_dropdown.clear_items()
+        for _, v in ipairs(installed_mods) do
+            IDE_dropdown.add_item(v.name)
+        end
+
+        IDE.visible = not IDE.visible
+        if IDE.visible then
+            player.opened = IDE
+        else
+            player.opened = nil
+        end
+    end,
+    ['hotpatch-menu.console'] = function(e)
+        local player = game.players[e.player_index]
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+
+        local hotpatch_console = center['hotpatch-console']
+        if not hotpatch_console then
+            hotpatch_console = center.add{type = 'frame', name = 'hotpatch-console', direction = 'vertical', caption = 'Hotpatch Console'}
+            local top_flow = hotpatch_console.add{type = 'flow', name = 'hotpatch-console-top', direction = 'horizontal'}
+            top_flow.add{type = 'label', name = 'hotpatch-console-mod-label', caption = 'Mod: '}
+            local console_dropdown = top_flow.add{type = 'drop-down', name = 'hotpatch-console-mod-selector'}
+            top_flow.add{type = 'label', name = 'hotpatch-console-mod-version', caption = 'Version: No mod selected'}
+            local bottom_flow = hotpatch_console.add{type = 'flow', name = 'hotpatch-console-bottom', direction = 'vertical'}
+            local output = bottom_flow.add{type = 'text-box', name = 'hotpatch-console-output'}
+            local bottom_input_flow = bottom_flow.add{type = 'flow', name = 'hotpatch-console-bottom-input', direction = 'horizontal'}
+            local input = bottom_input_flow.add{type = 'textfield', name = 'hotpatch-console-input'}
+            bottom_input_flow.add{type = 'button', name = 'hotpatch-console-run', caption = 'Run', tooltip = 'Run Lua Code'}
+            output.style.width = 800
+            output.style.height = 600
+            input.style.width = 600
+			hotpatch_console.visible = false
+        end
+
+        local console_dropdown = hotpatch_console['hotpatch-console-top']['hotpatch-console-mod-selector']
+        console_dropdown.clear_items()
+        for _, v in ipairs(loaded_mods) do
+            console_dropdown.add_item(v.name)
+        end
+
+        hotpatch_console.visible = not hotpatch_console.visible
+        if hotpatch_console.visible then
+            player.opened = hotpatch_console
+        else
+            player.opened = nil
+        end
+    end,
+    ['hotpatch-console-run'] = function(e)
+        local player = game.players[e.player_index]
+
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+
+        local hotpatch_console = center['hotpatch-console']
+        local output = hotpatch_console['hotpatch-console-bottom']['hotpatch-console-output']
+        local input = hotpatch_console['hotpatch-console-bottom']['hotpatch-console-bottom-input']['hotpatch-console-input']
+        local console_dropdown = hotpatch_console['hotpatch-console-top']['hotpatch-console-mod-selector']
+
+        if not player.admin then
+            output.text = table.concat{output.text, '\n', 'Only admins!'}
+            return
+        end
+
+        if not (console_dropdown.selected_index > 0) then
+            output.text = table.concat{output.text, '\n', 'Select a mod!'}
+            return
+        end
+
+        local mod_name = console_dropdown.items[console_dropdown.selected_index]
+        local loaded_index = find_loaded_mod(mod_name)
+        local env = loaded_mods[loaded_index].env
+        local old_print = env.print
+        local old_log = env.log
+
+
+
+
+
+        env.print = function(...)
+            --local count = select('#', ...)
+            local t = table.pack(...)
+            for k, v in pairs(t) do
+                t[k] = tostring(v)
+            end
+            local text = table.concat(t, '\t')
+            output.text = table.concat{output.text, '\n', text}
+        end
+
+        env.log = function(text)
+            output.text = table.concat{output.text, '\n', text}
+        end
+
+        local success
+        local code, err = load(input.text, input.text, 't', env)
+        if code then
+            success, err = pcall(code)
+            if not success then
+                output.text = table.concat{output.text, '\n', err}
+            end
+        else
+            output.text = table.concat{output.text, '\n', err}
+        end
+
+        env.print = old_print
+        env.log = old_log
+    end,
+    ['hotpatch-IDE-file'] = function(e)
+        local player = game.players[e.player_index]
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+
+        local element = e.element
+        local previous
+        for _, v in pairs(center['hotpatch-IDE']['hotpatch-IDE-table']['hotpatch-IDE-files']['hotpatch-IDE-files-table'].children) do
+            if table.compare(v.style.font_color or {}, {r=1.0, g=1.0, b=0.0, a=1.0}) then
+                previous = v
+                break
+            end
+        end
+        if previous then
+            previous.style.font_color = {r=1.0, g=1.0, b=1.0, a=1.0}
+        end
+        element.style.font_color = {r=1.0, g=1.0, b=0.0, a=1.0}
+        local file = element.name:match('.-%.(.*)')
+        local selected = center['hotpatch-IDE']['hotpatch-IDE-top']['hotpatch-IDE-mod-selector']
+        local mod_name = selected.items[selected.selected_index]
+        local code = center['hotpatch-IDE']['hotpatch-IDE-table']['hotpatch-IDE-code']
+        local index = find_installed_mod(mod_name)
+        if index then
+            local mod = installed_mods[index]
+            if file == 'control' then
+                code.text = mod.code
+            else
+                code.text = mod.files[file]
+            end
+        end
+    end,
+}
+
+script.on_event(defines.events.on_gui_click, function(e)
+    local element = e.element
+    if element.valid then
+        local name = element.name:match('([^%.]*)%.?.-')
+        local handler = on_gui_click_handlers[name]
+        if handler then handler(e) end
+    end
+end)
+
+on_gui_selection_state_changed_handlers = {
+    ['hotpatch-console-mod-selector'] = function(e)
+        local player = game.players[e.player_index]
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+
+        local element = e.element
+        local name = element.items[element.selected_index]
+        if name then
+            local index = find_loaded_mod(name)
+            if index then
+                local mod = loaded_mods[index]
+                local version_label = center['hotpatch-console']['hotpatch-console-top']['hotpatch-console-mod-version']
+                version_label.caption = 'Version: ' .. mod.version
+                local hotpatch_console = center['hotpatch-console']
+                local output = hotpatch_console['hotpatch-console-bottom']['hotpatch-console-output']
+                output.text = ''
+            end
+        end
+    end,
+    ['hotpatch-IDE-mod-selector'] = function(e)
+        local player = game.players[e.player_index]
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+
+        local element = e.element
+
+        local name = element.items[element.selected_index]
+        if name then
+            local index = find_installed_mod(name)
+            if index then
+                local mod = installed_mods[index]
+                local version_label = center['hotpatch-IDE']['hotpatch-IDE-top']['hotpatch-IDE-mod-version']
+                version_label.caption = 'Version: ' .. mod.version
+                local list = center['hotpatch-IDE']['hotpatch-IDE-table']['hotpatch-IDE-files']['hotpatch-IDE-files-table']
+                list.clear()
+                local file = list.add{type = 'label', style = 'hoverable_bold_label', caption = 'control', name = 'hotpatch-IDE-file.control'}
+                file.style.bottom_padding = 0
+                file.style.top_padding = 0
+                for k, _ in pairs(mod.files) do
+                    file = list.add{type = 'label', style = 'hoverable_bold_label', caption = k, name = 'hotpatch-IDE-file.' .. k}
+                    file.style.bottom_padding = 0
+                    file.style.top_padding = 0
+                end
+                local code = center['hotpatch-IDE']['hotpatch-IDE-table']['hotpatch-IDE-code']
+                code.text = ''
+            end
+        end
+    end,
+}
+
+script.on_event(defines.events.on_gui_selection_state_changed, function(e)
+    local element = e.element
+    local handler = on_gui_selection_state_changed_handlers[element.name]
+    if handler then handler(e) end
+end)
+
+script.on_event(defines.events.on_gui_closed, function(e)
+    local player = game.players[e.player_index]
+    local element = e.element
+    if e.gui_type == defines.gui_type.custom then
+        if element and element.valid then
+            if element.name == 'hotpatch-IDE' then
+                if element.visible then
+                    player.play_sound{path = "utility/gui_click"}
+                end
+                element.visible = false
+            elseif element.name == 'hotpatch-console' then
+                if element.visible then
+                    player.play_sound{path = "utility/gui_click"}
+                end
+                element.visible = false
+            end
+        end
+    end
+end)
+
+--]===])
+
+return true

lib/scenarios/Hotpatch/hotpatch/remote-interface.lua

@@ -0,0 +1,322 @@
+local hotpatch_tools = require 'hotpatch.mod-tools'
+hotpatch_tools.static_mod('hotpatch-remote-interface', '1.0.2', [===[
+--[[
+
+Copyright 2018 Chrisgbk
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+]]
+-- MIT License, https://opensource.org/licenses/MIT
+
+local hotpatch_tools = require 'hotpatch.mod-tools'
+
+--load private API
+-- mod installation/uninstallation support functions
+-- These take a mod NAME as a first argument
+local install_mod = hotpatch_tools.install_mod
+local find_installed_mod = hotpatch_tools.find_installed_mod
+local install_mod_file = hotpatch_tools.install_mod_file
+local uninstall_mod = hotpatch_tools.uninstall_mod
+
+-- mod interaction functions
+-- These take a LOADED INDEX as a first argument, except load_mod, which takes an INSTALLED INDEX
+local load_mod = hotpatch_tools.load_mod
+local find_loaded_mod = hotpatch_tools.find_loaded_mod
+local run_mod = hotpatch_tools.run_mod
+local reset_mod = hotpatch_tools.reset_mod
+local reset_mod_events = hotpatch_tools.reset_mod_events
+local register_mod_events = hotpatch_tools.register_mod_events
+local unload_mod = hotpatch_tools.unload_mod
+
+-- internal callbacks when a mod registers events
+local register_event = hotpatch_tools.register_event
+local register_nth_tick = hotpatch_tools.register_nth_tick
+local register_on_tick = hotpatch_tools.register_on_tick
+
+-- mod bootstrap functions
+-- These take a LOADED INDEX as a first argument
+local mod_on_init = hotpatch_tools.mod_on_init
+local mod_on_load = hotpatch_tools.mod_on_load
+local mod_on_configuration_changed = hotpatch_tools.mod_on_configuration_changed
+
+local static_mods = hotpatch_tools.static_mods
+local console = hotpatch_tools.console
+local debug_log = hotpatch_tools.debug_log
+local loaded_mods = hotpatch_tools.loaded_mods
+local installed_mods = hotpatch_tools.installed_mods
+
+local remote_interface = {}
+
+--IMPORTANT: WHEN COPY PASTING CODE TO CONSOLE THE CODE MUST HAVE SINGLE LINE COMMENTS REMOVED
+-- FACTORIO CONSOLE STRIPS LINEFEEDS WHICH MAKES ALL THE CODE BECOME COMMENTED OUT
+--TODO: gate these behind admin permissions; if (game.player and game.player.admin) should work for console commands?
+
+debug_log({'hotpatch-info.remote-installing'})
+
+remote_interface['install'] = function(mod_name, mod_version, mod_code, mod_files, only_install)
+    -- this installs a new mod and runs on_init, then registers events
+    -- Note that mods may expect that certain events haven't been called yet when their on_init is ran
+    -- This may prevent them from functioning properly, without manually calling the events they expect
+    -- examples: on_player_created
+    local caller = game.player or console
+    if caller.admin then
+		if mod_files then
+			for k,_ in pairs(mod_files) do
+				if k == 'control' then
+					caller.print('ERROR: control.lua loaded twice for mod ' .. mod_name)
+					return
+				end
+			end
+		end
+        local installed_index = find_installed_mod(mod_name)
+        local loaded_index = find_loaded_mod(mod_name)
+        if installed_index then
+            local old_version = installed_mods[installed_index].version
+            if old_version then
+                debug_log({'hotpatch-warning.already-exists', mod_name, old_version})
+                debug_log({'hotpatch-warning.reinstalling', mod_name, old_version})
+            end
+            if loaded_index then
+                unload_mod(loaded_index)
+            end
+        end
+
+        install_mod(mod_name, mod_version, mod_code, mod_files)
+        if not only_install then
+            installed_index = find_installed_mod(mod_name)
+            if installed_index then
+                if not load_mod(installed_index) then
+                    caller.print('compilation failed for mod ' .. mod_name)
+                    return
+                end
+                loaded_index = find_loaded_mod(mod_name)
+                if loaded_index then
+                    if not run_mod(loaded_index) then
+                        caller.print('execution failed for mod ' .. mod_name)
+						unload_mod(loaded_index)
+                        return
+                    end
+                    if not mod_on_init(loaded_index) then
+                        caller.print('on_init failed for mod ' .. mod_name)
+						unload_mod(loaded_index)
+                        return
+                    end
+                    -- TODO: notify all mods
+                    -- TODO: determine vanilla behaviour and replicate it
+                    if not mod_on_configuration_changed(loaded_index, {mod_changes = {mod_name={new_version=mod_version}}}) then
+                        caller.print('on_configuration_changed failed for mod ' .. mod_name)
+						unload_mod(loaded_index)
+                        return
+                    end
+                else
+                end
+            else
+            end
+        end
+    else
+        caller.print('You must be an admin to run this command.')
+    end
+end
+
+remote_interface['run'] = function(mod_name)
+    -- this runs on_init, then registers events
+    -- Note that mods may expect that certain events haven't been called yet when their on_init is ran
+    -- This may prevent them from functioning properly, without manually calling the events they expect
+    -- examples: on_player_created
+    local caller = game.player or console
+    if caller.admin then
+        local installed_index = find_installed_mod(mod_name)
+        local loaded_index = find_loaded_mod(mod_name)
+		local mod
+        local version
+        if installed_index and not loaded_index then
+            if not load_mod(installed_index) then
+                caller.print('compilation failed for mod ' .. mod_name)
+                return
+            end
+            loaded_index = find_loaded_mod(mod_name)
+        else
+            if loaded_index then
+                mod = loaded_mods[loaded_index]
+                version = mod.version
+                debug_log({'hotpatch-warning.already-loaded', mod_name, version})
+                debug_log({'hotpatch-warning.reinitializing', mod_name, version})
+            end
+        end
+
+        if loaded_index then
+            if not run_mod(loaded_index) then
+                caller.print('execution failed for mod ' .. mod_name)
+				unload_mod(loaded_index)
+                return
+            end
+            if not mod_on_init(loaded_index) then
+                caller.print('on_init failed for mod ' .. mod_name)
+				unload_mod(loaded_index)
+                return
+            end
+            -- TODO: notify all mods
+            -- TODO: determine vanilla behaviour and replicate it
+            if not mod_on_configuration_changed(loaded_index, {mod_changes = {mod_name={new_version=version}}}) then
+                caller.print('on_configuration_changed failed for mod ' .. mod_name)
+				unload_mod(loaded_index)
+                return
+            end
+        end
+    else
+        caller.print('You must be an admin to run this command.')
+    end
+end
+
+remote_interface['update'] = function(mod_name, mod_version, mod_code, mod_files)
+    -- this updates an existing mod
+    -- the current mods events are de-registered, the new code is installed, on_load is triggered, and then events are registered
+    -- finally, the mod is informed of the update, so it can run migrations from the previous version
+    -- TODO: validation
+    local caller = game.player or console
+    if caller.admin then
+		if mod_files then
+			for k,_ in pairs(mod_files) do
+				if k == 'control' then
+					caller.print('ERROR: control.lua loaded twice for mod ' .. mod_name)
+					return
+				end
+			end
+		end
+        local installed_index = find_installed_mod(mod_name)
+		if installed_index then
+			;
+		end
+        local loaded_index = find_loaded_mod(mod_name)
+        local old_version
+        if loaded_index then
+            old_version = loaded_mods[loaded_index].version
+            unload_mod(loaded_index)
+        end
+        install_mod(mod_name, mod_version, mod_code, mod_files)
+        installed_index = find_installed_mod(mod_name)
+        if not load_mod(installed_index) then
+            caller.print('compilation failed for mod ' .. mod_name)
+            return
+        end
+        loaded_index = find_loaded_mod(mod_name)
+        if not run_mod(loaded_index) then
+            caller.print('execution failed for mod ' .. mod_name)
+			unload_mod(loaded_index)
+            return
+        end
+        if old_version then
+            if not mod_on_load(loaded_index) then
+                caller.print('on_load failed for mod ' .. mod_name)
+				unload_mod(loaded_index)
+                return
+            end
+            -- The mod must do any migrations here
+            -- TODO: notify all mods
+            if not mod_on_configuration_changed(loaded_index, {mod_changes = {mod_name={old_version=old_version, new_version=mod_version}}}) then
+                caller.print('on_configuration_changed failed for mod ' .. mod_name)
+				unload_mod(loaded_index)
+                return
+            end
+        else
+            -- first time install
+            if not mod_on_init(loaded_index) then
+                caller.print('on_init failed for mod ' .. mod_name)
+				unload_mod(loaded_index)
+                return
+            end
+            -- TODO: notify all mods
+            if not mod_on_configuration_changed(loaded_index, {mod_changes = {mod_name={new_version=mod_version}}}) then
+                caller.print('on_configuration_changed failed for mod ' .. mod_name)
+				unload_mod(loaded_index)
+                return
+            end
+        end
+    else
+        caller.print('You must be an admin to run this command.')
+    end
+end
+
+remote_interface['install_mod_file'] = function(mod_name, mod_file, mod_file_code)
+    local caller = game.player or console
+    if caller.admin then
+        install_mod_file(mod_name, mod_file, mod_file_code)
+    else
+        caller.print('You must be an admin to run this command.')
+    end
+end
+
+remote_interface['exec'] = function(mod_name, exec_code)
+    local caller = game.player or console
+    if caller.admin then
+		local loaded_index = find_loaded_mod(mod_name)
+		local env = loaded_mods[loaded_index].env
+		
+		local success
+		local code, err = load(exec_code, exec_code, 't', env)
+		if code then
+			success, err = pcall(code)
+			if not success then
+				debug_log(err)
+			end
+		else
+			debug_log(err)
+		end
+	else
+		caller.print('You must be an admin to run this command.')
+    end
+end
+
+--TODO: most of this function
+remote_interface['clean'] = function(mod_name)
+    -- Removes ALL mod data and reinitializes
+    -- doesn't remove things a mod may add like surfaces, etc
+    local caller = game.player or console
+    if caller.admin then
+        --mod_reset(mod_name)
+        --run_mod(mod_name)
+        --mod_on_init(mod_name)
+		local loaded_index = find_loaded_mod(mod_name)
+		local mod = loaded_mods[loaded_index]
+        local version = mod.version
+        mod_on_configuration_changed(loaded_index, {mod_changes = {mod_name={new_version=version}}})
+    else
+        caller.print('You must be an admin to run this command.')
+    end
+end
+
+remote_interface['uninstall'] = function(mod_name)
+    -- Uninstalls a mod
+    local caller = game.player or console
+    if caller.admin then
+        uninstall_mod(mod_name)
+    else
+        caller.print('You must be an admin to run this command.')
+    end
+end
+
+remote.add_interface('hotpatch', remote_interface)
+
+debug_log({'hotpatch-info.complete', {'hotpatch-info.remote-installing'}})
+
+--]===])
+
+--[[
+
+remote.call('hotpatch, 'install', 'test', '1.0.0', [===[
+script.on_event(defines.events.on_player_changed_position, function(e)
+    game.print('changed position')
+end
+]===]
+
+local updated_code = ....
+remote.call('hotpatch', 'update', 'test', '1.0.1', updated_code)
+
+
+]]
+
+return true

lib/scenarios/Hotpatch/locale/af/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Hierdie is Factorio vryspel. Jou taak is om 'n vuurpyl in die buitenste ruimte in te stuur. Doen dit deur die bou van 'n Vuurpyl Silo en van daar af 'n vuurpyl te lanseer met a satelliet aan boord. Jy sal baie gevorderde tegnologiëe moet navors om die Vuurpyl Silo te ontsluit. Begin klein, werk jou pad op met outomatisering en moenie vergeet om jouself te beskerm teen die inboorlinge nie.
+
+

lib/scenarios/Hotpatch/locale/ar/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=.نييلصألا ناكسلا نم كسفن ةيامح ىسنت الو ةياهنلا ىلإ لصتل كتقيرطب لمعأو ،رفصلا نم أدبتس .خيراوصلا عماوص حتف لجأ نم ةمدقتم ايجولونكت نع ثحبلل جاتحت فوس .ةيعانصلا رامقألاب خيراوصلا قالطإو خيراوصلا عماوص ءانب قيرط نع كلذب مايقلا عيطتست .ءاضفلل اخوراص قلطت نا يه كتمهم .Factorio ـل رحلا بعللا وه اذه
+
+

lib/scenarios/Hotpatch/locale/be/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Гэта рэжым свабоднай гульні Factorio. Вашая мэта - запусціць ракету ў космас. Дзеля гэтага вам трэба пабудаваць ракетную шахту і саму ракету з спадарожнікам. Вы мусіце даследваць перадавыя тэхналогіі, каб навучыцца будаваць ракетную шахту. Пачынайце з малога, працуйце над аўтаматызацыяй вытворчасці, даследуйце новыя тэхналогіі і не забывайцеся на абарону ад "тутэйшых"!
+
+

lib/scenarios/Hotpatch/locale/bg/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Това е режимът на свободна игра. Задачата ви е да изстреляте ракета в космоса. За това ще е нужно да построите ракетна шахта и изстреляте ракетата със спътник. Ще трябва да проучите развити технологии, които ще отключат ракетната шахта. Започнете с малко и постепенно автоматизирайте процеса, като не забравяте да се защитавате от местните форми на живот.
+
+

lib/scenarios/Hotpatch/locale/ca/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Aquest és el mode lliure del Factorio. La vostra tasca és construir un coet i enviar-lo a l'espai. Ho haureu de fer construint un centre de coets espacials i llençant un coet amb un satèl·lit. Necessitareu investigar tecnologies avançades per poder-ho fer. Aneu pas a pas, avanceu cap a l'automatització i no oblideu protegir-vos dels natius.
+
+

lib/scenarios/Hotpatch/locale/cs/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Toto je volná hra Factorio. Tvým úkolem je vypustit raketu do vesmíru. Postav raketové silo a vypusť raketu se satelitem. Pro odemknutí raketového sila budeš muset vyzkoumat pokročilé technologie. Začni v malém, postupuj s automatizací a nezapomeň se chránit před domorodci.
+
+

lib/scenarios/Hotpatch/locale/da/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Det her er Factorio fri leg. Din opgave er at affyre en raket for at udforske rummet. For at gøre det skal du bygge en raket silo og affyre en raket med en satellit i. Du bliver nød til at udforske avancerede teknologier for at at kunne bygge en raket silo. Start småt, og arbejd din vej op med hjælp af automatisering, glem ikke at beskytte dig fra de indfødte.
+
+

lib/scenarios/Hotpatch/locale/de/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Dies ist das freie Spiel von Factorio. Deine Aufgabe ist es, eine Rakete in den Weltraum zu starten. Dazu musst Du ein Raketensilo bauen und eine Rakete mit einem Satelliten starten. Du wirst erweiterte Technologien erforschen müssen, um das Raketensilo freizuschalten. Fange klein an, arbeite Dich durch Automatisierung hoch und vergiss nicht, Dich vor den Einheimischen zu schützen.
+
+

lib/scenarios/Hotpatch/locale/el/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Αυτό είναι το ελεύθερο παιχνίδι του Factorio. Ο στόχος σου είναι να εκτοξεύσεις έναν πύραυλο στο διάστημα. Αυτό το κάνεις κατασκευάζοντας ένα σιλό πυραύλου και εκτοξεύοντας έναν πυραύλο με δορυφόρο. Θα πρέπει να ερευνήσεις προηγμένες τεχνολογίες για να ξεκλειδώσεις το σιλό πυραύλου. Ξεκινάς περιορισμένος, δούλεψε με αυτοματισμούς για την άνοδο σου και μην ξεχνάς να προστατέψεις τον εαυτό σου από τους ντόπιους.
+
+

lib/scenarios/Hotpatch/locale/en/freeplay.cfg

@@ -0,0 +1,2 @@
+msg-intro=This is the Factorio freeplay. Your task is to launch a rocket into space. Do this by constructing a Rocket Silo and launching a rocket with a satellite. You will need to research advanced technologies in order to unlock the Rocket Silo. Start small, work your way up with automation and don't forget to protect yourself from the natives.
+

lib/scenarios/Hotpatch/locale/en/hotpatch.cfg

@@ -0,0 +1,81 @@
+[hotpatch]
+log=@__1__:__2__] __3__
+log-mod=@__1__:__2__][__4__] __3__
+severe=SEVERE ERROR: __1__
+error=ERROR: __1__
+warning=WARNING: __1__
+info=INFO: __1__
+verbose=INFO: __1__
+trace=TRACE: __1__
+
+[hotpatch-info]
+logging-enabled=Logging enabled
+metatable-installed=_ENV metatable installed
+complete=__1__ Complete!
+on-init=initializing...
+on-load=loading...
+on-configuration-changed=mod configuration changed...
+installing-included-mods=installing included mods...
+loading-installed-mods=loading installed mods...
+loading-libs=loading Factorio.data.core.lualib...
+loading-library=loading library: __1__
+uninstalling=Uninstalling mod...
+installing=Installing version __1__...
+installing-file=Installing file __1__...
+script-shim=setting up mod script shim...
+setting-env=setting up mod _ENV...
+loading=loading...
+unloading=unloading...
+running=running...
+must-be-admin=You must be an admin to run this command
+remote-installing=installing remote interface
+
+[hotpatch-trace]
+nil-var-access=_ENV nil variable access: __1__
+nil-var-assignment=_ENV variable assignment: __1__
+event-registering=registering events...
+on-tick-event-registered=registered on_tick event...
+on-event-registered=registered event __1__...
+on-nth-tick-event-registered=registered nth_tick event __1__...
+event-running=running event __1__...
+nth-tick-event-running=running nth_event __1__...
+mod-on-init=running on_init...
+mod-on-load=running on_load...
+mod-on-configuration-changed=running on_configuration_changed...
+adding-event=adding event __1__
+adding-nth-tick-event=adding nth_tick event __1__
+caching-event=caching event: __1__...
+caching-nth-tick-event=caching nth_tick event: __1__...
+event-processing=processing event __1__...
+nth-tick-event-processing=processing nth_tick event __1__...
+nth-tick-handler-added=added nth_tick handler: __1__
+nth-tick-handler-removed=removed nth_tick handler: __1__
+on-tick-handler-added=added on_tick handler
+on-tick-handler-removed=removed on_tick handler
+on-event-handler-added=added event handler: __1__
+on-event-handler-removed=removed event handler: __1__
+cached-load-require=loading cached require'd file: __1__...
+load-require=loading require'd file: __1__...
+load-core-lib=loading from Factorio.data.core.lualib: __1__...
+
+[hotpatch-warning]
+contains-comments=mod code contains comments!
+contains-comments-no-lf=mod contains comments and no linefeed!
+contains-comments-console=comments from console will comment out the entire code!
+reset-events-not-running=tried to reset events for mod that isn't running!
+remote-interface-exists=remote interface __1__ already exists, removing...
+command-exists=command __1__ already exists, removing...
+already-exists=mod already exists: __1__ __2__
+reinstalling=reinstalling mod in-place: __1__ __2__
+already-loaded=mod already loaded: __1__ __2__
+reinitializing=reinitializing: __1__ __2__
+
+[hotpatch-error]
+invalid-API-access=Invalid API access: __1__
+not-installed=mod not installed, cannot install file for mod that does not exist
+compilation-failed=compilation failed for mod
+execution-failed=execution failed for mod
+path-not-found=path '__1__' not found
+on-init-failed=on_init failed
+on-load-failed=on_load failed
+on-configuration-changed-failed=on_configuration_changed failed

lib/scenarios/Hotpatch/locale/eo/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Tio estas la Factorio Libera Ludado. Via tasko estas ĵeti raketon en spacon. Fari tiun per konstruanta Raketo Silo kaj ĵeti raketon kun satelito. Vi bezonos esplori altnivelaj teknologioj por malŝlosi la Raketo Silo. Start malgranda, labori vian vojon supren per aŭtomatigo kaj ne forgesu protekti vin mem de la indiĝenoj.
+
+

lib/scenarios/Hotpatch/locale/es-ES/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Este es el modo de juego libre de Factorio. Tu tarea es la de lanzar un cohete al espacio. Logra esto construyendo un Silo de Cohetes y lanzando un cohete con un satélite. Necesitarás investigar tecnologías avanzadas para poder desbloquear el Silo de Cohetes. Comienza poco a poco, trabaja en tu sistema de automatización y no te olvides de protegerte de los nativos.
+
+

lib/scenarios/Hotpatch/locale/et/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=See on Factorio vabamäng. Sinu eesmärgiks on saata rakett avakosmosesse. Seda saad teha ehitades Raketi Silotorni ja lennutades Raketti koos satelliidiga. Selleks pead õppima selgeks keerukad tehnoloogiaharud, et Raketi Silotorni lahti lukustada. Alusta väikselt ning liigu edasi automatiseerimise abil ja ära unusta ennast kaitsta kohalike eluvormide eest.
+
+

lib/scenarios/Hotpatch/locale/fi/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Tämä on Factorion vapaapelimuoto. Tavoitteesi on lähettää satelliitti ulkoavaruuteen rakentamalla rakettisiilo ja laukaisemalla raketti. Rakettisiilon voit rakentaa vasta, kun olet kehittänyt siihen tarvittavat huipputeknologiat. Aloita pienestä ja automatisoi kaikki tarvittava, äläkä unohda suojella itseäsi alkuasukkailta.
+
+

lib/scenarios/Hotpatch/locale/fr/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Il s'agit du mode de jeu libre de Factorio. Votre tâche consiste à lancer une fusée dans l'espace. Ceci en construisant un silo à fusée, et en lançant un satellite avec la fusée. Vous aurez besoin de rechercher des technologies de pointe afin de débloquer le silo. Commencez petit, évoluez en automatisant et n'oubliez pas de vous protéger contre les autochtones.
+
+

lib/scenarios/Hotpatch/locale/he/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=.םיימוקמה םירוציה ינפמ םכמצע לע ןגהל וחכשת לאו ,יטמוטוא ןוכימ תועצמאב םכלש הישעתה תא וביחרה ,ןטקב וליחתה .ןקתמה תיינב תא רשפאל ידכ תומדקתמ תויגולונכט רוקחל םכילע היהי .ןייוול ליכמה ליט ותועצמאב רגשלו םיליט רוגיש ןקתמ תונבל םכילע .ללחל ליט רגשל איה םכתמישמ .ויִרֹוטְקַפ לש ישפוחה שיחרתה והז
+
+

lib/scenarios/Hotpatch/locale/hu/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Ez a Factorio szabad játék módja. A feladatod az, hogy kilőj egy rakétát az űr felderítésére. Ehhez egy Rakétasilót kell építened, melyből aztán egy műholddal felszerelt rakétát kell kilőnöd. A Rakétasiló kifejlesztéséhez különféle technológiákat kell fejlesztened. Kezdj kicsiben és küzdd fel magad az automatizálásban. Ne felejts el védekezni a honos fajok ellen.
+
+

lib/scenarios/Hotpatch/locale/it/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Questa è la modalità libera di Factorio. Il tuo obiettivo è quello di lanciare il razzo nello spazio. Completalo costruendo un Silo per Razzi e lanciando il razzo con il satellite. Avrai bisogno di ricercare tecnologie avanzate per riuscire a sbloccare il Silo per Razzi. Inizia in piccolo, espandi con l'automazione e non dimenticare di proteggerti dai nativi.
+
+

lib/scenarios/Hotpatch/locale/ja/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=これは、Factorioのフリープレイです。ロケットサイロを建造し、衛星を載せたロケットを宇宙へ打ち上げるのがあなたの任務です。ロケットサイロをアンロックするためには高度な技術研究をする必要があります。小規模に始め、自動化しつつ進み、原住生物から身を守ることも忘れないでください。
+
+

lib/scenarios/Hotpatch/locale/ko/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Factorio 자유플레이입니다. 당신의 목표는 우주로 로켓을 발사하는 것입니다. 로켓 격납고를 건설하고 인공위성을 탑재한 로켓을 발사하여 이 목표를 달성하세요. 로켓 격납고의 잠금을 해제하기 위해 고급 기술들을 연구할 필요가 있습니다. 작은 것부터 시작해 자동화로 차근차근 발전하고, 토착 생물로부터 자신을 보호하는 것도 잊지 마세요.
+
+

lib/scenarios/Hotpatch/locale/lt/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Tai Factorio laisvas žaidimas. Jūsų užduotis - paleisti raketą į kosmosą. Tam reikia pastatyti Raketos šachtą ir paleisti raketą su palydovu. Reikės atrasti pažangias technologijas kad atrakintumėte Raketos šachtą. Pradėkite palengva, tobulinkite automatiką ir neužmirškite apsisaugoti nuo vietinių.
+
+

lib/scenarios/Hotpatch/locale/lv/freeplay.cfg

@@ -0,0 +1,2 @@
+msg-intro=Šis ir Factorio brīvais režīms. Tavs uzdevums ir palaist raķeti kosmosā. Lai to izdarītu, tev vajadzēs uzbūvēt palaišanas platformu un palaist raķeti ar satelītu. Tev būs jāizpēta sarežģītas tehnoloģijas, lai atbloķētu palaišanas platformu. Sāc no mazumiņa, strādā un neaizmirsti pasargāt sevi no šīs planētas iemītniekiem...
+

lib/scenarios/Hotpatch/locale/nl/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Dit is Factorio vrij spel. Je taak is om een raket te lanceren in de ruimte. Bouw hiervoor een raket-silo en lanceer een raket met een satelliet. Je zult geavanceerde technologieën moeten onderzoeken om de raket-silo vrij te spelen. Begin op kleine schaal, breidt uit en automatiseer je fabriek en vergeet niet jezelf te beschermen tegen de inheemse bewoners.
+
+

lib/scenarios/Hotpatch/locale/no/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Dette er Factorio frispilling. Din oppgave er å sende en rakett til verdensrommet. Bygg en rakettsilo og send opp en rakett med en satellitt. Du blir nødt til å utforske avanserte teknologier for å få tilgang til rakettsiloen. Begynn i det små, jobb deg oppover med hjelp av automatisering, men ikke glem å beskytte deg mot de innfødte.
+
+

lib/scenarios/Hotpatch/locale/pl/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=To jest swobodna rozgrywka Factorio. Twoim zadaniem jest wysłanie rakiety w kosmos. Skonstruuj silos rakietowy i wystrzel z niego rakietę z satelitą. Żeby odblokować silos rakietowy będziesz musiał odkryć zaawansowane technologie. Rozpocznij od podstaw, rozwijaj się wykorzystując automatyzację i nie zapomnij o obronie przed rodzimymi mieszkańcami planety.
+
+

lib/scenarios/Hotpatch/locale/pt-BR/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Este é o modo livre do Factorio. Sua missão é lançar um foguete no espaço. Para fazer isso construa um centro de lançamento de foguetes e lance o foguete com um satélite. Você vai precisar pesquisar tecnologias avançadas para conseguir desbloquear um Centro de lançamento. Comece do começo, continue na automação e não se esqueça de se proteger dos nativos.
+
+

lib/scenarios/Hotpatch/locale/pt-PT/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Este é o jogo livre Factorio. A tua tarefa é lançar um foguetão para explorar o espaço. Faça isto, construindo um Silo de Foguetão e lançar um foguetão com um satélite. Tu vais precisar de pesquisar tecnologias avançadas para poderes desbloquear o Silo de Foguetão. Começa simples, trabalha e evolui com a automação e não te esqueças de proteger-te dos nativos.
+
+

lib/scenarios/Hotpatch/locale/ro/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Acesta este modul Factorio freeplay. Sarcina ta este de a lansa o rachetă în spațiu. Fă acest lucru prin construirea unui siloz de rachete și lansarea unei rachete cu satelit. Va trebui să cercetezi tehnologiile avansate pentru a debloca silozul de rachete. Începe încet, avansează cu automatizarea și nu uita să te protejezi de inamici.
+
+

lib/scenarios/Hotpatch/locale/ru/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Это режим свободной игры Factorio. Ваша задача запустить спутник в космос. Для его запуска потребуется создать ракету и ракетную шахту. Начните с малого, работайте над автоматизацией производства, исследуйте новые технологии и не забывайте о защите от местных форм жизни.
+
+

lib/scenarios/Hotpatch/locale/sk/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Toto je voľná hra Factorio. Tvojou úlohou je vypustiť raketu do vesmíru. Postav raketové silo a vypusti raketu so satelitom. Pre odomknutie raketového sila budeš musieť vyskúmať pokročilé technológie. Začni v malom, postupuj s automatizáciou a nezabnudni sa chrániť pred domácimi.
+
+

lib/scenarios/Hotpatch/locale/sl/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=To je Factorio freeplay. Vaša naloga je poslati raketo v vesolje. To storite tako, da zgradite silos za raketo in jo skupaj s satelitom izstrelite v vesolje. Raziskati bo potrebno napredne tehnologije, da bi lahko odklenili Raketni silos. Začnete z majhnim, nato nadgradite vse s pomočjo avtomatizacije in ne pozabite, zaščitite se pred domorodci.
+
+

lib/scenarios/Hotpatch/locale/sr/freeplay.cfg

@@ -0,0 +1,2 @@
+msg-intro=Ово је Factorio freeplay. Твој задатак је да лансираш ракету са сателитом у свемир. Уради ово грађом ракетног силоса. Треба да истражиш пуно напредних технологија да би откључао ракетни силос. Почни мало, а онда напредуј са аутоматизацијом и не заборави да се заштитиш од ванземаљаца.
+

lib/scenarios/Hotpatch/locale/sv-SE/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Det här är Factorio frispel. Ditt uppdrag är att avfyra en raket ut i rymden. Gör det genom att tillverka en raket silo och avfyra en raket med en satellit. Du kommer att behöva forska fram avancerade teknologier för att kunna låsa upp raket silon. Börja smått, jobba dig uppåt med hjälp av automatisering och glöm inte att försvara dig själv mot infödingarna.
+
+

lib/scenarios/Hotpatch/locale/th/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=นี้คือโหมดอิสระของ Factorio ภารกิจของคุณคือส่งจรวดสู่อวกาศ ซึ่งทำได้โดยการสร้างไซโลจรวดและส่งจรวดขึ้นไปพร้อมกับดาวเทียม คุณต้องวิจัยค้นคว้าเทคโนโลยีขั้นสูงเพื่อปลดล็อคไซโลจรวด เริ่มจากเล็กๆไปเรื่อยๆด้วยระบบอัตโนมัติและอย่าลืมป้องกันตัวเองจากคนพื้นเมืองด้วย
+
+

lib/scenarios/Hotpatch/locale/tr/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Bu Factorio'nun serbest oynanışı. Görevin roketleri uzaya yollamak. Bunu Roket Silosu yaparak ve uyduyla roket yollayarak yapacaksın. Roket Silo'sunu açmak için gelişmiş teknolojileri sırayla açmalısın. Yavaş başla, otomatikleş ve yerlilerden kendini korumayı untuma.
+
+

lib/scenarios/Hotpatch/locale/uk/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Це один з типів гри в Factorio - "Вільна гра". Ваше завдання - запустити ракету у космічний простір. Зробіть це, побудувавши ракетну шахту та запустивши ракету зі супутником. Вам потрібно дослідити передові технології, щоб мати змогу побудувати ракетну шахту. Починайте з малого, розвивайтеся за допомогою автоматизації, але не забувайте і про оборону!
+
+

lib/scenarios/Hotpatch/locale/vi/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=Đầy là chế độ freeplay của Factorio. Nhiệm cụ của bạn là phóng một chiếc tên lửa lên vũ trụ. Hãy xây dựng một bệ phóng tên lửa để phóng một chiếc tên lửa kèm theo vệ tinh. Bạn sẽ cần phải nghiên cứu nhiều công nghệ tiên tiến để có thể xây dựng bệ phóng tên lửa. Bắt đầu từ quy mô nhỏ, phát triển dần dần bằng tự động hóa, và đừng quên bảo vệ bản thân mình khỏi những sinh vật sinh sống ở đây.
+
+

lib/scenarios/Hotpatch/locale/zh-CN/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=欢迎来到异星工厂标准模式，你的目标是要把火箭发射到太空。为此你需要研发一系列高等科技，解锁并修建火箭发射井，直到把携带有卫星的火箭发射出去。从小作坊生产起步，逐渐建立起属于自己的自动化大工厂吧！同时，别忘了防范异星虫子的骚扰 ...
+
+

lib/scenarios/Hotpatch/locale/zh-TW/freeplay.cfg

@@ -0,0 +1,3 @@
+msg-intro=這是異星工廠的自由模式。你的任務是發射火箭，探索外太空。請建造一個火箭發射井，並發射攜帶著衛星的火箭。你會需要研究大量的進階科技以解鎖火箭發射井。從頭開始，靠著自動化科技的協助向目標邁進時，也別忘記從外星住民手的中保護你自己啊！
+
+

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

node_modules/_app/clusterTools/checkHotpatchInstallation.js

@@ -0,0 +1,9 @@
+module.exports = async function checkHotpatchInstallation(messageInterface){
+	let yn = await messageInterface("/silent-command if remote.interfaces['hotpatch'] then rcon.print('true') else rcon.print('false') end");
+	yn = yn.replace(/(\r\n\t|\n|\r\t)/gm, "");
+	if(yn == "true"){
+		return true;
+	} else if(yn == "false"){
+		return false;
+	}
+}

node_modules/_app/clusterTools/getCommand.js

@@ -0,0 +1,16 @@
+const fs = require("fs-extra");
+
+const getLua = require("./getLua.js");
+
+let commandCache;
+module.exports = async function getCommand(file, COMPRESS = true){
+	commandCache = commandCache || {};
+	if(!commandCache[file]){
+		commandCache[file] = await getLua(file);
+		return commandCache[file];
+	} else if(typeof commandCache[file] == "string"){
+		return commandCache[file];
+	} else {
+		throw new Error("Command not found");
+	}
+}

node_modules/_app/clusterTools/getInstanceName.js

@@ -0,0 +1,40 @@
+const needle = require("needle");
+
+module.exports = function(config){
+	const instances = [];
+	
+	if(config){
+		return function getInstanceName(instanceID){
+			return new Promise((resolve, reject) => {
+				let instance = instances[instanceID];
+				if(!instance){
+					needle.get(config.masterIP+":"+config.masterPort+ '/api/slaves', (err, response) => {
+						if(err || response.statusCode != 200) {
+							console.log("Unable to get JSON master/api/slaves, master might be unaccessible");
+						} else if (response && response.body) {	
+							if(Buffer.isBuffer(response.body)) {console.log(response.body.toString("utf-8")); reject(new Error())}
+								try {
+									for (let index in response.body)
+										instances[index] = response.body[index].instanceName;
+								} catch (e){
+									console.log(e);
+									return null;
+								}
+							instance = instances[instanceID] 							
+							if (!instance) instance = instanceID;  //somehow the master doesn't know the instance	
+							resolve(instance);
+						}
+					});
+				} else {
+					resolve(instance);
+				}
+			});
+		}
+	} else {
+		return async function thisAintGonnaWork(){
+			let err = new Error("getInstanceName from _app/clusterTools needs to be called with {config} to work");
+			console.log(err);
+			throw err;
+		}
+	}
+}

node_modules/_app/clusterTools/getLua.js

@@ -0,0 +1,40 @@
+const fs = require("fs-extra");
+
+module.exports = function getLua(filePath, COMPRESS_LUA = true){
+	return new Promise((resolve, reject) => {
+		fs.readFile(filePath, "utf8", (err, contents) => {
+			if(err){
+				reject(err);
+			} else {
+				// split content into lines
+				contents = contents.split(/\r?\n/);
+
+				// join those lines after making them safe again
+				contents = contents.reduce((acc, val) => {
+					val = val.replace(/\\/g ,'\\\\');
+					// remove leading and trailing spaces
+					val = val.trim();
+					// escape single quotes
+					val = val.replace(/'/g ,'\\\'');
+
+					// remove single line comments
+					let singleLineCommentPosition = val.indexOf("--");
+					let multiLineCommentPosition = val.indexOf("--[[");
+
+					if(multiLineCommentPosition === -1 && singleLineCommentPosition !== -1) {
+						val = val.substr(0, singleLineCommentPosition);
+					}
+
+					return acc + val + '\\n';
+				}, ""); // need the "" or it will not process the first row, potentially leaving a single line comment in that disables the whole code
+
+				// console.log(contents);
+
+				// this takes about 46 ms to minify train_stop_tracking.lua in my tests on an i3 6100u
+				if(COMPRESS_LUA) contents = require("luamin").minify(contents);
+				
+				resolve(contents);
+			}
+		});
+	});
+}

node_modules/_app/clusterTools/index.js

@@ -0,0 +1,41 @@
+/**
+
+Functions frequently needed from different places in the cluster. Ex:
+  * Loading Lua scripts
+  * Checking if hotpatch is installed
+  * Getting an instance's displayname from their ID
+
+*/
+
+module.exports = ({config} = {}) => ({
+	/**
+		async function to get Lua from a file, remove comments, minify and return.
+		
+		arg1 is the file path
+		arg2 is whether or not to compress the Lua. Makes debugging harder, but reduces bandwidth when many players are online. Recommended for polling commands. Defaults to true.
+		Promise resolves with a string of Lua.
+	*/
+	getLua: require("./getLua.js"),
+	/**
+		async function to check whether hotpatch is installed in a server.
+		
+		First argument is the servers async messageInterface for rcon return values
+		Promise resolves with boolean.
+	*/
+	checkHotpatchInstallation: require("./checkHotpatchInstallation.js"),
+	/**
+		async function to get an instances displayname from their instanceID
+		
+		arg1 is the instanceID
+		Promise resolves with a string, either the displayName or instanceID if not found.
+	*/
+	getInstanceName: require("./getInstanceName.js")(config),
+	/**
+		async function same as getLua, but using an in memory cache to lower FS operations.
+		
+		arg1 is the file path
+		arg2 is whether or not to compress, default true
+		Promise resolves with a string of Lua.
+	*/
+	getCommand: require("./getCommand.js"),
+})

package.json

@@ -10,7 +10,10 @@
     "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"
+    "install": "node lib/npmPostinstall.js",
+    "bundle-dependencies": "bundle-dependencies",
+    "snyk-protect": "snyk protect",
+    "prepublish": "npm run snyk-protect"
   },
   "keywords": [
     "factorio"
@@ -21,40 +24,52 @@
     "app-root-path": "^2.0.1",
     "as-table": "^1.0.31",
     "averaged-timeseries": "^1.4.0",
+    "base64url": "^3.0.0",
+    "bcrypt": "^2.0.1",
+    "bcrypt-promise": "^2.0.0",
     "bcryptjs": "^2.4.3",
     "body-parser": "^1.18.2",
-    "codecov": "^2.3.1",
+    "cache-require-paths": "^0.3.0",
+    "cli": "^1.0.1",
+    "cli-interact": "^0.1.9",
+    "codecov": "^3.0.1",
+    "compression": "^1.7.2",
+    "cookie-parser": "^1.4.3",
     "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",
+    "express-prometheus-request-metrics": "github:burnash/express-prometheus-request-metrics",
+    "follow-redirects": "^1.5.0",
+    "fs-extra": "^6.0.1",
     "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",
+    "minimist": "^1.2.0",
     "mkdirp": "^0.5.1",
     "mkdirp-promise": "^5.0.1",
-    "moment": "^2.20.1",
+    "moment": "^2.22.2",
     "ncp": "^2.0.0",
-    "nedb": "^1.8.0",
-    "needle": "^1.1.0",
+    "needle": "^2.2.4",
     "node-factorio-api": "^0.3.1-alpha",
     "node-forge": "^0.7.1",
     "prom-client": "^10.2.3",
+    "rcon-client": "git+https://gitlab.com/Hornwitser/rcon-client.git",
     "request": "^2.83.0",
     "right-pad": "^1.0.1",
     "rmdir-sync": "^1.0.1",
-    "simple-rcon": "^0.3.1",
+    "sanitizer": "^0.1.3",
+    "simple-git": "^1.96.0",
     "single-line-log": "^1.1.2",
+    "snyk": "^1.134.2",
     "socket.io": "^2.0.4",
     "socket.io-client": "^2.0.4",
+    "socket.io-prometheus": "^0.2.1",
     "sync-request": "^4.0.1",
+    "typescript-collections": "^1.3.2",
     "underscore": "^1.8.3"
   },
   "devDependencies": {
@@ -66,5 +81,6 @@
     "nock": "^9.1.6",
     "sinon": "^2.4.1",
     "supertest": "^3.0.0"
-  }
+  },
+  "snyk": true
 }

routes/api/getPictures.js

@@ -0,0 +1,16 @@
+const fs = require("fs-extra")
+const path = require("path")
+
+module.exports = function(app){
+	app.get("/api/getPictures", async (req, res) => {
+		let pictures = (await fs.readdir(path.join(__dirname, `../../static/pictures`)))
+		.filter(path => path.includes(".png"))
+		.map(name => ({
+			name: name.replace(".png",""),
+			path: `/pictures/${name}`
+		}))
+		
+		
+		res.send(pictures)
+	})
+}

routes/api/remove.js

@@ -0,0 +1,183 @@
+const averagedTimeSeries = require("averaged-timeseries")
+
+const doleNN = require("./../../lib/dole_nn_base.js")
+
+const Prometheus = require('prom-client');
+
+class neuralDole {
+    
+    getRequestStats(itemname,samples)
+    {
+        var sum=0;
+        samples=Math.min(samples,(this.stats[itemname] || []).length-1);
+        if (samples<1) return 0.1;
+        for (var i = 1; i <= samples; i++) {
+            sum+=this.stats[itemname][i].req;
+        }
+        if (sum==0) return 0.1;
+        return sum/samples;
+    }
+    
+    constructor({
+        items, gaugePrefix
+    }){
+        // Set some storage variables for the dole divider
+        this.prometheusNNDoleGauge = new Prometheus.Gauge({
+            name: gaugePrefix+'nn_dole_gauge',
+            help: 'Current demand being supplied by Neural Network ; 1 means all demand covered, 0.5 means about half of each supply is covered, 0 means no items are given',
+            labelNames: ["itemName"],
+        });
+        this.items = items
+        this.itemsLastTick = JSON.parse(JSON.stringify(items))
+        this.dole = {}
+        this.carry = {}
+        this.lastRequest = {}
+        this.stats=[]
+		this.debt= {}
+
+        setInterval(()=>{
+            for(let name in this.items){
+                // The items object have 2 functions tied to it - addItem and removeItem. A for loop will reveal those properties.
+                if(typeof this.items[name] !== "number") continue
+
+                let count = this.items[name]
+                let magicData = doleNN.Tick(
+                    count,
+                    this.dole[name],
+                    this.itemsLastTick[name],
+                    this.getRequestStats(name,5)
+                )
+                this.stats[name]=this.stats[name] || []
+                this.stats[name].unshift({req:0,given:0});//stats[name][0] is the one we currently collect
+                if (this.stats[name].length>10) this.stats[name].pop();//remove if too many samples in stats
+                
+                this.dole[name] = magicData[0]
+                // DONE handle magicData[1] for graphing for our users
+                this.prometheusNNDoleGauge.labels(name).set(magicData[1] || 0);
+            }
+            this.itemsLastTick = JSON.parse(JSON.stringify(this.items))
+        }, 1000)
+    }
+    divider({
+        res,
+        object,
+        config,
+        sentItemStatisticsBySlaveID,
+        prometheusImportGauge
+    }){
+        let magicData = doleNN.Dose(
+            object.count, // numReq
+            this.items[object.name],
+            this.itemsLastTick[object.name] || 0,
+            this.dole[object.name],
+            this.carry[object.name+" "+object.instanceID] || 0,
+            this.lastRequest[object.name+"_"+object.instanceID+"_"+object.instanceName] || 0,
+            this.getRequestStats(object.name,5),
+			this.debt[object.name+" "+object.instanceID] || 0
+        )
+        if ((this.stats[object.name] || []).length>0)
+        {
+            this.stats[object.name][0].req+=Number(object.count);
+            this.stats[object.name][0].given+=Number(magicData[0]);
+        }
+        this.lastRequest[object.name+"_"+object.instanceID+"_"+object.instanceName] = object.count
+        //0.Number of items to give in that dose
+        //1.New dole for item X
+        //2.New carry for item X slave Y
+        this.dole[object.name] = magicData[1]
+        this.carry[object.name+" "+object.instanceID] = magicData[2]
+		this.debt[object.name+" "+object.instanceID] = magicData[3]
+        
+        // Remove item from DB and send it
+        if(this.items.removeItem({count: magicData[0], name: object.name})){
+            if(config.logItemTransfers){
+                console.log("removed: " + object.name + " " + magicData[0] + " . " + this.items[object.name] + " and sent to " + object.instanceID + " | " + object.instanceName);
+            }
+            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:magicData[0],
+            });
+            //console.log(sentItemStatistics.data)
+            sentItemStatisticsBySlaveID[object.instanceID] = sentItemStatistics;
+            prometheusImportGauge.labels(object.instanceID, object.name).inc(Number(magicData[0]) || 0);
+
+            res.send({
+                name: object.name,
+                count: magicData[0],
+            })
+        } else {
+            res.send({
+                name: object.name,
+                count: 0,
+            })
+        }        
+    }
+}
+
+_doleDivisionFactor = {}; //If the server regularly can't fulfill requests, this number grows until it can. Then it slowly shrinks back down.
+function doleDivider({
+    item,
+    object,
+    db,
+    sentItemStatisticsBySlaveID,
+    config,
+    prometheusDoleFactorGauge,
+    prometheusImportGauge,
+    req,res,
+}){
+    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
+    
+    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;
+        }
+        
+        prometheusDoleFactorGauge.labels(object.name).set(_doleDivisionFactor[object.name] || 0);
+        prometheusImportGauge.labels(object.instanceID, object.name).inc(Number(object.count) || 0);
+        res.send({count: object.count, name: object.name});
+    } 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);
+        prometheusDoleFactorGauge.labels(object.name).set(_doleDivisionFactor[object.name] || 0);
+        res.send({name:object.name, count:0});
+        //console.log('failure out of ' + object.name + " | " + object.count + " from " + object.instanceID + " ("+object.instanceName+")");
+    }
+}
+
+module.exports = {
+    doleDivider,
+    neuralDole
+}

scenarios/doomsday/control.lua

@@ -0,0 +1,149 @@
+--[[
+HUGE SHOUTOUT TO HORNWITSER FOR WRITING THIS SEXY AS MODLOADER <3 
+and for not getting mad when i coppyed it :)
+]]
+
+local modules = {
+    require("pdnc"),
+    require("doomsday"),
+    require("gui"),
+}
+
+script.on_init(function()
+    for i,mod in ipairs(modules) do
+        if mod.on_init then
+            mod.on_init()
+        end
+    end
+end)
+
+script.on_load(function()
+    for i,mod in ipairs(modules) do
+        if mod.on_load then
+            mod.on_load()
+        end
+    end
+end)
+
+script.on_configuration_changed(function(data)
+    for i,mod in ipairs(modules) do
+        if mod.on_configuration_changed then
+            mod.on_configuration_changed(data)
+        end
+    end
+end)
+
+local function register_tick_handlers()
+    local ticks = {}
+    for i,mod in ipairs(modules) do
+        print(mod.on_nth_ticks)
+        if mod.on_nth_ticks then
+            mod_ticks = mod.on_nth_ticks
+            for t,f in pairs(mod_ticks) do
+                if not ticks[t] then
+                    ticks[t] = {}
+                end
+                
+                table.insert(ticks[t], f)
+            end
+        end
+    end
+    
+    for t,fs in pairs(ticks) do
+        script.on_nth_tick(t, function(event_data)
+            for i,f in ipairs(fs) do
+                f(event_data)
+            end
+        end)
+    end
+end
+register_tick_handlers()
+
+local function register_events()
+    local events = {}
+    for i,mod in ipairs(modules) do
+        if mod.get_events then
+            mod_events = mod.get_events()
+            for e,f in pairs(mod_events) do
+                if not events[e] then
+                    events[e] = {}
+                end
+                
+                table.insert(events[e], f)
+            end
+        end
+    end
+
+    for e,fs in pairs(events) do
+        script.on_event(e, function(event_data)
+            for i,f in ipairs(fs) do
+                f(event_data)
+            end
+        end)
+    end
+end
+register_events()
+
+for i,mod in ipairs(modules) do
+    if mod.add_remote_interfaces then
+        mod.add_remote_interfaces()
+    end
+end
+
+for i,mod in ipairs(modules) do
+    if mod.add_commands then
+        mod.add_commands()
+    end
+end
+
+
+--[[
+
+-- This is a example of what to put at the end of your code, ie doomsday.lua
+-- replace all the EXAMPLE 's with any name you want, they have to be all the same
+-- replace tick with number if ticks and function with the function name to call
+-- everywhere there is a blank space is where you put stuff in
+
+
+
+local EXAMPLE_init = {}
+
+local script_events = {
+	--place the here what you would normaly use Event.register for
+	-- Event.register(defines.events.on_player_created, testfunction)
+	-- is the same as 
+	-- [defines.events.on_player_created] = testfunction,
+	-- where testfunction is | local function testfunction() { }
+	--[Event] = function, 
+	--put stuff here
+ 
+}
+
+EXAMPLE_init.on_nth_ticks = {
+	--place the here what you would normaly use 
+    --[tick] = function,
+    --put stuff here
+
+}
+
+EXAMPLE_init.on_init = function() -- this runs when Event.core_events.init
+    log("EXAMPLE init")
+	--put stuff here
+
+    global.EXAMPLE_data = global.EXAMPLE_data or script_data  -- NO TOUCHY
+
+end
+
+EXAMPLE_init.on_load = function() -- this runs when Event.core_events.load
+    log("EXAMPLE load")
+	--put stuff here
+
+    script_data = global.EXAMPLE_data or script_data  -- NO TOUCHY
+end
+
+EXAMPLE_init.get_events = function()
+    return script_events
+end
+
+return EXAMPLE_init
+]]