From 86f77f0103809aee894c06de200cbb6cd49c5629 Mon Sep 17 00:00:00 2001 From: SeaswimmerTheFsh Date: Sun, 13 Aug 2023 16:30:36 -0400 Subject: [PATCH] added a readme --- Infern's Factorio Server/README.md | 35 ++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 Infern's Factorio Server/README.md diff --git a/Infern's Factorio Server/README.md b/Infern's Factorio Server/README.md new file mode 100644 index 0000000..fa7601d --- /dev/null +++ b/Infern's Factorio Server/README.md @@ -0,0 +1,35 @@ +# Infern009's Factorio Server + +[Discord Message Link (Galaxy Discord - #general-discussion)](https://discord.com/channels/204965774618656769/753714180900519937/1140330697446412428) +[Discord Message Link (seaswimmer (294518358420750336) & infern009 (420197112068964353) - Direct Messages)](https://discord.com/channels/@me/624776394676633663/1140332152530149447) + +These two `.sh` files were created for Infern009's Factorio Server, and use [Byobu](https://www.byobu.org/) to run a Factorio server. + +## Usage + +- First, make sure you have `Byobu` installed. + - Alpine + - `sudo apk add -y byobu` + - Arch + - `sudo pacman -Sy byobu` + - CentOS/RHEL + - `sudo yum install -y byobu` + - Debian/Mint/Ubuntu + - `sudo apt-get install -y byobu` + - Gentoo + - `sudo emerge -y byobu` + - MacOS **__(UNSUPPORTED)__** + - `sudo brew install byobu` +- Download the two shell scripts to an empty directory of your choice. +- Run the `start_server.sh` script. +- Once the server is online, stop it with `/quit` from the Factorio server's console or by running the `stop_server.sh` script. +- Modify the parameters in `start_server.sh`. + - `save_name` - This parameter controls the name of the save file this script will use to start the server. + - If you have modified any default config files except for the `config.ini`, you'll want to change the commands' parameters to match those files. I'll assume you're storing them in the `./data` directory. You can find more arguments on the [Factorio Wiki](https://wiki.factorio.com/Command_line_parameters). + - `extra_params_create=""` - This parameter adds additional flags to the `--create` command the script runs if a save matching `save_name` is not found. + - `--map-gen-settings ./data/map-gen-settings.json` + - `--map-settings ./data/map-settings.json` + - `extra_params_start_server=""` - This parameter adds additional flags to the `-server-start` command. + - `--server-settings ./data/server-settings.json` +- Run the `start_server.sh` script. + - To stop the server, either run the `stop_server.sh` script from a terminal or type `/quit` into the Factorio server's console. \ No newline at end of file