jacks xonotic image

Author: jackharrhy

.editorconfig

@@ -0,0 +1,5 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true

.github/workflows/publish-xonotic.yml

@@ -0,0 +1,41 @@
+name: Create and publish the Xonotic Docker image
+
+on:
+  push:
+    branches: ["release-xonotic"]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Log in to the Container registry
+        uses: docker/[email protected]
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/[email protected]
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/[email protected]
+        with:
+          context: ./docker-containers/xonotic/
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -1,3 +1,6 @@
+docker-containers/xonotic/xonotic.zip
+docker-containers/xonotic/Xonotic*
+
 # Local .terraform directories
 **/.terraform/*
 

docker-containers/xonotic/.dockerignore

@@ -0,0 +1,3 @@
+Xonotic
+xonotic.zip
+./sidecar-service/venv

docker-containers/xonotic/Dockerfile

@@ -0,0 +1,20 @@
+FROM debian:buster-slim
+
+WORKDIR /opt
+
+RUN apt-get update
+RUN apt-get -y install python3 python3-pip
+
+COPY Xonotic-clean .
+
+RUN mkdir -p /opt/server && touch /opt/server/server.cfg
+
+COPY sidecar-service/requirements.txt .
+COPY sidecar-service/sidecar-service.py .
+RUN pip3 install -r requirements.txt
+
+EXPOSE 26000/udp
+EXPOSE 5001/tcp
+
+ENTRYPOINT ["python3"]
+CMD ["-u", "sidecar-service.py"]

docker-containers/xonotic/Makefile

@@ -0,0 +1,13 @@
+all: download clean build
+
+download:
+	./download.sh
+
+clean:
+	./clean.sh
+
+build:
+	./build.sh
+
+run:
+	./run.sh

docker-containers/xonotic/build.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+docker-compose build xonotic

docker-containers/xonotic/clean.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env sh
+
+echo "Copying required data..."
+
+rm -rf ./Xonotic-clean
+mkdir -p ./Xonotic-clean/data
+
+cp ./Xonotic/xonotic-linux64-dedicated ./Xonotic-clean
+cp ./Xonotic/data/xonotic-20170401-data.pk3 ./Xonotic-clean/data
+cp ./Xonotic/data/xonotic-20170401-maps.pk3 ./Xonotic-clean/data
+cp ./Xonotic/data/xonotic-20170401-nexcompat.pk3 ./Xonotic-clean/data
+
+echo "Copied data!"

docker-containers/xonotic/docker-compose.yml

@@ -0,0 +1,9 @@
+version: '3'
+
+services:
+  xonotic:
+    image: xonotic:latest
+    build: ./.
+    ports:
+      - "127.0.0.1:26000:26000/udp"
+      - "127.0.0.1:5001:5001/tcp"

docker-containers/xonotic/download.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env sh
+
+FILE=xonotic.zip
+SHA_256_SUM=a22f7230f486c5825b55cfdadd73399c9b0fae98c9e081dd8ac76eca08359ad5
+
+validate() {
+  echo "$SHA_256_SUM $FILE" | sha256sum -c
+}
+
+exists() {
+  echo "$FILE exists, validating checksum"
+  validate
+}
+
+if [ -f "$FILE" ]; then
+  exists
+else 
+  echo "$FILE does not exist, downloading..."
+  curl https://dl.xonotic.org/xonotic-0.8.2.zip -L -o xonotic.zip
+  exists
+fi

docker-containers/xonotic/run.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+docker-compose run xonotic

docker-containers/xonotic/sidecar-service/requirements.txt

@@ -0,0 +1,2 @@
+Flask==2.*
+requests==2.*

docker-containers/xonotic/sidecar-service/sidecar-service.py

@@ -0,0 +1,87 @@
+from enum import Enum
+import os
+import subprocess
+from subprocess import PIPE
+from datetime import datetime
+from typing import Optional
+
+import requests
+from flask import Flask
+
+DEBUG = bool(os.environ.get("DEBUG", False))
+CONFIG_URL = os.environ.get(
+    "CONFIG_URL",
+    "https://raw.githubusercontent.com/xonotic/xonotic/master/server/server.cfg",
+)
+
+HOST = os.environ.get("HOST", "0.0.0.0")
+
+DEFAULT_PORT = 5001
+PORT = int(os.environ.get("PORT", DEFAULT_PORT))
+
+app = Flask(__name__)
+process = None
+
+
+def log(message):
+    print(f"SIDECAR: {message}")
+
+
+def get_game_pid() -> Optional[int]:
+    try:
+        int(subprocess.check_output(["pidof", "./xonotic-linux64-dedicated"]))
+    except:
+        log("Failed to get game pid, assuming not currently running")
+        return None
+
+
+def write_config():
+    with open("/opt/server/server.cfg", "wb") as f:
+        f.write(requests.get(CONFIG_URL).content)
+
+
+class Response(Enum):
+    STARTED = "started"
+    RESTARTED = "restarted"
+
+
+def start_or_restart_game() -> Response:
+    global process
+
+    def fresh():
+        return subprocess.Popen(["./xonotic-linux64-dedicated"], stdin=PIPE)
+
+    if process is None:
+        log("No process, starting initial process")
+        process = fresh()
+        return Response.STARTED
+    else:
+        log("Process already running, shutting down")
+        process.stdin.write(str.encode("exit\n"))
+        process.stdin.flush()
+        process.wait(15)
+        log("Process shutdown, starting fresh process")
+        process = fresh()
+        log("Fresh process started")
+        return Response.RESTARTED
+
+
+@app.route("/")
+def home():
+    global process
+    return {"pid": process.pid, "timestamp": datetime.now().isoformat()}
+
+
+@app.route("/restart")
+def restart():
+    global process
+    response = start_or_restart_game()
+    return {"pid": process.pid, "status": response.value}
+
+
+if __name__ == "__main__":
+    write_config()
+    start_or_restart_game()
+
+    log(f"Starting sidecar-service on {HOST}:{PORT}")
+    app.run(debug=DEBUG, host=HOST, port=PORT)