Update to Factorio 0.18.0 and 0.18.1 (#303)

* Update to Factorio 0.18.0 * Update to Factorio 0.18.1
2024-12-24 01:48:23 +01:00 · 2020-01-24 04:37:42 -05:00 · 2020-01-24 04:37:42 -05:00 · a2726704ed
commit a2726704ed
parent f4e8b30e90
9 changed files with 353 additions and 2 deletions
--- a/.travis.yml
+++ b/.travis.yml
@ -17,9 +17,11 @@ jobs:

    - &build
      stage: Build & update Docker HUB description
-      env: VERSION_SHORT=0.17 EXTRA_TAG=latest STABLE=0.17.79
+      env: VERSION_SHORT=0.18 EXTRA_TAG=latest
      script:
        - ./build.sh $VERSION_SHORT
+    - <<: *build
+      env: VERSION_SHORT=0.17 EXTRA_TAG=stable
    - <<: *build
      env: VERSION_SHORT=0.16
    - <<: *build
--- a/0.18/Dockerfile
+++ b/0.18/Dockerfile
@ -0,0 +1,46 @@
+FROM frolvlad/alpine-glibc:alpine-3.9
+
+LABEL maintainer="https://github.com/factoriotools/factorio-docker"
+
+ARG USER=factorio
+ARG GROUP=factorio
+ARG PUID=845
+ARG PGID=845
+
+ENV PORT=34197 \
+    RCON_PORT=27015 \
+    VERSION=0.18.1 \
+    SHA1=a23d5a33caa99ecc19b4f937bebbed4485d7b500 \
+    SAVES=/factorio/saves \
+    CONFIG=/factorio/config \
+    MODS=/factorio/mods \
+    SCENARIOS=/factorio/scenarios \
+    SCRIPTOUTPUT=/factorio/script-output \
+    PUID="$PUID" \
+    PGID="$PGID"
+
+RUN set -ox pipefail \
+    && archive="/tmp/factorio_headless_x64_$VERSION.tar.xz" \
+    && mkdir -p /opt /factorio \
+    && apk add --update --no-cache --no-progress bash binutils curl file gettext jq libintl pwgen shadow su-exec \
+    && curl -sSL "https://www.factorio.com/get-download/$VERSION/headless/linux64" -o "$archive" \
+    && echo "$SHA1  $archive" | sha1sum -c \
+    || (sha1sum "$archive" && file "$archive" && exit 1) \
+    && tar xf "$archive" --directory /opt \
+    && chmod ugo=rwx /opt/factorio \
+    && rm "$archive" \
+    && ln -s "$SAVES" /opt/factorio/saves \
+    && ln -s "$MODS" /opt/factorio/mods \
+    && ln -s "$SCENARIOS" /opt/factorio/scenarios \
+    && ln -s "$SCRIPTOUTPUT" /opt/factorio/script-output \
+    && addgroup -g "$PGID" -S "$GROUP" \
+    && adduser -u "$PUID" -G "$GROUP" -s /bin/sh -SDH "$USER" \
+    && chown -R "$USER":"$GROUP" /opt/factorio /factorio
+
+VOLUME /factorio
+
+EXPOSE $PORT/udp $RCON_PORT/tcp
+
+COPY files/ /
+
+ENTRYPOINT ["/docker-entrypoint.sh"]
--- a/0.18/docker-compose.yml
+++ b/0.18/docker-compose.yml
@ -0,0 +1,15 @@
+version: '2'
+services:
+  factorio:
+    build: .
+    ports:
+     - "34197:34197/udp"
+     - "27015:27015/tcp"
+    volumes:
+     - /opt/factorio:/factorio
+#    environment:
+#      - PUID=1000
+#      - PGID=1000
+#      - UPDATE_MODS_ON_START=true
+#      - USERNAME=FactorioUsername
+#      - TOKEN=FactorioToken
--- a/0.18/files/docker-entrypoint.sh
+++ b/0.18/files/docker-entrypoint.sh
@ -0,0 +1,96 @@
+#!/bin/bash
+set -eoux pipefail
+
+FACTORIO_VOL=/factorio
+LOAD_LATEST_SAVE="${LOAD_LATEST_SAVE:-true}"
+GENERATE_NEW_SAVE="${GENERATE_NEW_SAVE:-false}"
+SAVE_NAME="${SAVE_NAME:-""}"
+
+mkdir -p "$FACTORIO_VOL"
+mkdir -p "$SAVES"
+mkdir -p "$CONFIG"
+mkdir -p "$MODS"
+mkdir -p "$SCENARIOS"
+mkdir -p "$SCRIPTOUTPUT"
+
+if [[ ! -f $CONFIG/rconpw ]]; then
+  # Generate a new RCON password if none exists
+  pwgen 15 1 >"$CONFIG/rconpw"
+fi
+
+if [[ ! -f $CONFIG/server-settings.json ]]; then
+  # Copy default settings if server-settings.json doesn't exist
+  cp /opt/factorio/data/server-settings.example.json "$CONFIG/server-settings.json"
+fi
+
+if [[ ! -f $CONFIG/map-gen-settings.json ]]; then
+  cp /opt/factorio/data/map-gen-settings.example.json "$CONFIG/map-gen-settings.json"
+fi
+
+if [[ ! -f $CONFIG/map-settings.json ]]; then
+  cp /opt/factorio/data/map-settings.example.json "$CONFIG/map-settings.json"
+fi
+
+NRTMPSAVES=$( find -L "$SAVES" -iname \*.tmp.zip -mindepth 1 | wc -l )
+if [[ $NRTMPSAVES -gt 0 ]]; then
+  # Delete incomplete saves (such as after a forced exit)
+  rm -f "$SAVES"/*.tmp.zip
+fi
+
+if [[ ${UPDATE_MODS_ON_START:-} ]]; then
+  ./docker-update-mods.sh
+fi
+
+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
+  # Take ownership of factorio data if running as root
+  chown -R factorio:factorio "$FACTORIO_VOL"
+  # Drop to the factorio user
+  SU_EXEC="su-exec factorio"
+else
+  SU_EXEC=""
+fi
+
+NRSAVES=$(find -L "$SAVES" -iname \*.zip -mindepth 1 | wc -l)
+if [[ $GENERATE_NEW_SAVE != true && $NRSAVES ==  0 ]]; then
+    GENERATE_NEW_SAVE=true
+    SAVE_NAME=_autosave1
+fi
+
+if [[ $GENERATE_NEW_SAVE == true ]]; then
+    if [[ -z "$SAVE_NAME" ]]; then
+        echo "If \$GENERATE_NEW_SAVE is true, you must specify \$SAVE_NAME"
+        exit 1
+    fi
+    if [[ -f "$SAVES/$SAVE_NAME.zip" ]]; then
+        echo "Map $SAVES/$SAVE_NAME.zip already exists, skipping map generation"
+    else
+        $SU_EXEC /opt/factorio/bin/x64/factorio \
+            --create "$SAVES/$SAVE_NAME.zip" \
+            --map-gen-settings "$CONFIG/map-gen-settings.json" \
+            --map-settings "$CONFIG/map-settings.json"
+    fi
+fi
+
+FLAGS=(\
+  --port "$PORT" \
+  --server-settings "$CONFIG/server-settings.json" \
+  --server-banlist "$CONFIG/server-banlist.json" \
+  --rcon-port "$RCON_PORT" \
+  --server-whitelist "$CONFIG/server-whitelist.json" \
+  --use-server-whitelist \
+  --server-adminlist "$CONFIG/server-adminlist.json" \
+  --rcon-password "$(cat "$CONFIG/rconpw")" \
+  --server-id /factorio/config/server-id.json \
+)
+
+if [[ $LOAD_LATEST_SAVE == true ]]; then
+    FLAGS+=( --start-server-load-latest )
+else
+    FLAGS+=( --start-server "$SAVE_NAME" )
+fi
+
+# shellcheck disable=SC2086
+exec $SU_EXEC /opt/factorio/bin/x64/factorio "${FLAGS[@]}" "$@"
--- a/0.18/files/docker-update-mods.sh
+++ b/0.18/files/docker-update-mods.sh
@ -0,0 +1,28 @@
+#!/bin/bash
+set -eou pipefail
+
+if [[ -f /run/secrets/username ]]; then
+  USERNAME=$(cat /run/secrets/username)
+fi
+
+if [[ -f /run/secrets/username ]]; then
+  TOKEN=$(cat /run/secrets/token)
+fi
+
+if [[ -z ${USERNAME:-} ]]; then
+  USERNAME="$(jq -j ".username" "$CONFIG/server-settings.json")"
+fi
+
+if [[ -z ${TOKEN:-} ]]; then
+  TOKEN="$(jq -j ".token" "$CONFIG/server-settings.json")"
+fi
+
+if [[ -z ${USERNAME:-} ]]; then
+  echo "You need to provide your Factorio username to update mods."
+fi
+
+if [[ -z ${TOKEN:-} ]]; then
+  echo "You need to provide your Factorio token to update mods."
+fi
+
+./update-mods.sh "$VERSION" "$MODS" "$USERNAME" "$TOKEN"
--- a/0.18/files/scenario.sh
+++ b/0.18/files/scenario.sh
@ -0,0 +1,42 @@
+#!/bin/bash
+set -eoux pipefail
+
+if [[ -z ${1:-} ]]; then
+  echo "No argument supplied"
+fi
+
+SERVER_SCENARIO="$1"
+mkdir -p "$SAVES"
+mkdir -p "$CONFIG"
+mkdir -p "$MODS"
+mkdir -p "$SCENARIOS"
+
+#chown -R factorio /factorio
+
+if [[ ! -f $CONFIG/rconpw ]]; then
+  pwgen 15 1 >"$CONFIG/rconpw"
+fi
+
+if [[ ! -f $CONFIG/server-settings.json ]]; then
+  cp /opt/factorio/data/server-settings.example.json "$CONFIG/server-settings.json"
+fi
+
+if [[ ! -f $CONFIG/map-gen-settings.json ]]; then
+  cp /opt/factorio/data/map-gen-settings.example.json "$CONFIG/map-gen-settings.json"
+fi
+
+if [[ ! -f $CONFIG/map-settings.json ]]; then
+  cp /opt/factorio/data/map-settings.example.json "$CONFIG/map-settings.json"
+fi
+
+exec /opt/factorio/bin/x64/factorio \
+  --port "$PORT" \
+  --start-server-load-scenario "$SERVER_SCENARIO" \
+  --server-settings "$CONFIG/server-settings.json" \
+  --server-banlist "$CONFIG/server-banlist.json" \
+  --server-whitelist "$CONFIG/server-whitelist.json" \
+  --use-server-whitelist \
+  --server-adminlist "$CONFIG/server-adminlist.json" \
+  --rcon-port "$RCON_PORT" \
+  --rcon-password "$(cat "$CONFIG/rconpw")" \
+  --server-id /factorio/config/server-id.json
--- a/0.18/files/scenario2map.sh
+++ b/0.18/files/scenario2map.sh
@ -0,0 +1,27 @@
+#!/bin/bash
+set -eoux pipefail
+
+if [[ -z ${1:-} ]]; then
+  echo "No argument supplied"
+fi
+
+SERVER_SCENARIO="$1"
+mkdir -p "$SAVES"
+mkdir -p "$CONFIG"
+mkdir -p "$MODS"
+mkdir -p "$SCENARIOS"
+
+if [[ ! -f $CONFIG/server-settings.json ]]; then
+  cp /opt/factorio/data/server-settings.example.json "$CONFIG/server-settings.json"
+fi
+
+if [[ ! -f $CONFIG/map-gen-settings.json ]]; then
+  cp /opt/factorio/data/map-gen-settings.example.json "$CONFIG/map-gen-settings.json"
+fi
+
+if [[ ! -f $CONFIG/map-settings.json ]]; then
+  cp /opt/factorio/data/map-settings.example.json "$CONFIG/map-settings.json"
+fi
+
+exec /opt/factorio/bin/x64/factorio \
+  --scenario2map "$SERVER_SCENARIO"
--- a/0.18/files/update-mods.sh
+++ b/0.18/files/update-mods.sh
@ -0,0 +1,94 @@
+#!/bin/bash
+set -eou pipefail
+
+FACTORIO_VERSION=$1
+MOD_DIR=$2
+USERNAME=$3
+TOKEN=$4
+
+MOD_BASE_URL="https://mods.factorio.com"
+
+print_step()
+{
+  echo "$1"
+}
+
+print_success()
+{
+  echo "$1"
+}
+
+print_failure()
+{
+  echo "$1"
+}
+
+update_mod()
+{
+  MOD_NAME="${1// /%20}"
+
+  print_step "Checking for update of mod $MOD_NAME..."
+
+  MOD_INFO_URL="$MOD_BASE_URL/api/mods/$MOD_NAME"
+  MOD_INFO_JSON=$(curl --silent "$MOD_INFO_URL")
+
+  MOD_INFO=$(echo "$MOD_INFO_JSON" | jq -j --arg version "$FACTORIO_VERSION" ".releases|reverse|map(select(.info_json.factorio_version as \$mod_version | \$version | startswith(\$mod_version)))[0]|.file_name, \";\", .download_url, \";\", .sha1")
+
+  MOD_FILENAME=$(echo "$MOD_INFO" | cut -f1 -d";")
+  MOD_URL=$(echo "$MOD_INFO" | cut -f2 -d";")
+  MOD_SHA1=$(echo "$MOD_INFO" | cut -f3 -d";")
+
+  if [[ -z $MOD_URL ]]; then
+    return 1
+  fi
+
+  if [[ $MOD_FILENAME == null ]]; then
+    print_failure "  Not compatible with version"
+    return 1
+  fi
+
+  if [[ -f $MOD_DIR/$MOD_FILENAME ]]; then
+    print_success "  Already up-to-date."
+    return 0
+  fi
+
+  print_step "Downloading..."
+  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")
+
+  if [[ $HTTP_STATUS != 200 ]]; then
+    print_failure "  Download failed: Code $HTTP_STATUS."
+    rm -f "$MOD_DIR/$MOD_FILENAME"
+    return 1
+  fi
+
+  if [[ ! -f $MOD_DIR/$MOD_FILENAME ]]; then
+    print_failure "  Downloaded file missing!"
+    return 1
+  fi
+
+  if ! [[ $(sha1sum "$MOD_DIR/$MOD_FILENAME") =~ $MOD_SHA1 ]]; then
+    print_failure "  SHA1 mismatch!"
+    rm -f "$MOD_DIR/$MOD_FILENAME"
+    return 1
+  fi
+
+  print_success "  Download complete."
+
+  for file in "$MOD_DIR/${MOD_NAME}_"*".zip"; do # wildcard does usually not work in quotes: https://unix.stackexchange.com/a/67761
+    if [[ $file != $MOD_DIR/$MOD_FILENAME ]]; then
+      print_success "  Deleting old version: $file"
+      rm -f "$file"
+    fi
+  done
+
+  return 0
+}
+
+if [[ -f $MOD_DIR/mod-list.json ]]; then
+  jq -r ".mods|map(select(.enabled))|.[].name" "$MOD_DIR/mod-list.json" | while read -r mod; do
+    if [[ $mod != base ]]; then
+      update_mod "$mod"
+    fi
+  done
+fi
--- a/README.md
+++ b/README.md
@ -1,6 +1,7 @@
 # Factorio [![Build Status](https://travis-ci.org/factoriotools/factorio-docker.svg?branch=master)](https://travis-ci.org/factoriotools/factorio-docker) ![Updater status](https://img.shields.io/endpoint?label=Updater%20status&logo=a&url=https%3A%2F%2Fhealthchecks.supersandro.de%2Fbadge%2F1a0a7698-445d-4e54-9e4b-f61a1544e01f%2FBO8VukOA%2Fmaintainer.shields) [![Docker Version](https://images.microbadger.com/badges/version/factoriotools/factorio.svg)](https://hub.docker.com/r/factoriotools/factorio/) [![Docker Pulls](https://img.shields.io/docker/pulls/factoriotools/factorio.svg?maxAge=600)](https://hub.docker.com/r/factoriotools/factorio/) [![Docker Stars](https://img.shields.io/docker/stars/factoriotools/factorio.svg?maxAge=600)](https://hub.docker.com/r/factoriotools/factorio/) [![Microbadger Layers](https://images.microbadger.com/badges/image/factoriotools/factorio.svg)](https://microbadger.com/images/factoriotools/factorio "Get your own image badge on microbadger.com")

-* `0.17.79`, `0.17`, `latest`, `stable` [(0.17/Dockerfile)](https://github.com/factoriotools/factorio-docker/blob/master/0.17/Dockerfile)
+* `0.18.1`, `0.18`, `latest` [(0.18/Dockerfile)](https://github.com/factoriotools/factorio-docker/blob/master/0.18/Dockerfile)
+* `0.17.79`, `0.17`, `stable` [(0.17/Dockerfile)](https://github.com/factoriotools/factorio-docker/blob/master/0.17/Dockerfile)
 * `0.16.51`, `0.16` [(0.16/Dockerfile)](https://github.com/factoriotools/factorio-docker/blob/master/0.16/Dockerfile)
 * `0.15.40`, `0.15` [(0.15/Dockerfile)](https://github.com/factoriotools/factorio-docker/blob/master/0.15/Dockerfile)
 * `0.14.23`, `0.14` [(0.14/Dockerfile)](https://github.com/factoriotools/factorio-docker/blob/master/0.14/Dockerfile)