Change DLC_SPACE_AGE to enable specific Space Age mods (#530)

* Change variable DLC_SPACE_AGE to allow listing specific Space Age mods to enable

* Adjust DLC_SPACE_AGE note

Co-authored-by: Florian Kinder <florian.kinder@fankserver.com>

---------

Co-authored-by: Florian Kinder <florian.kinder@fankserver.com>

.github/workflows/docker-build.yml

@@ -4,9 +4,10 @@ on:
   push:
     branches:
       - master
-    tags:
+    paths:
-      - latest
+      - buildinfo.json
-  pull_request:
+  # workaround for #526
+  workflow_dispatch:
 
 jobs:
   build:

.github/workflows/docker-description.yml

@@ -4,6 +4,10 @@ on:
   push:
     branches:
       - master
+    paths:
+      - README.md
+  # workaround for #526
+  workflow_dispatch:
 
 jobs:
   docker-description:

README.md

@@ -6,8 +6,8 @@
 [中文](./README_zh_CN.md)
 
 <!-- start autogeneration tags -->
-* `2`, `2.0`, `2.0.8`, `latest`, `stable`, `stable-2.0.8`
+* `2`, `2.0`, `2.0.9`, `stable`, `stable-2.0.9`
-* `2`, `2.0`, `2.0.7`, `stable`, `stable-2.0.7`
+* `2.0.10`, `latest`
 * `1`, `1.1`, `1.1.110`, `stable-1.1.110`
 * `1.0`, `1.0.0`
 * `0.17`, `0.17.79`
@@ -261,18 +261,20 @@ The `server-settings.json` file may then contain the variable references like th
 
 These are the environment variables which can be specified at container run time.
 
-| Variable Name | Description | Default | Available in |
+| Variable Name        | Description                                                          | Default        | Available in |
-| - | - | - | - |
+|----------------------|----------------------------------------------------------------------|----------------|--------------|
-| GENERATE_NEW_SAVE | Generate a new save if one does not exist before starting the server  | false | 0.17+ |
+| GENERATE_NEW_SAVE    | Generate a new save if one does not exist before starting the server | false          | 0.17+        |
-| LOAD_LATEST_SAVE | Load latest when true. Otherwise load SAVE_NAME | true | 0.17+ |
+| LOAD_LATEST_SAVE     | Load latest when true. Otherwise load SAVE_NAME                      | true           | 0.17+        |
-| PORT | UDP port the server listens on | 34197 | 0.15+ |
+| PORT                 | UDP port the server listens on                                       | 34197          | 0.15+        |
-| BIND | IP address (v4 or v6) the server listens on (IP\[:PORT]) | | 0.15+ |
+| BIND                 | IP address (v4 or v6) the server listens on (IP\[:PORT])             |                | 0.15+        |
-| RCON_PORT | TCP port the rcon server listens on | 27015 | 0.15+ |
+| RCON_PORT            | TCP port the rcon server listens on                                  | 27015          | 0.15+        |
-| SAVE_NAME | Name to use for the save file | _autosave1 | 0.17+ |
+| SAVE_NAME            | Name to use for the save file                                        | _autosave1     | 0.17+        |
-| TOKEN | factorio.com token | | 0.17+ |
+| TOKEN                | factorio.com token                                                   |                | 0.17+        |
-| UPDATE_MODS_ON_START | If mods should be updated before starting the server | | 0.17+ |
+| UPDATE_MODS_ON_START | If mods should be updated before starting the server                 |                | 0.17+        |
-| USERNAME | factorio.com username | | 0.17+ | |
+| USERNAME             | factorio.com username                                                |                | 0.17+        |
-| CONSOLE_LOG_LOCATION | Saves the console log to the specifies location | |
+| CONSOLE_LOG_LOCATION | Saves the console log to the specifies location                      |                |              |
+| DLC_SPACE_AGE        | Enables or disables the mods for DLC Space Age in mod-list.json[^1]  | true           | 2.0.8+       |
+| MODS                 | Mod directory to use                                                 | /factorio/mods | 2.0.8+       |
 
 **Note:** All environment variables are compared as strings
 
@@ -430,3 +432,8 @@ Use the `PORT` environment variable to start the server on the a different port,
 * [bplein](https://github.com/bplein/docker_factorio_server) - Coded scenario support
 * [jaredledvina](https://github.com/jaredledvina/docker_factorio_server) - Contributed version updates
 * [carlbennett](https://github.com/carlbennett) - Contributed version updates and bugfixes
+
+[^1]: Space Age mods can also be individually enabled by using their name separated by space.  
+  Example 1: Enable all by using `true`
+  Example 2: Enable all by listing the mod names `space-age elevated-rails quality`  
+  Example 3: Enable only Elevated rails `elevated-rails`

buildinfo.json

@@ -57,15 +57,21 @@
       "1.1.110"
     ]
   },
-  "2.0.8": {
+  "2.0.9": {
-    "sha256": "d9594c4d552a3e4f965b188a4774da8c8b010fc23ddb0efc63b1d94818dde1ca",
+    "sha256": "f499077b3e2c1313452c350f1faf17db31cae2a0fa738f69166e97c3caa3c86d",
     "tags": [
-      "latest",
       "stable",
-      "stable-2.0.8",
+      "stable-2.0.9",
       "2",
       "2.0",
-      "2.0.8"
+      "2.0.9"
+    ]
+  },
+  "2.0.10": {
+    "sha256": "2d7dd212fa6f715218a5e33bad7d593af8998fa7bf7ce727343159ee1f8c23f4",
+    "tags": [
+      "latest",
+      "2.0.10"
     ]
   }
 }

docker/Dockerfile

@@ -28,7 +28,8 @@ ENV PORT=34197 \
     SCENARIOS=/factorio/scenarios \
     SCRIPTOUTPUT=/factorio/script-output \
     PUID="$PUID" \
-    PGID="$PGID"
+    PGID="$PGID" \
+    DLC_SPACE_AGE="true"
 
 SHELL ["/bin/bash", "-eo", "pipefail", "-c"]
 

docker/docker-compose.yml

@@ -6,8 +6,8 @@ services:
       args:
         # Check buildinfo.json for supported versions and SHAs
         # https://github.com/factoriotools/factorio-docker/blob/master/buildinfo.json
-        - VERSION=2.0.8
+        - VERSION=2.0.9
-        - SHA256=d9594c4d552a3e4f965b188a4774da8c8b010fc23ddb0efc63b1d94818dde1ca
+        - SHA256=f499077b3e2c1313452c350f1faf17db31cae2a0fa738f69166e97c3caa3c86d
     ports:
       - "34197:34197/udp"
       - "27015:27015/tcp"

docker/files/docker-dlc.sh

@@ -0,0 +1,57 @@
+#!/bin/bash
+set -eou pipefail
+
+# Path to the mod-list.json file
+MOD_LIST_FILE="$MODS/mod-list.json"
+
+ALL_SPACE_AGE_MODS=("elevated-rails" "quality" "space-age")
+
+if [[ ! -f "$MOD_LIST_FILE" ]]; then
+  # Create the mod-list.json file if it doesn't exist
+  echo '{"mods":[{"name":"base","enabled":true}]}' > "$MOD_LIST_FILE"
+fi
+
+enable_mod()
+{
+  echo "Enable mod $1 for DLC"
+  jq --arg mod_name "$1" 'if .mods | map(.name) | index($mod_name) then .mods |= map(if .name == $mod_name and .enabled == false then .enabled = true else . end) else . end' "$MOD_LIST_FILE" > "$MOD_LIST_FILE.tmp"
+  mv "$MOD_LIST_FILE.tmp" "$MOD_LIST_FILE"
+}
+
+disable_mod()
+{
+  echo "Disable mod $1 for DLC"
+  jq --arg mod_name "$1" 'if .mods | map(.name) | index($mod_name) then .mods |= map(if .name == $mod_name and .enabled == true then .enabled = false else . end) else .mods += [{"name": $mod_name, "enabled": false}] end' "$MOD_LIST_FILE" > "$MOD_LIST_FILE.tmp"
+  mv "$MOD_LIST_FILE.tmp" "$MOD_LIST_FILE"
+}
+
+# Enable or disable DLCs if configured
+if [[ ${DLC_SPACE_AGE:-} == "true" ]]; then
+  # Define the DLC mods
+  ENABLE_MODS=(${ALL_SPACE_AGE_MODS[@]})
+elif [[ ${DLC_SPACE_AGE:-} == "false" ]]; then
+  # Define the DLC mods
+  DISABLE_MODS=(${ALL_SPACE_AGE_MODS[@]})
+else
+  ENABLE_MODS=()
+  DISABLE_MODS=()
+
+  for SPACE_AGE_MOD in "${ALL_SPACE_AGE_MODS[@]}"; do
+    REGEX="(^|\s)$SPACE_AGE_MOD($|\s)"
+    if [[ "$DLC_SPACE_AGE" =~ $REGEX ]]; then
+      ENABLE_MODS+=($SPACE_AGE_MOD)
+    else
+      DISABLE_MODS+=($SPACE_AGE_MOD)
+    fi
+  done
+fi
+
+# Iterate over each DLC mod to enable
+for MOD in "${ENABLE_MODS[@]}"; do
+  enable_mod "$MOD"
+done
+
+# Iterate over each DLC mod to disable
+for MOD in "${DISABLE_MODS[@]}"; do
+  disable_mod "$MOD"
+done

docker/files/docker-entrypoint.sh

@@ -43,8 +43,10 @@ if [[ ${UPDATE_MODS_ON_START:-} == "true" ]]; then
   ./docker-update-mods.sh
 fi
 
+./docker-dlc.sh
+
 EXEC=""
-if [[ $(id -u) = 0 ]]; then
+if [[ $(id -u) == 0 ]]; then
   # Update the User and Group ID based on the PUID/PGID variables
   usermod -o -u "$PUID" factorio
   groupmod -o -g "$PGID" factorio
@@ -100,6 +102,7 @@ FLAGS=(\
   --server-adminlist "$CONFIG/server-adminlist.json" \
   --rcon-password "$(cat "$CONFIG/rconpw")" \
   --server-id /factorio/config/server-id.json \
+  --mod-directory "$MODS" \
 )
 
 if [ -n "$CONSOLE_LOG_LOCATION" ]; then

docker/files/update-mods.sh

@@ -28,7 +28,7 @@ update_mod()
   MOD_NAME="$1"
   MOD_NAME_ENCODED="${1// /%20}"
 
-  print_step "Checking for update of mod $MOD_NAME..."
+  print_step "Checking for update of mod $MOD_NAME for factorio $FACTORIO_VERSION ..."
 
   MOD_INFO_URL="$MOD_BASE_URL/api/mods/$MOD_NAME_ENCODED"
   MOD_INFO_JSON=$(curl --silent "$MOD_INFO_URL")
@@ -54,7 +54,7 @@ update_mod()
     return 0
   fi
 
-  print_step "Downloading..."
+  print_step "  Downloading $MOD_FILENAME"
   FULL_URL="$MOD_BASE_URL$MOD_URL?username=$USERNAME&token=$TOKEN"
   HTTP_STATUS=$(curl --silent -L -w "%{http_code}" -o "$MOD_DIR/$MOD_FILENAME" "$FULL_URL")
 

update.sh

@@ -4,12 +4,16 @@ SEMVER_REGEX="^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)$"
 
 stable_online_version=$(curl 'https://factorio.com/api/latest-releases' | jq '.stable.headless' -r)
 experimental_online_version=$(curl 'https://factorio.com/api/latest-releases' | jq '.experimental.headless' -r)
+
 stable_sha256=$(curl "https://factorio.com/download/sha256sums/" | grep -E "(factorio_headless_x64_|factorio-headless_linux_)${stable_online_version}.tar.xz" | awk '{print $1}')
 experimental_sha256=$(curl "https://factorio.com/download/sha256sums/" | grep -E "(factorio_headless_x64_|factorio-headless_linux_)${experimental_online_version}.tar.xz" | awk '{print $1}')
-stable_current_version=$(jq 'with_entries(select(contains({value:{tags:["stable"]}}))) | keys | .[0]' buildinfo.json -r)
+
-latest_current_version=$(jq 'with_entries(select(contains({value:{tags:["latest"]}}))) | keys | .[0]' buildinfo.json -r)
+stable_current_version=$(jq 'with_entries(select(.value.tags | index("stable"))) | keys | .[0]' buildinfo.json -r)
+latest_current_version=$(jq 'with_entries(select(.value.tags | index("latest"))) | keys | .[0]' buildinfo.json -r)
+
 echo "stable_online_version=${stable_online_version} experimental_online_version=${experimental_online_version}"
 echo "stable_current_version=${stable_current_version} latest_current_version=${latest_current_version}"
+
 if [[ -z "${stable_online_version}" ]] || [[ -z "${experimental_online_version}" ]]; then
     exit
 fi
@@ -57,6 +61,11 @@ echo "stableCurrentVersionShort=${stableCurrentVersionShort} latestCurrentVersio
 
 tmpfile=$(mktemp)
 
+# Remove stable tag
+cp buildinfo.json "$tmpfile"
+jq --arg stable_current_version "$stable_current_version" 'with_entries(if .key == $stable_current_version then .value.tags |= . - ["stable"] else . end)' "$tmpfile" > buildinfo.json
+rm -f -- "$tmpfile"
+
 # Remove latest tag
 cp buildinfo.json "$tmpfile"
 jq --arg latest_current_version "$latest_current_version" 'with_entries(if .key == $latest_current_version then .value.tags |= . - ["latest"] else . end)' "$tmpfile" > buildinfo.json