VR online list: the games players host before the dedicated servers

The server browser lists the master servers' dedicated servers first,
13 of them now, and the VR online panel shows 10 rows: a game a friend
hosts (or an OpenCE player's) was below them, out of sight. The panel
now lists the games players host first (the server browser's, then the
VR list's own), then the dedicated servers, and takes up to 64 listings
from the server browser rather than 32.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,5 @@
 blank_issues_enabled: true
 contact_links:
   - name: How to install
-    url: https://github.com/Cesarus85/ringfall-mjolnir-vr#install-on-meta-quest-3--3s
+    url: https://github.com/Cesarus85/mjolnir-vr#install-on-meta-quest-3--3s
     about: Step-by-step installation for the Quest 3 / 3S and the Steam Frame.

.github/workflows/build.yml

@@ -13,7 +13,7 @@ name: Build
 # - a newer push to the same branch cancels a run still going;
 # - pushes that only change documentation do not build;
 # - Windows, whose minutes cost twice Linux's, builds only Windows;
-# - Ringfall: Mjolnir VR builds only Android (the VR app): the Linux and
+# - Mjolnir VR builds only Android (the VR app): the Linux and
 #   Windows jobs are kept, off (if: false), so that upstream's changes to
 #   them still merge;
 # - artifacts are kept for three days.
@@ -24,7 +24,7 @@ name: Build
 # gives the latest build; the last five are kept. Its web build is then the
 # site on GitHub Pages (https://halocombatevolved.com/, port/web/README.md).
 on:
-  # (Ringfall: Mjolnir VR: main only; its branches are tried on the headsets
+  # (Mjolnir VR: main only; its branches are tried on the headsets
   # from local builds)
   push:
     branches: [main]
@@ -52,7 +52,7 @@ env:
 
 jobs:
   linux:
-    # (off: Ringfall: Mjolnir VR ships the Android app only)
+    # (off: Mjolnir VR ships the Android app only)
     if: ${{ false }}
     # Arch Linux has what the build needs as packages: clang 22 (for the
     # profile-guided optimisation in pgo/), and CMake, pkg-config and
@@ -99,7 +99,7 @@ jobs:
 
       - name: Test
         run: |
-          python -m pytest -q tools/test_linux_port.py tools/test_android_asm_convert.py tools/test_host_watch_hash.py tools/test_touch_menu.py tools/harness tools/test_profile.py
+          python -m pytest -q tools/test_linux_port.py tools/test_android_asm_convert.py tools/test_android_mirror_uploads.py tools/test_android_ce_texture_cache.py tools/test_host_watch_hash.py tools/test_touch_menu.py tools/harness tools/test_profile.py tools/stagekit/tests tools/test_net_compare.py
           python tools/test_light_storage.py
 
       - name: Compile cache
@@ -125,10 +125,15 @@ jobs:
       - name: Install the toolchain
         run: |
           mkdir -p "$RUNNER_TEMP/tools"
+          # (each download checked against the hash it had when it was pinned)
           curl -fsSL -o ninja.zip https://github.com/ninja-build/ninja/releases/download/v1.12.1/ninja-linux.zip
+          curl -fsSL -o ccache.tar.xz https://github.com/ccache/ccache/releases/download/v4.10.2/ccache-4.10.2-linux-x86_64.tar.xz
+          sha256sum -c - <<'EOF'
+          6f98805688d19672bd699fbbfa2c2cf0fc054ac3df1f0e6a47664d963d530255  ninja.zip
+          80cab87bd510eca796467aee8e663c398239e0df1c4800a0b5dff11dca0b4f18  ccache.tar.xz
+          EOF
           unzip -q ninja.zip -d "$RUNNER_TEMP/tools" && rm ninja.zip
-          curl -fsSL https://github.com/ccache/ccache/releases/download/v4.10.2/ccache-4.10.2-linux-x86_64.tar.xz \
-            | tar -xJ -C "$RUNNER_TEMP/tools" --strip-components=1 ccache-4.10.2-linux-x86_64/ccache
+          tar -xJf ccache.tar.xz -C "$RUNNER_TEMP/tools" --strip-components=1 ccache-4.10.2-linux-x86_64/ccache && rm ccache.tar.xz
           echo "$RUNNER_TEMP/tools" >> "$GITHUB_PATH"
 
       - uses: actions/checkout@v4
@@ -198,7 +203,7 @@ jobs:
           retention-days: 3
 
   windows:
-    # (off: Ringfall: Mjolnir VR ships the Android app only)
+    # (off: Mjolnir VR ships the Android app only)
     if: ${{ false }}
     # The runner image has LLVM, Python and Visual Studio's x86 libraries and
     # Windows SDK.
@@ -212,8 +217,11 @@ jobs:
         shell: pwsh
         run: |
           Invoke-WebRequest -OutFile ninja.zip https://github.com/ninja-build/ninja/releases/download/v1.12.1/ninja-win.zip
-          Expand-Archive ninja.zip -DestinationPath "$env:RUNNER_TEMP\tools"
           Invoke-WebRequest -OutFile ccache.zip https://github.com/ccache/ccache/releases/download/v4.10.2/ccache-4.10.2-windows-x86_64.zip
+          # (each download checked against the hash it had when it was pinned)
+          if ((Get-FileHash ninja.zip -Algorithm SHA256).Hash -ne "F550FEC705B6D6FF58F2DB3C374C2277A37691678D6ABA463ADCBB129108467A") { throw "ninja.zip: unexpected SHA-256" }
+          if ((Get-FileHash ccache.zip -Algorithm SHA256).Hash -ne "6252F081876A9A9F700FAE13A5AEC5D0D486B28261D7F1F72AC11C7AD9DF4DA9") { throw "ccache.zip: unexpected SHA-256" }
+          Expand-Archive ninja.zip -DestinationPath "$env:RUNNER_TEMP\tools"
           Expand-Archive ccache.zip -DestinationPath $env:RUNNER_TEMP
           Copy-Item "$env:RUNNER_TEMP\ccache-4.10.2-windows-x86_64\ccache.exe" "$env:RUNNER_TEMP\tools"
           Remove-Item ninja.zip, ccache.zip
@@ -271,7 +279,7 @@ jobs:
           retention-days: 3
 
   web:
-    # (off: Ringfall: Mjolnir VR ships the Android app only)
+    # (off: Mjolnir VR ships the Android app only)
     if: ${{ false }}
     # Emscripten (emsdk, the version below, cached) builds the web port's
     # site (port/web/README.md); the tests check its graph, the page's
@@ -371,7 +379,6 @@ jobs:
         with:
           sparse-checkout: |
             port/android
-            port/third_party/extract-xiso
             tools
 
       - uses: actions/download-artifact@v4
@@ -382,18 +389,26 @@ jobs:
       - name: Package
         run: |
           mkdir release
-          # (Ringfall: Mjolnir VR publishes its Android builds only, under
+          # (Mjolnir VR publishes its Android builds only, under
           # its own name: Updater.java looks for them; the desktop ports are
           # built to keep them building)
           for config in debug release; do
             (cd "artifacts/halo-android-$config" &&
-              zip -qr "$GITHUB_WORKSPACE/release/ringfall-mjolnir-vr-android-$config.zip" .)
+              zip -qr "$GITHUB_WORKSPACE/release/mjolnir-vr-android-$config.zip" .)
           done
           # the Steam Frame's installer (port/android/STEAM_FRAME.md): its
           # bundle with the release APK, and the desktop file that fetches it
           python3 tools/steam_frame_bundle.py artifacts/halo-android-release/app-release.apk release "$GH_REPO"
           # the APK itself, for sideloading on the Quest (SideQuest, adb)
-          cp artifacts/halo-android-release/app-release.apk release/RingfallMjolnirVR.apk
+          cp artifacts/halo-android-release/app-release.apk release/MjolnirVR.apk
+          # the same under the names before "Mjolnir VR" (Ringfall: Mjolnir
+          # VR, builds 302 to 313): their updaters (Updater.java, the Frame's
+          # launcher) and the links already shared ask for them
+          cp release/mjolnir-vr-android-debug.zip release/ringfall-mjolnir-vr-android-debug.zip
+          cp release/mjolnir-vr-android-release.zip release/ringfall-mjolnir-vr-android-release.zip
+          cp release/mjolnir-vr-steam-frame.zip release/ringfall-mjolnir-vr-steam-frame.zip
+          cp release/Install-Mjolnir-VR.desktop release/Install-Ringfall-Mjolnir-VR.desktop
+          cp release/MjolnirVR.apk release/RingfallMjolnirVR.apk
           ls -l release
 
       - name: Publish
@@ -408,15 +423,15 @@ jobs:
           readme="$GITHUB_SERVER_URL/$GITHUB_REPOSITORY"
           {
             printf '%s\n\n' "$subject"
-            printf '**Ringfall: Mjolnir VR** is an unofficial VR mod for Halo: Combat Evolved. It needs a disc image of your own, purchased Xbox copy of the game; no game files are included.\n\n'
+            printf '**Mjolnir VR** is an unofficial VR mod for Halo: Combat Evolved. It needs a disc image of your own, purchased Xbox copy of the game; no game files are included.\n\n'
             printf '| Headset | Download | How to install |\n| --- | --- | --- |\n'
-            printf '| Meta Quest 3 / 3S | `RingfallMjolnirVR.apk` | [Install on Quest](%s#install-on-meta-quest-3--3s) |\n' "$readme"
-            printf '| Steam Frame | `Install-Ringfall-Mjolnir-VR.desktop` (open it in Desktop Mode) | [Install on Steam Frame](%s#install-on-steam-frame) |\n\n' "$readme"
-            printf 'The other files are for the built-in updater and the Steam Frame installer.\n\n'
+            printf '| Meta Quest 3 / 3S | `MjolnirVR.apk` | [Install on Quest](%s#install-on-meta-quest-3--3s) |\n' "$readme"
+            printf '| Steam Frame | `Install-Mjolnir-VR.desktop` (open it in Desktop Mode) | [Install on Steam Frame](%s#install-on-steam-frame) |\n\n' "$readme"
+            printf 'The other files are for the built-in updater and the Steam Frame installer (those named `ringfall-…` / `Ringfall…`: the same, for the builds before the name Mjolnir VR).\n\n'
             printf 'Commit: %s\nBuild: %s\n' "$COMMIT_URL" "$RUN_URL"
           } > notes.md
           gh release create "$tag" release/* --target "$GITHUB_SHA" --latest \
-            --title "Ringfall: Mjolnir VR, build $GITHUB_RUN_NUMBER (${GITHUB_SHA:0:7})" --notes-file notes.md
+            --title "Mjolnir VR, build $GITHUB_RUN_NUMBER (${GITHUB_SHA:0:7})" --notes-file notes.md
           echo "tag=$tag" >> "$GITHUB_OUTPUT"
 
       # The Windows builds' executables and PDBs to Sentry, which turns the
@@ -458,7 +473,7 @@ jobs:
           done
 
   pages:
-    # (off: Ringfall: Mjolnir VR ships the Android app only)
+    # (off: Mjolnir VR ships the Android app only)
     if: ${{ false }}
     # The release's web build to GitHub Pages, which serves it at
     # https://halocombatevolved.com/ (port/web/README.md, "Hosting"). Only
@@ -469,6 +484,7 @@ jobs:
     runs-on: ubuntu-24.04
     timeout-minutes: 10
     permissions:
+      contents: write
       pages: write
       id-token: write
     concurrency:
@@ -483,6 +499,45 @@ jobs:
           name: halo-web-release
           path: site
 
+      # The game's wasm, most of a build, from jsDelivr rather than GitHub
+      # Pages, which serves 100 GB a month: the wasm alone in a commit of the
+      # web-wasm branch (pushed over the last, so the repository keeps one),
+      # which jsDelivr serves by its hash (with CORS; GitHub's release
+      # downloads have none, so a page cannot fetch them), and version.json
+      # names that copy and its SHA-256. The site's service worker takes the
+      # wasm from there, checked, and from the site only when it cannot
+      # (port/web/site/sw.js). A failure here leaves the site serving it.
+      - name: The wasm on jsDelivr
+        continue-on-error: true
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          sha256="$(sha256sum site/halo.wasm | cut -d' ' -f1)"
+          mkdir wasm
+          cp site/halo.wasm wasm/
+          cd wasm
+          git init -q -b web-wasm
+          git -c user.name="github-actions[bot]" -c user.email="41898282+github-actions[bot]@users.noreply.github.com" \
+            add halo.wasm
+          git -c user.name="github-actions[bot]" -c user.email="41898282+github-actions[bot]@users.noreply.github.com" \
+            commit -q -m "The web build's wasm (build $GITHUB_RUN_NUMBER, $GITHUB_SHA)"
+          git push -q --force "https://x-access-token:${GH_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" HEAD:refs/heads/web-wasm
+          url="https://cdn.jsdelivr.net/gh/${GITHUB_REPOSITORY}@$(git rev-parse HEAD)/halo.wasm"
+          # (jsDelivr fetches it now, and it must be the same file: it serves
+          # files of at most 20 MB from GitHub)
+          curl -fsSL --retry 6 --retry-delay 10 --retry-all-errors -o served.wasm "$url"
+          echo "$sha256  served.wasm" | sha256sum -c -
+          cd ..
+          python3 - "$url" "$sha256" <<'EOF'
+          import json, sys
+          with open("site/version.json") as file:
+              stamp = json.load(file)
+          stamp["wasm"] = {"url": sys.argv[1], "sha256": sys.argv[2]}
+          with open("site/version.json", "w") as file:
+              json.dump(stamp, file, indent=1)
+          EOF
+          echo "the wasm from $url"
+
       - uses: actions/configure-pages@v5
 
       - uses: actions/upload-pages-artifact@v3
@@ -539,7 +594,7 @@ jobs:
             title="Build failed"; color=15548997
           fi
           latest="$SERVER/$REPOSITORY/releases/latest"
-          downloads="[Quest]($latest/download/ringfall-mjolnir-vr-android-release.zip) · [Steam Frame]($latest/download/Install-Ringfall-Mjolnir-VR.desktop) ([all builds]($latest))"
+          downloads="[Quest]($latest/download/mjolnir-vr-android-release.zip) · [Steam Frame]($latest/download/Install-Mjolnir-VR.desktop) ([all builds]($latest))"
           if [ -n "$RELEASE_TAG" ]; then
             release="[$RELEASE_TAG]($SERVER/$REPOSITORY/releases/tag/$RELEASE_TAG)"
             if [ "$PAGES" = success ]; then

.github/workflows/server-image.yml

@@ -0,0 +1,199 @@
+name: Server image
+
+# The dedicated server's container image (deploy/docker), made from a
+# release's halo-linux-release.zip, and the Helm chart's checks
+# (deploy/helm/opence-server).
+#
+# - After each successful Build of main (which publishes release build-<n>):
+#   the image of that release, checked, pushed to
+#   ghcr.io/opencommunityedition/opence-server as sha-<commit>, build-<n> and
+#   latest, and signed keyless with cosign (this workflow's GitHub identity).
+# - Weekly, the latest release's image again, for Debian's fixes.
+# - By hand, any release's (latest moves only for the newest).
+#
+# The checks (no game data in CI: it is never published): the image runs as
+# 10001:10001; started on a read-only root without maps it writes its
+# settings to /state, says "server: no usable maps" and exits 2; halo
+# --version answers; the health check fails with nothing listening.
+#
+# Verify:
+#   cosign verify ghcr.io/opencommunityedition/opence-server:latest \
+#     --certificate-identity-regexp '^https://github\.com/OpenCommunityEdition/OpenCE/\.github/workflows/server-image\.yml@' \
+#     --certificate-oidc-issuer https://token.actions.githubusercontent.com
+on:
+  workflow_run:
+    workflows: [Build]
+    types: [completed]
+    branches: [main]
+  schedule:
+    - cron: "23 5 * * 1"
+  workflow_dispatch:
+    inputs:
+      release:
+        description: "The release to build the image of: a tag (build-206) or latest"
+        default: latest
+
+concurrency:
+  group: server-image-${{ github.event_name }}-${{ github.ref }}
+  cancel-in-progress: false
+
+permissions:
+  contents: read
+
+env:
+  IMAGE: ghcr.io/opencommunityedition/opence-server
+
+jobs:
+  chart:
+    # (off: Mjolnir VR ships no dedicated server image)
+    if: ${{ false }}
+    runs-on: ubuntu-24.04
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.workflow_run.head_sha || github.sha }}
+
+      - uses: azure/setup-helm@v4
+
+      - name: Lint
+        run: |
+          set -euo pipefail
+          chart=deploy/helm/opence-server
+          for values in "$chart"/ci/*-values.yaml; do
+            helm lint "$chart" --strict -f "$values"
+            helm template ci "$chart" -f "$values" > /dev/null
+          done
+          # the maps are never in the image: without game data the chart refuses to render
+          if helm template ci "$chart" > /dev/null 2>&1; then
+            echo "::error::the chart renders without gameData"; exit 1
+          fi
+
+      - name: Unit tests
+        run: |
+          set -euo pipefail
+          # (Helm 4 checks plugins' signatures, which helm-unittest does not publish)
+          if helm version --short | grep -q '^v3'; then verify=; else verify=--verify=false; fi
+          helm plugin install https://github.com/helm-unittest/helm-unittest $verify
+          helm unittest deploy/helm/opence-server
+
+  image:
+    # (off: Mjolnir VR ships no dedicated server image)
+    if: ${{ false }}
+    runs-on: ubuntu-24.04
+    timeout-minutes: 20
+    permissions:
+      contents: read
+      packages: write
+      # keyless signing: the workflow's OIDC token gets a short-lived Sigstore certificate
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.workflow_run.head_sha || github.sha }}
+
+      - name: Release
+        id: release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          EVENT: ${{ github.event_name }}
+          RUN_NUMBER: ${{ github.event.workflow_run.run_number }}
+          WANTED: ${{ inputs.release }}
+        run: |
+          set -euo pipefail
+          case "$EVENT" in
+          workflow_run) tag="build-$RUN_NUMBER" ;;
+          workflow_dispatch) tag="${WANTED:-latest}" ;;
+          *) tag=latest ;;
+          esac
+          newest="$(gh release view --repo "$GITHUB_REPOSITORY" --json tagName -q .tagName)"
+          if [ "$tag" = latest ]; then
+            tag="$newest"
+          fi
+          commit="$(gh release view "$tag" --repo "$GITHUB_REPOSITORY" --json targetCommitish -q .targetCommitish)"
+          gh release download "$tag" --repo "$GITHUB_REPOSITORY" --pattern halo-linux-release.zip --dir deploy/docker
+          echo "tag=$tag" >> "$GITHUB_OUTPUT"
+          echo "commit=$commit" >> "$GITHUB_OUTPUT"
+          echo "newest=$([ "$tag" = "$newest" ] && echo true || echo false)" >> "$GITHUB_OUTPUT"
+          echo "Release $tag (commit $commit; the newest: $newest)"
+
+      - name: Build
+        env:
+          TAG: ${{ steps.release.outputs.tag }}
+          COMMIT: ${{ steps.release.outputs.commit }}
+        run: |
+          set -euo pipefail
+          docker build --pull -t opence-server:ci \
+            --build-arg RELEASE=halo-linux-release.zip \
+            --label org.opencontainers.image.source="$GITHUB_SERVER_URL/$GITHUB_REPOSITORY" \
+            --label org.opencontainers.image.revision="$COMMIT" \
+            --label org.opencontainers.image.version="$TAG" \
+            --label org.opencontainers.image.licenses=AGPL-3.0-or-later \
+            --label org.opencontainers.image.title="OpenCE dedicated server" \
+            deploy/docker
+
+      - name: Smoke test
+        run: |
+          set -euo pipefail
+          [ "$(docker image inspect -f '{{.Config.User}}' opence-server:ci)" = 10001:10001 ] \
+            || { echo "::error::the image does not run as 10001:10001"; exit 1; }
+          docker run --rm --read-only --entrypoint /opt/opence/halo opence-server:ci --version | tee version.txt
+          grep -Eq '^OpenCE build-[0-9]+ \(network version [0-9]+\)$' version.txt \
+            || { echo "::error::halo --version did not answer"; exit 1; }
+          # without maps, on a read-only root with /state the one writable folder
+          docker volume create smoke-state > /dev/null
+          status=0
+          timeout 60 docker run --name smoke --read-only --cap-drop ALL --security-opt no-new-privileges \
+            --tmpfs /tmp -v smoke-state:/state -e HALO_SERVER_WEB_PASSWORD=ci-smoke-password \
+            opence-server:ci > server.log 2>&1 || status=$?
+          cat server.log
+          docker rm -f smoke > /dev/null
+          [ "$status" = 2 ] || { echo "::error::the server without maps exited with $status, not 2"; exit 1; }
+          grep -qF 'server: no usable maps' server.log \
+            || { echo "::error::no 'server: no usable maps' line"; exit 1; }
+          if grep -qF 'server: ready' server.log; then echo "::error::the server said it was ready"; exit 1; fi
+          docker run --rm -v smoke-state:/state --entrypoint /bin/bash opence-server:ci -c 'test -s /state/config.toml' \
+            || { echo "::error::no /state/config.toml"; exit 1; }
+          # the health check, with nothing listening
+          if docker run --rm --entrypoint /opt/opence/healthz.sh opence-server:ci; then
+            echo "::error::the health check passed with no server"; exit 1
+          fi
+          docker volume rm smoke-state > /dev/null
+
+      - uses: docker/login-action@v3
+        if: github.repository == 'OpenCommunityEdition/OpenCE'
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: sigstore/cosign-installer@v3
+        if: github.repository == 'OpenCommunityEdition/OpenCE'
+
+      - name: Push and sign
+        if: github.repository == 'OpenCommunityEdition/OpenCE'
+        env:
+          TAG: ${{ steps.release.outputs.tag }}
+          COMMIT: ${{ steps.release.outputs.commit }}
+          NEWEST: ${{ steps.release.outputs.newest }}
+          IDENTITY: ^https://github\.com/${{ github.repository }}/\.github/workflows/server-image\.yml@
+        run: |
+          set -euo pipefail
+          tags=("sha-${COMMIT:0:7}" "$TAG")
+          if [ "$NEWEST" = true ]; then
+            tags+=(latest)
+          fi
+          for tag in "${tags[@]}"; do
+            docker tag opence-server:ci "$IMAGE:$tag"
+            docker push "$IMAGE:$tag"
+          done
+          ref="$(docker image inspect -f '{{index .RepoDigests 0}}' "$IMAGE:$TAG")"
+          test -n "$ref"
+          cosign sign --yes "$ref"
+          cosign verify "$ref" --certificate-identity-regexp "$IDENTITY" \
+            --certificate-oidc-issuer https://token.actions.githubusercontent.com > /dev/null
+          {
+            echo "Pushed and signed $ref as ${tags[*]}."
+            echo
+            echo "Verify: cosign verify $IMAGE:$TAG --certificate-identity-regexp '$IDENTITY' --certificate-oidc-issuer https://token.actions.githubusercontent.com"
+          } >> "$GITHUB_STEP_SUMMARY"

AGENTS.md

@@ -15,19 +15,20 @@ end.
 | Path | Contents |
 | --- | --- |
 | `source/` | The game: 466 C files of the decompilation, compiled as they are with few changes (each marked, below) |
-| `port/linux/src/` | The platform layer the three ports share: Direct3D 8 on OpenGL (`d3d8_gl.c`), DirectSound and XInput on SDL3, files, threads, memory, sockets, settings (`port_config.c`), internet play (`p2p*.c`) |
-| `port/linux/game/` | The port's game-side code, compiled as the game's sources are: the distributed netcode (`network_*.c`), co-op, map sharing (`map_share*.c`), the menus (`menu_tags.c`, `menu_functions.c`), Custom Edition maps (`custom_edition_*.c`, `cache_file_formats.c`), the tag validator (`tag_validate.c`, `tag_schema_*.c`), touch, FOV and more |
+| `port/linux/src/` | The platform layer the three ports share: Direct3D 8 on OpenGL (`d3d8_gl.c`), DirectSound and XInput on SDL3, files, threads, memory, sockets, settings (`port_config.c`), the mods folder (`port_mods.c`), internet play (`p2p*.c`), the dedicated server's platform side (`server_*.c`: the mode, the log, the rotation's grammar, HTTP, RCON, the master servers' publisher) and the master servers' list (`master_list.c`) |
+| `port/linux/game/` | The port's game-side code, compiled as the game's sources are: the distributed netcode (`network_*.c`), co-op, OpenCE's gametypes (`game_modes.c`, `infection.c`, `gun_game.c`), map sharing (`map_share*.c`), the menus (`menu_tags.c`, `menu_functions.c`), Custom Edition maps (`custom_edition_*.c`, `cache_file_formats.c`), the tag validator (`tag_validate.c`, `tag_schema_*.c`), mods (`mods.c`, `mod_*.c`), streamer mode's word filter (`text_filter*.c`), the dedicated server's director, commands, gametypes and status (`server_*.c`), touch, FOV and more |
 | `port/linux/include/` | The port's headers: the limits (`halo_port_limits.h`, with `HALO_PORT_NETWORK_VERSION`), capacities (`halo_port_capacity.h`), the prefix header, `halo_linux_source_fixups.h` (port functions the game's sources call) |
 | `port/include/xdk/` | Stand-ins for the Xbox SDK's headers (declarations only) |
 | `port/windows/` | The Windows build's own files (`win32_*.c`, headers) |
 | `port/android/` | The Android app: the guest runtime, the host library (`host/`), the Java app (`app/`), host imports (`host_imports.list`) |
 | `port/web/` | The web build: its runtime (`src/`: entry, sockets inside the page, memory watch), the page and its service worker (`site/`), the SDL port, tests |
-| `port/assets/` | What the builds embed or ship: high-res HUD (`hud/`), fonts, titles, menus (`menus/`), icons, network brokers |
+| `port/assets/` | What the builds embed or ship: high-res HUD (`hud/`), fonts, titles, menus (`menus/`), icons, network brokers and master servers, the dedicated server's web page (`server_ui/`) |
 | `port/third_party/` | Vendored libraries, each with a README naming its upstream, version and checksum |
 | `port/tools/` | Stand-alone tools (`cache_file_report.c`) |
-| `tools/` | Build scripts (`linux_build.py`, `windows_build.py`, `android_build.py`, `web_build.py`, `ci_build.py`, `web_serve.py`), generators (`ce_menus.py`, `port_settings.py`, `hud_assets.py`, `title_assets.py`, `embed_assets.py`, `xdk_headers.py`) and tests |
-| `docs/` | Longer design notes (`custom_edition_caches.md`) |
+| `tools/` | Build scripts (`linux_build.py`, `windows_build.py`, `android_build.py`, `web_build.py`, `ci_build.py`, `web_serve.py`), generators (`ce_menus.py`, `port_settings.py`, `hud_assets.py`, `title_assets.py`, `embed_assets.py`, `server_ui_embed.py`, `xdk_headers.py`), the dedicated server's protocol simulator and remote console (`server_sim.py`, `opence_rcon.py`), tests, and `stagekit/` (scenarios staged and instrumented on the real engine, no retail assets) |
+| `docs/` | Longer design notes (`custom_edition_caches.md`, `mods.md`, `dedicated_server.md`, `master_protocol.md`) |
 | `pgo/` | Profile-guided optimisation profiles |
+| `deploy/` | Running a dedicated server: systemd, Docker, Pterodactyl, Helm, PufferPanel, MCSManager, example gametypes |
 | `assets/` | Game data for local runs (gitignored: `maps/`, `custom_maps/`) |
 | `.github/workflows/` | CI: builds every platform on each push, publishes releases from `main` |
 
@@ -39,7 +40,7 @@ ninja linux                    # build/linux/halo
 ninja android                  # the Android guest image and native libraries
 ninja android_apk              # the APK (Gradle)
 ninja web                      # build/web/site (Emscripten: port/web/README.md)
-ninja windows                  # on Windows only
+ninja windows                  # on Windows, or on Linux after configure.py --windows-cross
 python tools/ci_build.py linux release   # what CI builds
 ```
 
@@ -83,7 +84,10 @@ setting (`game.custom_edition`), checked at run time with
 
 ```sh
 python -m pytest -q tools/harness tools/test_touch_menu.py   # the engine's functions in a fake world
+python -m pytest -q tools/stagekit/tests                    # scenarios on the real engine, no retail assets (Linux)
 python -m pytest -q tools/test_linux_port.py                # the build, the maps' checks (needs assets/maps)
+python -m pytest -q tools/test_mods.py                      # mods played over a map (needs assets/maps)
+python -m pytest -q tools/test_bots.py                      # the bots in local games (needs assets/maps)
 python -m pytest -q tools/test_cache_file_formats.py tools/test_bmp_files.py tools/test_profile.py
 python tools/test_touch_layout.py                           # the Android touch layout (JDK 17+)
 python tools/test_light_storage.py
@@ -91,10 +95,16 @@ python tools/test_death_timing.py
 python -m pytest -q tools/test_web_build.py                 # the web build's graph, sockets, menus
 node --test "port/web/tests/*.test.js"                      # the web page's importer and service worker
 node port/web/tests/webrtc_native.mjs chromium firefox      # the native builds' WebRTC with browsers (Playwright)
+python -m pytest -q tools/test_dedicated_server.py          # the dedicated server with clients (needs assets/maps)
+python -m pytest -q tools/test_server_sim.py tools/test_egg.py   # the server's web page and protocol simulator, the egg
+python -m pytest -q tools/test_net_compare.py               # net_compare.py's judging of logs, its copies and their processes
+python tools/net_compare.py --a build/linux/halo --b <other build> --data <game data> --swap
+                                                            # two builds in one network game, in step (retail maps: local only)
 ```
 
 `tools/harness/README.md` explains how to add an asset-free test: the code
-under test is taken from the sources, not copied.
+under test is taken from the sources, not copied. `tools/stagekit/README.md`
+explains how to add a scenario: the real engine, with no retail assets.
 
 Running the game without a person at it:
 
@@ -103,6 +113,9 @@ Running the game without a person at it:
   several copies play on one machine on different loopback addresses
   (`HALO_NET_ADDRESS`, `HALO_NET_BROADCAST`). `NETCODE.md` describes the
   test settings.
+- `halo --server` is a dedicated server (`docs/dedicated_server.md`), and
+  `halo --probe [<invite>]` prints a game's advertisement as JSON and exits;
+  `tools/test_dedicated_server.py` runs both with clients.
 - `debug.exit_after`, `debug.hidden_window`, `debug.null_renderer`,
   `debug.menu_open` (start on one menu screen), `debug.telnet_console`.
 - Use a virtual display (Xvfb, with `SDL_VIDEO_DRIVER=x11`) for windowed
@@ -189,10 +202,18 @@ otherwise.
 
 ### Third-party code and licences
 
-The repository is CC0. Vendored code goes in `port/third_party/<name>`,
-copied unchanged, with a README naming the upstream, the version or commit,
-the checksum and what uses it. GPL code (OpenSauce, Reclaimer) may be read
-as documentation of file formats, never copied.
+The repository is `AGPL-3.0-or-later` (`LICENSE`); the commits before the
+change, and the releases built from them, stay CC0 (`LICENSES/CC0-1.0.txt`).
+The README's "Licence" section says what each part is under. Vendored code
+goes in `port/third_party/<name>`, copied unchanged, with a README naming
+the upstream, the version or commit, the licence, the checksum and what uses
+it. Its licence must let it be combined with the AGPL 3.0: MIT, BSD (without
+an advertising clause), ISC, zlib, Apache 2.0, MPL 2.0, LGPL or GPL 3.0 or
+later, public domain. GPL-2.0-only code and the 4-clause BSD licence cannot
+be. Code taken from another project, GPL 3.0 code included, keeps its
+notices and its licence, and says where it came from.
+The decompilation's upstream, punpckhdq/halo, is AGPL 3.0 from 17 October
+2026; bnunu/halo-1 is CC0.
 
 ### Commits and pull requests
 
@@ -216,10 +237,15 @@ as documentation of file formats, never copied.
 | [port/web/README.md](port/web/README.md) | The web build, the page, the game data in the browser, limits, how it operates, hosting on GitHub Pages |
 | [port/include/xdk/README.md](port/include/xdk/README.md) | How the SDK declarations were written and are checked |
 | [docs/custom_edition_caches.md](docs/custom_edition_caches.md) | Loading and converting Custom Edition maps, and the evidence for each layout |
+| [docs/dedicated_server.md](docs/dedicated_server.md) | The dedicated server: its command line, exit codes, commands, HTTP API, RCON, events and files |
+| [docs/master_protocol.md](docs/master_protocol.md) | The master servers' protocol: publishing, the probe, the signed list |
+| [docs/mods.md](docs/mods.md) | Mods: folders of Halo PC tag files whose sounds, bitmaps, text and models play over a map's on one machine |
+| [port/assets/text_filter/README.md](port/assets/text_filter/README.md) | Streamer mode's words: Surge AI's list, the review, the allowed words |
 | [port/assets/menus/README.md](port/assets/menus/README.md) | The menu files' format and how to write them again |
 | [port/assets/menus/NON_HANDDRAWN.md](port/assets/menus/NON_HANDDRAWN.md) | Menu pictures that are not redraws |
 | [port/assets/menus/UNWIRED.md](port/assets/menus/UNWIRED.md) | Menu functions that do nothing yet |
 | [port/assets/fonts/README.md](port/assets/fonts/README.md) | The fonts and their licences |
 | [tools/harness/README.md](tools/harness/README.md) | Asset-free regression tests |
+| [tools/stagekit/README.md](tools/stagekit/README.md) | Scenarios staged and instrumented on the real engine, no retail assets |
 | `port/third_party/*/README.md` | Each vendored library |
 | [AUTHORS.md](AUTHORS.md) | Art credits |

AUTHORS.md

@@ -10,6 +10,8 @@
   weapons' reticles): redraws by MrBruh (`port/assets/hud`), based on
   reference photos by Aerocatia. The sniper rifle's zoom labels (2x, 10x)
   are set in Overpass (`port/assets/fonts`).
+- **The menus' mouse cursor** (the blue arrow the menus show for the
+  mouse): by pugzysixtyfour (`port/assets/cursor`).
 
 ## Third-party art
 
@@ -18,3 +20,6 @@
   [Lucide](https://lucide.dev) 1.53.0, copyright (c) 2026 Lucide Icons and
   Contributors, under the ISC licence
   (`port/assets/icons/lucide/LICENSE`).
+- **The Mods menu's warning icons** (a mod out of its requested order, and
+  a mod that cannot be played): `triangle-alert` and `circle-x` from
+  [Lucide](https://lucide.dev) 1.53.0, under the same licence.

LICENSE

@@ -0,0 +1,661 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU Affero General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<https://www.gnu.org/licenses/>.

README.md

@@ -1,22 +1,25 @@
 <p align="center">
-  <img src="port/android/steam_frame_grid/library.png" width="640" alt="Ringfall: Mjolnir VR">
+  <img src="port/android/steam_frame_grid/library.png" width="640" alt="Mjolnir VR">
 </p>
 
-# Ringfall: Mjolnir VR
+# Mjolnir VR
 
 **A VR mod for Halo: Combat Evolved** (the original Xbox game) on the
 **Meta Quest 3 / 3S** and the **Steam Frame**. Play the campaign and
 multiplayer in full 6DoF virtual reality, with your hands in the game.
 
-Ringfall: Mjolnir VR runs on your headset by itself, without a PC. It
+Mjolnir VR runs on your headset by itself, without a PC. It
 brings no game files: it uses a disc image of **your own, purchased copy**
 of the game.
 
-> **Unofficial fan project.** Ringfall: Mjolnir VR is a free,
+> **Unofficial fan project.** Mjolnir VR is a free,
 > non-commercial fan project. It is not affiliated with, endorsed,
 > sponsored or approved by Microsoft, Xbox Game Studios, Halo Studios or
 > Bungie. See [Legal](#legal).
 
+Until build 313 it was called *Ringfall: Mjolnir VR*. Installed builds
+update to the new name by themselves, and the old links lead here.
+
 ## Contents
 
 - [What you get](#what-you-get)
@@ -68,7 +71,8 @@ of the game.
 - A **Meta Quest 3 / 3S** or a **Steam Frame**.
 - A **disc image** (`.iso` or `.xiso`) of **Halo: Combat Evolved for the
   original Xbox**, made from **a disc you own**. Any region and version
-  works.
+  works. The game plays in the disc's language; on the European disc in
+  Spanish and Italian it takes your headset's language (else the first).
 
 This project does not include, link to or help find game files. Please
 do not ask for or share disc images in issues or discussions; such posts
@@ -85,14 +89,14 @@ that it updates itself.
 2. **Install [SideQuest](https://sidequestvr.com/setup-howto)** (the
    "Advanced Installer") on your computer and connect the Quest with a
    USB cable. In the headset, allow USB debugging for this computer.
-3. **Download `RingfallMjolnirVR.apk`** from the
+3. **Download `MjolnirVR.apk`** from the
    [latest release](../../releases/latest) and drag it onto the SideQuest
    window. It installs the game.
 4. **Copy your disc image** to the Quest's `Download` folder: in
    SideQuest, open the file manager (the folder icon), go to `Download`
    and drag the `.iso` file in.
 5. **In the headset**, open your *Library*, choose *Unknown Sources* and
-   start **Ringfall: Mjolnir VR**. Select **Choose disc image** and pick
+   start **Mjolnir VR**. Select **Choose disc image** and pick
    your file in `Download`. The game copies what it needs (about 1.8 GB,
    a minute or two) and starts.
 
@@ -107,17 +111,18 @@ No computer and no keyboard needed.
    *Switch to Desktop*.
 2. **Put your disc image** in the `Downloads` folder (for example from a
    USB stick or memory card with the file manager, Dolphin).
-3. **Download `Install-Ringfall-Mjolnir-VR.desktop`** from the
+3. **Download `Install-Mjolnir-VR.desktop`** from the
    [latest release](../../releases/latest) with the web browser.
 4. **Open it**: in Dolphin, open `Downloads` and double-click the file.
    If you are asked whether to run it, choose to continue.
 5. **Answer the dialogs.** The installer finds your disc image, copies
-   what the game needs, adds **Ringfall: Mjolnir VR** to your Steam
+   what the game needs, adds **Mjolnir VR** to your Steam
    library and offers to switch back to Gaming Mode.
-6. Start **Ringfall: Mjolnir VR** from your library (under *Non-Steam*).
+6. Start **Mjolnir VR** from your library (under *Non-Steam*).
 
-To update, open the same file in Desktop Mode again; your settings,
-saves and game data stay. More about the Steam Frame:
+The game updates itself: when a new version is out, it is downloaded
+while you play and used from the next start on. Your settings, saves and
+game data stay. More about the Steam Frame:
 [port/android/STEAM_FRAME.md](port/android/STEAM_FRAME.md).
 
 ## Playing
@@ -153,7 +158,7 @@ telemetry.
 
 ## Credits
 
-Ringfall: Mjolnir VR stands on the work of others:
+Mjolnir VR stands on the work of others:
 
 - **[OpenCE](https://github.com/OpenCommunityEdition/OpenCE)** (Open
   Community Edition): the port of the decompiled game to Linux, Windows
@@ -168,8 +173,9 @@ Ringfall: Mjolnir VR stands on the work of others:
 - **[HaloCE-VR](https://github.com/astromaddie/HaloCE-VR)** by astromaddie
   (CC0): the Steam Frame work, whose findings (such as quieting Mesa's
   trace markers) are used here.
-- **[extract-xiso](https://github.com/XboxDev/extract-xiso)**: the disc
-  image readers follow its format handling.
+- **[xboxdevwiki](https://xboxdevwiki.net/XDVDFS)**: its description of
+  the Xbox's disc file system, which the disc image readers are written
+  from.
 - The libraries and fonts in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
 
 Thank you all.
@@ -183,7 +189,7 @@ port it is built on.
 
 ## Legal
 
-Ringfall: Mjolnir VR is an unofficial, free, non-commercial fan project.
+Mjolnir VR is an unofficial, free, non-commercial fan project.
 It is not affiliated with, endorsed, sponsored or approved by Microsoft
 Corporation, Xbox Game Studios, Halo Studios or Bungie. Halo, Halo: Combat
 Evolved and Xbox are trademarks of Microsoft Corporation; they are named
@@ -196,6 +202,26 @@ distributed. You need your own, legally purchased copy of the game. If
 you enjoy this mod, please support the creators of the original by buying
 their games.
 
-This project's own code is released under [CC0 1.0](LICENSE.md), as the
-decompilation it builds on. Third-party code and fonts keep their own
-licenses: see [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
+### Licence
+
+Mjolnir VR is free software: you can give it to others and change
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, version 3 of the License or (at your option)
+any later version (`AGPL-3.0-or-later`), as OpenCE, which it builds on, is.
+It comes with no warranty. The full text is in [LICENSE](LICENSE).
+
+- **From build 312 on.** The AGPL applies from the commit that took in
+  OpenCE's change of licence (19 October 2026), and to each release built
+  from it or a later one. Earlier releases, and the source at every earlier
+  commit, were released under [CC0 1.0](LICENSES/CC0-1.0.txt) and stay
+  that way.
+- **Hosts and servers.** If you change the game and let other persons play
+  with your version over a network (for example, as the host of an
+  internet game), the AGPL asks you to offer them the source of your
+  version. The game as released has its source here, and each release's
+  source is its tag (`build-<n>`).
+- **Third-party code and fonts** keep their own licences: see
+  [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
+- **Halo is not covered.** The licence covers the work of this project's
+  and OpenCE's authors. It gives no rights in Halo, its maps or anything
+  else that Microsoft owns.

THIRD_PARTY_NOTICES.md

@@ -1,14 +1,16 @@
 # Third-party notices
 
-Ringfall: Mjolnir VR's own code is released under [CC0 1.0](LICENSE.md).
-It includes or builds on the following, under their own licenses; each
-license's full text is in the file named.
+Mjolnir VR is released under the GNU Affero General Public
+License, version 3 or later ([LICENSE](LICENSE)); releases before build 312
+were released under [CC0 1.0](LICENSES/CC0-1.0.txt). It includes or builds
+on the following, under their own licenses; each license's full text is in
+the file named.
 
 ## Code
 
 | Component | Used for | License | Text |
 | --- | --- | --- | --- |
-| [OpenCE](https://github.com/OpenCommunityEdition/OpenCE) and the decompilation ([bnunu/halo-1](https://github.com/bnunu/halo-1), [punpckhdq/halo](https://github.com/punpckhdq/halo)) | the game's code, the port | CC0 1.0 | [LICENSE.md](LICENSE.md) |
+| [OpenCE](https://github.com/OpenCommunityEdition/OpenCE) and the decompilation ([bnunu/halo-1](https://github.com/bnunu/halo-1), [punpckhdq/halo](https://github.com/punpckhdq/halo)) | the game's code, the port | AGPL 3.0 or later (OpenCE from 19 October 2026, punpckhdq/halo from 17 October 2026; CC0 1.0 before); bnunu/halo-1: CC0 1.0 | [LICENSE](LICENSE), [LICENSES/CC0-1.0.txt](LICENSES/CC0-1.0.txt) |
 | [HaloCE-Quest-VR](https://github.com/moistman42069/HaloCE-Quest-VR) | the arm IK, forearm twist and finger poses (`port/linux/game/vr_arms.c`) | CC0 1.0 | (its repository) |
 | [HaloCE-VR](https://github.com/astromaddie/HaloCE-VR) | Steam Frame findings | CC0 1.0 | (its repository) |
 | [SDL 3](https://libsdl.org) | windows, input, sound | zlib | (in SDL's source, `LICENSE.txt`) |
@@ -22,11 +24,11 @@ license's full text is in the file named.
 | [tomlc17](https://github.com/cktan/tomlc17) | reading `config.toml` | MIT | [port/third_party/tomlc17/LICENSE](port/third_party/tomlc17/LICENSE) |
 | [stb](https://github.com/nothings/stb) | drawing the game's text sharply (stb_truetype) | MIT or public domain | [port/third_party/stb/LICENSE](port/third_party/stb/LICENSE) |
 | [SMAA](https://www.iryoku.com/smaa/) | anti-aliasing (flat screens; off in VR) | MIT | [port/third_party/smaa/LICENSE](port/third_party/smaa/LICENSE) |
-| [extract-xiso](https://github.com/XboxDev/extract-xiso) | reading disc images (followed by `XisoExtractor.java`, `steam_frame_xiso.py`, `xiso.c`) | BSD-style (in@fishtank.com) | [port/third_party/extract-xiso/LICENSE.TXT](port/third_party/extract-xiso/LICENSE.TXT) |
 
-The disc image readers include this acknowledgement, as extract-xiso's
-license asks: *This product includes software developed by in
-<in@fishtank.com>.*
+The disc image readers (`XisoExtractor.java`, `steam_frame_xiso.py`,
+`xiso.c`) are written from a description of the Xbox's disc file system
+([xboxdevwiki's XDVDFS page](https://xboxdevwiki.net/XDVDFS)), not from
+extract-xiso, which earlier releases followed.
 
 ## Fonts
 

configure.py

@@ -16,6 +16,11 @@ from tools.linux_build import check_profile_options, generate_linux_build, linux
 from tools.web_build import generate_web_build, web_configure_inputs
 from tools.windows_build import generate_windows_build, windows_configure_inputs
 
+
+def is_windows() -> bool:
+    return os.name == "nt"
+
+
 # arguments
 parser = argparse.ArgumentParser()
 parser.add_argument(
@@ -89,6 +94,38 @@ parser.add_argument(
     type=str,
     help="Emscripten's emcc for `ninja web` (default: emcc on the PATH, then EMSDK's or ~/emsdk's)",
 )
+
+# no need to spam those extra flags when running on Windows
+if not is_windows():
+    parser.add_argument(
+        "--windows-cross",
+        action="store_true",
+        help="generate the Windows build (`ninja windows`) on Linux, cross-compiling "
+        "with clang against an MSVC toolchain (--windows-vctools-dir and --windows-sdk-dir), "
+        "and make it the default target",
+    )
+    parser.add_argument(
+        "--windows-cc",
+        metavar="BINARY",
+        help="compiler for the Windows cross build, `ninja windows` (default: clang). "
+             "Only clang is supported for now.",
+    )
+    parser.add_argument(
+        "--windows-vctools-dir",
+        metavar="DIR",
+        type=Path,
+        help="the Visual C++ tools of the MSVC toolchain a --windows-cross build compiles "
+        "and links against: the versioned folder under VC/Tools/MSVC, the one with `include` "
+        "and `lib` (default: VCToolsInstallDir)",
+    )
+    parser.add_argument(
+        "--windows-sdk-dir",
+        metavar="DIR",
+        type=Path,
+        help="the Windows SDK a --windows-cross build compiles and links against: the "
+        "folder with `Include` and `Lib`, each with a versioned folder (default: WindowsSdkDir)",
+    )
+
 args = parser.parse_args()
 try:
     check_profile_options(args.profile, args.pgo)
@@ -110,10 +147,11 @@ sln = SimpleNamespace(
     android_guest_cc=args.android_guest_cc,
     web_emcc=args.web_emcc,
 )
-
-
-def is_windows() -> bool:
-    return os.name == "nt"
+if not is_windows():
+    sln.windows_cc = args.windows_cc
+    sln.windows_cross = args.windows_cross
+    sln.windows_vctools_dir = args.windows_vctools_dir
+    sln.windows_sdk_dir = args.windows_sdk_dir
 
 
 # build.ninja
@@ -159,7 +197,7 @@ n.newline()
 
 # the build for this computer, where it could be generated (the Windows
 # build is left out when SDL cannot be fetched, for instance)
-default = "windows" if is_windows() else "linux"
+default = "windows" if is_windows() or sln.windows_cross else "linux"
 if f"\nbuild {default}: " in out.getvalue():
     n.comment("Default rule: the build for this computer")
     n.default(default)

deploy/docker/.dockerignore

@@ -0,0 +1,3 @@
+*
+!healthz.sh
+!*.zip

deploy/docker/.gitignore

@@ -0,0 +1,2 @@
+# a release zip copied here to build the image from (README.md, "Building it")
+*.zip

deploy/docker/Dockerfile

@@ -0,0 +1,60 @@
+# syntax=docker/dockerfile:1
+#
+# The dedicated server (docs/dedicated_server.md) as a container image, made
+# from a release's halo-linux-release.zip (the portable build: halo, its
+# libSDL3.so.0, brokers.txt, masters.txt):
+#
+#   docker build -t opence-server deploy/docker
+#   docker build -t opence-server --build-arg RELEASE=https://github.com/OpenCommunityEdition/OpenCE/releases/download/build-206/halo-linux-release.zip deploy/docker
+#   docker build -t opence-server --build-arg RELEASE=halo-linux-release.zip deploy/docker   (a zip in deploy/docker)
+#
+# The game data is never in the image: mount the folder that holds maps/ at
+# /data, read-only. /state is the only folder the server writes (config.toml,
+# the save root with its map cache, the logs), so the root can be read-only.
+# deploy/docker/README.md says how to run it.
+
+FROM debian:bookworm-slim AS release
+RUN apt-get update \
+ && apt-get install -y --no-install-recommends unzip \
+ && rm -rf /var/lib/apt/lists/*
+# a URL, or a file beside this Dockerfile
+ARG RELEASE=https://github.com/OpenCommunityEdition/OpenCE/releases/latest/download/halo-linux-release.zip
+ADD ${RELEASE} /tmp/halo-linux-release.zip
+COPY healthz.sh /opt/opence/healthz.sh
+RUN unzip -q /tmp/halo-linux-release.zip -d /opt/opence \
+ && test -f /opt/opence/halo \
+ && chmod 0755 /opt/opence/halo /opt/opence/healthz.sh \
+ && if [ -f /opt/opence/halo-server ]; then chmod 0755 /opt/opence/halo-server; fi
+
+FROM debian:bookworm-slim
+# The 32-bit C runtime; the release's own libSDL3.so.0 needs nothing more for
+# a server, which opens no window or sound device. ca-certificates: the
+# master servers and the update check are HTTPS.
+RUN dpkg --add-architecture i386 \
+ && apt-get update \
+ && apt-get install -y --no-install-recommends libc6:i386 libgcc-s1:i386 ca-certificates \
+ && rm -rf /var/lib/apt/lists/* \
+ && groupadd -g 10001 opence \
+ && useradd -u 10001 -g 10001 -d /state -M -s /usr/sbin/nologin opence \
+ && mkdir -p /data /state \
+ && chown 10001:10001 /state
+COPY --from=release /opt/opence /opt/opence
+ENV HALO_SERVER=1 \
+    HALO_CONFIG_FILE=/state/config.toml \
+    HALO_DATA_ROOT=/data \
+    HALO_SAVE_ROOT=/state/saves \
+    HALO_LOG_ROOT=/state/logs \
+    HALO_NET_TUNNEL_PORT=2302 \
+    HALO_SERVER_WEB_BIND=0.0.0.0 \
+    HALO_SERVER_WEB_PORT=8080 \
+    HOME=/state
+VOLUME ["/state"]
+# Internet play's tunnel, and the web page, API and RCON (publish it on the
+# host's loopback, or behind a proxy with TLS). System link's 5150, 5151 and
+# 5153 are for a local network only.
+EXPOSE 2302/udp 8080/tcp
+USER 10001:10001
+WORKDIR /state
+HEALTHCHECK --interval=15s --timeout=3s --start-period=60s --retries=3 CMD ["/opt/opence/healthz.sh"]
+STOPSIGNAL SIGTERM
+ENTRYPOINT ["/opt/opence/halo", "--server"]

deploy/docker/README.md

@@ -0,0 +1,134 @@
+# The dedicated server in a container
+
+`ghcr.io/opencommunityedition/opence-server` is the dedicated server
+(`docs/dedicated_server.md`) as a container image: a release's
+`halo-linux-release.zip` on Debian 12 with the 32-bit C runtime, run as
+`halo --server` by the user 10001. CI builds it from each release
+(`.github/workflows/server-image.yml`) and signs it with cosign; the tags are
+`latest`, the release's (`build-206`) and `sha-<commit>`.
+
+The game data is never in the image. Mount the folder that holds `maps/`
+(from your own copy of the game: port/linux/README.md, "Game data") at
+`/data`, read-only. Without it the server exits with code 2 and says which
+maps it looked for.
+
+## Running it
+
+```sh
+docker run -d --name halo --restart unless-stopped \
+  --read-only --cap-drop ALL --security-opt no-new-privileges --tmpfs /tmp \
+  -p 2302:2302/udp -p 127.0.0.1:8080:8080 \
+  -v /srv/halo/data:/data:ro -v halo-state:/state \
+  -e HALO_SERVER_NAME="My server" \
+  -e HALO_SERVER_ROTATION="bloodgulch:ctf, sidewinder:team_slayer" \
+  -e HALO_SERVER_WEB_PASSWORD=changeme-please \
+  ghcr.io/opencommunityedition/opence-server:latest
+docker logs -f halo
+```
+
+Or with Compose: `compose.yaml` beside this file runs the same, with the
+settings taken from the shell or a `.env` file
+(`HALO_DATA=/srv/halo/data`, `HALO_SERVER_NAME=...`). Its `https` profile
+adds Caddy in front of the web port, with a certificate for
+`HALO_WEB_DOMAIN`:
+
+```sh
+HALO_DATA=/srv/halo/data docker compose -f deploy/docker/compose.yaml up -d
+HALO_WEB_DOMAIN=halo.example.org docker compose -f deploy/docker/compose.yaml --profile https up -d
+```
+
+The Compose file puts both on a network of its own, `172.30.80.0/24`, with
+Caddy at the fixed address `172.30.80.10` and the server's
+`HALO_SERVER_WEB_TRUSTED_PROXY` set to it: the server believes Caddy's
+`X-Forwarded-For`, `-Host` and `-Proto`, so its rate limits and log name the
+visitor rather than Caddy, and the session cookie is `Secure`. If that
+subnet overlaps one of the host's, change the subnet, Caddy's
+`ipv4_address` and the variable together.
+
+`docker stop` sends SIGTERM: the game in progress goes to its postgame,
+the players are told, the listing is withdrawn, and the server exits 0
+within the 15 seconds Compose waits (`docker stop -t 15` otherwise).
+
+## Folders
+
+| Path | What |
+| --- | --- |
+| `/opt/opence` | The release: `halo`, `libSDL3.so.0`, `brokers.txt`, `masters.txt`, `healthz.sh`, the licences (read-only) |
+| `/data` | The game data: `maps/`, and if you have them `custom_maps/`, `gametypes/` and `init.txt` (yours, read-only) |
+| `/state` | The only folder written: `config.toml` (`HALO_CONFIG_FILE`), `publisher.key` beside it, the save root `saves/` with the map cache (about 115 MB), `logs/` (`debug.txt`, `bans.txt`, `cheaters.txt`) |
+
+The image sets `HALO_CONFIG_FILE=/state/config.toml` rather than linking
+`config.toml` beside the executable into the volume: the settings file is
+then in the volume from the first start, and nothing in `/opt/opence` is
+written. The server writes every setting there at the first start, with
+the generated web password if none was given.
+
+## Settings
+
+Every setting is an environment variable (port/linux/README.md, "Dedicated
+server", and docs/dedicated_server.md). A variable that is set wins over
+`config.toml`, and the web page's settings cannot change it. The image sets:
+
+| Variable | Value |
+| --- | --- |
+| `HALO_SERVER` | `1` |
+| `HALO_CONFIG_FILE` | `/state/config.toml` |
+| `HALO_DATA_ROOT` | `/data` |
+| `HALO_SAVE_ROOT` | `/state/saves` |
+| `HALO_LOG_ROOT` | `/state/logs` |
+| `HALO_NET_TUNNEL_PORT` | `2302` |
+| `HALO_SERVER_WEB_BIND` | `0.0.0.0` (within the container; publish the port on `127.0.0.1` or behind TLS) |
+| `HALO_SERVER_WEB_PORT` | `8080` |
+
+The ones most often given: `HALO_SERVER_NAME`, `HALO_SERVER_ROTATION`,
+`HALO_SERVER_MAX_PLAYERS`, `HALO_SERVER_PASSWORD`, `HALO_SERVER_PUBLIC`,
+`HALO_SERVER_MOTD`, `HALO_SERVER_WEB_PASSWORD`, `HALO_NET_PUBLIC_ADDRESS`,
+`HALO_SERVER_PUBLISHER_KEY` (the master servers' key, as 64 hex
+characters; `docker run --rm -v halo-state:/state <image> --keygen` makes one
+into the volume instead), `HALO_SERVER_INSTANCE`, `HALO_SERVER_REGION`,
+`HALO_SERVER_LOG_FORMAT=json`.
+
+A tunnel port other than 2302 is published as the same number on both sides
+(`-e HALO_NET_TUNNEL_PORT=2303 -p 2303:2303/udp`), as the server offers its
+own port to joiners. Behind a NAT that STUN cannot see through, give the
+public address and port in `HALO_NET_PUBLIC_ADDRESS`.
+
+## Health
+
+`HEALTHCHECK` runs `/opt/opence/healthz.sh`, which asks `GET /healthz` on
+the web port (bash's `/dev/tcp`: the image has no curl) and is healthy on a
+200: the server is hosting (lobby, loading, playing or postgame) and its
+frames run. With `HALO_SERVER_WEB_PORT=0` it always passes.
+
+## Building it
+
+```sh
+docker build -t opence-server deploy/docker                     # the latest release
+docker build -t opence-server --build-arg RELEASE=https://github.com/OpenCommunityEdition/OpenCE/releases/download/build-206/halo-linux-release.zip deploy/docker
+```
+
+A build of your own (`python tools/ci_build.py linux release` leaves
+`dist/halo-linux-release/`) goes in as a zip beside the Dockerfile:
+
+```sh
+(cd dist/halo-linux-release && zip -qr ../../deploy/docker/halo-linux-release.zip .)
+docker build -t opence-server --build-arg RELEASE=halo-linux-release.zip deploy/docker
+```
+
+`RELEASE` is a URL or a file beside the Dockerfile. The image is 32-bit
+x86 and runs on amd64 hosts only.
+
+## Networking
+
+Bridge networking works for internet play: the tunnel port is published one
+to one, and the server needs no hole punching of its own. System link
+(UDP 5150 and 5151, TCP 5150 and 5153) finds other machines only with
+`--network host`.
+
+Verify an image's signature:
+
+```sh
+cosign verify ghcr.io/opencommunityedition/opence-server:latest \
+  --certificate-identity-regexp '^https://github\.com/OpenCommunityEdition/OpenCE/\.github/workflows/server-image\.yml@' \
+  --certificate-oidc-issuer https://token.actions.githubusercontent.com
+```

deploy/docker/compose.yaml

@@ -0,0 +1,92 @@
+# The dedicated server with Docker Compose (deploy/docker/README.md):
+#
+#   docker compose -f deploy/docker/compose.yaml up -d
+#   docker compose -f deploy/docker/compose.yaml --profile https up -d     (with Caddy in front of the web port)
+#
+# HALO_DATA is the folder that holds maps/ (and custom_maps/, gametypes/),
+# mounted read-only; settings come from the environment below or from a
+# .env file beside this one.
+name: opence
+
+services:
+  server:
+    image: ${OPENCE_IMAGE:-ghcr.io/opencommunityedition/opence-server:latest}
+    restart: unless-stopped
+    read_only: true
+    cap_drop: [ALL]
+    security_opt: ["no-new-privileges:true"]
+    tmpfs:
+      - /tmp
+    ports:
+      - "${HALO_NET_TUNNEL_PORT:-2302}:${HALO_NET_TUNNEL_PORT:-2302}/udp"
+      # (the web page on the host's loopback only; Caddy reaches it on the
+      # compose network)
+      - "127.0.0.1:${HALO_SERVER_WEB_PORT:-8080}:${HALO_SERVER_WEB_PORT:-8080}/tcp"
+    volumes:
+      - ${HALO_DATA:-./data}:/data:ro
+      - state:/state
+    # A variable named without a value is passed only when it is set (in the
+    # shell or .env): one that is set wins over config.toml, and sv_set
+    # cannot change it.
+    environment:
+      - HALO_NET_TUNNEL_PORT=${HALO_NET_TUNNEL_PORT:-2302}
+      - HALO_SERVER_WEB_PORT=${HALO_SERVER_WEB_PORT:-8080}
+      - HALO_SERVER_NAME
+      - HALO_SERVER_ROTATION
+      - HALO_SERVER_MAX_PLAYERS
+      - HALO_SERVER_PASSWORD
+      - HALO_SERVER_PUBLIC
+      - HALO_SERVER_MOTD
+      # (8 characters or more; unset: one is made at the first start, printed
+      # in the log and kept in the state volume's config.toml)
+      - HALO_SERVER_WEB_PASSWORD
+      - HALO_NET_PUBLIC_ADDRESS
+      - HALO_SERVER_PUBLISHER_KEY
+      - HALO_SERVER_INSTANCE
+      - HALO_SERVER_REGION
+      - HALO_SERVER_LOG_FORMAT
+      # Caddy's address on the network below (the https profile): its
+      # X-Forwarded-For, -Host and -Proto are believed, so the page's rate
+      # limits and log name the visitor, and its session cookie is Secure.
+      # Nothing else has this address.
+      - HALO_SERVER_WEB_TRUSTED_PROXY=172.30.80.10
+    networks:
+      - opence
+    stop_grace_period: 15s
+
+  # HTTPS for the web page, with a certificate from Let's Encrypt for
+  # HALO_WEB_DOMAIN (which must resolve to this host, ports 80 and 443 open).
+  caddy:
+    image: caddy:2
+    profiles: [https]
+    restart: unless-stopped
+    depends_on: [server]
+    ports:
+      - "80:80/tcp"
+      - "443:443/tcp"
+      - "443:443/udp"
+    command: ["caddy", "reverse-proxy", "--from", "${HALO_WEB_DOMAIN:-halo.example.org}", "--to", "server:${HALO_SERVER_WEB_PORT:-8080}"]
+    volumes:
+      - caddy-data:/data
+      - caddy-config:/config
+    networks:
+      opence:
+        # (server.web_trusted_proxy above; outside the range Docker hands
+        # out, so no other container takes it)
+        ipv4_address: 172.30.80.10
+
+# A fixed subnet, so that Caddy's address is known in advance. Containers
+# other than Caddy get addresses from ip_range only. Change it (and the two
+# addresses above) if it overlaps a network of the host's.
+networks:
+  opence:
+    ipam:
+      config:
+        - subnet: 172.30.80.0/24
+          ip_range: 172.30.80.128/25
+          gateway: 172.30.80.1
+
+volumes:
+  state:
+  caddy-data:
+  caddy-config:

deploy/docker/healthz.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+# The image's health check: GET /healthz on the web port, healthy on a 200
+# (the server answers 200 while it hosts and its frames run, 503 otherwise).
+# Bash's /dev/tcp, as the image has no curl.
+port="${HALO_SERVER_WEB_PORT:-8080}"
+# (no web port: nothing to ask)
+if [ -z "$port" ] || [ "$port" = 0 ]; then
+	exit 0
+fi
+{ exec 3<>"/dev/tcp/127.0.0.1/$port"; } 2>/dev/null || exit 1
+printf 'GET /healthz HTTP/1.1\r\nHost: 127.0.0.1:%s\r\nConnection: close\r\n\r\n' "$port" >&3 || exit 1
+IFS=' ' read -r -t 3 version status _ <&3 || exit 1
+exec 3<&-
+case "$version" in
+HTTP/1.*) ;;
+*) exit 1 ;;
+esac
+[ "$status" = 200 ]

deploy/gametypes/btb_slayer.toml

@@ -0,0 +1,29 @@
+# Big team slayer: first team to 50 kills, vehicles as Halo PC places them.
+# Play it with server.rotation entries such as bloodgulch:btb_slayer.
+base = "team_slayer"
+name = "BTB Slayer"
+
+[universal]
+teams = true
+score_to_win = 50
+lives = 0
+respawn_time = 5
+health = 100
+weapon_set = "normal"
+vehicle_set = "default"
+radar = true
+friend_indicators = true
+
+[options]
+time_limit = 20
+friendly_fire = "shields_only"
+friendly_fire_penalty = 5
+vehicle_respawn_time = 60
+auto_team_balance = true
+radar_players = "friends"
+team_vehicles = "pc"
+
+[slayer]
+no_death_bonus = false
+no_kill_penalty = false
+kill_in_order = false

deploy/gametypes/ctf_classic.toml

@@ -0,0 +1,27 @@
+# Capture the flag as players remember it: three captures, the flag must be
+# at home to score.
+base = "ctf"
+name = "Classic CTF"
+
+[universal]
+teams = true
+score_to_win = 3
+respawn_time = 5
+weapon_set = "normal"
+vehicle_set = "default"
+radar = true
+
+[options]
+time_limit = 25
+friendly_fire = "off"
+vehicle_respawn_time = 90
+auto_team_balance = true
+radar_players = "friends"
+team_vehicles = "pc"
+
+[ctf]
+assault = false
+reset_on_capture = false
+flag_must_reset = false
+flag_at_home_to_score = true
+single_flag_time = 0

deploy/gametypes/king_moving.toml

@@ -0,0 +1,17 @@
+# King of the hill whose hill moves about the map, for teams.
+base = "team_king"
+name = "Moving Hill"
+
+[universal]
+teams = true
+score_to_win = 3
+respawn_time = 5
+radar = true
+
+[options]
+time_limit = 15
+friendly_fire = "off"
+auto_team_balance = true
+
+[king]
+moving_hill = true

deploy/gametypes/lone_wolves.toml

@@ -0,0 +1,23 @@
+# Free for all slayer to 25 kills, starting with a pistol and an assault rifle.
+base = "slayer"
+name = "Lone Wolves"
+
+[universal]
+teams = false
+score_to_win = 25
+respawn_time = 3
+health = 100
+radar = false
+
+[options]
+time_limit = 15
+radar_players = "none"
+loadout = "custom"
+primary_weapon = "pistol"
+secondary_weapon = "assault_rifle"
+team_vehicles = "pc"
+
+[slayer]
+no_death_bonus = false
+no_kill_penalty = false
+kill_in_order = false

deploy/halo-server

@@ -0,0 +1,2 @@
+#!/bin/sh
+exec "$(dirname "$0")/halo" --server "$@"

deploy/helm/opence-server/.helmignore

@@ -0,0 +1,3 @@
+# Not part of the packaged chart: unit tests and CI values files.
+tests/
+ci/

deploy/helm/opence-server/Chart.yaml

@@ -0,0 +1,17 @@
+apiVersion: v2
+name: opence-server
+description: >-
+  The OpenCE dedicated server: a headless Halo: Combat Evolved host that plays games one after
+  another, with no window, sound or player of its own. The game data (maps) is mounted from a
+  volume you provide.
+type: application
+version: 0.1.0
+kubeVersion: ">=1.29.0-0"
+# Informational only: which image runs is set by image.repository, image.tag and image.digest.
+appVersion: "latest"
+home: https://github.com/OpenCommunityEdition/OpenCE
+sources:
+  - https://github.com/OpenCommunityEdition/OpenCE/tree/main/deploy/helm/opence-server
+keywords:
+  - halo
+  - game-server

deploy/helm/opence-server/README.md

@@ -0,0 +1,111 @@
+# opence-server
+
+The OpenCE dedicated server (`docs/dedicated_server.md`) on Kubernetes: one
+pod of the image `ghcr.io/opencommunityedition/opence-server`
+(`deploy/docker`), its tunnel port behind a UDP Service, its web page behind
+a ClusterIP Service, probes on `GET /healthz`, and a NetworkPolicy.
+
+The game data is never in the image or the chart: give a volume that holds
+`maps/` from your own copy of the game.
+
+## Quick start
+
+```sh
+kubectl create namespace halo
+# a claim (or an NFS export) holding maps/, read-only is enough
+helm install halo deploy/helm/opence-server -n halo \
+  --set gameData.existingClaim=halo-maps \
+  --set server.name="My server" \
+  --set persistence.enabled=true
+kubectl -n halo logs -f deploy/halo-opence-server
+```
+
+The admin password of the web page is made at the first install and kept in
+the release's Secret (NOTES.txt prints the command that shows it), unless
+`web.password` or `web.existingSecret` gives one. Reach the page with
+`kubectl -n halo port-forward deploy/halo-opence-server 8080`, or put an
+Ingress with TLS in front of the `-web` Service (and allow its namespace
+in `networkPolicy.webFrom`).
+
+## Values
+
+`values.yaml` describes each value. Each one under `server`, `web`,
+`network` and `publisherKey` is one of the server's `HALO_*` variables:
+
+| Value | Variable |
+| --- | --- |
+| `server.name` | `HALO_SERVER_NAME` (15 characters) |
+| `server.rotation` (a list) | `HALO_SERVER_ROTATION`, joined with commas |
+| `server.maxPlayers` | `HALO_SERVER_MAX_PLAYERS` |
+| `server.public` | `HALO_SERVER_PUBLIC` |
+| `server.lobbySeconds` | `HALO_SERVER_LOBBY_SECONDS` |
+| `server.motd` | `HALO_SERVER_MOTD` |
+| `server.logFormat` | `HALO_SERVER_LOG_FORMAT` |
+| `server.instance`, `server.region` | `HALO_SERVER_INSTANCE`, `HALO_SERVER_REGION` |
+| `server.masterPublish` | `HALO_SERVER_MASTER_PUBLISH` |
+| `server.password` | `HALO_SERVER_PASSWORD` (from a Secret) |
+| `publisherKey` | `HALO_SERVER_PUBLISHER_KEY` (from a Secret) |
+| `web.port` | `HALO_SERVER_WEB_PORT` (0: none, and no probes) |
+| `web.password`, `web.existingSecret` | `HALO_SERVER_WEB_PASSWORD` (from a Secret) |
+| `web.moderatorPassword` | `HALO_SERVER_WEB_MODERATOR_PASSWORD` (from a Secret) |
+| `network.tunnelPort` | `HALO_NET_TUNNEL_PORT` |
+| `network.publicAddress` | `HALO_NET_PUBLIC_ADDRESS` |
+| `customMaps` | `HALO_CUSTOM_MAPS_ROOT=/custom_maps` |
+
+The chart also sets `HALO_SERVER=1`, `HALO_CONFIG_FILE=/state/config.toml`,
+`HALO_DATA_ROOT=/data`, `HALO_SAVE_ROOT=/state/saves`,
+`HALO_LOG_ROOT=/state/logs`, `HALO_SERVER_CONSOLE=false` (a pod has no
+standard input) and, with a web port, `HALO_SERVER_WEB_BIND=0.0.0.0` (the
+kubelet's probes reach the pod's address). Any other setting goes in
+`extraEnv`, which comes last and so overrides the chart's.
+
+A variable the chart sets wins over `config.toml`, and neither `sv_set` nor
+the web page's settings can change it. So the values under `server` are
+unset by default (empty, `[]` or `null`): the chart then sets no variable,
+and the setting is `config.toml`'s (or the server's default, which
+`values.yaml` names), changeable from the web page and kept in the state
+volume. Give a value only for a setting you want fixed.
+
+## Web password
+
+With neither `web.password` nor `web.existingSecret`, the chart makes an
+admin password at the first install and keeps it in the release's Secret;
+on an upgrade it finds that Secret again with `lookup`. `helm template`,
+and GitOps tools that render with it (Argo CD, Flux's dry runs,
+Kustomize's Helm support), have no cluster to look in: each render makes a
+new password, and the Secret changes at every sync. There, create the Secret
+yourself and name it:
+
+```sh
+kubectl -n halo create secret generic halo-web \
+  --from-literal=web-password="$(openssl rand -base64 18)" \
+  --from-literal=web-moderator-password="$(openssl rand -base64 18)"
+helm template halo deploy/helm/opence-server -n halo \
+  --set gameData.existingClaim=halo-maps --set web.existingSecret=halo-web
+```
+
+(or a SealedSecret or an External Secrets object of the same name).
+`web.key` and `web.moderatorKey` name its keys; the moderator's is
+optional.
+
+## Networking
+
+`service.type` is `LoadBalancer` with `externalTrafficPolicy: Local` by
+default, so that the server sees the players' own addresses (its bans and
+limits are by address). `NodePort` works too; `ClusterIP` is for tests. The
+tunnel's Service port and `network.tunnelPort` should be the same number, as
+the server offers its own port to joiners; behind a NAT that STUN cannot see
+through, give the forwarded address in `network.publicAddress`.
+
+The NetworkPolicy lets anyone reach the tunnel port and only `webFrom` the
+web port, and lets the pod reach DNS, TCP 1883 (the MQTT brokers) and 443
+(the master servers) and any UDP port on public addresses.
+
+## Tests
+
+```sh
+helm lint deploy/helm/opence-server --strict -f deploy/helm/opence-server/ci/full-values.yaml
+helm unittest deploy/helm/opence-server
+```
+
+`.github/workflows/server-image.yml` runs both.

deploy/helm/opence-server/ci/full-values.yaml

@@ -0,0 +1,87 @@
+# Every option the chart has, for lint and the schema check (not installed: the NFS server is made
+# up).
+image:
+  tag: build-206@sha256:0000000000000000000000000000000000000000000000000000000000000000
+imagePullSecrets:
+  - name: registry-credentials
+gameData:
+  nfs:
+    server: nfs.example.com
+    path: /exports/halo
+  subPath: xbox
+customMaps:
+  existingClaim: halo-custom-maps
+server:
+  name: Example server
+  rotation: [bloodgulch:ctf_classic, sidewinder:team_slayer+score=50, hangemhigh:king_moving]
+  maxPlayers: 24
+  public: true
+  lobbySeconds: 20
+  motd: Welcome
+  logFormat: json
+  instance: eu-1
+  region: eu
+  masterPublish: true
+  password:
+    existingSecret: halo-join
+    key: password
+publisherKey:
+  existingSecret: halo-publisher
+  key: seed
+web:
+  port: 8080
+  existingSecret: halo-web
+  key: admin
+  moderatorKey: moderator
+network:
+  tunnelPort: 2303
+  publicAddress: halo.example.com:2303
+extraEnv:
+  - name: HALO_SERVER_EMPTY_SECONDS
+    value: "60"
+persistence:
+  enabled: true
+  storageClass: standard
+  annotations:
+    example.com/keep: "true"
+service:
+  type: LoadBalancer
+  port: 2303
+  nodePort: 30703
+  annotations:
+    example.com/address: 192.0.2.10
+  externalTrafficPolicy: Local
+  loadBalancerSourceRanges: [0.0.0.0/0]
+tolerations:
+  - key: dedicated
+    operator: Equal
+    value: games
+    effect: NoSchedule
+podAnnotations:
+  example.com/scrape: "true"
+podLabels:
+  team: games
+probes:
+  liveness:
+    periodSeconds: 30
+  readiness:
+    enabled: false
+networkPolicy:
+  webFrom:
+    - namespaceSelector:
+        matchLabels:
+          kubernetes.io/metadata.name: ingress-nginx
+  extraEgress:
+    - to:
+        - ipBlock:
+            cidr: 203.0.113.0/24
+      ports:
+        - protocol: TCP
+          port: 8443
+extraObjects:
+  - apiVersion: v1
+    kind: ConfigMap
+    metadata:
+      name: '{{ .Release.Name }}-extra'
+    data:
+      hello: world

deploy/helm/opence-server/ci/minimal-values.yaml

@@ -0,0 +1,6 @@
+# The smallest install that renders: no maps (an emptyDir in their place), so the server exits with
+# code 2 and the pod goes into CrashLoopBackOff. A real install gives gameData.existingClaim or
+# gameData.nfs instead.
+gameData:
+  volume:
+    emptyDir: {}

deploy/helm/opence-server/templates/NOTES.txt

@@ -0,0 +1,33 @@
+OpenCE dedicated server {{ .Chart.Version }}: {{ include "opence-server.fullname" . }} in namespace {{ .Release.Namespace }}.
+
+Rotation: {{ join ", " .Values.server.rotation | default "the server's default" }}.
+{{- if kindIs "invalid" .Values.server.public }}
+Listed in everyone's server browser{{ with .Values.server.name }} as "{{ . }}"{{ end }}, unless config.toml or the web page turns server.public off.
+{{- else if .Values.server.public }}
+Listed in everyone's server browser{{ with .Values.server.name }} as "{{ . }}"{{ end }}.
+{{- else }}
+Not listed: players join with the invite link from the log, or on the LAN.
+{{- end }}
+
+The log (the ready line, players, games):
+
+  kubectl -n {{ .Release.Namespace }} logs -f deploy/{{ include "opence-server.fullname" . }}
+
+Players reach UDP port {{ .Values.service.port }} through Service {{ include "opence-server.fullname" . }} ({{ .Values.service.type }}).
+{{- if eq .Values.service.type "ClusterIP" }}
+A ClusterIP Service is not reachable from outside the cluster: set service.type to LoadBalancer or
+NodePort for internet play.
+{{- end }}
+{{- if gt (int .Values.web.port) 0 }}
+
+The web page, API and remote console:
+
+  kubectl -n {{ .Release.Namespace }} port-forward deploy/{{ include "opence-server.fullname" . }} {{ .Values.web.port }}
+  open http://127.0.0.1:{{ .Values.web.port }}/
+{{- if not .Values.web.existingSecret }}
+
+The admin password:
+
+  kubectl -n {{ .Release.Namespace }} get secret {{ include "opence-server.secretName" . }} -o jsonpath='{.data.{{ .Values.web.key }}}' | base64 -d
+{{- end }}
+{{- end }}

deploy/helm/opence-server/templates/_helpers.tpl

@@ -0,0 +1,84 @@
+{{/* The objects' name: fullnameOverride, else the release name if it contains the chart's name,
+   else <release>-<chart>. */}}
+{{- define "opence-server.fullname" -}}
+{{- if .Values.fullnameOverride -}}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- $name := default .Chart.Name .Values.nameOverride -}}
+{{- if contains $name .Release.Name -}}
+{{- .Release.Name | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+{{- end -}}
+{{- end }}
+
+{{- define "opence-server.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
+{{- end }}
+
+{{- define "opence-server.labels" -}}
+{{ include "opence-server.selectorLabels" . }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+helm.sh/chart: {{ printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{- define "opence-server.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "opence-server.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/* repository:tag, repository:tag@digest, or repository@digest; an empty tag is the appVersion. */}}
+{{- define "opence-server.image" -}}
+{{- $image := .Values.image -}}
+{{- $ref := $image.repository -}}
+{{- $tag := toString ($image.tag | default .Chart.AppVersion) -}}
+{{- if $image.digest }}{{ $tag = regexReplaceAll "@.*$" $tag "" }}{{ if hasPrefix "sha256:" $tag }}{{ $tag = "" }}{{ end }}{{ end -}}
+{{- if hasPrefix "sha256:" $tag }}{{ $ref = printf "%s@%s" $ref $tag }}
+{{- else if $tag }}{{ $ref = printf "%s:%s" $ref $tag }}{{ end -}}
+{{- if and $image.digest (not (contains "@" $ref)) }}{{ $ref = printf "%s@%s" $ref $image.digest }}{{ end -}}
+{{- $ref -}}
+{{- end }}
+
+{{- define "opence-server.stateClaim" -}}
+{{- .Values.persistence.existingClaim | default (printf "%s-state" (include "opence-server.fullname" .)) -}}
+{{- end }}
+
+{{/* The chart's Secret: the web passwords it makes or is given, the join password, the publisher
+   key. */}}
+{{- define "opence-server.secretName" -}}
+{{- printf "%s-secrets" (include "opence-server.fullname" .) -}}
+{{- end }}
+
+{{/* The Secret holding the web password: web.existingSecret, else the chart's. */}}
+{{- define "opence-server.webSecret" -}}
+{{- .Values.web.existingSecret | default (include "opence-server.secretName" .) -}}
+{{- end }}
+
+{{- define "opence-server.hasGameData" -}}
+{{- with .Values.gameData -}}
+{{- if or .existingClaim (and .nfs.server .nfs.path) .volume }}true{{ end -}}
+{{- end -}}
+{{- end }}
+
+{{- define "opence-server.hasCustomMaps" -}}
+{{- with .Values.customMaps -}}
+{{- if or .existingClaim (and .nfs.server .nfs.path) .volume }}true{{ end -}}
+{{- end -}}
+{{- end }}
+
+{{/* A volume source of gameData or customMaps (the dict), read-only. */}}
+{{- define "opence-server.volumeSource" -}}
+{{- if .existingClaim }}
+persistentVolumeClaim:
+  claimName: {{ .existingClaim }}
+  readOnly: true
+{{- else if and .nfs.server .nfs.path }}
+nfs:
+  server: {{ .nfs.server }}
+  path: {{ .nfs.path }}
+  readOnly: true
+{{- else }}
+{{- toYaml .volume }}
+{{- end }}
+{{- end }}

deploy/helm/opence-server/templates/deployment.yaml

@@ -0,0 +1,198 @@
+{{- if not (include "opence-server.hasGameData" .) }}
+{{- fail "gameData: set existingClaim, nfs.server and nfs.path, or volume - the server needs the game's maps, which are never in the image" }}
+{{- end }}
+{{- $fullname := include "opence-server.fullname" . }}
+{{- $secret := include "opence-server.secretName" . }}
+{{- $webPort := int .Values.web.port }}
+{{- $env := list }}
+{{- $env = append $env (dict "name" "HALO_SERVER" "value" "1") }}
+{{- $env = append $env (dict "name" "HALO_CONFIG_FILE" "value" "/state/config.toml") }}
+{{- $env = append $env (dict "name" "HALO_DATA_ROOT" "value" "/data") }}
+{{- $env = append $env (dict "name" "HALO_SAVE_ROOT" "value" "/state/saves") }}
+{{- $env = append $env (dict "name" "HALO_LOG_ROOT" "value" "/state/logs") }}
+{{- if include "opence-server.hasCustomMaps" . }}
+{{- $env = append $env (dict "name" "HALO_CUSTOM_MAPS_ROOT" "value" "/custom_maps") }}
+{{- end }}
+{{- /* (a pod has no standard input to read commands from) */}}
+{{- $env = append $env (dict "name" "HALO_SERVER_CONSOLE" "value" "false") }}
+{{- $env = append $env (dict "name" "HALO_NET_TUNNEL_PORT" "value" (toString (int .Values.network.tunnelPort))) }}
+{{- with .Values.network.publicAddress }}
+{{- $env = append $env (dict "name" "HALO_NET_PUBLIC_ADDRESS" "value" .) }}
+{{- end }}
+{{- with .Values.server.name }}
+{{- if gt (len .) 15 }}
+{{- fail "server.name: 15 characters at most" }}
+{{- end }}
+{{- $env = append $env (dict "name" "HALO_SERVER_NAME" "value" .) }}
+{{- end }}
+{{- with .Values.server.rotation }}
+{{- $env = append $env (dict "name" "HALO_SERVER_ROTATION" "value" (join ", " .)) }}
+{{- end }}
+{{- /* (a value left null is not set, so that config.toml, sv_set and the web page's settings can
+change it) */}}
+{{- if not (kindIs "invalid" .Values.server.maxPlayers) }}
+{{- $env = append $env (dict "name" "HALO_SERVER_MAX_PLAYERS" "value" (toString (int .Values.server.maxPlayers))) }}
+{{- end }}
+{{- if not (kindIs "invalid" .Values.server.public) }}
+{{- $env = append $env (dict "name" "HALO_SERVER_PUBLIC" "value" (toString .Values.server.public)) }}
+{{- end }}
+{{- if not (kindIs "invalid" .Values.server.lobbySeconds) }}
+{{- $env = append $env (dict "name" "HALO_SERVER_LOBBY_SECONDS" "value" (toString (int .Values.server.lobbySeconds))) }}
+{{- end }}
+{{- with .Values.server.motd }}
+{{- $env = append $env (dict "name" "HALO_SERVER_MOTD" "value" .) }}
+{{- end }}
+{{- with .Values.server.logFormat }}
+{{- $env = append $env (dict "name" "HALO_SERVER_LOG_FORMAT" "value" .) }}
+{{- end }}
+{{- with .Values.server.instance }}
+{{- $env = append $env (dict "name" "HALO_SERVER_INSTANCE" "value" .) }}
+{{- end }}
+{{- with .Values.server.region }}
+{{- $env = append $env (dict "name" "HALO_SERVER_REGION" "value" .) }}
+{{- end }}
+{{- if not (kindIs "invalid" .Values.server.masterPublish) }}
+{{- $env = append $env (dict "name" "HALO_SERVER_MASTER_PUBLISH" "value" (toString .Values.server.masterPublish)) }}
+{{- end }}
+{{- if .Values.server.password.existingSecret }}
+{{- $env = append $env (dict "name" "HALO_SERVER_PASSWORD" "valueFrom" (dict "secretKeyRef" (dict "name" .Values.server.password.existingSecret "key" .Values.server.password.key))) }}
+{{- else if .Values.server.password.value }}
+{{- $env = append $env (dict "name" "HALO_SERVER_PASSWORD" "valueFrom" (dict "secretKeyRef" (dict "name" $secret "key" .Values.server.password.key))) }}
+{{- end }}
+{{- if .Values.publisherKey.existingSecret }}
+{{- $env = append $env (dict "name" "HALO_SERVER_PUBLISHER_KEY" "valueFrom" (dict "secretKeyRef" (dict "name" .Values.publisherKey.existingSecret "key" .Values.publisherKey.key))) }}
+{{- else if .Values.publisherKey.value }}
+{{- $env = append $env (dict "name" "HALO_SERVER_PUBLISHER_KEY" "valueFrom" (dict "secretKeyRef" (dict "name" $secret "key" .Values.publisherKey.key))) }}
+{{- end }}
+{{- $env = append $env (dict "name" "HALO_SERVER_WEB_PORT" "value" (toString $webPort)) }}
+{{- if gt $webPort 0 }}
+{{- /* (the kubelet's probes reach the pod's own address, not its loopback) */}}
+{{- $env = append $env (dict "name" "HALO_SERVER_WEB_BIND" "value" "0.0.0.0") }}
+{{- $env = append $env (dict "name" "HALO_SERVER_WEB_PASSWORD" "valueFrom" (dict "secretKeyRef" (dict "name" (include "opence-server.webSecret" .) "key" .Values.web.key))) }}
+{{- if .Values.web.existingSecret }}
+{{- $env = append $env (dict "name" "HALO_SERVER_WEB_MODERATOR_PASSWORD" "valueFrom" (dict "secretKeyRef" (dict "name" .Values.web.existingSecret "key" .Values.web.moderatorKey "optional" true))) }}
+{{- else if .Values.web.moderatorPassword }}
+{{- $env = append $env (dict "name" "HALO_SERVER_WEB_MODERATOR_PASSWORD" "valueFrom" (dict "secretKeyRef" (dict "name" $secret "key" .Values.web.moderatorKey))) }}
+{{- end }}
+{{- end }}
+{{- $probe := dict "httpGet" (dict "path" "/healthz" "port" "web") }}
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ $fullname }}
+  labels:
+    {{- include "opence-server.labels" . | nindent 4 }}
+spec:
+  # One server owns the tunnel port and the address players reach it at.
+  replicas: 1
+  strategy:
+    {{- toYaml .Values.strategy | nindent 4 }}
+  selector:
+    matchLabels:
+      {{- include "opence-server.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      labels:
+        {{- include "opence-server.selectorLabels" . | nindent 8 }}
+        {{- with .Values.podLabels }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+    spec:
+      # The server never calls the Kubernetes API.
+      automountServiceAccountToken: false
+      enableServiceLinks: false
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.priorityClassName }}
+      priorityClassName: {{ . }}
+      {{- end }}
+      terminationGracePeriodSeconds: {{ .Values.terminationGracePeriodSeconds }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      containers:
+        - name: opence-server
+          image: {{ include "opence-server.image" . | quote }}
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          env:
+            {{- toYaml $env | nindent 12 }}
+            {{- with .Values.extraEnv }}
+            {{- toYaml . | nindent 12 }}
+            {{- end }}
+          ports:
+            - name: tunnel
+              containerPort: {{ .Values.network.tunnelPort }}
+              protocol: UDP
+            {{- if gt $webPort 0 }}
+            - name: web
+              containerPort: {{ $webPort }}
+              protocol: TCP
+            {{- end }}
+          {{- if gt $webPort 0 }}
+          {{- range $name := list "startup" "readiness" "liveness" }}
+          {{- $p := index $.Values.probes $name }}
+          {{- if $p.enabled }}
+          {{ $name }}Probe:
+            {{- toYaml (merge (omit $p "enabled") $probe) | nindent 12 }}
+          {{- end }}
+          {{- end }}
+          {{- end }}
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+          securityContext:
+            {{- toYaml .Values.securityContext | nindent 12 }}
+          volumeMounts:
+            - name: game-data
+              mountPath: /data
+              readOnly: true
+              {{- with .Values.gameData.subPath }}
+              subPath: {{ . }}
+              {{- end }}
+            # config.toml, publisher.key, the save root and its map cache, the logs
+            - name: state
+              mountPath: /state
+            {{- if include "opence-server.hasCustomMaps" . }}
+            - name: custom-maps
+              mountPath: /custom_maps
+              readOnly: true
+              {{- with .Values.customMaps.subPath }}
+              subPath: {{ . }}
+              {{- end }}
+            {{- end }}
+            - name: tmp
+              mountPath: /tmp
+      volumes:
+        - name: game-data
+          {{- include "opence-server.volumeSource" .Values.gameData | trim | nindent 10 }}
+        - name: state
+          {{- if .Values.persistence.enabled }}
+          persistentVolumeClaim:
+            claimName: {{ include "opence-server.stateClaim" . }}
+          {{- else }}
+          emptyDir:
+            sizeLimit: {{ .Values.persistence.emptyDirSizeLimit }}
+          {{- end }}
+        - name: tmp
+          emptyDir:
+            sizeLimit: 64Mi
+        {{- if include "opence-server.hasCustomMaps" . }}
+        - name: custom-maps
+          {{- include "opence-server.volumeSource" .Values.customMaps | trim | nindent 10 }}
+        {{- end }}

deploy/helm/opence-server/templates/extra-objects.yaml

@@ -0,0 +1,4 @@
+{{- range .Values.extraObjects }}
+---
+{{ tpl (toYaml .) $ }}
+{{- end }}

deploy/helm/opence-server/templates/networkpolicy.yaml

@@ -0,0 +1,66 @@
+{{- if .Values.networkPolicy.enabled }}
+{{- $np := .Values.networkPolicy }}
+# In: the players' UDP on the tunnel port, and the web port from webFrom alone. Out: DNS, TCP to
+# the MQTT brokers and the master servers, UDP to the internet (STUN, the players' ports); nothing
+# on the private ranges.
+apiVersion: networking.k8s.io/v1
+kind: NetworkPolicy
+metadata:
+  name: {{ include "opence-server.fullname" . }}
+  labels:
+    {{- include "opence-server.labels" . | nindent 4 }}
+spec:
+  podSelector:
+    matchLabels:
+      {{- include "opence-server.selectorLabels" . | nindent 6 }}
+  policyTypes:
+    - Ingress
+    - Egress
+  ingress:
+    - ports:
+        - protocol: UDP
+          port: {{ .Values.network.tunnelPort }}
+      {{- with $np.from }}
+      from:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+    {{- if and $np.webFrom (gt (int .Values.web.port) 0) }}
+    - ports:
+        - protocol: TCP
+          port: {{ .Values.web.port }}
+      from:
+        {{- toYaml $np.webFrom | nindent 8 }}
+    {{- end }}
+    {{- with $np.extraIngress }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+  egress:
+    - to:
+        {{- toYaml $np.dns.to | nindent 8 }}
+      ports:
+        - protocol: UDP
+          port: 53
+        - protocol: TCP
+          port: 53
+    {{- if or $np.internet.tcpPorts $np.internet.udp }}
+    - to:
+        - ipBlock:
+            cidr: {{ $np.internet.cidr }}
+            {{- with $np.internet.except }}
+            except:
+              {{- toYaml . | nindent 14 }}
+            {{- end }}
+      ports:
+        {{- range $np.internet.tcpPorts }}
+        - protocol: TCP
+          port: {{ . }}
+        {{- end }}
+        {{- if $np.internet.udp }}
+        # every UDP port: STUN (19302, 3478) and the players' own
+        - protocol: UDP
+        {{- end }}
+    {{- end }}
+    {{- with $np.extraEgress }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+{{- end }}

deploy/helm/opence-server/templates/secret.yaml

@@ -0,0 +1,44 @@
+{{- $data := dict }}
+{{- if and (gt (int .Values.web.port) 0) (not .Values.web.existingSecret) }}
+{{- $password := .Values.web.password }}
+{{- if $password }}
+{{- if lt (len $password) 8 }}
+{{- fail "web.password: 8 characters or more (the server refuses a shorter one beyond loopback)" }}
+{{- end }}
+{{- else }}
+{{- /* made once, then kept from the Secret the release already has */}}
+{{- $existing := lookup "v1" "Secret" .Release.Namespace (include "opence-server.secretName" .) }}
+{{- if and $existing $existing.data (hasKey $existing.data .Values.web.key) }}
+{{- $password = index $existing.data .Values.web.key | b64dec }}
+{{- else }}
+{{- $password = randAlphaNum 24 }}
+{{- end }}
+{{- end }}
+{{- $_ := set $data .Values.web.key ($password | b64enc) }}
+{{- with .Values.web.moderatorPassword }}
+{{- if lt (len .) 8 }}
+{{- fail "web.moderatorPassword: 8 characters or more" }}
+{{- end }}
+{{- $_ := set $data $.Values.web.moderatorKey (. | b64enc) }}
+{{- end }}
+{{- end }}
+{{- if and .Values.server.password.value (not .Values.server.password.existingSecret) }}
+{{- $_ := set $data .Values.server.password.key (.Values.server.password.value | b64enc) }}
+{{- end }}
+{{- if and .Values.publisherKey.value (not .Values.publisherKey.existingSecret) }}
+{{- if not (regexMatch "^[0-9a-f]{64}$" .Values.publisherKey.value) }}
+{{- fail "publisherKey.value: the 64 lower-case hex characters of the seed (halo --server --keygen)" }}
+{{- end }}
+{{- $_ := set $data .Values.publisherKey.key (.Values.publisherKey.value | b64enc) }}
+{{- end }}
+{{- if $data }}
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ include "opence-server.secretName" . }}
+  labels:
+    {{- include "opence-server.labels" . | nindent 4 }}
+type: Opaque
+data:
+  {{- toYaml $data | nindent 2 }}
+{{- end }}

deploy/helm/opence-server/templates/service-web.yaml

@@ -0,0 +1,23 @@
+{{- if and .Values.web.service.enabled (gt (int .Values.web.port) 0) }}
+# The web page, its API and the remote console, inside the cluster only: for an Ingress with TLS,
+# or kubectl port-forward.
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "opence-server.fullname" . }}-web
+  labels:
+    {{- include "opence-server.labels" . | nindent 4 }}
+  {{- with .Values.web.service.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  type: ClusterIP
+  selector:
+    {{- include "opence-server.selectorLabels" . | nindent 4 }}
+  ports:
+    - name: web
+      port: {{ .Values.web.service.port }}
+      targetPort: web
+      protocol: TCP
+{{- end }}

deploy/helm/opence-server/templates/service.yaml

@@ -0,0 +1,40 @@
+# The tunnel port, UDP: the one port players need.
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "opence-server.fullname" . }}
+  labels:
+    {{- include "opence-server.labels" . | nindent 4 }}
+    {{- with .Values.service.labels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+  {{- with .Values.service.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  type: {{ .Values.service.type }}
+  {{- if ne .Values.service.type "ClusterIP" }}
+  {{- with .Values.service.externalTrafficPolicy }}
+  externalTrafficPolicy: {{ . }}
+  {{- end }}
+  {{- end }}
+  {{- if eq .Values.service.type "LoadBalancer" }}
+  {{- with .Values.service.loadBalancerClass }}
+  loadBalancerClass: {{ . }}
+  {{- end }}
+  {{- with .Values.service.loadBalancerSourceRanges }}
+  loadBalancerSourceRanges:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+  {{- end }}
+  selector:
+    {{- include "opence-server.selectorLabels" . | nindent 4 }}
+  ports:
+    - name: tunnel
+      port: {{ .Values.service.port }}
+      targetPort: tunnel
+      protocol: UDP
+      {{- if and (ne .Values.service.type "ClusterIP") .Values.service.nodePort }}
+      nodePort: {{ .Values.service.nodePort }}
+      {{- end }}

deploy/helm/opence-server/templates/state-pvc.yaml

@@ -0,0 +1,21 @@
+{{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) }}
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: {{ include "opence-server.stateClaim" . }}
+  labels:
+    {{- include "opence-server.labels" . | nindent 4 }}
+  {{- with .Values.persistence.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  accessModes:
+    {{- toYaml .Values.persistence.accessModes | nindent 4 }}
+  {{- with .Values.persistence.storageClass }}
+  storageClassName: {{ . }}
+  {{- end }}
+  resources:
+    requests:
+      storage: {{ .Values.persistence.size }}
+{{- end }}

deploy/helm/opence-server/tests/deployment_test.yaml

@@ -0,0 +1,221 @@
+suite: deployment
+templates:
+  - templates/deployment.yaml
+set:
+  gameData.existingClaim: halo-maps
+tests:
+  - it: refuses to render without game data, which is never in the image
+    set:
+      gameData.existingClaim: ""
+    asserts:
+      - failedTemplate:
+          errorPattern: "gameData: set existingClaim"
+
+  - it: mounts an existing claim read-only at /data
+    asserts:
+      - equal:
+          path: 'spec.template.spec.volumes[0]'
+          value: { name: game-data, persistentVolumeClaim: { claimName: halo-maps, readOnly: true } }
+      - contains:
+          path: 'spec.template.spec.containers[0].volumeMounts'
+          content: { name: game-data, mountPath: /data, readOnly: true }
+
+  - it: mounts an NFS export read-only, with a subPath
+    set:
+      gameData: { existingClaim: "", nfs: { server: nfs.example.com, path: /halo }, subPath: xbox }
+    asserts:
+      - equal:
+          path: 'spec.template.spec.volumes[0]'
+          value: { name: game-data, nfs: { server: nfs.example.com, path: /halo, readOnly: true } }
+      - contains:
+          path: 'spec.template.spec.containers[0].volumeMounts'
+          content: { name: game-data, mountPath: /data, readOnly: true, subPath: xbox }
+
+  - it: takes any other volume source
+    set:
+      gameData: { existingClaim: "", volume: { emptyDir: {} } }
+    asserts:
+      - equal:
+          path: 'spec.template.spec.volumes[0]'
+          value: { name: game-data, emptyDir: {} }
+
+  - it: runs one replica, replaced not rolled, hardened
+    asserts:
+      - equal: { path: spec.replicas, value: 1 }
+      - equal: { path: spec.strategy.type, value: Recreate }
+      - equal: { path: spec.template.spec.automountServiceAccountToken, value: false }
+      - equal: { path: spec.template.spec.securityContext.runAsNonRoot, value: true }
+      - equal: { path: spec.template.spec.securityContext.runAsUser, value: 10001 }
+      - equal: { path: spec.template.spec.securityContext.seccompProfile.type, value: RuntimeDefault }
+      - equal: { path: 'spec.template.spec.containers[0].securityContext.readOnlyRootFilesystem', value: true }
+      - equal: { path: 'spec.template.spec.containers[0].securityContext.allowPrivilegeEscalation', value: false }
+      - equal: { path: 'spec.template.spec.containers[0].securityContext.capabilities.drop', value: [ALL] }
+      - equal: { path: spec.template.spec.nodeSelector, value: { kubernetes.io/os: linux, kubernetes.io/arch: amd64 } }
+      - equal: { path: spec.template.spec.terminationGracePeriodSeconds, value: 15 }
+      - exists: { path: 'spec.template.spec.containers[0].resources.limits.memory' }
+
+  - it: sets the server's paths and mode
+    asserts:
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER, value: "1" } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_CONFIG_FILE, value: /state/config.toml } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_DATA_ROOT, value: /data } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SAVE_ROOT, value: /state/saves } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_LOG_ROOT, value: /state/logs } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_CONSOLE, value: "false" } }
+
+  - it: maps the values to the HALO_ variables
+    set:
+      server:
+        name: Test server
+        rotation: [bloodgulch:ctf, "sidewinder:team_slayer+score=50"]
+        maxPlayers: 24
+        public: false
+        lobbySeconds: 30
+        motd: Hello
+        logFormat: json
+        instance: eu-1
+        region: eu
+        masterPublish: false
+      network: { tunnelPort: 2303, publicAddress: "halo.example.com:2303" }
+    asserts:
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_NAME, value: Test server } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_ROTATION, value: "bloodgulch:ctf, sidewinder:team_slayer+score=50" } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_MAX_PLAYERS, value: "24" } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_PUBLIC, value: "false" } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_LOBBY_SECONDS, value: "30" } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_MOTD, value: Hello } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_LOG_FORMAT, value: json } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_INSTANCE, value: eu-1 } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_REGION, value: eu } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_MASTER_PUBLISH, value: "false" } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_NET_TUNNEL_PORT, value: "2303" } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_NET_PUBLIC_ADDRESS, value: "halo.example.com:2303" } }
+      - equal: { path: 'spec.template.spec.containers[0].ports[0]', value: { name: tunnel, containerPort: 2303, protocol: UDP } }
+
+  - it: leaves empty values to config.toml
+    asserts:
+      - notContains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_NAME, value: "" } }
+      - notContains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_MOTD, value: "" } }
+      - notContains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_NET_PUBLIC_ADDRESS, value: "" } }
+
+  - it: leaves the settings the values do not give to config.toml, sv_set and the web page
+    asserts:
+      - notExists: { path: 'spec.template.spec.containers[0].env[?(@.name == "HALO_SERVER_ROTATION")]' }
+      - notExists: { path: 'spec.template.spec.containers[0].env[?(@.name == "HALO_SERVER_MAX_PLAYERS")]' }
+      - notExists: { path: 'spec.template.spec.containers[0].env[?(@.name == "HALO_SERVER_PUBLIC")]' }
+      - notExists: { path: 'spec.template.spec.containers[0].env[?(@.name == "HALO_SERVER_LOBBY_SECONDS")]' }
+      - notExists: { path: 'spec.template.spec.containers[0].env[?(@.name == "HALO_SERVER_LOG_FORMAT")]' }
+      - notExists: { path: 'spec.template.spec.containers[0].env[?(@.name == "HALO_SERVER_MASTER_PUBLISH")]' }
+
+  - it: sets a false or zero value that is given
+    set:
+      server: { public: false, masterPublish: false, lobbySeconds: 0 }
+    asserts:
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_PUBLIC, value: "false" } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_MASTER_PUBLISH, value: "false" } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_LOBBY_SECONDS, value: "0" } }
+
+  - it: refuses a name longer than the game's 15 characters (the values' schema, or the template)
+    set:
+      server.name: "A name too long!"
+    asserts:
+      - failedTemplate:
+          errorPattern: "server.name|/server/name|15 characters"
+
+  - it: takes the web password from the chart's Secret, bound beyond loopback for the probes
+    release: { name: opence-server }
+    asserts:
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_WEB_PORT, value: "8080" } }
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_WEB_BIND, value: 0.0.0.0 } }
+      - contains:
+          path: 'spec.template.spec.containers[0].env'
+          content: { name: HALO_SERVER_WEB_PASSWORD, valueFrom: { secretKeyRef: { name: opence-server-secrets, key: web-password } } }
+      - contains: { path: 'spec.template.spec.containers[0].ports', content: { name: web, containerPort: 8080, protocol: TCP } }
+
+  - it: takes the passwords and the publisher key from existing Secrets
+    set:
+      web: { existingSecret: halo-web, key: admin, moderatorKey: moderator }
+      server.password: { existingSecret: halo-join, key: password }
+      publisherKey: { existingSecret: halo-publisher, key: seed }
+    asserts:
+      - contains:
+          path: 'spec.template.spec.containers[0].env'
+          content: { name: HALO_SERVER_WEB_PASSWORD, valueFrom: { secretKeyRef: { name: halo-web, key: admin } } }
+      - contains:
+          path: 'spec.template.spec.containers[0].env'
+          content: { name: HALO_SERVER_WEB_MODERATOR_PASSWORD, valueFrom: { secretKeyRef: { name: halo-web, key: moderator, optional: true } } }
+      - contains:
+          path: 'spec.template.spec.containers[0].env'
+          content: { name: HALO_SERVER_PASSWORD, valueFrom: { secretKeyRef: { name: halo-join, key: password } } }
+      - contains:
+          path: 'spec.template.spec.containers[0].env'
+          content: { name: HALO_SERVER_PUBLISHER_KEY, valueFrom: { secretKeyRef: { name: halo-publisher, key: seed } } }
+
+  - it: probes GET /healthz on the web port
+    asserts:
+      - equal: { path: 'spec.template.spec.containers[0].startupProbe.httpGet', value: { path: /healthz, port: web } }
+      - equal: { path: 'spec.template.spec.containers[0].readinessProbe.httpGet', value: { path: /healthz, port: web } }
+      - equal: { path: 'spec.template.spec.containers[0].livenessProbe.httpGet', value: { path: /healthz, port: web } }
+      - equal: { path: 'spec.template.spec.containers[0].startupProbe.failureThreshold', value: 60 }
+
+  - it: drops a probe that is turned off
+    set:
+      probes.liveness.enabled: false
+    asserts:
+      - notExists: { path: 'spec.template.spec.containers[0].livenessProbe' }
+      - exists: { path: 'spec.template.spec.containers[0].readinessProbe' }
+
+  - it: has no web port, password or probes with web.port 0
+    set:
+      web.port: 0
+    asserts:
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_WEB_PORT, value: "0" } }
+      - notContains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_SERVER_WEB_BIND, value: 0.0.0.0 } }
+      - lengthEqual: { path: 'spec.template.spec.containers[0].ports', count: 1 }
+      - notExists: { path: 'spec.template.spec.containers[0].startupProbe' }
+      - notExists: { path: 'spec.template.spec.containers[0].livenessProbe' }
+
+  - it: puts extraEnv after the chart's variables, so it can override them
+    set:
+      extraEnv: [{ name: HALO_SERVER_LOBBY_SECONDS, value: "5" }]
+    asserts:
+      - equal:
+          path: 'spec.template.spec.containers[0].env[-1:]'
+          value: { name: HALO_SERVER_LOBBY_SECONDS, value: "5" }
+
+  - it: keeps the state in an emptyDir without persistence
+    asserts:
+      - contains: { path: spec.template.spec.volumes, content: { name: state, emptyDir: { sizeLimit: 1Gi } } }
+      - lengthEqual: { path: spec.template.spec.volumes, count: 3 }
+
+  - it: uses the claim with persistence
+    release: { name: opence-server }
+    set:
+      persistence.enabled: true
+    asserts:
+      - contains: { path: spec.template.spec.volumes, content: { name: state, persistentVolumeClaim: { claimName: opence-server-state } } }
+
+  - it: mounts a custom_maps claim read-only, with its variable
+    set:
+      customMaps: { existingClaim: halo-custom-maps, subPath: ce }
+    asserts:
+      - contains: { path: 'spec.template.spec.containers[0].env', content: { name: HALO_CUSTOM_MAPS_ROOT, value: /custom_maps } }
+      - contains:
+          path: spec.template.spec.volumes
+          content: { name: custom-maps, persistentVolumeClaim: { claimName: halo-custom-maps, readOnly: true } }
+      - contains:
+          path: 'spec.template.spec.containers[0].volumeMounts'
+          content: { name: custom-maps, mountPath: /custom_maps, readOnly: true, subPath: ce }
+
+  - it: takes a tag with a digest, and lets digest replace it
+    set:
+      image.tag: build-206@sha256:1111111111111111111111111111111111111111111111111111111111111111
+      image.digest: sha256:2222222222222222222222222222222222222222222222222222222222222222
+    asserts:
+      - equal:
+          path: 'spec.template.spec.containers[0].image'
+          value: ghcr.io/opencommunityedition/opence-server:build-206@sha256:2222222222222222222222222222222222222222222222222222222222222222
+
+  - it: uses the appVersion as the default tag
+    asserts:
+      - equal: { path: 'spec.template.spec.containers[0].image', value: "ghcr.io/opencommunityedition/opence-server:latest" }

deploy/helm/opence-server/tests/networkpolicy_test.yaml

@@ -0,0 +1,39 @@
+suite: network policy
+templates:
+  - templates/networkpolicy.yaml
+tests:
+  - it: lets anyone reach the tunnel port, and nothing else in
+    asserts:
+      - equal: { path: spec.policyTypes, value: [Ingress, Egress] }
+      - equal: { path: spec.ingress, value: [{ ports: [{ protocol: UDP, port: 2302 }] }] }
+
+  - it: allows DNS, TCP 1883 and 443 and all UDP to public addresses only
+    asserts:
+      - equal: { path: 'spec.egress[0].ports', value: [{ protocol: UDP, port: 53 }, { protocol: TCP, port: 53 }] }
+      - equal: { path: 'spec.egress[1].to[0].ipBlock.cidr', value: 0.0.0.0/0 }
+      - contains: { path: 'spec.egress[1].to[0].ipBlock.except', content: 10.0.0.0/8 }
+      - contains: { path: 'spec.egress[1].to[0].ipBlock.except', content: 192.168.0.0/16 }
+      - equal: { path: 'spec.egress[1].ports', value: [{ protocol: TCP, port: 1883 }, { protocol: TCP, port: 443 }, { protocol: UDP }] }
+
+  - it: lets webFrom reach the web port
+    set:
+      networkPolicy.webFrom: [{ namespaceSelector: { matchLabels: { kubernetes.io/metadata.name: ingress-nginx } } }]
+    asserts:
+      - equal:
+          path: 'spec.ingress[1]'
+          value: { ports: [{ protocol: TCP, port: 8080 }], from: [{ namespaceSelector: { matchLabels: { kubernetes.io/metadata.name: ingress-nginx } } }] }
+
+  - it: narrows the players' sources and follows the tunnel port
+    set:
+      network.tunnelPort: 2303
+      networkPolicy.from: [{ ipBlock: { cidr: 198.51.100.0/24 } }]
+    asserts:
+      - equal:
+          path: spec.ingress
+          value: [{ ports: [{ protocol: UDP, port: 2303 }], from: [{ ipBlock: { cidr: 198.51.100.0/24 } }] }]
+
+  - it: renders nothing when off
+    set:
+      networkPolicy.enabled: false
+    asserts:
+      - hasDocuments: { count: 0 }

deploy/helm/opence-server/tests/persistence_test.yaml

@@ -0,0 +1,21 @@
+suite: persistence
+templates:
+  - templates/state-pvc.yaml
+release:
+  name: opence-server
+tests:
+  - it: makes no claim without persistence
+    asserts:
+      - hasDocuments: { count: 0 }
+  - it: makes the state claim with persistence
+    set:
+      persistence: { enabled: true, size: 3Gi, storageClass: fast }
+    asserts:
+      - equal: { path: metadata.name, value: opence-server-state }
+      - equal: { path: spec.resources.requests.storage, value: 3Gi }
+      - equal: { path: spec.storageClassName, value: fast }
+  - it: makes none for an existing claim
+    set:
+      persistence: { enabled: true, existingClaim: mine }
+    asserts:
+      - hasDocuments: { count: 0 }

deploy/helm/opence-server/tests/secret_test.yaml

@@ -0,0 +1,48 @@
+suite: secret
+templates:
+  - templates/secret.yaml
+release:
+  name: opence-server
+tests:
+  - it: makes a web password when none is given
+    asserts:
+      - hasDocuments: { count: 1 }
+      - isKind: { of: Secret }
+      - equal: { path: metadata.name, value: opence-server-secrets }
+      - matchRegex: { path: data.web-password, pattern: "^[A-Za-z0-9+/]{32}$" }
+
+  - it: keeps a given web password, join password and publisher key
+    set:
+      web.password: correct-horse
+      server.password.value: letmein
+      publisherKey.value: "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
+    asserts:
+      - equal: { path: data.web-password, value: Y29ycmVjdC1ob3JzZQ== }
+      - equal: { path: data.password, value: bGV0bWVpbg== }
+      - exists: { path: data.publisher-key }
+
+  - it: refuses a short web password
+    set:
+      web.password: short
+    asserts:
+      - failedTemplate:
+          errorPattern: "8 characters or more"
+
+  - it: refuses a publisher key that is not 64 hex characters
+    set:
+      publisherKey.value: not-a-key
+    asserts:
+      - failedTemplate:
+          errorPattern: "64 lower-case hex"
+
+  - it: makes none when every secret comes from elsewhere
+    set:
+      web.existingSecret: halo-web
+    asserts:
+      - hasDocuments: { count: 0 }
+
+  - it: makes none without a web port or secrets
+    set:
+      web.port: 0
+    asserts:
+      - hasDocuments: { count: 0 }

deploy/helm/opence-server/tests/service_test.yaml

@@ -0,0 +1,43 @@
+suite: service
+templates:
+  - templates/service.yaml
+  - templates/service-web.yaml
+release:
+  name: opence-server
+tests:
+  - it: exposes the tunnel port over UDP on a load balancer that keeps the players' addresses
+    template: templates/service.yaml
+    asserts:
+      - equal: { path: metadata.name, value: opence-server }
+      - equal: { path: spec.type, value: LoadBalancer }
+      - equal: { path: spec.externalTrafficPolicy, value: Local }
+      - equal: { path: 'spec.ports[0]', value: { name: tunnel, port: 2302, targetPort: tunnel, protocol: UDP } }
+
+  - it: ignores externalTrafficPolicy and nodePort on a ClusterIP Service
+    template: templates/service.yaml
+    set:
+      service: { type: ClusterIP, nodePort: 30702 }
+    asserts:
+      - notExists: { path: spec.externalTrafficPolicy }
+      - notExists: { path: 'spec.ports[0].nodePort' }
+
+  - it: sets a fixed node port
+    template: templates/service.yaml
+    set:
+      service: { type: NodePort, nodePort: 30702 }
+    asserts:
+      - equal: { path: 'spec.ports[0].nodePort', value: 30702 }
+
+  - it: keeps the web port inside the cluster
+    template: templates/service-web.yaml
+    asserts:
+      - equal: { path: metadata.name, value: opence-server-web }
+      - equal: { path: spec.type, value: ClusterIP }
+      - equal: { path: 'spec.ports[0]', value: { name: web, port: 8080, targetPort: web, protocol: TCP } }
+
+  - it: has no web Service without a web port
+    template: templates/service-web.yaml
+    set:
+      web.port: 0
+    asserts:
+      - hasDocuments: { count: 0 }

deploy/helm/opence-server/values.schema.json

@@ -0,0 +1,445 @@
+{
+  "$schema": "https://json-schema.org/draft-07/schema#",
+  "title": "opence-server values",
+  "description": "Strict where the chart defines the structure; free-form where values pass through to Kubernetes. values.yaml describes each value.",
+  "type": "object",
+  "additionalProperties": false,
+  "definitions": {
+    "port": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 65535
+    },
+    "volume": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "existingClaim": {
+          "type": "string"
+        },
+        "nfs": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "server": {
+              "type": "string"
+            },
+            "path": {
+              "type": "string"
+            }
+          }
+        },
+        "volume": {
+          "type": "object"
+        },
+        "subPath": {
+          "type": "string"
+        }
+      }
+    },
+    "secretValue": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "value": {
+          "type": "string"
+        },
+        "existingSecret": {
+          "type": "string"
+        },
+        "key": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "probe": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "initialDelaySeconds": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "periodSeconds": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "timeoutSeconds": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "failureThreshold": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "successThreshold": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "terminationGracePeriodSeconds": {
+          "type": "integer",
+          "minimum": 1
+        }
+      }
+    }
+  },
+  "properties": {
+    "global": {
+      "type": "object"
+    },
+    "nameOverride": {
+      "type": "string"
+    },
+    "fullnameOverride": {
+      "type": "string"
+    },
+    "image": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "repository"
+      ],
+      "properties": {
+        "repository": {
+          "type": "string",
+          "minLength": 1
+        },
+        "tag": {
+          "type": [
+            "string",
+            "number"
+          ]
+        },
+        "digest": {
+          "type": "string",
+          "pattern": "^(sha256:[0-9a-f]{64})?$"
+        },
+        "pullPolicy": {
+          "enum": [
+            "Always",
+            "IfNotPresent",
+            "Never"
+          ]
+        }
+      }
+    },
+    "imagePullSecrets": {
+      "type": "array"
+    },
+    "gameData": {
+      "$ref": "#/definitions/volume"
+    },
+    "customMaps": {
+      "$ref": "#/definitions/volume"
+    },
+    "server": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string",
+          "maxLength": 15,
+          "pattern": "^[ -~]*$"
+        },
+        "rotation": {
+          "type": "array",
+          "maxItems": 64,
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "maxPlayers": {
+          "type": [
+            "integer",
+            "null"
+          ],
+          "minimum": 2,
+          "maximum": 127
+        },
+        "public": {
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "lobbySeconds": {
+          "type": [
+            "integer",
+            "null"
+          ],
+          "minimum": 0,
+          "maximum": 300
+        },
+        "motd": {
+          "type": "string",
+          "maxLength": 127
+        },
+        "logFormat": {
+          "enum": [
+            "",
+            "text",
+            "json",
+            null
+          ]
+        },
+        "instance": {
+          "type": "string",
+          "pattern": "^[A-Za-z0-9_-]{0,32}$"
+        },
+        "region": {
+          "type": "string",
+          "maxLength": 16
+        },
+        "masterPublish": {
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "password": {
+          "$ref": "#/definitions/secretValue"
+        }
+      }
+    },
+    "publisherKey": {
+      "$ref": "#/definitions/secretValue"
+    },
+    "web": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "port": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 65535
+        },
+        "password": {
+          "type": "string"
+        },
+        "existingSecret": {
+          "type": "string"
+        },
+        "key": {
+          "type": "string",
+          "minLength": 1
+        },
+        "moderatorPassword": {
+          "type": "string"
+        },
+        "moderatorKey": {
+          "type": "string",
+          "minLength": 1
+        },
+        "service": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "enabled": {
+              "type": "boolean"
+            },
+            "port": {
+              "$ref": "#/definitions/port"
+            },
+            "annotations": {
+              "type": "object"
+            }
+          }
+        }
+      }
+    },
+    "network": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "tunnelPort": {
+          "$ref": "#/definitions/port"
+        },
+        "publicAddress": {
+          "type": "string"
+        }
+      }
+    },
+    "extraEnv": {
+      "type": "array"
+    },
+    "persistence": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "existingClaim": {
+          "type": "string"
+        },
+        "size": {
+          "type": "string"
+        },
+        "storageClass": {
+          "type": "string"
+        },
+        "accessModes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "annotations": {
+          "type": "object"
+        },
+        "emptyDirSizeLimit": {
+          "type": "string"
+        }
+      }
+    },
+    "service": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "enum": [
+            "ClusterIP",
+            "NodePort",
+            "LoadBalancer"
+          ]
+        },
+        "port": {
+          "$ref": "#/definitions/port"
+        },
+        "nodePort": {
+          "type": [
+            "string",
+            "integer"
+          ]
+        },
+        "annotations": {
+          "type": "object"
+        },
+        "labels": {
+          "type": "object"
+        },
+        "externalTrafficPolicy": {
+          "enum": [
+            "",
+            "Cluster",
+            "Local"
+          ]
+        },
+        "loadBalancerClass": {
+          "type": "string"
+        },
+        "loadBalancerSourceRanges": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "strategy": {
+      "type": "object"
+    },
+    "resources": {
+      "type": "object"
+    },
+    "nodeSelector": {
+      "type": "object"
+    },
+    "affinity": {
+      "type": "object"
+    },
+    "tolerations": {
+      "type": "array"
+    },
+    "priorityClassName": {
+      "type": "string"
+    },
+    "podAnnotations": {
+      "type": "object"
+    },
+    "podLabels": {
+      "type": "object"
+    },
+    "terminationGracePeriodSeconds": {
+      "type": "integer",
+      "minimum": 1
+    },
+    "podSecurityContext": {
+      "type": "object"
+    },
+    "securityContext": {
+      "type": "object"
+    },
+    "probes": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "startup": {
+          "$ref": "#/definitions/probe"
+        },
+        "readiness": {
+          "$ref": "#/definitions/probe"
+        },
+        "liveness": {
+          "$ref": "#/definitions/probe"
+        }
+      }
+    },
+    "networkPolicy": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "from": {
+          "type": "array"
+        },
+        "webFrom": {
+          "type": "array"
+        },
+        "dns": {
+          "type": "object"
+        },
+        "internet": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "cidr": {
+              "type": "string"
+            },
+            "except": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "tcpPorts": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/port"
+              }
+            },
+            "udp": {
+              "type": "boolean"
+            }
+          }
+        },
+        "extraIngress": {
+          "type": "array"
+        },
+        "extraEgress": {
+          "type": "array"
+        }
+      }
+    },
+    "extraObjects": {
+      "type": "array"
+    }
+  }
+}

deploy/helm/opence-server/values.yaml

@@ -0,0 +1,239 @@
+# opence-server: the OpenCE dedicated server (docs/dedicated_server.md). One replica: the server
+# owns its tunnel port and the address players reach it at.
+
+nameOverride: ""
+fullnameOverride: ""
+
+image:
+  repository: ghcr.io/opencommunityedition/opence-server
+  # Empty: the chart's appVersion (latest). A release's tag (build-206) or sha-<commit> pins it;
+  # <tag>@sha256:... as Argo CD Image Updater writes it works too.
+  tag: ""
+  # sha256:... ; replaces any digest in tag.
+  digest: ""
+  pullPolicy: IfNotPresent
+
+imagePullSecrets: []
+
+# The game data: the folder that holds maps/ (and custom_maps/, gametypes/ and init.txt if you have
+# them), from your own copy of the game. It is never in the image. Mounted read-only at /data
+# (HALO_DATA_ROOT). One source is required.
+gameData:
+  # An existing PersistentVolumeClaim.
+  existingClaim: ""
+  # Or an NFS export.
+  nfs:
+    server: ""
+    path: ""
+  # Or any other volume source, as in a pod's volumes (without the name), e.g.
+  # {hostPath: {path: /srv/halo, type: Directory}}. Without maps/ui.map and the rotation's maps the
+  # server exits with code 2 and says which maps it looked for, and the pod goes into
+  # CrashLoopBackOff.
+  volume: {}
+  # The folder within the volume that holds maps/. Empty: the volume's root.
+  subPath: ""
+
+# A custom_maps folder of its own (Custom Edition maps with bitmaps.map, sounds.map and loc.map),
+# mounted read-only at /custom_maps (HALO_CUSTOM_MAPS_ROOT). Optional: without one the server uses
+# gameData's custom_maps/.
+customMaps:
+  existingClaim: ""
+  nfs:
+    server: ""
+    path: ""
+  volume: {}
+  subPath: ""
+
+# The server's settings, as its HALO_* environment variables (docs/dedicated_server.md and
+# port/linux/README.md, "Dedicated server"). A value given here wins over config.toml, and sv_set
+# and the web page's settings cannot change it. Each is unset by default (empty, or null): the
+# setting is then config.toml's, or the server's default (named below), and can be changed from
+# the web page.
+server:
+  # server.name: 15 characters of printable ASCII (default "OpenCE Server").
+  name: ""
+  # server.rotation: map[:gametype[+rule=value...]] entries, played in turn, e.g.
+  # [bloodgulch:ctf, sidewinder:team_slayer, prisoner:slayer] (the default).
+  rotation: []
+  # server.max_players: 2 to 127 (default 16).
+  maxPlayers: null
+  # server.public: list the server in everyone's server browser (default true).
+  public: null
+  # server.lobby_seconds (default 15).
+  lobbySeconds: null
+  # server.motd: a notice each player is shown on joining.
+  motd: ""
+  # server.log_format: text or json (default text).
+  logFormat: ""
+  # server.instance and server.region, as the master servers list them.
+  instance: ""
+  region: ""
+  # server.master_publish: publish the server to the official master servers (needs a publisher
+  # key, below; default true).
+  masterPublish: null
+  # server.password: the password the server browser asks for. value, or a key of an existing
+  # Secret; empty for none.
+  password:
+    value: ""
+    existingSecret: ""
+    key: password
+
+# The master servers' publisher key (HALO_SERVER_PUBLISHER_KEY): the 64 hex characters of the seed
+# halo --server --keygen writes. value, or a key of an existing Secret; empty: the state volume's
+# publisher.key, if there is one.
+publisherKey:
+  value: ""
+  existingSecret: ""
+  key: publisher-key
+
+# The web page, its API and the remote console (server.web_port), on which the probes ask
+# GET /healthz. 0 turns them off, and the probes with them.
+web:
+  port: 8080
+  # The admin password (server.web_password, 8 characters or more), from existingSecret's key, else
+  # from password, else made at the first install and kept in the chart's Secret. The made one is
+  # found again with lookup on upgrades, which helm template and GitOps tools (Argo CD, Flux's
+  # dry runs) cannot do: they make a new one at each render. Give password or existingSecret
+  # there (README.md, "Web password").
+  password: ""
+  existingSecret: ""
+  key: web-password
+  # server.web_moderator_password, from the same Secret's moderatorKey when it has one.
+  moderatorPassword: ""
+  moderatorKey: web-moderator-password
+  # A ClusterIP Service for the web port, for an Ingress (with TLS) or kubectl port-forward.
+  service:
+    enabled: true
+    port: 8080
+    annotations: {}
+
+network:
+  # network.tunnel_port: the UDP port of internet play, which the Service exposes.
+  tunnelPort: 2302
+  # network.public_address: host[:port] players reach the tunnel port at, when the cluster is behind
+  # a NAT that STUN cannot see through. Empty: what STUN finds.
+  publicAddress: ""
+
+# More environment variables, as in a pod spec ({name, value} or {name, valueFrom}); they come after
+# the chart's, so the same name overrides it.
+extraEnv: []
+
+# /state: config.toml (HALO_CONFIG_FILE), publisher.key, the save root with its map cache (about
+# 115 MB for the multiplayer maps), the logs. Without persistence an emptyDir: the cache is built
+# again at each start, and settings changed from the web page are lost.
+persistence:
+  enabled: false
+  existingClaim: ""
+  size: 2Gi
+  storageClass: ""
+  accessModes:
+    - ReadWriteOnce
+  annotations: {}
+  emptyDirSizeLimit: 1Gi
+
+# The tunnel port's Service. Players reach it from outside the cluster, so a real deployment needs
+# LoadBalancer or NodePort.
+service:
+  type: LoadBalancer
+  port: 2302
+  nodePort: ""
+  annotations: {}
+  labels: {}
+  # Local keeps the players' own addresses (no SNAT to a node), which bans and the server's limits
+  # rely on.
+  externalTrafficPolicy: Local
+  loadBalancerClass: ""
+  loadBalancerSourceRanges: []
+
+strategy:
+  type: Recreate
+
+resources:
+  requests:
+    cpu: 100m
+    memory: 192Mi
+  limits:
+    memory: 600Mi
+
+# The image is 32-bit x86 Linux code, which runs on amd64 nodes only.
+nodeSelector:
+  kubernetes.io/os: linux
+  kubernetes.io/arch: amd64
+affinity: {}
+tolerations: []
+priorityClassName: ""
+
+podAnnotations: {}
+podLabels: {}
+
+# SIGTERM ends the game in progress, tells the players and exits 0; a second signal, or 5 seconds
+# on, exits at once.
+terminationGracePeriodSeconds: 15
+
+podSecurityContext:
+  runAsNonRoot: true
+  runAsUser: 10001
+  runAsGroup: 10001
+  fsGroup: 10001
+  seccompProfile:
+    type: RuntimeDefault
+
+securityContext:
+  allowPrivilegeEscalation: false
+  readOnlyRootFilesystem: true
+  capabilities:
+    drop: ["ALL"]
+
+# GET /healthz on the web port: 200 while the server hosts (lobby, loading, playing, postgame) and
+# its frames run. Each probe's fields override these; enabled: false drops it.
+probes:
+  startup:
+    enabled: true
+    periodSeconds: 2
+    failureThreshold: 60
+    timeoutSeconds: 2
+  readiness:
+    enabled: true
+    periodSeconds: 10
+    failureThreshold: 3
+    timeoutSeconds: 2
+  liveness:
+    enabled: true
+    periodSeconds: 20
+    failureThreshold: 3
+    timeoutSeconds: 3
+
+networkPolicy:
+  enabled: true
+  # Who may reach the tunnel port. Empty: anyone (players are on the internet).
+  from: []
+  # Who may reach the web port, as NetworkPolicy peers (an Ingress controller's namespace, say).
+  # Empty: no pod; kubectl port-forward and the kubelet's probes still reach it.
+  webFrom: []
+  dns:
+    to:
+      - namespaceSelector:
+          matchLabels:
+            kubernetes.io/metadata.name: kube-system
+        podSelector:
+          matchLabels:
+            k8s-app: kube-dns
+  # The internet: TCP to the MQTT brokers (1883) and the master servers (443), and UDP to anywhere
+  # (STUN, and the players' own ports). The private ranges are excepted.
+  internet:
+    cidr: 0.0.0.0/0
+    except:
+      - 10.0.0.0/8
+      - 172.16.0.0/12
+      - 192.168.0.0/16
+      - 100.64.0.0/10
+      - 169.254.0.0/16
+    tcpPorts:
+      - 1883
+      - 443
+    udp: true
+  extraIngress: []
+  extraEgress: []
+
+# More objects to render with the release (templated).
+extraObjects: []

deploy/init.txt.example

@@ -0,0 +1,31 @@
+# init.txt: commands a dedicated server runs once at its start, one a line,
+# as if typed at its console (docs/dedicated_server.md, "Commands"). Copy
+# this file to init.txt in the data folder (server.init_file), and take the
+# "# " off the lines you want. Lines starting with # or ; are comments.
+#
+# Settings are better given in config.toml or as HALO_* variables; these are
+# for what changes from one start to the next.
+
+# The rotation, replacing server.rotation (and written to it):
+# sv_rotation_set bloodgulch:ctf, sidewinder:team_slayer+score=50, hangemhigh:king_moving
+# sv_rotation_add prisoner:slayer+time=10
+# sv_rotation_begin 2
+
+# The game's name, players and notice (sv_set of the server.* settings):
+# sv_name My server
+# sv_maxplayers 12
+# sv_motd Welcome. Be nice; admins are watching.
+# sv_public 1
+# sv_password secret
+
+# Any setting the server lists in sv_settings:
+# sv_set server.lobby_seconds 20
+# sv_set server.empty_seconds 60
+
+# A first game other than the rotation's, which goes on after it:
+# sv_map bloodgulch ctf_classic
+
+# The state of the server, in the log:
+# sv_status
+
+# The game's own console commands run too, with the owner's role.

deploy/mcsmanager/README.md

@@ -0,0 +1,40 @@
+# The dedicated server on MCSManager
+
+`mcsmanager-config.json` holds two MCSManager quick-install entries for the
+dedicated server (`docs/dedicated_server.md`). Each unzips a release's
+`halo-linux-release.zip` into the instance's folder and runs
+`./halo --server` there, stopped with `quit`.
+
+| Entry | How it runs |
+| --- | --- |
+| Host | On the node itself, which needs the 32-bit C runtime (Debian and Ubuntu: `dpkg --add-architecture i386 && apt install libc6:i386`) |
+| Docker | In a container of `ghcr.io/ptero-eggs/games:source` (Debian 12 with the 32-bit libraries), the instance's folder mounted at `/workspace` |
+
+## Using it
+
+1. Add the entries to the node's quick-install list, and create an
+   instance from one.
+2. Upload the `maps/` folder of your own copy of the game into the
+   instance's folder. Without `maps/ui.map` and the rotation's maps the
+   server exits with code 2 and says which maps it looked for.
+3. Start it.
+
+## Folders
+
+The Docker entry's container is made again at each start, so it sets
+`HALO_SAVE_ROOT=/workspace/saves` and `HALO_LOG_ROOT=/workspace/logs`: the
+save root with the map cache (about 115 MB, built at the first start) and
+the logs stay in the instance's folder rather than in the container. The
+host entry keeps the save root in the home folder of the daemon's user
+(`~/.local/share/halo-linux`), which every host instance of that user
+shares; give each its own with
+`HALO_SAVE_ROOT=saves` (in the instance's environment, or as
+`env HALO_SAVE_ROOT=saves ./halo --server` for its start command).
+`config.toml` is written beside `halo` at the first start.
+
+## Ports
+
+UDP 2302 is the tunnel port, the one players need; the web page, its API
+and the remote console are on 127.0.0.1:8080. A second instance on the node
+needs ports of its own: `HALO_NET_TUNNEL_PORT` and `HALO_SERVER_WEB_PORT`,
+and for the Docker entry its published ports to match.

deploy/mcsmanager/mcsmanager-config.json

@@ -0,0 +1,139 @@
+{
+  "_comment": "MCSManager quick-install entries for the OpenCE dedicated server (docs/dedicated_server.md). Each package unzips the release into the instance's folder; put the maps/ folder of your own copy of the game beside halo before the first start. Settings: config.toml beside halo, written at the first start, or HALO_* variables.",
+  "languages": [
+    {
+      "label": "English",
+      "value": "en_us"
+    }
+  ],
+  "packages": [
+    {
+      "language": "en_us",
+      "platform": "Linux",
+      "title": "OpenCE Dedicated Server",
+      "category": "Halo: Combat Evolved",
+      "runtime": "Linux x86-64 with 32-bit libraries",
+      "hardware": "1 CPU core, 600 MB of memory",
+      "size": "45 MB, and the game data you upload",
+      "author": "OpenCE",
+      "targetLink": "https://github.com/OpenCommunityEdition/OpenCE/releases/latest/download/halo-linux-release.zip",
+      "description": "The dedicated server run on the node itself, which needs the 32-bit C runtime (Debian and Ubuntu: dpkg --add-architecture i386 && apt install libc6:i386). Open UDP 2302; the web page is on http://127.0.0.1:8080/.",
+      "remark": "Host",
+      "setupInfo": {
+        "nickname": "OpenCE Dedicated Server",
+        "startCommand": "./halo --server",
+        "stopCommand": "quit",
+        "ie": "utf-8",
+        "oe": "utf-8",
+        "type": "universal",
+        "tag": [
+          "halo",
+          "opence"
+        ],
+        "processType": "general",
+        "updateCommand": "",
+        "crlf": 1,
+        "actionCommandList": [
+          {
+            "name": "Status",
+            "command": "sv_status"
+          },
+          {
+            "name": "Players",
+            "command": "sv_players"
+          },
+          {
+            "name": "Next map",
+            "command": "sv_map_next"
+          },
+          {
+            "name": "Reload settings",
+            "command": "sv_reload"
+          }
+        ],
+        "eventTask": {
+          "autoStart": false,
+          "autoRestart": true,
+          "ignore": false
+        },
+        "terminalOption": {
+          "haveColor": false,
+          "pty": false
+        }
+      }
+    },
+    {
+      "language": "en_us",
+      "platform": "Linux",
+      "title": "OpenCE Dedicated Server",
+      "category": "Halo: Combat Evolved",
+      "runtime": "Linux x86-64 with 32-bit libraries",
+      "hardware": "1 CPU core, 600 MB of memory",
+      "size": "45 MB, and the game data you upload",
+      "author": "OpenCE",
+      "targetLink": "https://github.com/OpenCommunityEdition/OpenCE/releases/latest/download/halo-linux-release.zip",
+      "description": "The dedicated server in a container of ghcr.io/ptero-eggs/games:source (Debian 12 with the 32-bit libraries), the instance's folder mounted as its working folder; the save root (with the map cache) and the logs are kept in it, as the container is made again at each start. Publishes UDP 2302 and the web page on the node's 127.0.0.1:8080 (each instance on a node needs ports of its own).",
+      "remark": "Docker",
+      "setupInfo": {
+        "nickname": "OpenCE Dedicated Server",
+        "startCommand": "./halo --server",
+        "stopCommand": "quit",
+        "ie": "utf-8",
+        "oe": "utf-8",
+        "type": "universal",
+        "tag": [
+          "halo",
+          "opence"
+        ],
+        "processType": "docker",
+        "updateCommand": "",
+        "crlf": 1,
+        "actionCommandList": [
+          {
+            "name": "Status",
+            "command": "sv_status"
+          },
+          {
+            "name": "Players",
+            "command": "sv_players"
+          },
+          {
+            "name": "Next map",
+            "command": "sv_map_next"
+          },
+          {
+            "name": "Reload settings",
+            "command": "sv_reload"
+          }
+        ],
+        "eventTask": {
+          "autoStart": false,
+          "autoRestart": true,
+          "ignore": false
+        },
+        "terminalOption": {
+          "haveColor": false,
+          "pty": false
+        },
+        "docker": {
+          "image": "ghcr.io/ptero-eggs/games:source",
+          "ports": [
+            "2302:2302/udp",
+            "127.0.0.1:8080:8080/tcp"
+          ],
+          "extraVolumes": [],
+          "networkMode": "bridge",
+          "networkAliases": [],
+          "env": [
+            "HALO_SERVER_WEB_BIND=0.0.0.0",
+            "HALO_SAVE_ROOT=/workspace/saves",
+            "HALO_LOG_ROOT=/workspace/logs"
+          ],
+          "memory": 600,
+          "workingDir": "/workspace/",
+          "changeWorkdir": true
+        }
+      }
+    }
+  ]
+}

deploy/pterodactyl/README.md

@@ -0,0 +1,94 @@
+# The dedicated server on Pterodactyl and Pelican
+
+`egg-opence-dedicated-server.json` is an egg (`PTDL_v2`) that installs a
+release of OpenCE from GitHub and runs it as a dedicated server
+(`docs/dedicated_server.md`). Pelican imports the same file.
+
+## Importing it
+
+1. Admin > Nests (Pelican: Eggs) > Import Egg, and choose the file.
+2. Create a server with the egg. Its primary allocation is the tunnel port
+   (`network.tunnel_port`, UDP): the one port players need, from 1025 up
+   (the container cannot bind lower ports).
+3. Upload the game data: the `maps/` folder of your own copy of the game
+   (port/linux/README.md, "Game data"), into the server's folder over SFTP
+   (the panel's SFTP details, on the Settings tab). Without `maps/ui.map`
+   and the rotation's maps the server stops at once with exit code 2 and
+   says which maps it looked for.
+4. Start it. The panel shows it running once it prints its ready line
+   (`server: ready`, or `"msg":"ready (` with `server.log_format = "json"`).
+
+## Files
+
+| Path (in `/home/container`) | What |
+| --- | --- |
+| `halo`, `halo-server`, `libSDL3.so.0`, `brokers.txt`, `masters.txt`, the licences | The release (replaced on Reinstall) |
+| `maps/` | The game data (yours) |
+| `custom_maps/` | Custom Edition maps, with `bitmaps.map`, `sounds.map` and `loc.map` (shared with players who join) |
+| `gametypes/*.toml` | Gametypes of your own (the release adds examples, never replacing yours) |
+| `init.txt` | Commands run at each start (`init.txt.example` has examples) |
+| `config.toml` | Every setting, written at the first start |
+| `publisher.key` | The master servers' key: made by `./halo --server --keygen` on any machine with the release and uploaded, or given as the Publisher key variable instead |
+| `logs/` | `debug.txt`, `bans.txt`, `cheaters.txt` |
+
+Reinstall (Settings tab) downloads the release again, the one the Release
+variable names, and keeps `config.toml`, `init.txt`, `publisher.key`,
+`gametypes/`, `custom_maps/`, `maps/` and `logs/`.
+
+## Variables
+
+Every variable is one of the server's settings, by its environment name
+(docs/dedicated_server.md and port/linux/README.md, "Dedicated server"). A
+variable wins over `config.toml`, and the web page's settings cannot
+change it.
+
+| Variable | Setting |
+| --- | --- |
+| Release (`OPENCE_RELEASE`) | `latest` or a tag (`build-206`); used by Reinstall |
+| Server name (`HALO_SERVER_NAME`) | `server.name`, 15 characters |
+| Rotation (`HALO_SERVER_ROTATION`) | `server.rotation` |
+| Max players (`HALO_SERVER_MAX_PLAYERS`) | `server.max_players` |
+| Join password (`HALO_SERVER_PASSWORD`) | `server.password` |
+| Public (`HALO_SERVER_PUBLIC`) | `server.public` |
+| Message of the day (`HALO_SERVER_MOTD`) | `server.motd` |
+| Lobby seconds (`HALO_SERVER_LOBBY_SECONDS`) | `server.lobby_seconds` |
+| Web UI port (`HALO_SERVER_WEB_PORT`) | `server.web_port`; 0 for none |
+| Web UI password (`HALO_SERVER_WEB_PASSWORD`) | `server.web_password` |
+| Public address (`HALO_NET_PUBLIC_ADDRESS`) | `network.public_address` |
+| Publisher key (`HALO_SERVER_PUBLISHER_KEY`) | The master servers' key itself, in place of `publisher.key` |
+| Instance name (`HALO_SERVER_INSTANCE`) | `server.instance` |
+| Region (`HALO_SERVER_REGION`) | `server.region` |
+| Log format (`HALO_SERVER_LOG_FORMAT`) | `server.log_format` |
+
+The startup command sets `HALO_NET_TUNNEL_PORT` to the primary allocation's
+port and `HALO_LOG_ROOT` to `logs/`. Two variables are the administrator's
+only: Web UI bind (`0.0.0.0`, as the allocation's address is the node's,
+not the container's) and GitHub repository (`OpenCommunityEdition/OpenCE`).
+
+## The web page
+
+The admin page, its API and the remote console need a second allocation:
+the node's administrator adds one to the server (or raises its allocation
+limit so the owner can, on the Network tab). Give its port as Web UI port
+and a password of 8 characters or more as Web UI password, restart, and
+open `http://<allocation address>:<port>/`. The page has no TLS of its own:
+put it behind a reverse proxy with HTTPS for anything but a private network.
+
+## Stopping and restarting
+
+The panel's Stop sends SIGINT, which the server takes as SIGTERM: the game
+in progress goes to its postgame, the players are told, the listing is
+withdrawn, and it exits 0. The console's `quit` command does the same, but
+Wings counts an exit it did not ask for as a crash and starts the server
+again; use Stop. `sv_restart` exits with code 5, which Wings also takes as a
+crash and restarts, which is what it asks for.
+
+Updates: `server.auto_update` is for servers that own their files; on a
+panel, change the Release variable (or keep `latest`) and Reinstall, by hand
+or as a schedule.
+
+## Checking the egg
+
+`python tools/egg_build.py` copies `install.sh` into the egg and checks it;
+`python -m pytest -q tools/test_egg.py` checks the egg and runs `install.sh`
+in a `debian:bookworm-slim` container against a release served locally.

deploy/pterodactyl/egg-opence-dedicated-server.json

@@ -0,0 +1,203 @@
+{
+    "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO",
+    "meta": {
+        "version": "PTDL_v2",
+        "update_url": null
+    },
+    "exported_at": "2026-10-24T00:00:00+00:00",
+    "name": "OpenCE Dedicated Server",
+    "author": "opence@halocombatevolved.com",
+    "description": "A dedicated server of OpenCE, the port of Halo: Combat Evolved: hosts multiplayer games one after another, with no window, sound or player of its own. Installs a release from GitHub. The game data is yours to upload: put the maps/ folder of your own copy of the game in the server's folder over SFTP; the server does not start without it.",
+    "features": [],
+    "docker_images": {
+        "Debian 12 with 32-bit libraries (Pterodactyl)": "ghcr.io/ptero-eggs/games:source",
+        "Debian 12 with 32-bit libraries (Pelican)": "ghcr.io/pelican-eggs/games:source"
+    },
+    "file_denylist": [],
+    "startup": "HALO_NET_TUNNEL_PORT={{SERVER_PORT}} HALO_LOG_ROOT=/home/container/logs ./halo --server",
+    "config": {
+        "files": "{}",
+        "startup": "{\r\n    \"done\": [\r\n        \"server: ready\",\r\n        \"\\\"msg\\\":\\\"ready (\"\r\n    ]\r\n}",
+        "logs": "{}",
+        "stop": "^C"
+    },
+    "scripts": {
+        "installation": {
+            "script": "#!/bin/bash\n# The OpenCE dedicated server egg's installation script (Pterodactyl and\n# Pelican), run as root in ghcr.io/ptero-eggs/installers:debian with the\n# server's folder at /mnt/server. tools/egg_build.py copies it into\n# egg-opence-dedicated-server.json.\n#\n# OPENCE_RELEASE: \"latest\" or a release tag (build-206).\n# OPENCE_REPOSITORY: the GitHub repository (owner/name) to download from.\n#\n# A reinstall replaces the release's files and keeps the owner's:\n# config.toml, init.txt, publisher.key, gametypes/, custom_maps/, maps/ and\n# logs/. The panel ignores this script's exit code, so each failure says\n# what went wrong.\n\nset -u\n\nSERVER_DIR=\"${SERVER_DIR:-/mnt/server}\"\nRELEASE=\"${OPENCE_RELEASE:-latest}\"\nREPOSITORY=\"${OPENCE_REPOSITORY:-OpenCommunityEdition/OpenCE}\"\nGITHUB_URL=\"${OPENCE_GITHUB_URL:-https://github.com}\"\nGITHUB_API=\"${OPENCE_GITHUB_API:-https://api.github.com}\"\nASSET=halo-linux-release.zip\n\nfail() {\n\techo \"INSTALL FAILED: $*\"\n\texit 1\n}\n\nif ! [[ \"$REPOSITORY\" =~ ^[A-Za-z0-9._-]+/[A-Za-z0-9._-]+$ ]]; then\n\tfail \"the repository \\\"$REPOSITORY\\\" is not owner/name\"\nfi\nif [ -z \"$RELEASE\" ] || [ \"$RELEASE\" = latest ]; then\n\t# (no API call, so no rate limit)\n\turl=\"$GITHUB_URL/$REPOSITORY/releases/latest/download/$ASSET\"\nelse\n\tif ! [[ \"$RELEASE\" =~ ^[A-Za-z0-9._-]+$ ]]; then\n\t\tfail \"the release \\\"$RELEASE\\\" is not a tag name (build-206) or latest\"\n\tfi\n\techo \"Looking up release $RELEASE of $REPOSITORY\"\n\trelease_json=\"$(curl -fsSL --retry 3 -H 'Accept: application/vnd.github+json' \\\n\t\t\"$GITHUB_API/repos/$REPOSITORY/releases/tags/$RELEASE\")\" \\\n\t\t|| fail \"no release $RELEASE in $REPOSITORY (or GitHub's API did not answer)\"\n\turl=\"$(printf '%s' \"$release_json\" | jq -r --arg name \"$ASSET\" \\\n\t\t'[.assets[]? | select(.name == $name) | .browser_download_url][0] // empty')\"\n\t[ -n \"$url\" ] || fail \"release $RELEASE has no $ASSET\"\nfi\n\nmkdir -p \"$SERVER_DIR\" || fail \"cannot make $SERVER_DIR\"\ncd \"$SERVER_DIR\" || fail \"cannot enter $SERVER_DIR\"\n\nwork=\"$(mktemp -d)\" || fail \"cannot make a temporary folder\"\ntrap 'rm -rf \"$work\"' EXIT\n\necho \"Downloading $url\"\ncurl -fL --retry 3 --progress-bar -o \"$work/$ASSET\" \"$url\" || fail \"the download of $url failed\"\nunzip -tq \"$work/$ASSET\" > /dev/null || fail \"$ASSET is not a zip file\"\nmkdir \"$work/release\"\nunzip -q \"$work/$ASSET\" -d \"$work/release\" || fail \"cannot unzip $ASSET\"\n[ -f \"$work/release/halo\" ] || fail \"$ASSET has no halo executable\"\n\n# the release's files, over the old release's; the owner's are never in it,\n# and gametypes/ only adds the examples not already there\nfor entry in \"$work/release\"/* \"$work/release\"/.[!.]*; do\n\t[ -e \"$entry\" ] || continue\n\tname=\"$(basename \"$entry\")\"\n\tcase \"$name\" in\n\tconfig.toml | init.txt | publisher.key | custom_maps | maps | logs)\n\t\tcontinue\n\t\t;;\n\tgametypes)\n\t\tmkdir -p gametypes\n\t\tcp -rn \"$entry\"/. gametypes/\n\t\tcontinue\n\t\t;;\n\tesac\n\trm -rf \"./$name\"\n\tcp -a \"$entry\" \"./$name\" || fail \"cannot copy $name\"\ndone\n\nchmod 0755 halo\nif [ ! -f halo-server ]; then\n\tprintf '#!/bin/sh\\nexec \"$(dirname \"$0\")/halo\" --server \"$@\"\\n' > halo-server\nfi\nchmod 0755 halo-server\nmkdir -p maps custom_maps gametypes logs\n\necho \"Checking that the server runs\"\nif version=\"$(HOME=\"$work\" HALO_SAVE_ROOT=\"$work/saves\" timeout 30 ./halo --version 2>&1)\"; then\n\techo \"$version\"\nelse\n\techo \"WARNING: ./halo --version did not run. The server needs the 32-bit C runtime\"\n\techo \"WARNING: (the egg's ghcr.io/ptero-eggs/games:source image has it):\"\n\techo \"$version\"\nfi\n\nif [ ! -f maps/ui.map ]; then\n\techo \"No game data yet: upload your maps/ folder (ui.map and the multiplayer maps)\"\n\techo \"over SFTP into the server's folder before starting it.\"\nfi\necho \"Installation completed\"\n",
+            "container": "ghcr.io/ptero-eggs/installers:debian",
+            "entrypoint": "bash"
+        }
+    },
+    "variables": [
+        {
+            "name": "Release",
+            "description": "A release tag (build-206) or latest. A change takes effect on Reinstall (Settings tab), which keeps config.toml, init.txt, gametypes/, custom_maps/ and maps/.",
+            "env_variable": "OPENCE_RELEASE",
+            "default_value": "latest",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string|max:40|regex:/^[A-Za-z0-9._-]+$/",
+            "field_type": "text"
+        },
+        {
+            "name": "Server name",
+            "description": "The game's name in the lobby and the server browser: 15 characters of printable ASCII.",
+            "env_variable": "HALO_SERVER_NAME",
+            "default_value": "OpenCE Server",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string|max:15|regex:/^[\\x20-\\x7E]+$/",
+            "field_type": "text"
+        },
+        {
+            "name": "Rotation",
+            "description": "The games played one after another, separated by commas: map:gametype, with +rule=value after a gametype (bloodgulch:ctf, sidewinder:team_slayer+score=50). A gametype is a built-in's name or a gametypes/<name>.toml of yours.",
+            "env_variable": "HALO_SERVER_ROTATION",
+            "default_value": "bloodgulch:ctf, sidewinder:team_slayer, prisoner:slayer",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string|max:4096",
+            "field_type": "text"
+        },
+        {
+            "name": "Max players",
+            "description": "2 to 127.",
+            "env_variable": "HALO_SERVER_MAX_PLAYERS",
+            "default_value": "16",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|integer|between:2,127",
+            "field_type": "text"
+        },
+        {
+            "name": "Join password",
+            "description": "The password the server browser asks for; empty for none. The invite link joins without it.",
+            "env_variable": "HALO_SERVER_PASSWORD",
+            "default_value": "",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "nullable|string|max:64",
+            "field_type": "text"
+        },
+        {
+            "name": "Public",
+            "description": "List the server in everyone's server browser.",
+            "env_variable": "HALO_SERVER_PUBLIC",
+            "default_value": "true",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string|in:true,false",
+            "field_type": "text"
+        },
+        {
+            "name": "Message of the day",
+            "description": "A notice each player is shown on joining (127 characters); empty for none.",
+            "env_variable": "HALO_SERVER_MOTD",
+            "default_value": "",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "nullable|string|max:127",
+            "field_type": "text"
+        },
+        {
+            "name": "Lobby seconds",
+            "description": "Seconds the lobby counts down before each game (0 to 300).",
+            "env_variable": "HALO_SERVER_LOBBY_SECONDS",
+            "default_value": "15",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|integer|between:0,300",
+            "field_type": "text"
+        },
+        {
+            "name": "Web UI port",
+            "description": "0: no web page. Else the port of an additional allocation (Network tab) for the admin page, its API and the remote console, at http://<allocation address>:<port>/; it needs a web UI password.",
+            "env_variable": "HALO_SERVER_WEB_PORT",
+            "default_value": "0",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|integer|between:0,65535",
+            "field_type": "text"
+        },
+        {
+            "name": "Web UI password",
+            "description": "The admin password of the web page, 8 characters or more.",
+            "env_variable": "HALO_SERVER_WEB_PASSWORD",
+            "default_value": "",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "nullable|string|min:8|max:64",
+            "field_type": "text"
+        },
+        {
+            "name": "Public address",
+            "description": "host[:port] offered to joiners first, for a node behind a NAT that STUN cannot see through; usually empty.",
+            "env_variable": "HALO_NET_PUBLIC_ADDRESS",
+            "default_value": "",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "nullable|string|max:253",
+            "field_type": "text"
+        },
+        {
+            "name": "Publisher key",
+            "description": "Your approved key for the master servers that list dedicated servers: the 64 hex characters of the seed ./halo --server --keygen writes to publisher.key. Empty: the key file, if there is one; the server is not listed on the masters without one.",
+            "env_variable": "HALO_SERVER_PUBLISHER_KEY",
+            "default_value": "",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "nullable|string|regex:/^[0-9a-f]{64}$/",
+            "field_type": "text"
+        },
+        {
+            "name": "Instance name",
+            "description": "Tells this server from your others on the master servers: letters, digits, dashes.",
+            "env_variable": "HALO_SERVER_INSTANCE",
+            "default_value": "main",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string|alpha_dash|max:32",
+            "field_type": "text"
+        },
+        {
+            "name": "Region",
+            "description": "A label in the server browser (eu, na-east); empty for none.",
+            "env_variable": "HALO_SERVER_REGION",
+            "default_value": "",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "nullable|string|alpha_dash|max:16",
+            "field_type": "text"
+        },
+        {
+            "name": "Log format",
+            "description": "The console's lines: text, or json for a log collector.",
+            "env_variable": "HALO_SERVER_LOG_FORMAT",
+            "default_value": "text",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string|in:text,json",
+            "field_type": "text"
+        },
+        {
+            "name": "Web UI bind",
+            "description": "The container's address the web port listens on: all of them, as the allocation's address is the node's.",
+            "env_variable": "HALO_SERVER_WEB_BIND",
+            "default_value": "0.0.0.0",
+            "user_viewable": false,
+            "user_editable": false,
+            "rules": "required|string|in:0.0.0.0",
+            "field_type": "text"
+        },
+        {
+            "name": "GitHub repository",
+            "description": "owner/name the installation downloads the release from.",
+            "env_variable": "OPENCE_REPOSITORY",
+            "default_value": "OpenCommunityEdition/OpenCE",
+            "user_viewable": false,
+            "user_editable": false,
+            "rules": "required|string|max:100|regex:/^[A-Za-z0-9._-]+\\/[A-Za-z0-9._-]+$/",
+            "field_type": "text"
+        }
+    ]
+}

deploy/pterodactyl/install.sh

@@ -0,0 +1,100 @@
+#!/bin/bash
+# The OpenCE dedicated server egg's installation script (Pterodactyl and
+# Pelican), run as root in ghcr.io/ptero-eggs/installers:debian with the
+# server's folder at /mnt/server. tools/egg_build.py copies it into
+# egg-opence-dedicated-server.json.
+#
+# OPENCE_RELEASE: "latest" or a release tag (build-206).
+# OPENCE_REPOSITORY: the GitHub repository (owner/name) to download from.
+#
+# A reinstall replaces the release's files and keeps the owner's:
+# config.toml, init.txt, publisher.key, gametypes/, custom_maps/, maps/ and
+# logs/. The panel ignores this script's exit code, so each failure says
+# what went wrong.
+
+set -u
+
+SERVER_DIR="${SERVER_DIR:-/mnt/server}"
+RELEASE="${OPENCE_RELEASE:-latest}"
+REPOSITORY="${OPENCE_REPOSITORY:-OpenCommunityEdition/OpenCE}"
+GITHUB_URL="${OPENCE_GITHUB_URL:-https://github.com}"
+GITHUB_API="${OPENCE_GITHUB_API:-https://api.github.com}"
+ASSET=halo-linux-release.zip
+
+fail() {
+	echo "INSTALL FAILED: $*"
+	exit 1
+}
+
+if ! [[ "$REPOSITORY" =~ ^[A-Za-z0-9._-]+/[A-Za-z0-9._-]+$ ]]; then
+	fail "the repository \"$REPOSITORY\" is not owner/name"
+fi
+if [ -z "$RELEASE" ] || [ "$RELEASE" = latest ]; then
+	# (no API call, so no rate limit)
+	url="$GITHUB_URL/$REPOSITORY/releases/latest/download/$ASSET"
+else
+	if ! [[ "$RELEASE" =~ ^[A-Za-z0-9._-]+$ ]]; then
+		fail "the release \"$RELEASE\" is not a tag name (build-206) or latest"
+	fi
+	echo "Looking up release $RELEASE of $REPOSITORY"
+	release_json="$(curl -fsSL --retry 3 -H 'Accept: application/vnd.github+json' \
+		"$GITHUB_API/repos/$REPOSITORY/releases/tags/$RELEASE")" \
+		|| fail "no release $RELEASE in $REPOSITORY (or GitHub's API did not answer)"
+	url="$(printf '%s' "$release_json" | jq -r --arg name "$ASSET" \
+		'[.assets[]? | select(.name == $name) | .browser_download_url][0] // empty')"
+	[ -n "$url" ] || fail "release $RELEASE has no $ASSET"
+fi
+
+mkdir -p "$SERVER_DIR" || fail "cannot make $SERVER_DIR"
+cd "$SERVER_DIR" || fail "cannot enter $SERVER_DIR"
+
+work="$(mktemp -d)" || fail "cannot make a temporary folder"
+trap 'rm -rf "$work"' EXIT
+
+echo "Downloading $url"
+curl -fL --retry 3 --progress-bar -o "$work/$ASSET" "$url" || fail "the download of $url failed"
+unzip -tq "$work/$ASSET" > /dev/null || fail "$ASSET is not a zip file"
+mkdir "$work/release"
+unzip -q "$work/$ASSET" -d "$work/release" || fail "cannot unzip $ASSET"
+[ -f "$work/release/halo" ] || fail "$ASSET has no halo executable"
+
+# the release's files, over the old release's; the owner's are never in it,
+# and gametypes/ only adds the examples not already there
+for entry in "$work/release"/* "$work/release"/.[!.]*; do
+	[ -e "$entry" ] || continue
+	name="$(basename "$entry")"
+	case "$name" in
+	config.toml | init.txt | publisher.key | custom_maps | maps | logs)
+		continue
+		;;
+	gametypes)
+		mkdir -p gametypes
+		cp -rn "$entry"/. gametypes/
+		continue
+		;;
+	esac
+	rm -rf "./$name"
+	cp -a "$entry" "./$name" || fail "cannot copy $name"
+done
+
+chmod 0755 halo
+if [ ! -f halo-server ]; then
+	printf '#!/bin/sh\nexec "$(dirname "$0")/halo" --server "$@"\n' > halo-server
+fi
+chmod 0755 halo-server
+mkdir -p maps custom_maps gametypes logs
+
+echo "Checking that the server runs"
+if version="$(HOME="$work" HALO_SAVE_ROOT="$work/saves" timeout 30 ./halo --version 2>&1)"; then
+	echo "$version"
+else
+	echo "WARNING: ./halo --version did not run. The server needs the 32-bit C runtime"
+	echo "WARNING: (the egg's ghcr.io/ptero-eggs/games:source image has it):"
+	echo "$version"
+fi
+
+if [ ! -f maps/ui.map ]; then
+	echo "No game data yet: upload your maps/ folder (ui.map and the multiplayer maps)"
+	echo "over SFTP into the server's folder before starting it."
+fi
+echo "Installation completed"

deploy/pufferpanel/README.md

@@ -0,0 +1,49 @@
+# The dedicated server on PufferPanel
+
+`template.json` is a PufferPanel template for the dedicated server
+(`docs/dedicated_server.md`), run in PufferPanel's host environment: it
+downloads a release's `halo-linux-release.zip` into the server's folder,
+runs `./halo --server` there, and stops it by writing `quit` to its
+standard input.
+
+## Using it
+
+1. The node needs the 32-bit C runtime (Debian and Ubuntu:
+   `dpkg --add-architecture i386 && apt install libc6:i386`). The template
+   mounts `/lib32` and `/usr/lib32` into PufferPanel's sandbox, which does
+   not otherwise; without them the 32-bit `halo` cannot start.
+2. Add the template (Templates, New, and paste the file), and create a
+   server from it.
+3. Upload the `maps/` folder of your own copy of the game into the
+   server's folder. Without `maps/ui.map` and the rotation's maps the server
+   exits with code 2 and says which maps it looked for.
+4. Start it.
+
+## Ports
+
+The **Tunnel port** (UDP, 2302 by default) is the one port players need.
+The **Web UI port** is the web page, its API and the remote console, on
+127.0.0.1 only. Its default is 8090, because PufferPanel itself listens on
+8080. Each server on a node needs a tunnel port and a web port of its own
+(or a web port of 0, for none).
+
+## Files
+
+Everything the server writes stays in its folder: `config.toml` (every
+setting, written at the first start, with the web page's admin password if
+none was given), `saves/` (`HALO_SAVE_ROOT`: the profiles and the map cache,
+about 115 MB, built at the first start), `logs/` (`HALO_LOG_ROOT`:
+`debug.txt`, `bans.txt`, `cheaters.txt`) and `status.json`
+(`server.status_file`, the status every 2 seconds).
+
+The template's variables are passed as `HALO_*` variables, which win over
+`config.toml`: `sv_set` and the web page cannot change those settings.
+
+## PufferPanel versions
+
+The template is in the format of PufferPanel 2's templates (`run.command`
+as a string, `run.stop` as the command written to standard input). We have
+not confirmed how PufferPanel 3 imports it, nor the form of its standard
+input settings; if a server made from it on PufferPanel 3 does not stop
+with `quit`, set its stop to send `quit` to standard input (or SIGTERM,
+which the server takes as well) in the server's settings.

deploy/pufferpanel/template.json

@@ -0,0 +1,140 @@
+{
+  "type": "opence",
+  "display": "OpenCE Dedicated Server",
+  "install": [
+    {
+      "type": "download",
+      "files": [
+        "${release_url}"
+      ]
+    },
+    {
+      "type": "command",
+      "commands": [
+        "unzip -o halo-linux-release.zip",
+        "rm -f halo-linux-release.zip",
+        "chmod 0755 halo halo-server",
+        "mkdir -p maps custom_maps gametypes saves logs",
+        "./halo --version"
+      ]
+    }
+  ],
+  "run": {
+    "command": "./halo --server",
+    "stop": "quit",
+    "workingDirectory": "",
+    "pre": [],
+    "post": [],
+    "environmentVars": {
+      "HALO_NET_TUNNEL_PORT": "${port}",
+      "HALO_SERVER_NAME": "${name}",
+      "HALO_SERVER_ROTATION": "${rotation}",
+      "HALO_SERVER_MAX_PLAYERS": "${max_players}",
+      "HALO_SERVER_PUBLIC": "${public}",
+      "HALO_SERVER_WEB_PORT": "${web_port}",
+      "HALO_SERVER_LOG_FORMAT": "${log_format}",
+      "HALO_SERVER_STATUS_FILE": "status.json",
+      "HALO_SAVE_ROOT": "saves",
+      "HALO_LOG_ROOT": "logs"
+    },
+    "autostart": false,
+    "autorecover": true,
+    "autorestart": false
+  },
+  "data": {
+    "release_url": {
+      "type": "string",
+      "display": "Release",
+      "desc": "The release's halo-linux-release.zip: .../releases/latest/download/halo-linux-release.zip, or .../releases/download/<tag>/halo-linux-release.zip. Used when the server is installed again.",
+      "required": true,
+      "value": "https://github.com/OpenCommunityEdition/OpenCE/releases/latest/download/halo-linux-release.zip",
+      "userEdit": true
+    },
+    "port": {
+      "type": "integer",
+      "display": "Tunnel port",
+      "desc": "The UDP port of internet play (network.tunnel_port), the one port players need.",
+      "required": true,
+      "value": 2302,
+      "userEdit": true
+    },
+    "name": {
+      "type": "string",
+      "display": "Server name",
+      "desc": "The game's name in the server browser: 15 characters of printable ASCII.",
+      "required": true,
+      "value": "OpenCE Server",
+      "userEdit": true
+    },
+    "rotation": {
+      "type": "string",
+      "display": "Rotation",
+      "desc": "The games played one after another: map:gametype entries separated by commas.",
+      "required": true,
+      "value": "bloodgulch:ctf, sidewinder:team_slayer, prisoner:slayer",
+      "userEdit": true
+    },
+    "max_players": {
+      "type": "integer",
+      "display": "Max players",
+      "desc": "2 to 127.",
+      "required": true,
+      "value": 16,
+      "userEdit": true
+    },
+    "public": {
+      "type": "boolean",
+      "display": "Public",
+      "desc": "List the server in everyone's server browser.",
+      "required": true,
+      "value": true,
+      "userEdit": true
+    },
+    "web_port": {
+      "type": "integer",
+      "display": "Web UI port",
+      "desc": "The web page, its API and the remote console, on 127.0.0.1 (server.web_port); 0 for none. Each server on a node needs a port of its own, and not PufferPanel's own (8080). The admin password is printed at the first start and kept in config.toml.",
+      "required": true,
+      "value": 8090,
+      "userEdit": true
+    },
+    "log_format": {
+      "type": "option",
+      "display": "Log format",
+      "desc": "The console's lines.",
+      "required": true,
+      "value": "text",
+      "userEdit": true,
+      "options": [
+        {
+          "value": "text",
+          "display": "Text"
+        },
+        {
+          "value": "json",
+          "display": "JSON"
+        }
+      ]
+    }
+  },
+  "environment": {
+    "type": "host",
+    "mounts": [
+      "/lib32",
+      "/usr/lib32"
+    ]
+  },
+  "supportedEnvironments": [
+    {
+      "type": "host",
+      "mounts": [
+        "/lib32",
+        "/usr/lib32"
+      ]
+    }
+  ],
+  "requirements": {
+    "os": "linux",
+    "arch": "amd64"
+  }
+}

deploy/release-key.pub

@@ -0,0 +1 @@
+d04e8b101007d1641cace8b95fcca76f7f44709f6885c3d031b52394dbdf9376

deploy/systemd/README.md

@@ -0,0 +1,52 @@
+# The dedicated server under systemd
+
+`halo-server@.service` runs the dedicated server (`docs/dedicated_server.md`)
+as a templated unit: one instance for each folder
+`/opt/opence/servers/<name>`, all sharing one release in `/opt/opence/bin`
+and one read-only copy of the game data in `/opt/opence/data`.
+
+| Path | What |
+| --- | --- |
+| `/opt/opence/bin/` | The release (`halo-linux-release.zip`, unzipped) |
+| `/opt/opence/data/` | The game data, only read: `maps/`, `custom_maps/`, `gametypes/` |
+| `/opt/opence/servers/<name>/` | The instance's own, the only folder it may write: `config.toml`, `init.txt`, `publisher.key`, `server.env`, `saves/` (the map cache), `logs/` |
+
+## Installing
+
+```sh
+sudo useradd --system --home-dir /opt/opence --shell /usr/sbin/nologin halo
+sudo install -d -o halo -g halo -m 0750 /opt/opence/servers/main
+sudo cp deploy/systemd/halo-server@.service /etc/systemd/system/
+sudo systemctl daemon-reload
+sudo systemctl enable --now halo-server@main
+journalctl -u halo-server@main -f
+```
+
+Open UDP 2302 (the instance's `network.tunnel_port`) in the firewall.
+
+## Settings
+
+`server.env` in the instance's folder holds its settings as `HALO_*`
+variables, one a line (port/linux/README.md, "Dedicated server"). A
+variable set there wins over `config.toml`, and `sv_set` and the web page
+cannot change it; leave out what you want to change from the web page.
+
+A second instance on the machine needs ports of its own, and its own
+loopback address for system link:
+
+```sh
+HALO_NET_TUNNEL_PORT=2303
+HALO_SERVER_WEB_PORT=8081
+HALO_NET_ADDRESS=127.0.0.2
+HALO_NET_BROADCAST=127.0.0.1
+```
+
+The web port stays on 127.0.0.1 unless `server.env` says otherwise (and
+then it needs a password, and TLS in front of it).
+
+## Exit codes
+
+Exit code 5 (`sv_restart`, or an update installed) restarts the server; 2
+(no usable maps) and 3 (bad configuration) do not, as a restart would fail
+the same way. The unit has no console (`StandardInput=null`): commands come
+from `init.txt` and the web port.

deploy/systemd/halo-server@.service

@@ -0,0 +1,96 @@
+# A dedicated server under systemd (docs/dedicated_server.md), one instance
+# for each folder /opt/opence/servers/<name>:
+#
+#   /opt/opence/bin/                the release (halo-linux-release.zip, unzipped)
+#   /opt/opence/data/               the game data, shared by every instance and
+#                                   only read: maps/, custom_maps/, gametypes/
+#   /opt/opence/servers/<name>/     the instance's own: config.toml, init.txt,
+#                                   publisher.key, server.env, logs/, saves/
+#
+# server.env holds the instance's settings as HALO_* variables, one a line.
+# A second instance on the machine needs its own ports, and its own loopback
+# address for system link:
+#
+#   HALO_NET_TUNNEL_PORT=2303
+#   HALO_SERVER_WEB_PORT=8081
+#   HALO_NET_ADDRESS=127.0.0.2
+#   HALO_NET_BROADCAST=127.0.0.1
+#
+# Install:
+#   sudo useradd --system --home-dir /opt/opence --shell /usr/sbin/nologin halo
+#   sudo install -d -o halo -g halo -m 0750 /opt/opence/servers/main
+#   sudo cp deploy/systemd/halo-server@.service /etc/systemd/system/
+#   sudo systemctl daemon-reload
+#   sudo systemctl enable --now halo-server@main
+#   journalctl -u halo-server@main -f
+#
+# Open UDP 2302 (each instance's network.tunnel_port) in the firewall. The
+# web port stays on 127.0.0.1 unless server.env says otherwise.
+#
+# Exit code 5 (sv_restart, or an update installed) restarts the server;
+# 2 (no usable maps) and 3 (bad configuration) do not, as a restart would
+# fail the same way.
+[Unit]
+Description=OpenCE dedicated server %i
+Documentation=https://github.com/OpenCommunityEdition/OpenCE/blob/main/docs/dedicated_server.md
+After=network-online.target
+Wants=network-online.target
+
+[Service]
+Type=exec
+User=halo
+Group=halo
+WorkingDirectory=/opt/opence/servers/%i
+Environment=HOME=/opt/opence/servers/%i
+Environment=HALO_CONFIG_FILE=/opt/opence/servers/%i/config.toml
+Environment=HALO_DATA_ROOT=/opt/opence/data
+Environment=HALO_SAVE_ROOT=/opt/opence/servers/%i/saves
+Environment=HALO_LOG_ROOT=/opt/opence/servers/%i/logs
+Environment=HALO_SERVER_INIT_FILE=/opt/opence/servers/%i/init.txt
+Environment=HALO_NET_TUNNEL_PORT=2302
+EnvironmentFile=-/opt/opence/servers/%i/server.env
+ExecStartPre=/bin/mkdir -p /opt/opence/servers/%i/logs /opt/opence/servers/%i/saves
+ExecStart=/opt/opence/bin/halo --server
+# (no console: commands come from init.txt and the web port)
+StandardInput=null
+StandardOutput=journal
+StandardError=journal
+KillSignal=SIGTERM
+TimeoutStopSec=15
+Restart=on-failure
+RestartSec=10
+RestartForceExitStatus=5
+RestartPreventExitStatus=2 3
+# (no privileges, nothing writable but the instance's folder)
+NoNewPrivileges=yes
+CapabilityBoundingSet=
+AmbientCapabilities=
+ProtectSystem=strict
+ReadWritePaths=/opt/opence/servers/%i
+ProtectHome=yes
+PrivateTmp=yes
+PrivateDevices=yes
+ProtectKernelTunables=yes
+ProtectKernelModules=yes
+ProtectKernelLogs=yes
+ProtectControlGroups=yes
+ProtectClock=yes
+ProtectHostname=yes
+ProtectProc=invisible
+RestrictAddressFamilies=AF_INET AF_UNIX AF_NETLINK
+RestrictNamespaces=yes
+RestrictRealtime=yes
+RestrictSUIDSGID=yes
+LockPersonality=yes
+MemoryDenyWriteExecute=yes
+# (a 32-bit x86 program)
+SystemCallArchitectures=native x86
+SystemCallFilter=@system-service
+SystemCallFilter=~@privileged
+SystemCallErrorNumber=EPERM
+UMask=0027
+MemoryMax=600M
+TasksMax=64
+
+[Install]
+WantedBy=multi-user.target

docs/OPENCE_README.md

@@ -1,5 +1,5 @@
 > This is the README of [OpenCE](https://github.com/OpenCommunityEdition/OpenCE),
-> the port Ringfall: Mjolnir VR is built on, kept for its build and
+> the port Mjolnir VR is built on, kept for its build and
 > development notes. Its download links are OpenCE's. For the VR mod, see
 > the [main README](../README.md).
 
@@ -35,7 +35,7 @@ problems.
 
 The game updates itself. At start-up it looks for a newer release, and asks
 if you want to install it. Refer to "Updates" in
-[port/linux/README.md](../port/linux/README.md#updates). The web site offers
+[port/linux/README.md](port/linux/README.md#updates). The web site offers
 each new build when it is out.
 
 Each build of the `main` branch that passes on all four platforms is a new
@@ -43,9 +43,13 @@ release, and the web site then plays it. The [Releases](https://github.com/OpenC
 page keeps the last five releases. If the latest build has a problem, get
 an older build from that page.
 
+### Arch-based Linux Distributions
+
+The above Linux binary release is available on the [AUR](https://aur.archlinux.org/packages/opence-bin).
+
 ## Game data
 
-The port does not include the game data. Make an Xbox disc image from your own copy
+The port does not include the game data. Download an Xbox disc image
 (`.xiso` or `.iso`) of Halo: Combat Evolved. All versions of the game
 operate. The maps of the European (PAL) version were made for a slower
 console. The port changes them to play as the North American (NTSC) maps do,
@@ -57,10 +61,19 @@ so players of the two versions can play together.
 
 On Linux and Windows, the game puts `maps/` next to the executable. On
 Android, copy the disc image to the phone first. The app puts `maps/` in its
-data folder. Refer to [port/android/README.md](../port/android/README.md). On
+data folder. Refer to [port/android/README.md](port/android/README.md). On
 the web, the page copies `maps/` out of the disc image into the browser's
 storage for the site; nothing is uploaded. Refer to
-[port/web/README.md](../port/web/README.md).
+[port/web/README.md](port/web/README.md).
+
+## Mods
+
+Mods are folders of Halo PC tag files, as the Halo Editing Kit and Invader
+write them, in `mods/` next to `maps/`: texture, sound, text and model packs
+that play over the maps' on your machine only, in any game. Each has a
+`mod.toml`. Every mod in the folder is on; the main menu's Mods turns them
+off and on and sets the order they load in.
+Refer to [docs/mods.md](docs/mods.md).
 
 ## Platforms
 
@@ -68,10 +81,10 @@ Each platform has its own instructions:
 
 | Platform | Instructions |
 | --- | --- |
-| Linux (32-bit x86 executable, OpenGL 4.5, SDL3) | [port/linux/README.md](../port/linux/README.md) |
-| Windows (32-bit x86 executable, OpenGL 4.5, SDL3) | [port/windows/README.md](../port/windows/README.md) |
-| Android (arm64 app, OpenGL ES 3, SDL3) | [port/android/README.md](../port/android/README.md) |
-| Web (WebAssembly, WebGL 2, SDL3; desktop Chrome, Edge and Firefox) | [port/web/README.md](../port/web/README.md) |
+| Linux (32-bit x86 executable, OpenGL 4.5, SDL3) | [port/linux/README.md](port/linux/README.md) |
+| Windows (32-bit x86 executable, OpenGL 4.5, SDL3) | [port/windows/README.md](port/windows/README.md) |
+| Android (arm64 app, OpenGL ES 3, SDL3) | [port/android/README.md](port/android/README.md) |
+| Web (WebAssembly, WebGL 2, SDL3; desktop Chrome, Edge and Firefox) | [port/web/README.md](port/web/README.md) |
 
 The Linux README also gives the controls, the settings and the multiplayer
 functions. These are almost the same on all platforms.
@@ -84,19 +97,19 @@ The game can play system link games on a local network and on the internet:
 - Linux, Windows and Android machines and browsers can play in the same
   game. On a local network, the native builds play system link; browsers
   play each other in rooms, over WebRTC
-  ([port/web/README.md](../port/web/README.md)).
+  ([port/web/README.md](port/web/README.md)).
 - An invite link, or the server browser, lets a machine join a game on the
   internet, browsers too: a native build takes a browser's WebRTC
-  ([port/linux/README.md](../port/linux/README.md), "Browsers"). No server of
+  ([port/linux/README.md](port/linux/README.md), "Browsers"). No server of
   this project is necessary.
 - The netcode is new. Each machine moves its own player at once,
   and the host makes the decisions for the game. Refer to
-  [port/linux/NETCODE.md](../port/linux/NETCODE.md).
+  [port/linux/NETCODE.md](port/linux/NETCODE.md).
 
 ## Build the game
 
 You do not need the Xbox SDK. The port supplies the SDK declarations that
-the game uses. Refer to [port/include/xdk](../port/include/xdk/README.md).
+the game uses. Refer to [port/include/xdk](port/include/xdk/README.md).
 
 To build the game:
 
@@ -127,7 +140,7 @@ Give these options to `configure.py`:
 | --- | --- |
 | (none) | A debug build. A failed assertion stops the game. |
 | `--release` | A release build. The game does not examine assertions, as in the retail game. |
-| `--portable` | The Linux and Windows builds operate on all x86-64 processors. The Linux build also operates on older distributions and on SteamOS: refer to "Portable build" in [port/linux/README.md](../port/linux/README.md#portable-build). Use this option for builds that you give to other persons. |
+| `--portable` | The Linux and Windows builds operate on all x86-64 processors. The Linux build also operates on older distributions and on SteamOS: refer to "Portable build" in [port/linux/README.md](port/linux/README.md#portable-build). Use this option for builds that you give to other persons. |
 | `--lto=thin`, `--lto=off` | Less link-time optimization. The link is faster. |
 | `--pgo=off` | No profile-guided optimization. |
 | `--pgo=train` | Records a new optimization profile. Refer to "Optimization profiles". |
@@ -187,10 +200,41 @@ file.
 `debug.profile_memory` sets the memory of a recording in MB (default 256,
 from 4 to 1024). A recording has no length limit:
 the game writes a part each time the memory is full. Refer to "Settings" in
-[port/linux/README.md](../port/linux/README.md).
+[port/linux/README.md](port/linux/README.md).
 
 On Android, the files are in `/sdcard/Android/data/com.halo.decomp/files/profiles/`.
 Enter `adb pull` to copy the recording parts to a computer.
 
 A profiling build plays with normal builds. It does not use
 `--pgo=train`.
+
+## Licence
+
+OpenCE is free software: you can give it to others and change it under the
+terms of the GNU Affero General Public License as published by the Free
+Software Foundation, version 3 of the License or (at your option) any later
+version (`AGPL-3.0-or-later`). It comes with no warranty. The full text is in
+[LICENSE](LICENSE).
+
+- **From the change.** The AGPL applies from the commit that made the change,
+  and to each release built from that commit or a later one. Earlier
+  releases, and the source at every earlier commit, were released under
+  [CC0 1.0](LICENSES/CC0-1.0.txt) and stay that way.
+- **What OpenCE builds on.** The decompilation of
+  [punpckhdq/halo](https://github.com/punpckhdq/halo) is under the AGPL 3.0
+  from 17 October 2026, and under CC0 1.0 before that date.
+  [bnunu/halo-1](https://github.com/bnunu/halo-1) is under CC0 1.0.
+- **Contributions** are under `AGPL-3.0-or-later`. A change taken from a
+  project under GPL 3.0 keeps that licence and its notices; the GPL 3.0 and
+  the AGPL 3.0 let the two be combined (section 13 of each).
+- **Hosts and servers.** If you change the game and let other persons play
+  with your version over a network (for example, as the host of an internet
+  game, or on a web site), the AGPL asks you to offer them the source of
+  your version (section 13). The game as released has its source here, and
+  each release's source is its tag (`build-<n>`).
+- **Third-party code, fonts and art** keep their own licences, which are
+  next to them (`port/third_party`, `port/assets/fonts`,
+  `port/assets/icons`, `port/assets/text_filter`). The release downloads and
+  the web site's `licenses.txt` carry their notices.
+- **Halo is not covered.** The licence covers the work of OpenCE's authors.
+  It gives no rights in Halo, its maps or anything else that Microsoft owns.

docs/custom_edition_caches.md

@@ -493,9 +493,9 @@ file the same as the host's; with `network.map_download` off, or a host with
   but their model parts have its 0x68-byte layout and their shader types its
   numbering, which makes them a check on what the conversion produces.
 
-OpenSauce and Reclaimer are GPL-3.0 and this repository is CC0: no code from
-either was copied. They were read as documentation of the file formats, and
-every layout used was then checked against the sample maps.
+No code from OpenSauce or Reclaimer (both GPL-3.0) was copied: they were
+read as documentation of the file formats, and every layout used was then
+checked against the sample maps.
 
 ### Documented facts (source, checked against the sample maps)
 

docs/dedicated_server.md

@@ -0,0 +1,761 @@
+# The dedicated server: reference
+
+`halo --server` runs the game as a host with no window, sound or player of
+its own: other machines join it on the LAN, by its invite link or from the
+server browser, as they join any host. `port/linux/README.md`, "Dedicated
+server", says how to run one; this document is the reference for what it
+takes and answers: the command line, the exit codes, the commands, the
+HTTP API, the remote console (RCON) over WebSocket, the events, the log and
+the files. `docs/master_protocol.md` is the master servers' protocol, which
+the server publishes to and the server browser reads.
+
+The code is `port/linux/src/server_*.c` (the platform side: the mode, the
+standard input, the log, the rotation's grammar, the HTTP and WebSocket
+server, the master servers' publisher) and `port/linux/game/server_*.c`
+(the game side: the director that plays one game after another, the
+commands, the gametypes, the status). The Android and web builds have no
+dedicated server: they compile those files to nothing, but for
+`server_json.c` (the JSON reader, which the server browser's list of master
+servers uses in every build) and `server_rotation.c` (the rotation's
+grammar and the gametype rules), which every build compiles.
+
+## Panels and fleets
+
+A game panel (Pterodactyl, PufferPanel, MCSManager: `deploy/`) runs one
+server and reads its standard output; `deploy/systemd` and `deploy/docker`
+run servers on one machine. For many servers on many machines, `opence-fleet`
+([github.com/OpenCommunityEdition/opence-fleet](https://github.com/OpenCommunityEdition/opence-fleet))
+is one control plane over them all: an agent on each machine runs the
+servers and drives each through this document's API, as the owner from
+the machine itself (`server.web_owner_password`, below). What it relies on
+is named in the status's and the RCON's `capabilities`: `owner_web` (the
+owner's role over the web, from loopback), `ban_address` (`sv_ban_address`,
+`POST /api/bans`), `stop` (`sv_stop`, `POST /api/stop`, the `drain` event),
+`event_addresses` (addresses in the player events) and `identity` (the
+status's `pid`, `instance`...).
+
+## Command line
+
+| Argument | What it does |
+| --- | --- |
+| `--server` | Dedicated server mode (as `HALO_SERVER=1` or `server.enabled = true`) |
+| `--config <path>` | The settings file; default `config.toml` beside the executable. `HALO_CONFIG_FILE`, when it is set, wins over `--config` |
+| `--version` | Prints `OpenCE build-<n> (network version <v>)` and exits 0 |
+| `--keygen` | Writes a new publisher key (`server.publisher_key_file`) unless one exists, prints its public key and key id, exits 0; exits 3 when the key cannot be made, read or written |
+| `--sign <text>` | Prints the publisher key's Ed25519 signature of the text, in hex (an application's proof of key), exits 0; exits 3 without a text or a usable key |
+| `--probe [<invite>]` | A look at a server, for a list site that shows its state: joins nothing and never starts a server (whatever `--server`, `HALO_SERVER` or `server.enabled` say). It finds the invite's game over its tunnel (without an invite, the LAN's first) and prints it as one line of JSON, the game of the invite's host alone (never another game that answers), and exits 0; when nothing answers in 30 seconds it prints `{"ok":false,"error":"no game answered in 30 seconds"}` and exits 1. Internet play is as set (`network.online`, on by default), which an invite needs |
+| `--help` | Prints these, exits 0 |
+
+`--version`, `--help`, `--keygen`, `--sign` and `--probe` write no settings: the
+settings file is read, never completed or made. `--probe` wins over
+`--server`, `HALO_SERVER` and `server.enabled`: a probe never writes to
+`config.toml`.
+
+A probe's line:
+
+```json
+{"ok":true,"name":"OpenCE Server","map":"bloodgulch","gametype":"ctf","players":5,"max_players":16,
+ "teams":true,"in_progress":true,"open":true,"dedicated":true,"network_version":38,"kind":0}
+```
+
+`gametype` is the game engine's name (`ctf`, `slayer`, `oddball`, `king`,
+`race`, or `none`), `kind` the OpenCE gametype's kind the host sends (0 for
+none), `open` whether it takes players now.
+
+The release has a `halo-server` script beside `halo`, which runs
+`halo --server` with its arguments.
+
+## Exit codes and signals
+
+| Code | Meaning |
+| --- | --- |
+| 0 | Stopped: `quit`, `sv_stop` (now, or at the end of its drain), SIGTERM or SIGINT |
+| 1 | A fatal error in the game (a halt, a map that failed to load); the last error lines were logged. The process exits within 5 seconds of the error, even when what runs at the exit (a hook, a listing's withdrawal) does not return |
+| 2 | No usable game data: `maps/ui.map`, or every rotation map, missing or not a cache file; nothing was bound |
+| 3 | Bad server configuration: no rotation entry that can be played (and `server.rotation_fallback` off), `server.web_port` past 65535, a web port the server may not bind (a port below 1024 without the right to it) or whose `server.web_bind` is an address the machine does not have, or a web password (admin, moderator or viewer) shorter than 8 characters with the web port bound beyond loopback (on loopback, a warning), or the owner's (`server.web_owner_password`) shorter than 8 wherever it is bound; `--keygen` or `--sign` failing. An entry that cannot be played (a bad gametype file among them) is left out with a warning: the server stops only when none is left |
+| 4 | A port in use: the tunnel's UDP port, or the web port (another program listens on it) |
+| 5 | Restart asked for (`sv_restart`, now or at the end of its drain, or an update installed: `server.auto_update = "install"` installs a new release once the server has been empty for 10 minutes, on a thread of its own: the server goes on meanwhile, and stops with 5 once it is empty again (a player who joined during the install plays on). An install that fails is tried again at the next check, 6 hours on) |
+| 128 + n | Stopped by signal n: a second SIGTERM or SIGINT, or the shutdown not done 5 seconds after the first |
+
+SIGTERM and SIGINT stop the server: a game in progress goes to its
+postgame, every machine is told, the listings are withdrawn, and it exits 0.
+SIGHUP reloads the server's settings, the rotation and the gametype files
+(`sv_reload`). SIGUSR1 prints the status on standard output. SIGPIPE and
+SIGTTIN are ignored.
+
+## Standard output
+
+One line per event, for the operator and the panel:
+
+```
+2026-10-19T18:03:11Z INFO server: ready (tunnel 2302/udp, web 127.0.0.1:8080, listing public)
+2026-10-19T18:03:40Z INFO player: Milenko joined (slot 0, machine 1)
+2026-10-19T18:04:02Z INFO game: started: CTF on bloodgulch, 2 players
+```
+
+The fields are the time (UTC), the level (`INFO`, `WARN`, `ERROR`), the
+category (`server`, `lobby`, `game`, `player`, `chat`, `moderation`, `net`,
+`master`, `console`, `health`) and the text. `server: ready` is printed once,
+when the lobby is open and, for a public server, its listing has been
+published (or 10 seconds on, as the brokers are other people's): it is the
+line a panel waits for. With `server.log_format = "json"` each line is an
+object instead, and the line a panel waits for holds `"msg":"ready (`:
+
+```json
+{"time":"2026-10-19T18:03:11Z","level":"info","cat":"server","msg":"ready (tunnel 2302/udp, ...)"}
+```
+
+Every line is also kept in the log the web's viewers read (`/api/log`,
+`sv_log`, the RCON's `log` events), but for these, which go to standard
+output alone: the web password a first start makes, the invite (a
+private server's lets anyone in; `/api/status` gives it to admins), and
+the owner's console, the commands typed on standard input or read from the
+init file and what they answered (a password's command is shown as `(a
+password's command)` there too).
+
+A health line comes once a minute: `health: players=3 frame_ms_max=4.1
+frame_ms_avg=1.20 cpu=2.1% rss=96MB` (the longest and the mean frame of
+the last minute, in milliseconds). Standard error keeps the platform
+layer's `halo-linux:` lines, and `debug.txt` everything, as for a player's
+game.
+
+## Commands
+
+The same commands come from standard input, `server.init_file` (run once at
+the start, a command a line, `#`, `;` and `//` starting comments), the telnet
+console (`debug.telnet_console`, loopback), the RCON, `POST /api/command`
+and the web page. Each runs on the game's thread between frames. Every
+command has a role; a caller may run it if their role is that one or above:
+**viewer** < **moderator** < **admin** < **owner** (standard input, the
+init file and the telnet console are the owner's: whoever holds the
+process; so is a sign-in to the web or the RCON with
+`server.web_owner_password` from the machine itself: "Signing in"). When
+standard input ends and `server.console_exit_on_eof` is on, its last line
+runs, whether or not a line's end ended it, and then the server stops.
+
+A `<player>` is a slot number (`sv_players` lists them) or the start of a
+name; a name that begins more than one player's is refused. A `<duration>`
+is a number and a unit (`45s`, `30m`, `2h`, `7d`, `1w`), a bare number of
+minutes, or `forever`; ten years at most. A word in quotes (`"two words"`)
+is one word.
+
+A command's text (a notice, a reason, `sv_set`'s value, a name) is kept to
+printable ASCII: control characters (a line's end, a tab) and other bytes
+outside it are dropped, as are the quotes around the whole text, and
+standard input's and the init file's lines are cleaned so before they run.
+The web is stricter where it takes a value as it is: `PUT /api/settings`
+refuses a value with a control character (`schema`), and nothing is changed
+for that setting. A command's reply is sent whole, however many lines.
+
+Commands that are not the server's (the game's own console commands, the
+scripts' globals and functions) need the owner role: from the web or the
+RCON they are refused (`not a command of the server's`) but to the owner's
+session. The server's
+commands come first, so `kick` and `ban` are always the server's below, not
+the game's console commands of those names.
+
+| Command | Role | What it does |
+| --- | --- | --- |
+| `help [command]` | viewer | The commands, or one command's use |
+| `sv_status [--json]` | viewer | The server's state, map, gametype, players, uptime, games played, network version, listing and next game |
+| `sv_players [--json]` | viewer | Each player's slot, name, team, score, kills, deaths, assists, ping and machine; with the owner role or `server.log_addresses`, their address and hardware id |
+| `sv_rotation` (`sv_mapcycle`), `sv_maps`, `sv_gametypes`, `sv_version`, `sv_log [n]` | viewer | Lists: the rotation, the maps there are, the gametypes, the build, the log's last n lines |
+| `sv_bans` (`sv_banlist`), `sv_settings` | admin | Lists: the bans of `bans.txt`, the settings `sv_set` changes |
+| `sv_masters`, `sv_publisher` | viewer | The master servers and how each answered; the publisher key's id and public key (never its seed) |
+| `say <text>` (`sv_say`) | moderator | A notice on every machine's screen |
+| `tell <player> <text>` | moderator | A notice on one player's machine |
+| `kick <player>` (`sv_kick`) | moderator | Drops the player's machine; it may join again |
+| `ban <player> [<duration>] [<reason>]` (`sv_ban`) | moderator (a day at most), admin | Drops the player's machine and bans its address and hardware id, for the duration (else for ever). A moderator must give a duration of a day or less: a ban for ever, or longer, is refused |
+| `unban <number\|address\|hardware id>` (`sv_unban`) | admin | Takes a ban out of `bans.txt`; the machine may join again at once, by the LAN or the internet |
+| `sv_ban_address <address\|hardware id> [<duration>] [<reason>]` | admin | Bans an IPv4 address (`a.b.c.d`) or a hardware id (up to 32 hex digits), its machine here or not: its line in `bans.txt` as `ban` writes it (the other part `none`), so that `sv_bans`, `unban` and `GET /api/bans` see it, and a machine present of that address or hardware id is dropped as `ban` drops it (`player_left`'s reason `banned`). Answers `ban <n> added` (`n`: its number in `sv_bans`) |
+| `mute <player> [<minutes>]`, `unmute <player>` | moderator | The host's mute of a player's chat and voice for everyone |
+| `sv_map <map> [<gametype>]`, `sv_map <entry>` | moderator | Plays that game (or a rotation entry, `map:gametype+rule=value`; a co-op one too), below |
+| `sv_map_next` (`sv_next`) | moderator | Ends the game without its scores and plays the rotation's next |
+| `sv_end_game` | moderator | Ends the game: its scores, then the next |
+| `sv_rotation_set <entries>`, `sv_rotation_add <entry>`, `sv_rotation_del <n>`, `sv_rotation_begin [<n>]` (`sv_mapcycle_add`, `_del`, `_begin`) | admin | Changes the rotation (written to `server.rotation`, 4096 characters at most) |
+| `sv_set <setting> <value>` | admin | Changes one of the server's settings, now where it can be, and in `config.toml` (below); a setting its environment variable sets is refused. A value is 256 characters at most |
+| `sv_name <name>`, `sv_maxplayers <n>`, `sv_password [<password>]`, `sv_public <0\|1>`, `sv_motd <text>` | admin | `sv_set` of `server.name`, `server.max_players`, `server.password`, `server.public`, `server.motd` |
+| `sv_reload` | admin | Reads `config.toml`'s server settings, the rotation and the gametype files again (as SIGHUP) |
+| `sv_stop [now\|game\|empty] [<notice>]`, `sv_stop cancel` | owner | Stops the server (exit code 0): `now` (the default) as `quit` does; `game` once the game being played is over, `empty` once nobody plays (a drain, below); `cancel` the drain waiting. The notice is said to every machine first |
+| `sv_restart [now\|game\|empty] [<notice>]`, `sv_restart cancel` | owner | As `sv_stop`, with exit code 5 (restart me) |
+| `quit` (`exit`) | owner | Stops the server (exit code 0) |
+
+`sv_map`'s game is played as soon as it can be, and its answer says when:
+`next: <entry> (now)` in the lobby before its start was sent (the lobby
+takes the entry, and the rotation's entry it replaced is played after it),
+`(now: this game ends)` while a game is played (it ends at once, without
+its scores), and `(once this game is over)` once the lobby's start was sent
+or while a map loads (it is the next game). `sv_map` of the game being
+played plays it again. The rotation goes on after it.
+
+A drain (`sv_stop` or `sv_restart` with `game` or `empty`, `POST
+/api/stop`) is a stop that waits: the listings are withdrawn as `sv_public
+0` withdraws them (a new invite, the masters told), without the setting
+changing; new machines are refused as while a map loads (the game is not
+open: the LAN's search shows it closed, a join by the invite is told the
+game is not open); then the server stops. With `game` it stops once no
+game is played nor about to be: at once in the lobby with nobody in it, or
+with no countdown running (fewer players than `server.min_players`);
+otherwise once the game played (or about to start) is over and its
+postgame shown. With `empty` it stops once nobody is on the server (at once
+if nobody is now). `sv_stop cancel` (or `sv_restart cancel`) ends the
+drain: the server is listed again as `server.public` says and takes new
+players. A `drain` event says each (`after`: `now`, `game`, `empty` or
+`cancel`), and the stop that ends a drain has the `shutdown` reason
+`drained`. `/api/status`'s `drain` is the drain waiting, or `null`.
+
+A co-op entry (`<level>:coop`) is ended as a game is: by `sv_end_game`,
+`sv_map_next`, `sv_map`, `server.empty_seconds` and `server.idle_minutes`.
+It has no scores: the server goes back to the lobby at once (no postgame),
+and a level won ends it with `game_ended`'s reason `score`.
+
+`sv_set` (and the settings of the web page, `PUT /api/settings`) changes
+these settings, which `sv_settings` and `GET /api/settings` list:
+`server.name`, `server.max_players`, `server.min_players`,
+`server.password`, `server.public`, `server.rotation_fallback`,
+`server.lobby_seconds`, `server.postgame_seconds`, `server.empty_seconds`,
+`server.idle_minutes`, `server.team_start`, `server.motd`,
+`server.frame_rate`, `server.web_password`,
+`server.web_moderator_password`, `server.log_format`,
+`server.log_addresses`, `server.status_file`, `server.auto_update`,
+`server.coop_difficulty`, `server.region`, `server.master_publish`,
+`server.chat_filter`, `server.chat_filter_slurs`, `server.chat_filter_swearing`,
+`server.chat_filter_insults`,
+`server.master_publish_address`, `server.metrics`, and `network.text_chat`,
+`network.voice_lobby`, `network.voice_mode`, `network.voice_kbps`,
+`network.votekick`, `network.votekick_minutes`,
+`network.votekick_ban_minutes`, `network.map_share`,
+`network.map_share_upload`, `network.public_address`,
+`network.coop_friendly_fire`, `network.coop_player_collisions`,
+`network.coop_ally_friendly_fire` and `network.shield_effects`. Of them,
+`server.status_file`, `server.auto_update` and `server.log_addresses` need
+the owner role: from the web's admin, `sv_set` of one of them (`POST
+/api/command`) answers `403 forbidden`, and `PUT /api/settings` leaves it
+out, in its `errors` with the code `forbidden` and the message `<setting>
+needs the owner role (the server's console)`; the owner's session changes
+them both ways. A web password is empty or
+8 characters or more. A value outside a setting's choices or range is
+refused (`400 failed` from `sv_set`, `schema` in `PUT /api/settings`'s
+`errors`), with `<setting> takes a whole number from <min> to <max>` (or
+`from <min>`) or `<setting> is one of <a>|<b>|<c>`; a choice may be given
+in either case, and is kept as the table spells it:
+
+| Setting | Choices or range |
+| --- | --- |
+| `server.max_players` | 2 to 127 |
+| `server.min_players` | 1 to 16 |
+| `server.lobby_seconds`, `server.postgame_seconds` | 0 to 300 |
+| `server.empty_seconds`, `server.idle_minutes` | 0 or more |
+| `server.frame_rate` | 30 to 120 |
+| `server.team_start` | `one`, `both`, `skip` |
+| `server.log_format` | `text`, `json` |
+| `server.auto_update` | `off`, `check`, `install` |
+| `server.coop_difficulty` | `easy`, `normal`, `hard`, `impossible` |
+| `network.text_chat` | `on`, `links`, `off` |
+| `server.chat_filter` | `off`, `censor`, `block` |
+| `server.chat_filter_slurs`, `server.chat_filter_swearing`, `server.chat_filter_insults` | `off`, `severe`, `strong`, `mild` |
+| `network.voice_mode` | `off`, `team_proximity`, `team_enemy_proximity`, `team_global`, `team_global_enemy_proximity` |
+| `network.voice_kbps` | 8 to 64 |
+| `network.votekick_minutes` | 0 to 60 |
+| `network.votekick_ban_minutes` | 1 to 1440 |
+| `network.map_share_upload` | 16 to 20480 |
+| `network.coop_friendly_fire` | `off`, `on`, `shields_only`, `explosives_only` |
+| `network.shield_effects` | `stock`, `glow`, `light_show`, `overshield`, `glow_overshield`, `light_show_overshield`, `players` |
+
+A dedicated server may also keep words out of its chat and its players'
+names (`server.chat_filter`, off by default): the words of streamer mode's
+list, by group, each group from the least severity its setting names
+(`server.chat_filter_slurs`, `mild` by default: every slur;
+`server.chat_filter_swearing` and `server.chat_filter_insults`, `off`).
+`censor` shows a line's words as stars to everyone; `block` refuses the
+line (its sender is told "Your line was not sent: it has words this server
+does not allow") and refuses at the door a machine whose player's name has
+them, which an updated game shows as "The host refused: your player name"
+(an older one says the game is closed). Each is logged (`chat filter: …`,
+`refusing a machine … its name has words the server's filter keeps out`).
+Links are `network.text_chat`'s, refused by default. A list of words is
+not a moderator: spaced letters and look-alikes get past it.
+
+A dedicated server's text chat is its `network.text_chat`'s, listed or
+not: `on` by default (lines with links refused), `links`, or `off`, live
+(`sv_set network.text_chat off`). A game a player hosts has no text chat
+while it is listed in the server browser; a dedicated server is the
+exception, and the players who join it from the browser's dedicated servers
+have the chat as it says, as long as a master server lists it (the
+masters' word that it is an approved operator's; a listing's own flag is
+not enough, so a dedicated server listed by the brokers alone, before its
+operator is approved, has none for them).
+
+The settings `sv_set` does not change (`server.web_viewer_password`,
+`server.web_owner_password`, `server.web_port`, `server.web_bind`, `server.web_trusted_proxy`, the
+paths, the master servers' files...) are changed in `config.toml` or their
+environment variables: `sv_reload` reads the file's `server.*` settings
+again, and the web port and its address are bound once, at the start. The
+rotation is changed by the `sv_rotation_*` commands.
+
+## HTTP
+
+The server listens on `server.web_port` (8080; 0 for none) at
+`server.web_bind` (`127.0.0.1`, an IPv4 address). Bound beyond loopback,
+every web password that is set (admin, moderator, viewer) must have 8
+characters or more, else the server exits with code 3; the owner's
+(`server.web_owner_password`) must have 8 or more wherever the port is
+bound. The page (`/`), the API
+(`/api/...`), the RCON (`/ws`), `/healthz` and `/metrics` share the port.
+
+Requests are HTTP/1.1 (or 1.0), `GET`, `HEAD`, `POST`, `PUT` or `DELETE`
+(`HEAD` is answered as `GET` is, without the body, and counts as a read,
+as a `GET`; `/api/login` takes `POST` alone), a head of 8 KB at most whose
+lines end with CRLF (a bare LF, a CR inside a line, or more after the empty
+line that ends it: `400 bad_request`) and a body of 64 KB at most, sent within 10 seconds of the
+connection's opening or of its last answer (a connection that sends
+nothing is closed then too). `Transfer-Encoding` and `Expect` are refused.
+24 connections are taken at once; when they are all taken, the oldest that
+waits for a request (no RCON, no request being answered) is closed for a
+new one. A client that does not read its answers is read no further once
+256 KB of them wait, and is closed past 2 MB.
+
+Every request but `/healthz` counts against its address's allowance, the
+page's files, `/metrics`, a sign-in and the RCON's upgrades (`/ws`) too: 60
+a minute, or 600 with a session (429 `rate_limited` past it, with
+`Retry-After: 60`). Behind `server.web_trusted_proxy`, a request's address
+is the last entry of its `X-Forwarded-For` (the one the proxy appended: an
+IPv4 address, `a.b.c.d` or `a.b.c.d:port`, or an IPv6 one, `v6`, `[v6]` or
+`[v6]:port`), and its `X-Forwarded-Host` and `X-Forwarded-Proto` are
+believed, whether or not it sends `X-Forwarded-For`; from any other
+address they are ignored. IPv6 clients are counted by their /64: one
+host's addresses share its allowance and its lockouts. Every answer is JSON
+(`Content-Type: application/json`) unless said, with
+`Cache-Control: no-store`, `X-Content-Type-Options: nosniff`,
+`Referrer-Policy: same-origin` (under `no-referrer` a browser would send
+the page's own changes with `Origin: null`) and
+`Content-Security-Policy: default-src 'self'; frame-ancestors 'none'`.
+
+### Signing in
+
+`POST /api/login` with `{"password":"…"}` answers
+`{"ok":true,"token":"<64 hex>","role":"admin","csrf":"<32 hex>","expires":<unix seconds>}`
+and sets the cookie `opence_session=<token>; HttpOnly; SameSite=Strict;
+Path=/`, with `Secure` when the request came through
+`server.web_trusted_proxy` with `X-Forwarded-Proto: https` (never from
+another address, whatever it says). The admin password
+(`server.web_password`) gives the admin role, the moderator password
+(`server.web_moderator_password`) the moderator role, the viewer password
+(`server.web_viewer_password`) the viewer role; `{"by":"…"}` beside the
+password names who signed in, in the log. A session lasts 12 hours, or 30
+minutes without a request (the RCON's messages do not count: a page left
+open asks `GET /api/session` now and then); 16 are kept at most, of every
+role.
+
+The owner's password (`server.web_owner_password`, empty by default: none)
+gives the owner role, for a supervisor on the server's own machine (a
+fleet's agent, a panel's daemon): what standard input may do, over the
+API and the RCON (`quit`, `sv_stop`, `sv_restart`, `POST /api/stop`, the
+owner's settings by `sv_set` and `PUT /api/settings`, the game's own
+console commands by `POST /api/command`, the players' addresses and
+hardware ids in `/api/players` and the events). It signs in only when the
+connection's own peer address is in `127.0.0.0/8` and is not the trusted
+proxy's: never by `X-Forwarded-For`, and never through
+`server.web_trusted_proxy`, even one on the machine itself. From any other
+address the right owner's password is refused with `403 forbidden` (the
+RCON's `auth`: `{"code":"forbidden"}`, and the connection closes 1008),
+and counts toward the address's lockout as a wrong password does. An
+owner's session is used from the machine itself alone, as it was begun
+(from elsewhere its token is no session: `401`, the RCON's `auth` with it
+`denied`). A password that is also another role's gives the owner role
+from the machine itself and the other role from elsewhere: give the owner
+a password of its own.
+
+A script passes `Authorization: Bearer <token>`. The page passes the
+cookie, and on every request that changes something the header
+`X-CSRF-Token: <csrf>`; the `Origin` of such a request (and of the
+WebSocket's) must be the server's own. An `Origin: null` is taken only
+when the browser's `Sec-Fetch-Site` says `same-origin`.
+
+`POST /api/logout` ends the session (with the `X-CSRF-Token` by the
+cookie; `GET` answers 405). `GET /api/session` answers
+`{"ok":true,"role":…,"csrf":…,"expires":…}`, or 401.
+
+When `server.web_password`, `server.web_moderator_password`,
+`server.web_viewer_password` or `server.web_owner_password` changes
+(`sv_set` and the settings change the first two; `sv_reload` reads any of
+them from `config.toml`), the sessions of its role end and that role's RCON
+connections close (1008, `the password changed`).
+
+Five wrong passwords from an address (an IPv6 one's /64) in 10 minutes
+lock it out for 10 minutes (429), and no more than 30 passwords a minute
+are checked in all. `/api/login` takes `POST` alone (any other method:
+405).
+
+### Errors
+
+```json
+{"ok":false,"error":{"code":"forbidden","message":"needs the admin role"}}
+```
+
+| Status | Codes |
+| --- | --- |
+| 400 | `bad_request`, `schema` (a field missing or out of range), `failed` (the command ran and failed: its lines in `lines`), `rejected` (rotation entries: `rejected[]`), `invalid` (a gametype file: `line`) |
+| 401 | `denied` (no session, or a wrong password) |
+| 403 | `forbidden` (the role; the owner's password from beyond the machine), `csrf`, `origin` |
+| 404 | `not_found` (also a command that is not one, a player or a ban that is not there) |
+| 405 | `method` |
+| 409 | `pinned` (a setting its environment variable sets), `changed` (a player's action whose slot holds another player now: the current name in `name`, nothing done) |
+| 413 | `too_large` |
+| 426 | `bad_request` (the WebSocket's version is not 13) |
+| 429 | `rate_limited`, `locked` (with `Retry-After`) |
+| 500 | `internal` (out of memory, a file that cannot be written) |
+| 503 | `loading` (the game did not answer in 20 seconds, as while a map loads; with `Retry-After: 5`), `starting`, `busy` (8 RCON connections already; with `Retry-After: 5`) |
+
+### Endpoints
+
+| Method, path | Role | Body → answer |
+| --- | --- | --- |
+| `GET /healthz` | none | `200 {"state":"lobby"}` (or `loading`, `playing`, `postgame`) while the server hosts and its frames run; `503` with `{"state":"starting"}`, `{"state":"stalled"}` (no frame for a minute) or the other state otherwise |
+| `GET /metrics` | none (`server.metrics`) | Prometheus text |
+| `GET /api/status` | viewer | The status (below) |
+| `GET /api/players` | viewer | `{"ok":true,"players":[<player>…]}` (with `address` and `hwid` for the owner, or every role with `server.log_addresses`) |
+| `POST /api/players/{slot}/kick` | moderator | `{"name":"<the player's name, checked>"}` → `{"ok":true,"lines":[…]}`, or `409 changed` when the slot holds another player |
+| `POST /api/players/{slot}/ban` | moderator | `{"name":…,"duration":"1d","reason":"…"}` (no duration: for ever, which a moderator's ban cannot be: `400 failed`) |
+| `POST /api/players/{slot}/mute` | moderator | `{"name":…,"minutes":10}` |
+| `POST /api/players/{slot}/unmute` | moderator | `{"name":…}` |
+| `POST /api/players/{slot}/tell` | moderator | `{"name":…,"text":"…"}` |
+| `POST /api/say` | moderator | `{"text":"…"}` |
+| `GET /api/rotation` | viewer | `{"ok":true,"index":0,"entries":[<entry>…],"next":<entry>}` |
+| `PUT /api/rotation` | admin | `{"entries":["bloodgulch:ctf",…]}` → the rotation, or `400 rejected` with `"error":{…,"rejected":[{"index":1,"entry":"…","reason":"…"}]}` and nothing changed |
+| `POST /api/rotation/next` | moderator | `{}`: `sv_map_next` |
+| `POST /api/rotation/play` | moderator | `{"map":"…","gametype":"…"}`: `sv_map` (a map or gametype that cannot be played: `400 failed`) |
+| `GET /api/gametypes` | viewer | `{"ok":true,"builtin":["slayer",…],"schema":{"fields":[<field>…]},"files":[{"name":…,"base":…,"description":…,"error":null}]}` (`builtin`: the Xbox's gametypes, then OpenCE's; a file that cannot be read has `base` and `description` empty and `error` saying why) |
+| `GET /api/gametypes/{name}` | viewer | `{"ok":true,"name":…,"text":"<the TOML>"}` |
+| `PUT /api/gametypes/{name}` | admin | `{"text":"<TOML>"}` → `{"ok":true}`, or `400 invalid` with `line` and `message` (a name is `a`–`z`, `0`–`9`, `_` and `-`, 32 at most) |
+| `DELETE /api/gametypes/{name}` | admin | `{"ok":true}` |
+| `GET /api/maps` | viewer | `{"ok":true,"maps":[{"name":"bloodgulch","level":"levels\\test\\bloodgulch\\bloodgulch","kind":"xbox","title":"Blood Gulch"}…]}` (`kind`: `xbox` or `custom`; `title` is the map's display name, else its `name`) |
+| `GET /api/bans` | admin | `{"ok":true,"bans":[{"n":0,"when":"2026-10-19 18:00:00","ip":"…","hwid":"…","players":"…","reason":"…","until":<unix>\|null}…]}` |
+| `POST /api/bans` | admin | `{"ip":"203.0.113.5","hwid":"…","names":"…","duration":"1d","reason":"…"}` (`ip` or `hwid`, or both; the rest may be left out: no duration is for ever) → `{"ok":true,"n":<the new ban's number in GET /api/bans>}`: `sv_ban_address`, a machine present of the address or the hardware id dropped; `400 schema` for an address that is not IPv4, a hardware id that is not hex, a duration that is not one |
+| `DELETE /api/bans/{n}` | admin | `{"ok":true}` |
+| `GET /api/settings` | admin | `{"ok":true,"settings":[<setting>…]}` |
+| `PUT /api/settings` | admin | `{"server.name":"…","server.max_players":16,"server.public":true,…}` (a value as JSON, a boolean, a number or a string, or its text: `"true"`, `"16"`; `null` empties it) → `{"ok":true,"applied":["server.name"],"errors":[{"name":…,"code":…,"message":…}]}`; each setting is changed or refused on its own |
+| `POST /api/command` | the command's | `{"line":"sv_status"}` (511 characters at most) → `{"ok":true,"lines":["…"]}`, or a refusal (`failed`, `forbidden`, `not_found`, `pinned`) with the command's `lines` |
+| `POST /api/stop` | owner | `{"after":"now\|game\|empty","notice":"…","restart":false}` (`notice` and `restart` may be left out) or `{"cancel":true}` → `{"ok":true,"lines":["…"]}`: `sv_stop` (`sv_restart` with `restart`) `after notice`, or `sv_stop cancel` (`400 failed` with no drain waiting); `400 schema` for another `after` |
+| `GET /api/log?after=<n>&limit=<m>` | viewer | `{"ok":true,"lines":[{"n":12,"time":<ms>,"level":"info","cat":"game","text":"…"}…],"next":12,"missed":0}` (`limit` 1 to 1024, 256 by default; the chat's lines for admins only) |
+| `GET /api/events?after=<seq>` | viewer | `{"ok":true,"events":[<event>…],"next":<seq>,"missed":0}` (`player_joined` and `player_left` with `address` and `hwid` for the owner, or every role with `server.log_addresses`) |
+| `GET /ws` | | The RCON (below) |
+| `GET /`, `/app.js`, `/app.css`, `/icon.svg` | none | The page (`server.web_ui`) |
+
+`next` is the `after` of the next request: the last line's `n` (or event's
+`seq`) read. An `after` past the latest (as after a restart) reads from the
+start. `missed` counts lines or events that left the ring (2048 lines, 512
+events) before they were asked for.
+
+### The status
+
+```json
+{"ok":true,"time":1760900000123,"name":"OpenCE Server","state":"playing",
+ "build":"build-206","network_version":38,"uptime":3600,"games_hosted":4,
+ "map":"bloodgulch","level":"levels\\test\\bloodgulch\\bloodgulch","gametype":"ctf","variant":"CTF","teams":true,
+ "players":5,"max_players":16,"machines":5,"countdown":-1,"game_seconds":312,"team_scores":[2,1],
+ "listing":{"online":true,"public":true,"password":false,"invite":"halo://join/…"},
+ "rotation":{"index":0,"count":3,"next":{"text":"sidewinder:team_slayer","map":"sidewinder","gametype":"team_slayer"}},
+ "frame_ms_max":4.1,"frame_ms_avg":1.2,"tick_ms_avg":1.2,
+ "masters":[{"url":"https://master1.example.org","listed":true,"probe":"ok","code":"","message":"","updated":1760899990}],
+ "update":{"available":false,"build":""},
+ "drain":null,
+ "pid":4021,"started":1760896400,"instance":"eu-1","region":"eu","tunnel_port":2302,
+ "publisher_key_id":"3f9a2c7d1e5b8a04","web_port":8080,
+ "capabilities":["events","status","rotation","settings","bans","owner_web","ban_address","stop","event_addresses","identity"]}
+```
+
+`state` is `waiting` (the menus settling), `hosting` (making the game),
+`lobby`, `loading`, `playing`, `postgame` or `stopping`. `countdown` is the
+lobby's seconds left, `-1` when it is not counting. `team_scores` is `null`
+in a game without teams. `frame_ms_max` and `frame_ms_avg` are the longest
+and the mean frame of the last minute (`tick_ms_avg` is the mean again, for
+older readers). `invite` is given to admins only (empty for others). An entry of the rotation is
+`{"text":"sidewinder:team_slayer+score=50","map":"sidewinder","gametype":"team_slayer","rules":{"score":50},"rejected":null}`
+(`rejected` is why it cannot be played, else `null`). `drain` is the
+drain waiting (`sv_stop game`...), `{"after":"game","restart":false,"since":<unix
+seconds>}`, else `null`. `pid` is the server's process, `started` when it
+started (seconds since 1970), `instance` the name the master servers know
+it by (`server.instance`, else the slug of `server.name` they are given),
+`region` `server.region`, `tunnel_port` the tunnel's UDP port
+(`network.tunnel_port`; 0 when `network.online` is off), `publisher_key_id`
+the publisher key's id (16 hex digits; empty without a key: `sv_publisher`)
+and `web_port` `server.web_port`. `capabilities` is the RCON's hello's. The rotation's
+`index` (in the status and `GET /api/rotation`) is the entry being played,
+`-1` while an `sv_map` game is played or before the first lobby; `next` is
+the entry after the one played last (the first while none has been).
+
+A player is
+`{"slot":0,"name":"Milenko","team":0,"score":3,"kills":3,"deaths":1,"assists":0,"ping":42,"machine":1,"joined":1760899000,"muted":false}`;
+with the owner role, or `server.log_addresses`, also
+`"address":"203.0.113.5","hwid":"…"`. `team` is 0 (red), 1 (blue) or -1
+(no teams); `ping` is in milliseconds, `null` when it is not known yet.
+`client` is the player's machine's build as its game tells it (shortly
+after it joins), for every role:
+`{"build":282,"flavor":"release","version":"OpenCE Linux | build 282 (release)","repository":"OpenCommunityEdition/OpenCE","mods":["trollface 1.0"]}`
+(`build` 0 for a build CI did not number, `repository` empty when the build
+does not know it, `mods` the mods it plays in their load order, each its
+folder and its version), or `null` from a game that does not tell it. It is
+what the player's game says, which a changed build can make anything.
+
+A setting is
+`{"name":"server.name","type":"string","value":"OpenCE Server","default":"OpenCE Server","comment":"…","env":"HALO_SERVER_NAME","pinned":false,"secret":false,"choices":null,"min":null,"max":null}`;
+`type` is `boolean`, `integer`, `real` or `string`, and `value` and
+`default` are of that type in JSON (`true`, `16`, `"OpenCE Server"`); a
+reader should also take their text (`"true"`, `"16"`), which older servers
+sent. `choices` lists a word setting's words, `min` and `max` bound a
+number's, each `null` where there is none (the table above). `env` is
+`null` for a setting no environment variable sets. A secret one (the
+passwords) has `value` and `default` empty and `"set":true` when it is
+set. `pinned` is a setting
+its environment variable (`env`) sets: it cannot be changed.
+
+A gametype schema field is
+`{"key":"score_to_win","alias":"score","table":"universal","engine":"all","type":"integer","min":0,"max":999,"choices":null,"default":null,"description":"…"}`
+(`table`: the gametype file's table it goes in, `universal`, `options`,
+`ctf`, `slayer`, `oddball`, `king` or `race`; `engine`: `all`, or the game
+engine whose table it is; `type`: `integer`, `boolean` or `choice`).
+
+## The RCON
+
+`GET /ws` with `Upgrade: websocket` and the subprotocol `opence-rcon-1`.
+Every frame is text holding one JSON object. The server speaks first:
+
+```
+→ {"type":"hello","protocol":1,"server":"OpenCE Server","build":"build-206","network_version":38,
+   "capabilities":["events","status","rotation","settings","bans","owner_web","ban_address","stop","event_addresses","identity"]}
+← {"type":"auth","password":"…","by":"paul"}       or {"type":"auth","token":"<session token>"}
+→ {"type":"auth","ok":true,"role":"admin"}
+→ {"type":"auth","ok":false,"error":{"code":"denied"}}  and the connection closes (1008)
+← {"type":"command","id":1,"line":"kick Milenko"}    or {"type":"command","id":1,"command":"say","args":["two words"]}
+→ {"type":"reply","id":1,"ok":true,"lines":["Milenko kicked by the host"]}
+→ {"type":"reply","id":2,"ok":false,"lines":["…why…"]}                       (the command ran and failed)
+→ {"type":"reply","id":3,"ok":false,"lines":[],"error":{"code":"busy","message":"…"}}   (not run)
+← {"type":"subscribe","events":["player","chat","game","moderation","status","log","master"],"after":1830}
+→ {"type":"event","seq":1831,"time":1760900000123,"event":"player_joined","slot":3,"name":"Milenko",…,"replay":true}
+→ {"type":"event","seq":1831,"time":…,"event":"status","status":{…the status…}}   (at the subscribe, then every 2 s)
+→ {"type":"event","time":…,"event":"log","n":5120,"level":"info","cat":"game","text":"…"}   (no seq: n is its sequence)
+← {"type":"ping"}
+→ {"type":"pong"}
+→ {"type":"overflow"}  and the connection closes (1013): the client read too slowly
+→ {"type":"error","id":…,"error":{"code":"…","message":"…"}}   (an unknown type, a malformed message)
+```
+
+A connection signed in with the page's cookie (on the same origin) needs no
+`auth` message: its `hello` is followed by `{"type":"auth","ok":true,…}`.
+The `capabilities` say what the server has beyond the first release's
+(`events`, `status`, `rotation`, `settings`, `bans`): `owner_web`,
+`ban_address`, `stop`, `event_addresses` and `identity` ("Panels and
+fleets"); a client checks for one before it uses it. The owner's password
+signs in from the server's own machine alone ("Signing in").
+A command is a `line`, or a `command` and its `args`, which the server
+joins with spaces, quoting an argument that holds a space or is empty (511
+characters in all at most). Ids are the client's (a number or a string),
+echoed in the reply; each command gets exactly one reply. A connection
+runs one command at a time: a command sent before the last one's reply is
+not run. A reply whose command ran has `ok` and the command's `lines`, and
+no `error`, whether it succeeded or failed; one that was not run has `ok`
+false, no lines and an `error`: `denied` (not signed in), `rate_limited`
+(32 commands a second, in bursts of 64), `bad_request` (no command, or too
+long), `busy` (another command's reply is awaited) or `loading` (the game
+did not answer in 20 seconds; the command may still have run, and is never
+sent again by the server). `after` replays the events still in the ring
+since that sequence number, marked `"replay":true`. A connection holds 1024
+messages for the client at most; 8 connections are taken at once (a ninth
+upgrade answers `503 busy`), and each upgrade counts against its address's
+allowance (above). The
+event groups are `player` (`player_joined`, `player_left`, `map_share`), `chat`
+(`chat`), `game` (`lobby_opened`, `countdown`, `game_started`,
+`game_ended`, `postgame`, `score`, `kill`), `moderation` (`kick`, `ban`,
+`unban`, `mute`, `unmute`, `speed_hack`), `status` (`status`), `log`
+(`log`, each log line as `{"n","level","cat","text"}`), `master`
+(`master`), and `server` (`server_started`, `reloaded`, `warning`,
+`drain`, `shutdown`), which every subscriber gets.
+The log's lines of the `chat` category go to the `chat` group, the others
+to `log`.
+`status` and `log` events go to their subscribers as they come and are
+not kept in the ring: `after` does not replay them (`/api/log` reads the
+log's own ring). A `status` event's `seq` is the latest event's (no new
+number: the same one comes again until another event), and a `log` event
+has no `seq`: its `n`, the log line's number and `/api/log`'s cursor, is
+its sequence. A client keeps one cursor for the events (`seq`, of the
+events of the ring) and another for the log's lines (`n`); a client that
+reconnects with `after` may get events it had, and drops those whose `seq`
+it has seen (a `status` event is never dropped so).
+
+## Events
+
+Every event has `seq` (rising, never reused while the server runs; a
+`status` event has the latest one's, a `log` event none: above), `time`
+(milliseconds since the epoch) and `event`:
+
+| Event | Fields |
+| --- | --- |
+| `server_started` | `name, build, network_version, pid, started, instance, region, tunnel_port, publisher_key_id, web_port` (as the status's), `rotation[]` (the entries' texts) |
+| `lobby_opened` | `map, gametype, variant` (the gametype's name as the game shows it), `teams, index` (the rotation's entry) |
+| `countdown` | `seconds` (-1: paused) |
+| `game_started` | `map, gametype, variant, teams, team_scores[]` (team games), `players[]` |
+| `game_ended` | `map, gametype, variant, teams, reason` (`score`, `time`, `idle`, `empty`, `command`, `next`), `duration` (seconds), `team_scores[]` (team games), `players[]` |
+| `postgame` | `seconds` |
+| `player_joined` | `slot, name, team, machine`; `address, hwid` for the owner, or every role with `server.log_addresses` |
+| `player_left` | `slot, name, reason` (`left`; `kicked` and `banned` when the server's `kick`, `ban` or `sv_ban_address` dropped the machine, `banned` for a speed hack's drop too); `address, hwid` (as it joined) as `player_joined`'s |
+| `chat` | `channel` (`everyone`, `team`, `vehicle`), `slot, name, text` (admins only; the lines the host sends on) |
+| `kill` | `killer, victim` (slots; -1 for none), `weapon` (the killer's weapon's or the killing object's tag name, or null), `friendly_fire` |
+| `score` | `map, gametype, variant, teams, team_scores[]` (team games), `players[]` (once a second at most, on a change) |
+| `kick`, `ban`, `unban`, `mute`, `unmute` | `name, by, reason?, until?` |
+| `speed_hack` | `machine, names, rate, ahead_ticks, action` (`kicked`, or `unverified`: its datagrams alone said so, and it stays) |
+| `map_share` | `machine, map, state` (`asked`, `downloading` at each tenth, `downloaded` or `failed` once for each request), `progress` (0 to 100: a percentage already) |
+| `warning` | `text` (a newer release, with `server.auto_update`) |
+| `reloaded` | `rotation_changed, rejected[]` (`{"entry","reason"}` of each entry left out) |
+| `master` | `url, listed, probe, code, message` |
+| `drain` | `after` (`now`, `game`, `empty`, `cancel`), `restart` (exit code 5), `notice` (empty for none) |
+| `shutdown` | `reason` (`quit`, `sv_stop`, `sv_restart`, `drained`: a drain's end, `signal <n>`, `update installed`, `nothing to play`, `debug.exit_after`), `code` (the exit code) |
+
+Players in events are as in `/api/players` for the viewer role (no
+addresses), but for `player_joined` and `player_left`, which carry the
+player's address and hardware id (`""` when not known) to the owner, and to
+every role when `server.log_addresses` is on (`/api/players`' rule), in the
+RCON's events, their replay and `GET /api/events` alike. `variant` is the gametype's name as the game shows it (`Co-op`
+in a co-op entry).
+
+## Bans
+
+A ban is a line of `bans.txt` (in `paths.logs`, else the data root). A
+timed ban is kept out by its line's `until=` alone, and ends then. A ban
+for ever, and a machine dropped for cheating, also keep the machine out
+for the rest of the run by its address, its real address or its hardware
+id. `sv_ban_address` and `POST /api/bans` write such a line for an address
+or a hardware id with no player of it needed (the part not given is
+`none`). `unban` takes the line out and readmits the machine by
+the line's address or hardware id, whether it joins on the LAN or by
+internet play.
+
+## The rotation
+
+`server.rotation` (and `sv_rotation_set`, `PUT /api/rotation`) is a list of
+entries, `map[:gametype[+rule=value...]]`, separated by commas, semicolons
+or new lines; a line that begins with `#` is a comment (to its line's end,
+commas and all). The text is 4096 characters at most (the entries past it
+are left out, with a warning), an entry 255 characters and the list 64
+entries. `config.toml` keeps a string setting of up to 4096 characters, so
+a rotation that long is saved whole and read back after a restart.
+
+- The map is a multiplayer map's name (`bloodgulch`: the Xbox's
+  `maps/<name>.map`, else a Custom Edition map of `custom_maps`),
+  `custom_maps\<name>` (a Custom Edition map; `/` is taken for `\`), or a
+  level's path (`levels\test\bloodgulch\bloodgulch`). A campaign level is
+  played as co-op only: `<level>:coop`, at `server.coop_difficulty`.
+- The gametype (`slayer` when there is none) is a built-in's name
+  (`slayer`, `team_slayer`, `slayer_pro`, `elimination`, `phantoms`,
+  `endurance`, `rockets`, `snipers`, `stalker`, `ctf`, `ironctf`,
+  `ctf_pro`, `invasion`, `oddball`, `team_oddball`, `reverse_tag`,
+  `accumulation`, `juggernaut`, `king`, `team_king`, `king_pro`,
+  `crazy_king`, `race`, `team_race`, `rally`, `team_rally`, and Halo PC's
+  names `ffa`, `ffa_slayer`, `teamslayer`, `tslayer`, `koth`, `team_koth`,
+  `iron_ctf`, `teamrace`, `teamoddball`), an OpenCE gametype's (`swat`,
+  `infection`, `gun_game`, `hardcore`, `hardcore_ctf`, `hardcore_oddball`,
+  `hardcore_king`), a gametype file's name (`gametypes/<name>.toml`), or
+  `file=<name>` (a gametype a player's game saved, below). A gametype's
+  name is letters, digits, `_`, `-` and `.`, in any case.
+- A rule is a gametype rule's name or its short name (`score`, `time`,
+  `weapons`, `ff`...; `GET /api/gametypes`'s schema lists them), with a
+  value it takes; a rule of another game engine than the gametype's is
+  refused. 48 rules at most; a rule given twice is the last.
+
+An entry that cannot be played (a map that is not there, a bad gametype
+file, a rule out of range) is left out with a warning, at the start and at
+`sv_reload`; `sv_rotation_set` and `PUT /api/rotation` change nothing when
+one of their entries cannot be played.
+
+A change of the rotation (`sv_rotation_*`, `PUT /api/rotation`,
+`sv_reload`) keeps its place: the next game is the entry after the one
+played last, found again in the new list (the first entry only when none
+has been played yet). `sv_reload` takes the rotation again when its text
+changed, and also when only its entries' rejections changed (a map or a
+gametype file added or taken out since).
+
+`server.team_start` decides how a team game starts. `one` (the default)
+starts it with the players of one team. `both` waits, saying nothing,
+for a player on each team. `skip`, when one player waits for a team game
+that `sv_map` did not ask for, plays the rotation's next entry without
+teams instead (if it has one); it is checked when the lobby opens and
+again when its countdown would begin. With no entry left, the server
+stops with exit code 3 (2 when no rotation map is there), or plays
+`bloodgulch:slayer` with `server.rotation_fallback`.
+
+## Gametype files
+
+A gametype file, `gametypes/<name>.toml` (the name `a`–`z`, `0`–`9`, `_`
+and `-`), is a built-in or OpenCE gametype (`base`) and rules over it:
+
+```toml
+base = "team_king"     # the gametype it starts from
+name = "Moving Hill"   # the name the game shows: 11 characters of printable ASCII
+
+[universal]
+score_to_win = 3
+
+[options]
+time_limit = 15
+friendly_fire = "off"
+
+[king]
+moving_hill = true
+```
+
+Each rule goes in its table (the schema's `table`): `[universal]`,
+`[options]`, and one game engine's, `[ctf]`, `[slayer]`, `[oddball]`,
+`[king]` or `[race]`. A file gives each rule its full name
+(`vehicle_set`, `team_vehicles`, `score_to_win`): the short names
+(`vehicles`, `score`) are the rotation's alone. A file is 64 KB at most.
+`deploy/gametypes` has examples. The server reads the `gametypes` folder
+beside `config.toml` if there is one, else the data root's, and writes the
+web page's files to it.
+
+A gametype a player's game saved is played with `file=<name>`: copy the
+saved gametype, as `<name>.gametype`, into the same `gametypes` folder
+(beside `config.toml` if there is one, else the data root's).
+
+## The listing
+
+A public server (`server.public`, with `network.online` and
+`network.public_lobby`) is published to each master server of
+`masters.txt` (`docs/master_protocol.md`). A change that a list shows (the
+listing made public or private, a player joining or leaving, the name, the
+map) is published within 5 seconds. Made private, the server makes a new
+invite and sends the masters a closed publish, which takes it off their
+lists;
+`network.public_lobby = false` stops the publishing too. A master's
+`Retry-After` is kept (a day at most). `key_revoked` and
+`publisher_revoked` stop the publishing to that master for the run;
+`unknown_key`, `publisher_pending`, `application_denied` and
+`listing_taken` are logged once a minute while they last.
+
+## Files
+
+| File | What |
+| --- | --- |
+| `config.toml` | Every setting (beside the executable; `HALO_CONFIG_FILE`, else `--config`, names another) |
+| `init.txt` (`server.init_file`) | Commands run at the start, in the data root unless a full path |
+| `gametypes/<name>.toml` | Gametype files: the `gametypes` folder beside `config.toml` if there is one, else the data root's |
+| `gametypes/<name>.gametype` | Gametypes saved by a player's game (`file=<name>` in the rotation): the same `gametypes` folder |
+| `publisher.key` | The publisher key for the master servers (beside `config.toml`). On Windows, a server's `config.toml` and `publisher.key` are given an access list of their owner alone (the entries inherited for Administrators and SYSTEM taken out) |
+| `masters.txt` | The master servers (`server.masters_file`: beside `config.toml`, else beside the executable); one that names none leaves the official master, built in |
+| `bans.txt`, `cheaters.txt`, `debug.txt` | In `paths.logs`, else the data root |
+| `status.json` (`server.status_file`) | The status, written every 2 seconds |
+| A password's file (`HALO_SERVER_WEB_PASSWORD_FILE`, `HALO_SERVER_WEB_OWNER_PASSWORD_FILE`, `HALO_SERVER_WEB_MODERATOR_PASSWORD_FILE`, `HALO_SERVER_WEB_VIEWER_PASSWORD_FILE`, `HALO_SERVER_PASSWORD_FILE`) | A container's secret: when the plain variable is not set, the file's first line (its CR and LF off) is the setting's value, which is then pinned as the plain variable's would be (`sv_set` and `PUT /api/settings` refuse it, `409 pinned`). Read once, at the start; a file that cannot be read is logged, and the setting is `config.toml`'s |
+
+## Releases
+
+Each release has `SHA256SUMS` (the SHA-256 of each of its files, as
+`sha256sum` writes them: `<hex>  <name>`, written by `tools/ci_build.py
+sums`) and `SHA256SUMS.sig`: the Ed25519 signature of that file's exact
+bytes by the project's release key, in 128 lowercase hex digits and a
+newline (the form `opence-master-server`'s `cmd/release-sign` writes). The
+public key is `deploy/release-key.pub` (64 hex digits:
+`d04e8b101007d1641cace8b95fcca76f7f44709f6885c3d031b52394dbdf9376`).
+`tools/release_sign.sh verify SHA256SUMS` checks the signature (OpenSSL 3),
+and `sha256sum -c --ignore-missing SHA256SUMS` the files downloaded. The
+build workflow signs with the `RELEASE_SIGNING_KEY` secret (the key's seed,
+64 hex digits) and checks the signature against `deploy/release-key.pub`
+before it publishes the release.

docs/master_protocol.md

@@ -0,0 +1,650 @@
+# The master servers' protocol, version 1
+
+A master server lists dedicated servers and vouches for who publishes them.
+An operator applies to a master once with the public half of an Ed25519
+key, the *publisher key*, through the master's Discord bot; once an
+approver approves the application, the
+operator's servers publish to the master with requests signed by that key,
+and the master lists them after probing their UDP port. The game's server
+browser fetches each master's list, checks the master's signature with the
+key pinned in `masters.txt`, and joins a listed game by the invite in its
+listing, as it joins a game heard on the brokers.
+
+A master carries no game traffic: each list entry holds the host-signed
+listing the game publishes to the signalling brokers (`p2p_lobby.c`), so
+the join path is unchanged and nobody needs the master to be honest about a
+game's details.
+
+This document is the contract between the game (the publisher in
+`port/linux/src/server_master.c`, the probe's answer, the list client in
+`port/linux/src/master_list.c`) and the masters' implementations. The
+project's implementation is `opence-master`
+(github.com/OpenCommunityEdition/opence-master-server, Go, AGPL-3.0-or-later),
+whose `testdata/vectors.json` holds fixed keys and every value this
+document derives from them, and whose `tests/conformance` is the test a
+master must pass to be an official one. `docs/dedicated_server.md` is the
+server's side: its settings, `--keygen` and `--sign`.
+
+## Conventions
+
+| Thing | Form |
+| --- | --- |
+| Hexadecimal | Lowercase, two digits a byte, no prefix |
+| Base64 | The standard alphabet (RFC 4648 section 4) with `=` padding |
+| Times | Unix seconds, decimal, UTC |
+| JSON | UTF-8; every string the protocol defines is printable ASCII (0x20 to 0x7E) |
+| Signatures | Ed25519 as RFC 8032 defines it (with SHA-512): Monocypher's `crypto_ed25519_sign` and `crypto_ed25519_check`, Go's `crypto/ed25519` |
+| Transport | HTTPS. A master refuses publishes, key changes and peers' requests over plain HTTP except from loopback |
+| Unknown JSON fields | Ignored by both sides, so later versions can add fields |
+
+## Keys and identifiers
+
+| Thing | Definition |
+| --- | --- |
+| Key file (`publisher.key`, `master.key`) | One line of 64 hexadecimal digits: the Ed25519 seed (32 bytes). Anything after `#` is a comment; blank lines are skipped. Mode 0600 |
+| Public key, as text | `ed25519:` and the 32-byte public key in hexadecimal (64 digits) |
+| Key id | The first 8 bytes of SHA-256 of the 32-byte public key. Written as 16 hexadecimal digits (`keyid=`, `key_id`, `Signature-Key`); in the probe's packets it is the 8 raw bytes |
+| Instance | A name the operator gives each server process (`server.instance`): 1 to 32 characters of `a-z`, `0-9`, `-` and `_`, the first a letter or a digit |
+| Server id | The first 16 hexadecimal digits (8 bytes) of SHA-256 of the ASCII text of the key id's 16 hexadecimal digits followed by the instance's text, with nothing between them |
+
+The server id hashes the key id **as its 16 characters of text**, not its 8
+bytes. With the vectors' publisher key (RFC 8032's first test seed):
+
+```
+seed        9d61b19deffd5a60ba844af492ec2cc44449c5697b326919703bac031cae7f60
+public key  ed25519:d75a980182b10ab7d54bfed3c964073a0ee172f3daa62325af021a68f707511a
+key id      21fe31dfa154a261            (SHA-256 of the 32 key bytes: 21fe31dfa154a261...)
+instance    main
+hashed      "21fe31dfa154a261main"      (20 ASCII bytes)
+server id   4c5f15237c866f6f            (SHA-256 of those 20 bytes: 4c5f15237c866f6f...)
+```
+
+The same instance under another key is another server id, so a server
+keeps its id across restarts as long as it keeps its key and its instance.
+A master refuses a public key whose point has a small order (its X25519
+form multiplied by a clamped scalar is zero, as `p2p_ed25519_verify`
+checks), since anyone can make signatures that verify under one.
+
+`masters.txt` (the one beside `config.toml`, else the one beside the
+executable) lists the masters, one per line:
+`https://master1.example.org ed25519:<64 hex>`; `#` starts a comment; the
+first 4 are used. A file that names none (missing, empty, or comments alone,
+as the release's) leaves the official master, built into the game
+(`master_list_read_defaults` in `port/linux/src/master_list.c`) and the web
+page (`servers.js`):
+`https://master.opencommunityedition.com ed25519:89f4eda71229f11f3538679f49ef7fb0c2b407b380093f7f4fe02105b92225aa`.
+The web build reads its site's `masters.json` before the official master. The URL is an origin with no path, or a path
+the master is served under as it is (a proxy must not rewrite paths, since
+the path is signed).
+
+## Signed requests
+
+A publisher's requests carry a detached signature in one header:
+
+```
+Authorization: OpenCE-Ed25519 keyid=<16 hex>, ts=<unix seconds>, nonce=<32 hex>, sig=<base64 of 64 bytes>
+```
+
+The signature is the key's over the bytes of this string, its parts joined
+by single line feeds (0x0A) and no line feed at the end:
+
+```
+OpenCE-Master-v1
+<the receiving master's key id>
+<METHOD>
+<PATH>
+<ts>
+<nonce>
+<SHA-256 of the body, in hexadecimal>
+```
+
+| Part | Rule |
+| --- | --- |
+| Master key id | The key id of the master the request is sent to: the first 8 bytes of SHA-256 of the master's list-signing public key (the key pinned for it in `masters.txt`), as 16 lowercase hexadecimal digits. It binds the request to that master: a request signed for one master does not verify at another, even within the replay window. A master checks the signature with its own key id |
+| `METHOD` | The request's method in capitals: `PUT`, `DELETE`, `GET`, `POST` |
+| `PATH` | The path exactly as the request line sends it, without the query string: `/v1/servers/4c5f15237c866f6f`, `/v1/me`, `/v1/publishers` |
+| `ts` | The same decimal text as in the header: no sign, no leading zeros |
+| `nonce` | 16 random bytes in hexadecimal (32 digits), new for each request |
+| Body hash | Of the exact body bytes sent; an empty body's is SHA-256 of no bytes, `e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855` |
+
+The four parameters come once each, in any order, separated by commas with
+optional spaces; a publisher sends them in the order above. The master
+checks, in this order, and answers the first failure:
+
+| Check | Failure |
+| --- | --- |
+| The header parses (scheme, the four parameters and their forms) | `401 bad_signature` |
+| `ts` is within 300 seconds of the master's clock | `401 clock` (the body's `master_time` is the master's clock, for the server to log) |
+| The key id is a publisher's, or an application's | `403 unknown_key` |
+| The signature verifies, for this master's key id | `401 bad_signature` |
+| The nonce was not seen with this key in the last 600 seconds | `401 replay` |
+
+Since `unknown_key` is answered before the signature is checked, anyone can
+learn whether a key id is known to a master (a publisher's or an
+application's) by sending it with any signature. This is a known property
+of version 1: key ids are not secret (each is a hash of a public key, which
+an operator hands out when applying), and the answer says nothing more of
+the key than that the master has seen it.
+
+The vectors' `GET /v1/me` to the vectors' master (key id
+`39f713d0a644253f`) at 1760900001 with the nonce
+`f0e0d0c0b0a090807060504030201000` signs
+
+```
+OpenCE-Master-v1\n39f713d0a644253f\nGET\n/v1/me\n1760900001\nf0e0d0c0b0a090807060504030201000\ne3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+```
+
+and sends
+
+```
+Authorization: OpenCE-Ed25519 keyid=21fe31dfa154a261, ts=1760900001, nonce=f0e0d0c0b0a090807060504030201000, sig=duRZ+WKAI8hbvidtC63U1XHxOSoeRN5mcrZvw4qihhlilhZjbVBCLYjsQLr4+F2C1gy6lN9/ixqevFX7dfNGDA==
+```
+
+## Publishing
+
+`PUT /v1/servers/{server_id}`, signed, with a JSON body of 16 KB at most.
+A server publishes to every master in `masters.txt` every 30 seconds, and
+within 5 seconds of a change (the lobby opened, a game started or ended, a
+player joined or left, the name or map changed). On shutdown it publishes
+`closed: true` (or `DELETE`s) and waits up to 2 seconds.
+
+```json
+{"protocol":1,"instance":"main","name":"OpenCE Dedicated","map":"bloodgulch","gametype":"CTF","variant":"CTF",
+ "players":5,"max_players":16,"teams":true,"in_progress":false,"password":false,"dedicated":true,
+ "network_version":38,"build":"build-206","region":"eu","tunnel_port":2302,
+ "listing":"<base64 of the host-signed listing>","closed":false,"serial":412}
+```
+
+(The vectors' publish, made at network version 38: "The listing" says
+why the examples keep it.) The game's publisher sends `protocol`,
+`instance`, `listing` (but in a tombstone), `tunnel_port`, `dedicated`,
+`build`, `region` and `variant` when they are set, `address` with
+`server.master_publish_address`, `serial` and `closed`; the listing holds
+the rest. A server that goes private, or off the internet, sends one more
+publish, `closed: true`, to each master that listed it.
+
+| Field | Type | Required | Meaning |
+| --- | --- | --- | --- |
+| `protocol` | number | yes | 1 |
+| `instance` | string | yes | The instance; the path's server id must be the server id of the signing key's id and this instance, else `400 server_id` |
+| `listing` | string | yes, but with `closed: true` | Base64 of the exact bytes `listing_make` makes, the bytes the game publishes to the brokers |
+| `tunnel_port` | number | yes, unless `address` is given | The UDP port the game's tunnel socket is bound to (`network.tunnel_port`), 1 to 65535 |
+| `address` | string | no | `"203.0.113.5:2302"`: an IP address (IPv4, or IPv6 in brackets) and a port to probe instead of the request's source address. Sent only with `server.master_publish_address`; a master serves it in its list only if its own policy allows (`MASTER_SERVE_ADDRESSES`). It must be globally routable (below); a private or loopback address is taken only from a private or loopback source |
+| `dedicated` | boolean | no | A dedicated server. Also read from the listing's flag 32, which a dedicated server sets; either makes the entry dedicated. A player's public game, published with the player's publisher key, sends `false` |
+| `variant` | string | no | The gametype's name as the server shows it; printable ASCII, cut to 24 |
+| `build` | string | no | The game's build (`build-206`); cut to 32 |
+| `region` | string | no | Up to 16 of `a-z`, `0-9` and `-` (`server.region`) |
+| `serial` | number | no | A whole number the server raises at each change; kept and shown to admins |
+| `closed` | boolean | no | `true`: unlist the server now |
+| `name`, `map`, `gametype`, `players`, `max_players`, `teams`, `in_progress`, `password`, `network_version` | | no | Informational only: the listing is authoritative. A value that differs from the listing's is ignored, and the answer's `warnings` says so |
+
+The master parses the listing and checks the host's signature (below), and
+takes from it the name, the map, the gametype, the players and most
+players, the gametype's engine, the game's kind, the open, in-progress,
+teams and password flags, and the network version, so a publish cannot
+claim more than the host signed. A listing that does not parse or verify
+is `400 listing`. So is one whose own time is more than 3600 seconds from
+the master's clock. A listing with the same host key and a lower sequence
+than the one the master holds is not taken (the newer stays; a warning
+says so). A listing with the closed flag unlists the server, as
+`closed: true` does.
+
+The master records the request's source address (behind a reverse proxy,
+the address its trusted proxy forwards) to probe the server. It keeps the
+addresses 7 days at most after a server's last publish, for probes and
+abuse handling, and never serves them.
+
+The addresses a master probes and serves are an allowlist of globally
+routable unicast addresses: an IPv4 address outside IANA's special-purpose
+ranges (`0/8`, `10/8`, `100.64/10`, `127/8`, `169.254/16`, `172.16/12`,
+`192.0.0/24`, `192.0.2/24`, `192.88.99/24`, `192.168/16`, `198.18/15`,
+`198.51.100/24`, `203.0.113/24`, `224/4`, `240/4`); an IPv6 address in
+`2000::/3` outside `2001::/23`, `2001:db8::/32`, `3fff::/20` and
+`5f00::/16`; a 6to4 (`2002::/16`) or well-known NAT64 (`64:ff9b::/96`)
+address whose embedded IPv4 address is global. An IPv4-mapped address is
+judged as its IPv4 address. Everything else (link-local, site-local
+`fec0::/10`, unique local, multicast, `64:ff9b:1::/48`, zones) is refused
+(`400 schema`, `field: address`), except a private or loopback address
+from a private or loopback source (a master on the same network). A
+publish from a source address outside the allowlist without `address` is
+refused the same way when the master probes.
+
+A listing's host key is published by one publisher at a time: a listing
+whose host key is that of a live server of another publisher is refused,
+`403 listing_taken`, so a listing's bytes copied from a list cannot be
+published by someone else. The same publisher may carry it under another
+server id (another key or instance). A host makes a new listing (a higher
+sequence) at each of its publishes, so a live server that has taken no newer
+listing of its host key for 90 seconds (3 intervals) is replaying a copy:
+a publish of a newer listing of that host key takes the host key from it,
+and its server is unlisted. A server an admin hid, or whose publisher or key
+is not approved, holds no host key. A master shows its admins the publishes
+it refused with `listing_taken`, to settle (see "Known limitations").
+
+### The answer
+
+`200` once the publish is taken and the master's decision for now is made;
+`202` while the first probe of the server's address is unanswered:
+
+```json
+{"ok":true,"server_id":"4c5f15237c866f6f","listed":true,"interval":30,"ttl":90,"probe":"ok","reachable":true,
+ "observed_address":"203.0.113.5","master_time":1760900000}
+{"ok":true,"server_id":"4c5f15237c866f6f","listed":false,"interval":30,"ttl":90,"probe":"pending","reachable":false,
+ "observed_address":"203.0.113.5","probe_address":"203.0.113.5:2302","master_time":1760900000}
+```
+
+| Field | Meaning |
+| --- | --- |
+| `listed` | Whether the list shows the server now |
+| `interval` | Seconds between publishes the master expects (30) |
+| `ttl` | Seconds after its last publish that a server is unlisted (90): one lost publish does not unlist it, three do |
+| `probe` | `pending` (no answer yet at this address), `ok`, `failed` (three attempts unanswered), `skipped` (an admin marked the server trusted), `off` (the master does not probe) |
+| `reachable` | The probe was answered |
+| `observed_address` | The address the master saw the request come from |
+| `probe_address` | With `pending` and `failed`: the address and port the master probes |
+| `hidden`, `reason` | An admin hid the server: it is listed to nobody, and `reason` says why. With `probe: failed`, `reason` is the hint to log: `let UDP port <n> through your firewall or NAT, or set network.public_address` |
+| `closed` | `true` after `closed: true`, a tombstone or `DELETE` |
+| `warnings` | Body fields the listing contradicts, which were ignored |
+| `master_time` | The master's clock |
+
+A server with a failed probe is unlisted unless the master's policy lists
+unreachable servers (`MASTER_LIST_UNREACHABLE`), as `reachable: false`.
+The server logs each change of outcome once (not every 30 seconds), and
+the failed probe's hint once a minute until the probe passes.
+
+`DELETE /v1/servers/{server_id}`, signed by any key of the server's
+publisher with an empty body, unlists the server at once and answers
+`200 {"ok":true,"server_id":…,"listed":false,"closed":true,…}`; `404
+not_found` for a server that is not the publisher's.
+
+### Limits
+
+| Limit | Answer |
+| --- | --- |
+| A server publishes at most once each 5 seconds, with a burst of 2 | `429 rate_limited` with `Retry-After` |
+| 120 publishes a minute per source address, and per key | `429 rate_limited` |
+| A body is 16 KB at most | `413 too_large` |
+| A publisher has at most its quota of live servers at once (default 4; live: published within `ttl` and not closed) | `403 quota_exceeded` |
+| An instance is published by one key of a publisher at a time | `403 instance_taken` (another key's server of that instance is live) |
+| A publisher holds at most its quota and 16 server records (one per server id); for a new server id past that, its oldest records that are not live are dropped, and if none can be | `403 too_many_instances` |
+
+## The listing
+
+The listing is `p2p_lobby.c`'s (`listing_make`, `listing_read`), in network
+byte order. The master reads it as `listing_read` does and checks its
+signature as `listing_signed` does.
+
+| Offset | Size | Field |
+| --- | --- | --- |
+| 0 | 2 | `"HL"` |
+| 2 | 1 | Format: 1 |
+| 3 | 2 | Network version (`HALO_PORT_NETWORK_VERSION`, 39 now) |
+| 5 | 1 | Flags (below) |
+| 6 | 4 | Sequence: the host's count of its listings (the newest wins) |
+| 10 | 4 | The host's Unix time when it made the listing |
+| 14 | 32 | The host's Ed25519 public key (one per run of the game) |
+| 46 | 16, or 56 with the password flag | The invite's token (zero in a tombstone); with the password flag the token sealed with the password's key: nonce (24), MAC (16), the token encrypted (16), XChaCha20-Poly1305 with the host's key as additional data (`p2p_seal_token`) |
+| then | 1 | Players (at most 255) |
+| | 1 | Most players |
+| | 1 | The gametype's engine: 0 none (co-op), 1 CTF, 2 Slayer, 3 Oddball, 4 King of the Hill, 5 Race |
+| | 1 + up to 32 | The game's name: a length byte, then that many bytes |
+| | 1 + up to 32 | The map's name |
+| | 1 + up to 24 | The gametype's name |
+| | 8 | The stamp: the game's kind (`game_modes_kind`: the OpenCE mode, 1 SWAT, 2 Infection, 3 Gun Game, or 0; with 0x80 for Hardcore), then 7 reserved bytes, zero |
+| | 64 | The Ed25519 signature, by the listing's key, of the 12 ASCII bytes `hceu-lobby-1` followed by every byte before the signature |
+
+| Flag | Meaning |
+| --- | --- |
+| 1 | Open: it takes players now |
+| 2 | In progress: a game is under way (or loading) |
+| 4 | Teams |
+| 8 | Closed: a tombstone, the host stopped |
+| 16 | Password: the token is sealed |
+| 32 | Dedicated: a dedicated server (`halo --server` sets it, since network version 39) |
+
+A listing is 140 bytes at least (all names empty) and 268 at most (a
+password and every name at its length). A reader refuses one outside those
+sizes, without `"HL"` and format 1, with a name's length byte past its
+field's maximum or past the end, or whose stamp and signature do not end it
+exactly. The names are sanitised as the game's `sanitize` does: a byte
+outside 0x20 to 0x7E becomes `?`, and a zero ends the name. A master also
+refuses a listing whose key has a small order.
+
+The vectors' first listing (an open team game of a dedicated server,
+sequence 412, 5 of 16 players, CTF on bloodgulch, named `OpenCE Dedicated`)
+is these 169 bytes, of which the first 105 are signed. The vectors were made
+at network version 38 and are kept as they are (the bytes and signatures
+are fixed): their listings carry version 38 with flag 32, which the game
+sets from version 39 on, so a game of version 39 reads them, checks their
+signatures and hides them from its browser as another version's games, as
+it does any. The examples' `network_version` of 38 in this document are the
+vectors' too.
+
+| Field | Bytes |
+| --- | --- |
+| Magic, format | `484c` `01` |
+| Network version 38, flags 37 (open, teams, dedicated) | `0026` `25` |
+| Sequence 412, time 1760900000 | `0000019c` `68f533a0` |
+| Host key | `fc51cd8e6218a1a38da47ed00230f0580816ed13ba3303ac5deb911548908025` |
+| Token | `a0a1a2a3a4a5a6a7a8a9aaabacadaeaf` |
+| Players 5, most 16, engine 1 (CTF) | `05` `10` `01` |
+| Name, map, gametype | `10` `4f70656e434520446564696361746564`, `0a` `626c6f6f6467756c6368`, `03` `435446` |
+| Stamp (kind 0) | `0000000000000000` |
+| Signature | `633dc63eb27828d6e589e34dc4336dbb2d514b2018e4bf4a3adf5aeb774b6a523fe662c3d29241c6f91c8714a8ca2b5e493aacb32bcaeb9bce715f15b76d230f` |
+
+(`testdata/vectors.json` has it whole, with a password game's, a
+tombstone's and an altered one that must be refused.)
+
+## The probe
+
+Before it lists a server, the master proves that the server's UDP port is
+reachable from the internet and that the publisher key's holder answers on
+it. It sends a datagram to the probe address (the published `address`, or
+the request's source address with `tunnel_port`) from its probe socket:
+
+| Offset | Size | Probe (35 bytes) |
+| --- | --- | --- |
+| 0 | 10 | `"OPCE-PROBE"` |
+| 10 | 1 | 1 |
+| 11 | 8 | The master's key id, raw |
+| 19 | 16 | A nonce |
+
+The game's tunnel socket, which dispatches what it receives by its first
+bytes, recognises the magic and answers from the same socket to the
+address the probe came from:
+
+| Offset | Size | Answer (103 bytes) |
+| --- | --- | --- |
+| 0 | 14 | `"OPCE-PROBE-ACK"` |
+| 14 | 1 | 1 |
+| 15 | 8 | The master's key id, as the probe had it |
+| 23 | 16 | The nonce, as the probe had it |
+| 39 | 64 | The publisher key's Ed25519 signature of the 29 bytes `"probe"`, the master's key id, the nonce |
+
+The server answers only a probe of exactly 35 bytes whose key id is that of
+a master in its `masters.txt`, only to the probe's source, a given nonce at
+most once per second, at most 2 answers a second to one source address and
+at most 10 answers a second in all, so the probe cannot be used to reflect
+traffic (a 103-byte answer to a 35-byte probe is the whole amplification),
+and probes forged from one address cannot use up the answers a master's
+probe needs. A probe whose nonce was answered in the same second counts
+against neither limit.
+The master takes only an answer from the probed address and port, with its
+own key id, a nonce it made for that address and key, and a signature that
+verifies with the key that signed the publish.
+
+| Rule | Value |
+| --- | --- |
+| Attempts | 3, 2 seconds apart; failed 2 seconds after the third |
+| Again | Every 5 minutes while the server is reachable (it stays listed meanwhile); a failed server at its first publish a minute or more after the failure; at once when its probe address or key changes |
+| Nonce | Opaque to the server. A master uses a fresh nonce for each probe round (the round's attempts share it), and never the same one for two rounds of one address and key. `opence-master`'s is stateless: the first 16 bytes of HMAC-SHA-256(seed, `"opence-probe-1"` 0x00 address 0x00 key id 0x00 step), the step the decimal Unix time of the round's start divided by 30; it accepts the current and the previous hour's random seed and the current and the previous step, and starts rounds of one address and key at least a step apart |
+| Duplicates | A server answers a given nonce at most once per second: it remembers the nonces it answered (the last 64) with the Unix second they came in, and ignores a probe whose nonce it answered in the same second, whatever came between (A, B, A in one second: the second A is ignored). A master's retries, 2 seconds apart, are answered again; a nonce resent within the second is not |
+
+With the vectors' master key (id `39f713d0a644253f`) and the nonce
+`101112131415161718191a1b1c1d1e1f`, the probe is
+`4f5043452d50524f42450139f713d0a644253f101112131415161718191a1b1c1d1e1f`, the
+signed message `70726f626539f713d0a644253f101112131415161718191a1b1c1d1e1f`,
+and the publisher's answer
+`4f5043452d50524f42452d41434b0139f713d0a644253f101112131415161718191a1b1c1d1e1f`
+followed by the signature
+`a63af355db038dff90e6c82abc0e252eddbd1ed3562580d7becaf3e4edbdd39cef7ef3163b91849ba57f6e83240b92df1efbce15dfa42f4a12981590a0234109`.
+
+## The list
+
+`GET /v1/servers`, with the optional query `network_version=<n>`,
+`dedicated=1` (or `0`), `region=<region>`, `q=<text>` (a case-insensitive
+substring of the name, map, gametype or variant; 32 characters at most).
+No signature is needed and plain HTTP is allowed: the body is signed.
+
+```json
+{"protocol":1,"master":{"name":"OpenCE Master 1","key_id":"39f713d0a644253f","time":1760900000},
+ "servers":[{"id":"4c5f15237c866f6f","publisher":{"id":"p_kz3c5lb2xvq7mdpa","name":"Milenko's servers","since":"2026-10"},
+   "name":"OpenCE Dedicated","map":"bloodgulch","gametype":"CTF","variant":"CTF","players":5,"max_players":16,
+   "teams":true,"in_progress":false,"password":false,"open":true,"dedicated":true,"kind":0,"engine":1,
+   "network_version":38,"build":"build-206","region":"eu","reachable":true,"updated":1760899990,
+   "listing":"<base64>"}]}
+```
+
+| Entry field | Meaning |
+| --- | --- |
+| `id` | The server id |
+| `publisher` | The publisher's id (`p_` and up to 32 of `a-z0-9`), display name, and the year and month it was approved |
+| `name`, `map`, `gametype`, `players`, `max_players`, `teams`, `in_progress`, `password`, `open`, `kind`, `engine`, `network_version` | From the listing |
+| `variant`, `build`, `region` | From the publish |
+| `dedicated` | The listing's flag 32 or the publish's `dedicated` |
+| `reachable` | The last probe was answered (`false` for a trusted server or under `MASTER_LIST_UNREACHABLE`) |
+| `updated` | The time of the server's last publish |
+| `address` | Only with the operator's and the master's consent (above); absent otherwise |
+| `listing` | Base64 of the listing's exact bytes, as the server published them |
+
+The list holds at most 512 entries: dedicated servers first, then by
+players. Its headers:
+
+| Header | Value |
+| --- | --- |
+| `Signature` | `ed25519=` and the base64 of the master key's signature of the body's exact bytes (before any `Content-Encoding`) |
+| `Signature-Key` | The master's key id, 16 hexadecimal digits |
+| `Signature-Time` | The body's `master.time` |
+| `ETag` | `"` and the first 16 hexadecimal digits of SHA-256 of the body, and `"`; `If-None-Match` with it answers `304` |
+| `Cache-Control` | `public, max-age=5` (the master serves the same body for 5 seconds) |
+| `Content-Encoding` | `gzip` when the request's `Accept-Encoding` asks for it |
+| `Access-Control-Allow-Origin` | `*` (and `Access-Control-Expose-Headers` names the four above), for the web build |
+
+A client:
+
+1. checks `Signature` over the decompressed body bytes with the key in
+   `masters.txt`, and that `Signature-Key` is that key's id, and refuses
+   the whole body otherwise (a missing `Signature-Key` too; a client that
+   cannot check Ed25519, such as an old browser, refuses every list rather
+   than show one unchecked);
+2. parses the body, and refuses it unless `protocol` is 1, `master.key_id`
+   is the key's id, and `master.time` is no older than 300 seconds and no
+   more than 300 seconds ahead of the client's clock (a list dated ahead
+   would be taken for longer when it is replayed later, and a clock that
+   far off is wrong). The time is in the signed body: `Signature-Time` only
+   repeats it, since a header is not signed, and a client need not read
+   it;
+3. type-checks each entry, decodes its `listing`, runs `listing_read` and
+   the host signature's check on it, and skips an entry that fails rather
+   than the list; it shows the name, map, gametype and players of the
+   signed listing (an entry's own fields are the master's word, and may
+   differ); it filters control characters from every name, and takes at
+   most 512 entries (a 512-entry list is some 26,000 JSON tokens: the game
+   reads a list of 65,536 tokens at most);
+4. merges the masters' lists: entries with the same `id` are one game (the
+   newest `updated` wins), and an entry whose listing key is also heard on
+   the brokers is one game, shown as master-listed;
+5. never pings listed servers (that would tell every server the player's
+   address): it shows the `region`, and the ping once a game is joined.
+
+The vectors' signed body is
+`{"protocol":1,"master":{"name":"OpenCE Master 1","key_id":"39f713d0a644253f","time":1760900000},"servers":[]}`
+with `Signature: ed25519=18dmQnIfmRnC+wUwRJ/loxAH1VfASRBVnZgCfRuHrAw/2uo4thTibWnNQFScgRju+5lQtt709blK86BLT0fYCw==`
+and `ETag: "cd755a50c5cfc457"`.
+
+`GET /v1/servers/{server_id}` answers one listed server the same way:
+`{"protocol":1,"master":{…},"server":{<entry>}}` with the same headers, or
+`404 not_found`.
+
+## Other endpoints
+
+| Request | Who | Answer |
+| --- | --- | --- |
+| `GET /v1/publishers/{id}` | anyone (the list's limit) | `{"ok":true,"id","name","since":"2026-10","status","servers":<listed now>}`, or `404` |
+| `POST /v1/applications`, `/v1/applications/…` | anyone | `410 applications_by_discord`: applications are made with the master's Discord bot (below), not over HTTP |
+| `POST /v1/keys` | signed, an approved publisher's active key | Body `{"public_key":"ed25519:…"}`: adds a key (8 active at most). `201 {"ok":true,"key_id","status":"active"}`; `409 key_exists`; `403 too_many_keys` |
+| `GET /v1/me` | signed, any key the master knows | The publisher's record: `{"ok":true,"key_id","status","publisher":{"id","name","since","status","quota","origin","keys":[{"key_id","public_key","status","updated","last_used"}],"servers":[{"id","instance","key_id","listed","probe","reachable","hidden","trusted","updated","name","players","max_players"}]}}`; for a key still in an application, `"publisher":null` and `"application":{"id","status","reason","created"}`; `403 key_revoked` |
+| `GET /v1/master` | anyone | The master's name, key id, public key, contact, data policy and limits (informational: clients use the key in `masters.txt`) |
+| `GET /healthz` | anyone | `200 {"ok":true,…}` while the database answers |
+| `GET /metrics` | anyone (the list's limit) | Prometheus text, read at most once each 5 seconds: `master_servers{reachable}`, `master_publishers{status}`, `master_publishes_total{result}`, `master_probes_total{result}`, `master_list_requests_total`, `master_peer_requests_total`, `master_build_info{version,protocol}` |
+| `GET /`, `GET /apply`, `/admin/*` | people | The list page (the list's limit), how to apply (the Discord bot, and an invite to its server), the admin pages |
+
+## Applications
+
+An operator applies with the master's Discord bot, in the master's
+Discord server (the `/apply` page links to it): the bot's `/apply` command
+takes the region (a menu of the master's choices) and the number of servers
+at once as its options, and answers the applicant alone with a nonce for
+the proof of key,
+`opence-apply-<unix>-<16 hex>`, good for 24 hours and bound to that Discord
+user (a nonce given to another user, or to none, does not prove this one's
+key), and a button that opens the application's form: a display name, the
+public key, the proof, and a note. The application's name is 3 to 32 printable ASCII characters,
+`servers` is 1 to 64, and the region up to 16 of `a-z`, `0-9` and `-`. The
+proof of key is required unless the master's policy says otherwise
+(`MASTER_REQUIRE_PROOF`, true by default): it is the publisher key's
+Ed25519 signature of the nonce's ASCII text, in hexadecimal (128 digits,
+what `halo --server --sign <nonce>` prints) or base64. An application
+without one is shown to the approvers as unproven. A key already a
+publisher's is refused, and so is a key with an application pending. The
+applicant is answered on Discord, and told of the decision by a direct
+message; the applicant's identity is their Discord user id and username.
+
+Each application is posted to the master's log channel with Approve and
+Deny buttons, which only the members of the master's approver roles may
+press; the admin pages decide too. Once decided, anywhere, the message
+shows the outcome and who decided. The master's operator can also add an
+application on its command line (`opence-master challenge` for the nonce,
+then `add-application`), as the conformance test does.
+
+A master limits applications, since each one is posted to its approvers:
+`opence-master` takes one pending application at a time and 3 a day per
+Discord user, 3 a day per key, and, of applications without a proof of key,
+100 an hour in all; one with a proof is not refused for the hour's number,
+but past 100 applications in an hour the approvers are alerted once and the
+next ones are not posted one by one (its settings change these numbers). It
+deletes a denied application 30 days after its denial.
+
+The earlier HTTP application (`POST /v1/applications` with an e-mail
+address verified by a mailed link, `GET /v1/applications/challenge`, and
+the application's status by its mailed token) is gone: its endpoints
+answer `410 applications_by_discord`. A master keeps the applications made
+that way readable to its admins.
+
+## Approval sharing between masters
+
+The official masters share approvals, so an operator applies once. Each
+master fetches each peer's `GET /v1/publishers?since=<unix>` (every minute
+in `opence-master`), signed with its own master key in the request scheme
+above (`keyid` is its master key id, and the signed string's master key id
+is the peer's, the one it fetches from; a master answers only the peers it
+is configured with, else `403 not_a_peer`). The answer is signed as the list
+is (`Signature`, `Signature-Key`, `Signature-Time`, the body's
+`master.time`):
+
+```json
+{"protocol":1,"master":{"name","key_id","time"},
+ "publishers":[{"id","name","status","since","updated","origin","quota",
+   "keys":[{"key_id","public_key","status","updated"}]}]}
+```
+
+A master shares only what it holds a word of its own on: the publishers it
+approved or moderated (`status` is its own word: `approved`, `suspended` or
+`revoked`; `null` when it only vouches for keys), and the keys it added or
+revoked (`active` or `revoked`). `origin` is the key id of the master that
+approved the publisher, as the sharing master knows it (a master records a
+publisher new to it as come from the peer it fetched the record from,
+whatever origin the record claims, and only that peer's records rename
+it); `since` its approval time; `updated` the time of
+the newest word in the record; `since=` returns the records updated after
+it. The next fetch's `since` is the answer's `master.time` less 120 seconds,
+on the peer's own clock.
+
+The importing master keeps each master's word apart and takes the most
+restrictive of the trusted masters' words as the publisher's status
+(`revoked` over `suspended` over `approved`) and the smallest quota given;
+a newer word from a master replaces that master's older one. So a
+suspension or revocation anywhere wins everywhere, and only the master that
+suspended a publisher can lift its suspension. A key revoked by any trusted
+master is revoked, for good; a key two publishers claim is refused. A
+master may refuse a peer's words (`MASTER_PEERS_TRUST`); they then count
+for nothing.
+
+## Errors
+
+Every error is `{"ok":false,"error":{"code":"…","message":"…","field":"…"?},"master_time":<unix>}`.
+The message is for people and may change; programs read the code.
+
+| Status | Code | Meaning | A server's publisher should |
+| --- | --- | --- | --- |
+| 400 | `schema` | A field is missing, of the wrong type or out of range (`field` names it), or the body is not one JSON object | Log it once; it is a bug |
+| 400 | `server_id` | The path's id is not the key's and the instance's | Log it once |
+| 400 | `listing` | The listing does not parse, its signature fails, its key has a small order, or its time is an hour off | Log it once |
+| 401 | `bad_signature` | The Authorization header is malformed or its signature fails | Log it once |
+| 401 | `clock` | `ts` is more than 300 seconds from `master_time` | Log the difference (from the answer's `master_time`): the machine's clock is wrong |
+| 401 | `replay` | The nonce was used in the last 600 seconds | Send a new nonce |
+| 403 | `unknown_key` | No publisher or application has the key | Log `master: apply with key <id>` once a minute |
+| 403 | `publisher_pending` | The key's application waits for review | Log `master: publisher pending` once a minute; keep publishing every 30 s |
+| 403 | `application_denied` | The key's application was denied (`message` says why) | Log it once a minute |
+| 403 | `publisher_suspended` | The publisher is suspended | Log it; keep publishing slowly |
+| 403 | `publisher_revoked`, `key_revoked` | Revoked for good | Log it; stop publishing to that master |
+| 403 | `quota_exceeded` | The publisher has its quota of servers live | Log it |
+| 403 | `instance_taken` | Another key of the publisher has a live server of this instance | Log it; the old server expires after `ttl` |
+| 403 | `listing_taken` | The listing's host key is that of another publisher's live server, which has renewed it within 90 seconds | Log it once a minute; it is someone else's listing, or the host key is shared; keep publishing |
+| 403 | `too_many_instances` | The publisher holds its quota and 16 server records, none of which can be dropped | Log it; use fewer instance names |
+| 403 | `tls_required` | Plain HTTP from beyond loopback | Use the `https://` URL |
+| 403 | `not_a_peer` | A peer's request from a master not configured as a peer | |
+| 404 | `not_found` | No such server, publisher or endpoint | |
+| 409 | `key_exists` | The key added (`POST /v1/keys`) is known already | |
+| 410 | `applications_by_discord` | An application sent over HTTP: applications are made with the master's Discord bot | Log it: apply with the bot's `/apply` |
+| 413 | `too_large` | The body is over 16 KB | |
+| 429 | `rate_limited` | Too many requests; `Retry-After` gives the seconds to wait | Wait that long (the header's name read in any case; the game waits a day at most, and 30 seconds without one) |
+| 500 | `internal` | The master failed | Try again at the next interval |
+
+## Privacy and limits
+
+| What | Rule |
+| --- | --- |
+| Servers' addresses | Kept 7 days after the server's last publish, for probes and abuse handling; never served unless the operator and the master both chose to; not in the master's log unless its operator asks (`MASTER_LOG_ADDRESSES`) |
+| Applicants | Their Discord user id and username, seen by the master's admins and approvers (the log channel) only; no address is kept |
+| Applications | A denied one: deleted 30 days after the denial |
+| Servers' records | A closed server's: deleted an hour after it closed; one not published again: after 24 hours (unless an admin flagged it) |
+| Contacts | Discord names (and the earlier HTTP applications' e-mail addresses) are seen by the master's admins and approvers only, and are not shared with peers |
+| Strings | Printable ASCII, cut to the listing's lengths: name 32, map 32, gametype and variant 24, build 32 |
+| Requests | 60 list requests a minute per address (the list, one server, a publisher's page, the list page and the metrics together); the application limits above; bodies 16 KB at most; the publish limits above. Every limit by address counts an IPv6 address by its /64 |
+
+## Known limitations
+
+A listing's host key is bound to the first publisher whose live server
+publishes it, not to the host's own publisher: the listing does not say
+which publisher key the host chose. A publisher that copies a listing from a
+list while the host's publisher is not publishing (more than `ttl`) holds
+the host key, and the host's publisher is refused `listing_taken`, until the
+copy goes 90 seconds without a newer listing; one that keeps copying the
+host's newest listings from other lists keeps it until an admin hides its
+server or suspends it. The planned fix is in the listing: the host signs the
+key id of the publisher key it publishes with into the listing (a new
+listing format, with a new network version), and a master takes a listing
+only from that key.
+
+## Versions
+
+This is protocol 1: `protocol` in bodies, `/v1/` in paths and
+`OpenCE-Master-v1` in signed strings (followed by the receiving master's
+key id). A change that an older client or
+server would misread is a new version, with new paths; fields may be added
+to version 1, and both sides ignore what they do not know. The listing's
+own format follows the game's network version: a client hides entries
+whose `network_version` is not its own, as it does for the brokers'
+listings.
+
+## Testing an implementation
+
+`testdata/vectors.json` in the master's repository has, from fixed seeds:
+three key pairs with their key ids (the publisher's, the master's, a
+host's), a server id, a signed publish and a signed `GET /v1/me` to the
+vectors' master (its key id, the canonical strings, the signatures, the
+headers), a probe and its answer,
+four listings (a dedicated team game, a password game in progress with its
+sealed token, a tombstone, and an altered listing that must be refused), a
+signed list body with its headers and ETag, a small-order key that must be
+refused, and a proof of key. Monocypher's `crypto_ed25519_sign`,
+`crypto_ed25519_check` and `crypto_aead_lock` give the same bytes.
+`tests/conformance/opence_publisher.py` is a reference publisher in Python
+(keys, signatures, listings, publishing, the probe's answer), and
+`tests/conformance/test_master_protocol.py` runs a master through the whole
+flow: an application (on the master's command line, since the Discord bot
+is beyond a test's reach), the HTTP application's `410`, a pending
+publish, approval, the probe, the listed
+server's exact bytes in a signed list, closing, every refusal, and two
+masters sharing an approval, a suspension and a revocation.

docs/mods.md

@@ -0,0 +1,329 @@
+# Mods
+
+A mod is a folder of Halo PC tag files that the game plays over a map's own
+tags on your machine, as a resource pack does: sounds (a high-res audio
+pack), bitmaps (a texture pack, a HUD redraw), text (a translation) and
+models (higher-detail weapons, vehicles and scenery). Only the machine that
+has a mod plays it. Nothing of a mod is sent to another machine, and a mod
+changes nothing that the machines of a network game must agree on, so you
+can play with mods in any game, with players who have other mods or none. (A host's mod sounds of other lengths change how long
+the host's scripts and AI wait for dialogue to end; the host decides those
+for every machine, so they still agree.)
+
+The game's code is `port/linux/game/mods.c` (with `mod_sounds.c`,
+`mod_bitmaps.c`, `mod_strings.c` and `mod_models.c`, one for each kind of
+tag) and `port/linux/src/port_mods.c` (the mods folder and its files).
+
+## A mod's folder
+
+The mods are in the `mods` folder of the data root (the folder with
+`maps/`; on Android the app's data folder, on the web the browser's storage
+for the site). Each mod is a folder in it, with a `mod.toml` and a `tags`
+folder:
+
+```
+mods/
+  hd_audio/
+    mod.toml
+    tags/
+      sound/sfx/weapons/assault rifle/fire.sound
+      sound/dialog/...
+  german/
+    mod.toml
+    tags/
+      ui/hud/hud_item_messages.unicode_string_list
+```
+
+The files in `tags` have the paths of the tags they replace: a tag's name,
+then its group's extension, as the Halo Editing Kit and Invader keep them.
+`tags/sound/sfx/weapons/assault rifle/fire.sound` replaces the sound tag
+`sound\sfx\weapons\assault rifle\fire` of every map that has one. Names are
+not case-sensitive. The game only looks up the names of the map's tags among
+a mod's files: a mod cannot add tags, and no tag name of a map makes a path
+outside the mod.
+
+`mod.toml` says what the mod is. Every key is optional:
+
+```toml
+name = "High-res audio"       # what the Mods menu shows (else the folder's name)
+id = "hd_audio"               # what other mods name it by (else the folder's name)
+version = "1.0"
+authors = ["Someone", "Someone else"]   # or one string
+description = "The game's sounds at 44 kHz"
+maps = ["a10", "bloodgulch"]  # the maps it is for, by their files' names (else every map)
+load_after = ["hd_textures"]  # mods it plays over: they load before it
+load_before = ["fixes"]       # mods that play over it: they load after it
+incompatible = ["other_audio"]  # mods it cannot be played with
+format = 1                    # the mods' format it is made for
+```
+
+`load_after`, `load_before` and `incompatible` name other mods by their `id`
+or their folder's name, not case-sensitive. A mod they name that is not in
+the mods folder is passed over. `maps = []` is every map.
+
+A folder without `mod.toml` is not a mod. A mod made for a later `format`
+than the build's, or whose `maps` names no map, is not played. The game
+logs anything else wrong in `mod.toml` (an unknown key, a value of the
+wrong type) and uses the rest; a `mod.toml` that is not TOML at all is
+logged, and the mod played without what it says.
+
+The game's log is its output: the terminal on Linux, `halo.log` beside
+`halo.exe` on Windows, logcat on Android, and the page's log on the web.
+
+Limits: 256 mods, folder names of 63 bytes at most, 262144 files in all, 24
+folders deep under `tags`, and 64 maps in a mod's `maps`.
+
+## The load order
+
+Every mod in the mods folder is on until you turn it off. The mods load in
+an order, and where two mods have a file for the same tag, the one loaded
+later plays.
+
+- The default order is the folders' names in alphabetical order (not
+  case-sensitive), except that the mods a mod must load after (those it
+  asks to load after, and those that ask to load before it) are taken to
+  just before it. Mods that ask in a ring (a after b, b after a) load
+  alphabetically, and the game's log says so.
+- The main menu's **Mods** (in the PC version's menus, `display.menus =
+  "pc"`, the default) is laid out as the game lobby is: the mods on the
+  left as a resource pack list has them, the one at the top playing over
+  all those below it (the load order upside down: the mod loaded last is at
+  the top), and the chosen mod's details in the frame on the right (its
+  name, what is wrong with it, whether it is on, its priority, 1 the top,
+  and its version, authors, folder, maps and description). Choosing a mod
+  (A, or a click on the chosen one: the first click chooses it) turns it on
+  or off (ON, OFF); left and right, or **Move up** and **Move down**, move
+  the chosen mod (up: over one more mod). **OK** keeps the order and plays
+  it at once (on a map that is loaded, too); **Cancel** leaves it as it was.
+- A warning sign beside a mod means it is on the wrong side of a mod it
+  asks to load before or after (both on): a mod that loads after another is
+  above it in the menu. A red cross means a mod that is on says it cannot be
+  played with this one, or that it cannot be played at all (made for a later
+  build, or its `maps` names none): it stays off. The details say which.
+
+The menu keeps the order, and the mods turned off, in `mods/load_order.toml`,
+by the mods' folders' names:
+
+```toml
+order = ["german", "hd_audio", "hd_textures"]
+disabled = ["hd_textures"]
+```
+
+A mod added to the folder later is put where the default order puts it,
+after the mod before it there (but on the side it asks for of the mods it
+names), and is on. A mod gone from the folder is left out. When the file
+cannot be written, the game says so in its log and keeps the order until it
+quits.
+
+### Mods that cannot be played together
+
+When a mod that is on names another that is on as `incompatible`, the game
+asks as it starts, before the window opens:
+
+- **Play anyway** plays them all (closing the box does too);
+- **Turn off ...** turns off the mods named as incompatible (if mod A says
+  it cannot be played with mod B, B is turned off), and keeps that in
+  `load_order.toml`;
+- **Quit** closes the game.
+
+The Mods menu turns them on again. On the web, **Quit** starts the page
+again. A run nobody watches (`debug.hidden_window`, `debug.null_renderer`,
+`debug.exit_after` or `debug.network_test`) is not asked: it plays them all,
+and the game's log says which conflict.
+
+At the console:
+
+| Command | What it does |
+| --- | --- |
+| `mods_list` | Lists the mods in the mods folder in their load order, and which are on, then how many of the map's string lists, bitmaps, sounds and models the mods play. |
+| `mods_reload` | Finds the mods again and reads their files again: a changed file is read again (one that now fails a check leaves what was played before), a new one is played, and the map's tag comes back for a file that is gone. If a sound changed, all sounds stop. It does nothing while `mods_enable false`. |
+| `mods_enable false` | Plays the map's own tags until `mods_enable true` or the next map. |
+
+These commands work in any game, a client's too: they change nothing of the
+game.
+
+### Getting a mod onto each platform
+
+- **Linux, Windows**: put the mod's folder in `mods/` next to `maps/`.
+- **Android**: put it in `mods/` in the app's data folder,
+  `/sdcard/Android/data/com.halo.decomp/files/mods`, for example with
+  `adb push hd_audio /sdcard/Android/data/com.halo.decomp/files/mods/`.
+- **Web**: on the page, **Mods**, **Add a mod folder…** copies a mod's
+  `mod.toml` and `tags` folder into the browser's storage for the site.
+  **Remove** deletes it again.
+
+## What a mod can replace
+
+The game plays these groups from a mod. It does not read the files of any
+other group (a `.weapon`, `.vehicle`, `.model_collision_geometry` or
+`.scenario`, for example): they would change what the machines of a network
+game must agree on.
+
+| Group | Extension | What it is |
+| --- | --- | --- |
+| Sound | `.sound` | Sounds, music and dialogue |
+| Bitmap | `.bitmap` | Textures, sprites, the HUD's pictures |
+| Unicode string list | `.unicode_string_list` | The text the game shows |
+| String list | `.string_list` | Other text |
+| Model | `.gbxmodel` (Halo PC's), `.model` (the Xbox's) | What objects look like: weapons, first-person weapons and arms, vehicles, scenery, characters |
+
+A file must be a Halo PC tag file of its group, as the Halo Editing Kit's
+tools and Invader write them (a model also as `invader-extract` writes an
+Xbox map's: `.model`). The game checks every count, size and offset
+in it against the file, and every value against what the game reads, before
+it uses the file. A file that fails a check is left out (the map's tag
+plays), and `debug.txt` and the console say why.
+
+### Sounds
+
+- The samples can be 16-bit PCM, Xbox ADPCM or Ogg Vorbis, mono or stereo,
+  at 22 or 44 kHz. The game converts them to the Xbox ADPCM that it plays,
+  as it does for Custom Edition maps: mono at 22 kHz, stereo at its own rate.
+- Empty values are filled in as a map's build fills them in: the defaults
+  of the sound's class, the playback rates and the bend.
+- A sound must have permutations: a file with an empty pitch range (some
+  Halo PC translations have them) is left out.
+- A permutation must fit in a block of the sound cache (one sound's samples:
+  `MAXIMUM_SOUND_DATA_SIZE`).
+
+### Bitmaps
+
+- A bitmap's types and formats are those the game draws: 2D, 3D and cube
+  maps; A8, Y8, AY8, A8Y8, R5G6B5, A1R5G5B5, A4R4G4B4, X8R8G8B8, A8R8G8B8,
+  DXT1, DXT3, DXT5 and P8 bump. Sides are 4096 at most (512 for a 3D
+  bitmap). A bitmap that is not a power of two on each side is drawn
+  linear, as a Custom Edition map's is: it must be an uncompressed 2D
+  bitmap.
+- One bitmap's pixels may take a quarter of the texture cache: 64 MB on
+  Linux and Windows, 5.5 MB on Android and the web (a 2048 x 2048 DXT5 with
+  its mipmaps fits on all of them).
+- A bitmap replaces the map's bitmap of its name, and the map's other tags
+  use it as the map's: it must have at least as many bitmaps, of the same
+  types, and as many sequences, each with at least as many sprites. It can
+  be larger: a redraw at twice the size is drawn at the map's size, sharper.
+- The HUD draws a bitmap at its own size. So for each HUD element that draws
+  a mod's bitmap, the game scales the element by the map's size of what it
+  draws (its sprite, or with no sprites its bitmap) to the mod's, when that
+  is the same ratio for all of them. A bitmap the HUD draws that is not the
+  map's redrawn so (Halo PC's HUD bitmaps lay their sprites out to other
+  sizes) is left out. The HUD's digits can be the map's size or twice it.
+- The menus draw a bitmap in their widgets' bounds, whatever its size.
+- Halo PC keeps the channels of a model shader's multipurpose maps and of
+  the HUD's meters in another order than the Xbox. The game finds those
+  bitmaps among the mod's and draws them in the Xbox's order, as it does for
+  Custom Edition maps (`custom_edition_bitmaps.c`).
+- The pixels are read from the file when the texture cache loads them, not
+  kept in memory.
+
+### Text
+
+- A list keeps the map's number of strings: a mod's strings past it are
+  left out, and the map's own strings stay where the mod's list is shorter.
+- The game uses many strings as the format of what it prints
+  (`%s was killed by %s`). A mod's string replaces the map's only if it has
+  the same conversions in the same order (`%s`, `%d`, ...); otherwise the
+  map's string stays. A translation keeps the conversions of the original.
+- Unicode strings are UTF-16, as the tool writes them.
+- The main menu is the port's own (the PC version's menus, `port/assets/menus`),
+  whose text is in tags named `pc\...`. A mod's `ui\shell` lists change the
+  Xbox's menus (`display.menus = "xbox"`) and the text shown while playing
+  (HUD messages, the multiplayer messages, the pause menu).
+
+### Models
+
+A model is more than what is drawn: its nodes (its skeleton) are what its
+animations move, its markers are where projectiles leave a weapon, where a
+unit sits and where things attach, and its regions and permutations are what
+damage and an object's variant choose among. The machines of a network game
+agree on those, so a mod's model must have the map's:
+
+- the same nodes: their names, hierarchy and default positions;
+- the same markers: their names, regions, permutations, nodes, positions
+  and rotations (on the model's permutations, as the Halo Editing Kit keeps
+  them, or on the model, as a map does);
+- the same regions and permutations: their names and flags.
+
+Positions and rotations may differ from the map's by 0.001 at most (a model
+exported again is not always bit for bit the map's). Only what is drawn is
+the mod's: the geometries, their parts and vertices, which geometry each
+permutation draws at each detail level, the detail levels' cutoffs, the
+base map's scale, and which shaders each part is drawn with. A detail level
+the map draws must draw one of the mod's geometries, and one the map draws
+nothing at stays so. Every shader must be one the map has (a mod cannot add
+tags); a mod's bitmaps can redraw them.
+
+The model is checked against each map's own model of its name as that map
+loads. On a map whose model of that name has other nodes, markers or
+regions (a custom map's own assault rifle, say), or lacks a shader the mod
+names, the mod's model is left out and the map's drawn; the mod's other
+files still play there. `maps` in `mod.toml` keeps a mod to the maps it is
+made for.
+
+- Where a mod has both, its `.gbxmodel` plays; otherwise the file of the mod
+  loaded later, whichever its format.
+- What the tool works out as it builds a map is worked out as it does: a
+  part's strip is its triangles block, its centroid's nodes are its most
+  weighted, its links of 0 to the parts drawn before and after it are none,
+  a base map scale of 0 is 1, and a model whose tag asks for it has the
+  normals of its vertices that share a position blended. The vertices are
+  compressed as the game draws them.
+- A part's links to the parts drawn before and after it (for transparency)
+  must not go round.
+- A model of 44 nodes or more (the renderer skins 43 at once; only Custom
+  Edition maps' have so many) is drawn a part's own nodes at a time, as a
+  Custom Edition map's is: a part's vertices may name 22 nodes at most.
+- The collision geometry, the animations and the object's tag are the map's:
+  a larger weapon still hits and is hit where the map's does, and an object
+  is still left undrawn by the map's bounds of it (a much larger model may
+  vanish at the screen's edges).
+- Every model made from a file is kept until the map changes, a file edited
+  and read again by `mods_reload` too, and counts against the mods' memory.
+
+### Shaders
+
+A model's parts can be drawn with a shader of every group Halo PC has but
+one: `shader_transparent_chicago_extended`, which Gearbox added for Halo PC.
+The Xbox game does not have it, so do not use it: use a
+`shader_transparent_chicago` shader instead. (A Custom Edition map's
+chicago extended shaders become chicago shaders as the map loads, keeping
+only their four-stage maps: see
+[custom_edition_caches.md](custom_edition_caches.md).) As for every
+shader, it must be one the map has.
+
+## Making a mod
+
+1. Get the tags you want to change as tag files. `invader-extract` extracts
+   them from a map, and the Halo Editing Kit's tags are Halo PC's own.
+2. Change them with the Halo Editing Kit or Invader (`invader-bitmap`,
+   `invader-sound` and `invader-model` build bitmaps, sounds and models from
+   images, audio files and JMS files). Keep each tag's name.
+3. Put them in `tags/` of a folder in `mods/`, with a `mod.toml`.
+4. Load a map (a new mod is on). `mods_reload` at the console reads the
+   files again as you change them, without loading the map again.
+
+`debug.txt` has a line for every file the game leaves out, and why, and a
+summary of what each kind of tag plays from the mods:
+
+```
+mods: 9 string lists from their files (9 new), 0 given back, 0 left out
+mods: 66 HUD placements scaled to draw larger bitmaps at the map's size
+mods: 354 bitmaps from their files (354 new), 0 given back, 6 left out
+mods: 313 sounds from their files (313 new), 0 given back, 2 left out
+mods: 4 models from their files (4 new), 0 given back, 1 left out
+```
+
+## How it operates
+
+- When a map's tags load, at `mods_reload` and at the Mods menu's **OK**,
+  the game lists the files of the mods that are on, once, in a table of
+  their tag paths. Each of the map's sound, bitmap, string list and model
+  tags is looked up in it.
+- A tag replaced by a mod takes the file's values in place, so everything
+  that holds the tag keeps it, and the map's own values come back when the
+  file goes. A sound playing or a texture in the cache is never changed
+  under the game: before a reload changes anything, the sounds stop and the
+  caches let go of what they hold.
+- The mods' tags keep at most 512 MB in memory (192 MB on Android and the
+  web): their files, their sounds' samples, their bitmaps' tags and their
+  models' geometry.
+- A Custom Edition map takes mods as an Xbox map does.

port/android/README.md

@@ -1,6 +1,7 @@
 # Android
 
-The app of Ringfall: Mjolnir VR (application id `io.github.cesarus85.ringfall`;
+The app of Mjolnir VR (application id `io.github.cesarus85.ringfall`, from
+the name before, "Ringfall: Mjolnir VR", kept so that installed apps update;
 its Java classes keep the decompilation's package, `com.halo.decomp`).
 `ninja android` builds the game for 64-bit ARM Android (arm64-v8a).
 `ninja android_apk` makes an app from it:
@@ -98,6 +99,7 @@ To install the data from a computer:
 | Item | Location in `/sdcard/Android/data/io.github.cesarus85.ringfall/files` |
 | --- | --- |
 | Saved games (`z:\` and `u:\`) | `save` |
+| Mods (`docs/mods.md`) | `mods`: `adb push <mod folder> /sdcard/Android/data/com.halo.decomp/files/mods/`; the main menu's Mods orders them and turns them off |
 | Log | `debug.txt` |
 | Settings | `config.toml` |
 
@@ -160,7 +162,7 @@ controller for player 1. With the default buttons of the profile:
 | Crouch, Zoom | left and right stick clicks |
 | Light, Gren. type | white, black |
 | Pause, Back | start, back |
-| Up, Down, Left, Right | D-pad |
+| Up, Down, Left, Right | D-pad (in a network game, Up opens the text chat's keyboard) |
 
 The names on the buttons follow the profile's "Button layout" (Settings >
 Gamepads): with "Swap triggers", the right trigger's button says "Grenade".
@@ -231,7 +233,7 @@ These settings are only for Android:
 | `display.shader_cache` | `true` (the default): the linked shader programs are kept in `shader_cache` in the data folder (their binaries, the driver that made them and their sources), and each map's list of the programs it drew with; as a map loads, the programs on its list are made ready, so that its first frames do not wait for the driver to compile them. A driver update compiles them again from the kept sources. `false`: each program is compiled the first time it is drawn. The folder may be deleted at any time. |
 | `display.shader_worker` | `true` (the default): the shader programs are made on a thread of their own, whose GL context shares the game's (loaded from the shader cache, or compiled), and drawn with once there (`debug.shader_warm_up`: `"worker"`, `"load"` on the game's thread as a map loads, or `"off"`); a draw whose program is not made yet is left out for the frames it takes, and the frame does not wait. As a map loads, its own programs and then every map's (`shader_cache/all.txt`) are asked for. `false`: each is made on the game's thread when first drawn with. |
 | `debug.sample_seconds` | Refer to "Find problems". |
-| `debug.memory_watch` | `true` (the default): the app notices the game's writes to textures and vertices by page protection. `false`: it compares page contents once a frame instead, which is slower. Refer to "Limits". |
+| `debug.memory_watch` | `true` (the default): the app notices the game's writes to cached textures by page protection. `false`: it compares page contents once a frame instead, which is slower. Geometry uses the streaming path in either mode. Refer to "Limits". |
 
 ## Internet play
 
@@ -541,6 +543,23 @@ assembly of the port is necessary:
 - The symbol aliases in `guest/libc/src_include/features.h`. The Darwin
   target does not accept alias attributes.
 
+## Geometry uploads
+
+Android streams vertex and index data from the current CPU bytes instead
+of reusing the persistent geometry mirror or its cached index extents.
+This is automatic; no console command or configuration change is needed.
+Affected players reported that bypassing the cache resolved stretched or
+missing geometry, with some also reporting better performance. The exact
+cache failure mechanism remains unconfirmed.
+
+The Android-only guard in `mirror_range` uses the existing streaming
+fallback. Streamed upload methods, frame fences, shaders, texture caching
+and CPU write tracking are unchanged. Desktop and web retain their cache.
+Xbox and Custom Edition maps keep their existing loaders and resource
+paths. `tools/test_android_mirror_uploads.py` checks the bypass with large
+and reused ranges, frame-counter rollover and desktop/web cache controls;
+it does not substitute for device gameplay validation.
+
 ## Find problems
 
 - Enter `adb logcat -s halo` to see the log of the port and the errors of
@@ -570,8 +589,11 @@ assembly of the port is necessary:
   operate. The Xbox memory uses 4 KB pages.
 - The x86 Android emulator runs the app through its ARM translation. The
   translation cannot deliver the page faults that the renderer uses to
-  notice changed textures and vertices. On the emulator the app compares
+  notice changed textures. On the emulator the app compares
   page contents once a frame instead ("write tracking: page hashes" in the
-  log). This is slower, and a write shows one frame later, so moving
-  geometry can glitch briefly. `debug.memory_watch = false` does the same
-  on a device.
+  log). This is slower, and texture changes may appear one frame later.
+  `debug.memory_watch = false` does the same on a device. The translation
+  also has no scalar conversion from floating
+  point to an integer in a SIMD register (`fcvtzs s0, s1`, an illegal
+  instruction there), so `tools/android_asm_convert.py` writes each as the
+  vector form, which leaves the register and the exception flags the same.

port/android/STEAM_FRAME.md

@@ -10,28 +10,33 @@ On the Frame, in Desktop Mode (Steam menu > Power > Switch to Desktop):
 1. Put your own disc image of Halo: Combat Evolved for the original Xbox (`.iso` or
    `.xiso`, any version) in Downloads (or Documents, the Desktop, a memory
    card).
-2. Download `Install-Ringfall-Mjolnir-VR.desktop` from the latest release and open it
+2. Download `Install-Mjolnir-VR.desktop` from the latest release and open it
    (double-click; confirm running it).
 3. Answer the dialogs: the installer finds the disc image (or asks for it),
-   copies the game data out of it, adds "Ringfall: Mjolnir VR" to the Steam library
+   copies the game data out of it, adds "Mjolnir VR" to the Steam library
    and switches back to Gaming Mode. Start it from the library there.
 
-Opening the same file again updates the game (settings, saves and game data
-stay).
+The game updates itself: while it runs, its launcher looks for a newer
+release, fetches it and puts it in place as the next start begins
+(`steam_frame_launch.sh`; `update.auto = false` in `config.toml` stops it;
+`launcher.log` says what it did). Opening the same file again updates it
+too (settings, saves and game data stay).
 
 The desktop file (`steam_frame_installer.desktop`) downloads the latest
-release's `ringfall-mjolnir-vr-steam-frame.zip` (`tools/steam_frame_bundle.py`, made by
+release's `mjolnir-vr-steam-frame.zip` (`tools/steam_frame_bundle.py`, made by
 the release job of `.github/workflows/build.yml`) and runs its
 `install.sh` (`steam_frame_install.sh`), with zenity dialogs:
 - `~/Documents/RingfallMjolnirVR`: the launcher (`ringfall-mjolnir-vr.sh`)
   and the release APK (`RingfallMjolnirVR.apk`); the folder of the builds
   before the name, `~/Documents/HaloCE`, renamed to it, and their "Halo VR"
-  shortcut replaced;
+  shortcut replaced. (These keep the name of builds 302 to 313, "Ringfall:
+  Mjolnir VR": the Steam shortcut of an installed game starts the launcher
+  there, and the launcher's update looks for them in the bundle.);
 - the maps folder out of the disc image (`steam_frame_xiso.py`, the app's
   `XisoExtractor.java` in Python), unless `maps/ui.map` is there;
 - the Steam shortcut, unless it is there: added by Steam itself
   (`steam://addnonsteamgame`, as SteamOS's "Add to Steam" does) from
-  `Ringfall Mjolnir VR.desktop` beside the game, then the library pictures
+  `Mjolnir VR.desktop` beside the game, then the library pictures
   under the id Steam gave it. Steam is not closed: on the Frame, Desktop
   Mode runs inside Gaming Mode's session, and closing Steam ends it (and the
   installer with it). An old "Halo VR" shortcut is left for the player to
@@ -80,7 +85,7 @@ dialogs, for testing over adb; it leaves Steam and its shortcuts alone.
 
 ## Starting it on the Frame
 
-A button in the Steam library ("Ringfall: Mjolnir VR", a non-Steam game)
+A button in the Steam library ("Mjolnir VR", a non-Steam game)
 runs `~/Documents/RingfallMjolnirVR/ringfall-mjolnir-vr.sh` (`port/android/steam_frame_launch.sh`),
 which starts the game as Steam starts an Android title of its own:
 `lepton waitforexitandrun -- ~/Documents/RingfallMjolnirVR/RingfallMjolnirVR.apk`, in a container

port/android/VR_ROADMAP.md

@@ -1,6 +1,6 @@
 # VR roadmap
 
-What Ringfall: Mjolnir VR (Quest 3, Steam Frame) has, and what comes next, in the
+What Mjolnir VR (Quest 3, Steam Frame) has, and what comes next, in the
 agreed order. Updated with every step: a step is **done** once the user has
 tried it in the headset and it is merged into `main`; **built** means in a
 branch, not yet tried in the headset.
@@ -18,15 +18,17 @@ named where code is taken over.
 | --- | --- |
 | Headsets | Quest 3; Steam Frame (Lepton): its controllers' layout, a Steam library tile that installs, starts, updates and quits the game, data kept in `~/Documents/RingfallMjolnirVR` |
 | Rendering | The eyes drawn one by one (both at once, multiview, only with `debug.multiview`: its eyes did not always fuse, see the open points); lens flares at their depth in stereo; HUD, menus, scope, crosshair and names as layers of their own |
-| Aiming | The weapon in the hand, its shots from the muzzle, laser and crosshair options |
+| Aiming | The weapon in the hand, its shots from the muzzle, laser and crosshair options; each weapon held so that its model's hand lands on the real one, as the free hand's (it learns where each weapon's animations hold the hand; the pistol's had been 15 cm before the real hand, the assault rifle's 8 cm aside), the scope's disc moved with it; `vr.weapon_hand_*` to adjust (2026-10-17) |
 | Body | Physical crouch (`vr.crouch_limit`) beside the crouch button, leaning (`vr.lean_limit`), melee by swinging, grenades thrown with the left hand, two-handed weapons |
 | Vehicles | The Warthog's wheel turned with the hands, right trigger throttle, left brake; first-person seats; turrets with handles |
+| Scores | The menu button held shows the scores on the Quest (a press pauses, as it is let go); the Steam Frame's View button as before; the text chat's lines where the desktop has them (2026-10-18) |
 | Comfort | Snap or smooth turning, a comfort vignette in vehicles, VR options in the main and pause menus (Y), a page of every controller button |
 | Menus | The PC version's menus in VR (`vr.menus`), clicked with a laser; text typed on the on-screen keyboard |
-| Multiplayer | Up to date with OpenCE (network version 29, 2026-10-14): cross-play, its server browser, co-op campaign, password lobbies; join codes and the VR online list |
-| Bots | Bots in multiplayer: on foot (paths, items, objectives), in vehicles and at turrets; they make room for a joining person |
+| Multiplayer | Up to date with OpenCE (network version 32, 2026-10-20; HDR kept off in VR): cross-play, its server browser, co-op campaign, password lobbies; join codes and the VR online list |
+| Bots | Bots in multiplayer (`host_bots.c`; OpenCE's own, `bots.c`, are local split screen games' and off in VR): on foot (paths, items, objectives), in vehicles and at turrets; they make room for a joining person, on the LAN too (2026-10-18); they climb ladders (Damnation's) and take paths as near their goal as a search reaches, as OpenCE's do: on Damnation 0 searches of 1747 failed, 1078 of 1605 before (2026-10-20). Later: OpenCE's bots' aiming (lead, bursts, taps for the pistol and sniper rifle, field of view), learnt obstacles and map fixes into ours |
 | Voice chat | Push to talk on any button (`vr.button_talk`, BUTTONS page; the free hand's grip by default, sending nothing while it reaches for the foregrip or the wheel), open mic, off (2026-10-13) |
 | Builds | The Android build's assembly conversion (`tools/android_asm_convert.py`) keeps string data as it is: strings and tables starting with "_" or holding \" lost a "_" (Opus's pulse cache among them: the Steam Frame's crashes in online games while talking), 2026-10-13 |
+| Languages | The European disc in Spanish and Italian (a maps folder for each, `maps_es` and `maps_it`, none called `maps`) imported on the Quest and the Steam Frame: the headset's language's, its language the game's and the menus' (`maps/language.txt`, unless `game.language` is set), 2026-10-17; not yet tried with that disc |
 | Controls | Left-handed mode (`vr.handedness`): the weapon in the left hand, the arms and grips mirrored, sticks and buttons mirrored on both controllers (`vr.mirror_controls`), the assault rifle's counter read the right way round (2026-10-06) |
 | Graphics | Presets low / medium / high / max (`vr.graphics`), refresh rate and resolution in the VR options, all kept over a restart (2026-10-06) |
 | Arms and hands | Both arms by IK from shoulders that follow the torso, the elbow led by the hand's roll; fingers from trigger, grip and touch; `vr.body` arms / hands / off, `vr.fingers` (2026-10-06) |
@@ -44,6 +46,7 @@ named where code is taken over.
 | 4 | Later: disc image import in the launcher; moving by swinging the arms (in place of the stick, never faster than it: online too), and a sprint by swinging them harder (faster than the game allows: offline only) | import **done** (in `main` 2026-10-06): the app's import (tried on the Quest 3: all 24 maps; on the Frame kept in `~/Documents/RingfallMjolnirVR`), a Steam Frame installer from Desktop Mode (`STEAM_FRAME.md`; tried on the Frame: the old folder renamed, the shortcut added by Steam), a release signing key (CI and local builds the same). Arm swinging and its offline sprint still open |
 | 5 | Later: multiview again (both eyes in one pass, half the drawing's CPU cost): find why its eyes do not fuse in big online games on the Quest 3 (and now and then on the Steam Frame), then turn it back on | open: off by default since 2026-10-16 (`debug.multiview`); findings in the open points |
 | R | Release as **Ringfall: Mjolnir VR** (no "Halo" in the product's name): app name, id `io.github.cesarus85.ringfall`, icon and library pictures (`tools/ringfall_art.py`), Frame folder and installer, release assets, README; the repository renamed | **done** (in `main` 2026-10-06; Quest 3 and Steam Frame good) |
+| R2 | Renamed **Mjolnir VR** ("Ringfall" is another game's name): app and Steam names, logo (`tools/mjolnir_art.py`), release assets (also under the old names for the updaters of builds 302 to 313), updaters, README; the repository renamed `Cesarus85/mjolnir-vr` (GitHub forwards the old links). Kept: the app id, the signing key's alias, the Frame's `~/Documents/RingfallMjolnirVR` and the names inside its bundle (installed games and their shortcuts) | in `feature/rename-mjolnir-vr` (2026-10-21) |
 
 ## Step 2, first part (done)
 

port/android/app/src/main/java/com/halo/decomp/LauncherActivity.java

@@ -35,7 +35,7 @@ import java.nio.channels.FileChannel;
  */
 public class LauncherActivity extends Activity {
     private static final int PICK_IMAGE = 1;
-    private static final String SHARED_DATA_ROOT = "/home/steamos/Documents/RingfallMjolnirVR";
+    static final String SHARED_DATA_ROOT = "/home/steamos/Documents/RingfallMjolnirVR";
 
     private File dataRoot;
     private TextView status;
@@ -147,7 +147,7 @@ public class LauncherActivity extends Activity {
         layout.setBackgroundColor(Color.rgb(12, 16, 20));
 
         TextView title = new TextView(this);
-        title.setText("Ringfall: Mjolnir VR needs game data");
+        title.setText("Mjolnir VR needs game data");
         title.setTextColor(Color.WHITE);
         title.setTextSize(TypedValue.COMPLEX_UNIT_SP, 24);
         title.setGravity(Gravity.CENTER);

port/android/app/src/main/java/com/halo/decomp/Updater.java

@@ -36,7 +36,8 @@ import java.util.zip.ZipInputStream;
  * the latest release when it starts, on a thread of its own, and if it is
  * newer asks the player whether to update:
  *
- * - Yes: the release's app (halo-android-release.zip or -debug.zip) is
+ * - Yes: the release's app (mjolnir-vr-android-release.zip or
+ *   -debug.zip) is
  *   downloaded and handed to Android's package installer, which replaces the
  *   game (closing it) and offers to open the new version.
  * - No: nothing, until the next start.
@@ -45,12 +46,15 @@ import java.util.zip.ZipInputStream;
  *
  * Every build of main is signed with the same key (the workflow's), which an
  * app must keep for Android to install a new version over it.
+ *
+ * Not on the Steam Frame: Lepton installs the APK in the game's folder there
+ * at every start, so its launcher updates that (steam_frame_launch.sh).
  */
 final class Updater {
     /* the VR port's own releases: the original's, made without VR, must
        never replace it (they share the package name) */
-    private static final String APP_NAME = "Ringfall: Mjolnir VR";
-    private static final String REPOSITORY = "Cesarus85/ringfall-mjolnir-vr";
+    private static final String APP_NAME = "Mjolnir VR";
+    private static final String REPOSITORY = "Cesarus85/mjolnir-vr";
     private static final String USER_AGENT = "halo-ce-universal-updater";
     private static final int TIMEOUT_MILLISECONDS = 20000;
     /** the most a download (a release's zip, about 35 MB) or the app in it may be */
@@ -63,7 +67,8 @@ final class Updater {
     static void start(Activity activity) {
         File config = configFile(activity);
 
-        if (BuildConfig.HALO_BUILD_NUMBER <= 0 || config == null || !autoUpdate(config))
+        if (BuildConfig.HALO_BUILD_NUMBER <= 0 || config == null || !autoUpdate(config) ||
+                new File(LauncherActivity.SHARED_DATA_ROOT).isDirectory())
             return;
         new Thread(() -> {
             int latest = latestRelease();
@@ -235,7 +240,7 @@ final class Updater {
     /* ---------- updating */
 
     private static void update(Activity activity, int latest) {
-        String asset = "ringfall-mjolnir-vr-android-" + (BuildConfig.DEBUG ? "debug" : "release") + ".zip";
+        String asset = "mjolnir-vr-android-" + (BuildConfig.DEBUG ? "debug" : "release") + ".zip";
         File directory = new File(activity.getCacheDir(), UpdateProvider.DIRECTORY);
         LinearLayout layout = new LinearLayout(activity);
         TextView status = new TextView(activity);

port/android/app/src/main/java/com/halo/decomp/XisoExtractor.java

@@ -4,94 +4,101 @@ import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.nio.ByteBuffer;
-import java.nio.ByteOrder;
 import java.nio.channels.FileChannel;
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.BitSet;
 import java.util.List;
+import java.util.Locale;
 
 /**
- * Copies the maps folder out of an Xbox disc image (an "xiso", or a whole
- * disc's ".iso"), as the desktop games do (port/linux/src/xiso.c, which this
- * follows).
+ * Copies the maps folder out of the player's Xbox disc image of Halo, for
+ * LauncherActivity, as the desktop games do (port/linux/src/xiso.c; the web
+ * page's is port/web/site/xiso-worker.js). The image is a document the
+ * player picked, read through its FileChannel at absolute positions.
  *
- * The image's file system is XDVDFS, read as extract-xiso does
- * (https://github.com/XboxDev/extract-xiso, extract-xiso.c, whose format
- * handling this follows; its license is below and in
- * port/third_party/extract-xiso/LICENSE.TXT): 2048-byte sectors; a volume
- * descriptor at 0x10000 that starts and ends with "MICROSOFT*XBOX*MEDIA" and
- * gives the root directory's sector and size; and directories whose entries
- * form a binary tree (each entry: left and right subtree offsets in 4-byte
- * units, the start sector, the size, attributes, the name's length and the
- * name, 4-byte aligned). Images made from a whole disc put the game partition
- * further in, at one of the offsets below.
+ * Written from a description of the Xbox's disc file system, XDVDFS
+ * (xboxdevwiki's XDVDFS page, https://xboxdevwiki.net/XDVDFS, and the format
+ * facts OpenCE's readers rely on). What this class relies on:
  *
- * The files are written to maps.partial first and moved into maps once they
- * all are, so an interrupted extraction never leaves maps/ui.map behind.
+ * - Sectors are 2048 bytes and integers little-endian. Sector numbers count
+ *   from the start of the game partition: an image of the partition alone
+ *   has it at 0, an image of a whole disc further in (0x0FD90000, 0x02080000
+ *   or 0x18300000 for XGD2, XGD3 and XGD1 discs). They are tried in that
+ *   order.
+ * - The volume descriptor is the partition's sector 32 (at 0x10000). It
+ *   holds "MICROSOFT*XBOX*MEDIA" at its start and again at 0x7EC, and the
+ *   root directory table's start sector (u32 at 0x14) and size in bytes (u32
+ *   at 0x18).
+ * - A directory table is a binary tree of entries whose root is the entry at
+ *   offset 0. An entry is a left and a right subtree link (u16 each, in
+ *   4-byte units from the table's start, 0 for none), the start sector and
+ *   the size of the file or of the subdirectory's table (u32 each), the
+ *   attributes (u8, 0x10 for a directory), the name's length (u8) and the
+ *   name. Unused bytes of a table are 0xFF, so a left link of 0xFFFF is
+ *   padding, not an entry.
+ * - A file is one contiguous run of bytes from the start of its sector.
  *
- * Some parts of this code are copyright in@fishtank.com. This product
- * includes software developed by in <in@fishtank.com>.
+ * The image is the player's file and nothing read from it is trusted. Only
+ * the root's table and the maps folder's are read, each whole and at most
+ * 4 MB; the walk of a table visits each offset once, goes at most 64 links
+ * deep and looks at most 4096 entries; and a file is written only under a
+ * plain name that no file before it had (ignoring case).
  *
- * Copyright (c) 2003 in <in@fishtank.com>
- * All rights reserved.
+ * The loading screen's picture, which the retail disc has no file of, is
+ * taken out of the root's default.xbe (read whole, at most 64 MB) and
+ * written beside the maps as the loading.tga the game reads, when the maps
+ * folder has none (loadingPicture, as xiso.c's xiso_write_loading_picture);
+ * without it the light sweeps over black, as the game's own does.
  *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
- *
- * 3. All advertising materials mentioning features or use of this software
- *    must display the following acknowledgement:
- *
- *    This product includes software developed by in <in@fishtank.com>.
- *
- * 4. Neither the name of "in" nor the email address "in@fishtank.com"
- *    may be used to endorse or promote products derived from this software
- *    without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED `AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES
- * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
- * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
- * AUTHOR OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
- * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
- * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
- * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * The app starts the game once maps/ui.map exists, and makes the maps folder
+ * itself, so the copy is written to maps.partial (emptied first of what an
+ * earlier attempt left) and its files moved into maps once all are
+ * complete, ui.map last.
  */
 final class XisoExtractor {
     private static final int SECTOR_SIZE = 2048;
-    private static final long VOLUME_DESCRIPTOR_OFFSET = 0x10000;
-    private static final int ENTRY_HEADER_SIZE = 14;
+    private static final int DESCRIPTOR_OFFSET = 0x10000;
+    private static final byte[] MAGIC = "MICROSOFT*XBOX*MEDIA".getBytes(StandardCharsets.ISO_8859_1);
+    private static final int SECOND_MAGIC_OFFSET = 0x7EC;
+    private static final int ENTRY_FIXED_SIZE = 14;
     private static final int ATTRIBUTE_DIRECTORY = 0x10;
-    /* directory tables are a few sectors; anything much larger is not one */
-    private static final long MAXIMUM_DIRECTORY_SIZE = 4 << 20;
-    private static final int MAXIMUM_FILES = 256;
-    private static final int COPY_BUFFER_SIZE = 1 << 20;
-    private static final byte[] VOLUME_MAGIC = "MICROSOFT*XBOX*MEDIA".getBytes(StandardCharsets.US_ASCII);
-
-    /* where the game partition starts: a plain image, and whole-disc images
-    (extract-xiso's GLOBAL, XGD3 and XGD1 offsets) */
-    private static final long[] PARTITION_OFFSETS = { 0, 0x0FD90000L, 0x02080000L, 0x18300000L };
+    private static final int PADDING_LINK = 0xFFFF;
+    /** where the game partition may start, in the order they are tried */
+    private static final long[] PARTITION_STARTS = {
+        0x00000000L, // an image of the game partition alone
+        0x0FD90000L, // a whole XGD2 disc
+        0x02080000L, // a whole XGD3 disc
+        0x18300000L, // a whole XGD1 disc (the original Xbox's)
+    };
+    /** directory tables are a few sectors; anything much larger is not one */
+    private static final int MAXIMUM_TABLE_SIZE = 4 * 1024 * 1024;
+    private static final int MAXIMUM_DEPTH = 64;
+    private static final int MAXIMUM_VISITS = 4096;
+    private static final int MAXIMUM_ENTRIES = 256;
+    private static final int COPY_CHUNK = 1024 * 1024;
+    private static final String PARTIAL_DIRECTORY = "maps.partial";
+    /** the loading screen's picture (source/interface/progress_bar.c), out of default.xbe; the executable is a few MB */
+    private static final int LOADING_WIDTH = 320;
+    private static final int LOADING_HEIGHT = 240;
+    private static final int TGA_HEADER_SIZE = 18;
+    private static final long MAXIMUM_XBE_SIZE = 64 * 1024 * 1024;
+    private static final String LOADING_PICTURE = "loading.tga";
 
+    /** Told as the copy goes: the file being copied, and the bytes copied of all the files'. */
     interface Progress {
         void report(String file, long done, long total);
     }
 
-    /** a reason the player can act on */
+    /** A reason the player can act on: its message is shown as it is. */
     static final class ExtractException extends IOException {
         ExtractException(String message) {
             super(message);
         }
     }
 
+    /** a file or folder found in a directory table */
     private static final class Entry {
         final String name;
         final long sector;
@@ -104,187 +111,414 @@ final class XisoExtractor {
         }
     }
 
-    private final FileChannel image;
-    private long partition;
-
-    private XisoExtractor(FileChannel image) {
-        this.image = image;
+    private XisoExtractor() {
     }
 
-    /** copies the image's maps folder to destination/maps */
+    /** Copies the image's maps folder to destination/maps. */
     static void extractMaps(FileChannel image, File destination, Progress progress) throws IOException {
-        new XisoExtractor(image).extract(destination, progress);
-    }
+        long imageSize = image.size();
+        long partition = -1;
+        long rootSector = 0, rootSize = 0;
+        ByteBuffer descriptor = ByteBuffer.allocate(SECTOR_SIZE);
 
-    private void readAt(long offset, ByteBuffer buffer) throws IOException {
-        while (buffer.hasRemaining()) {
-            int count = image.read(buffer, offset);
-
-            if (count <= 0)
-                throw new ExtractException("Could not read the disc image (is it complete?).");
-            offset += count;
-        }
-        buffer.flip();
-    }
-
-    private static boolean magicAt(ByteBuffer buffer, int offset) {
-        for (int index = 0; index < VOLUME_MAGIC.length; index++) {
-            if (buffer.get(offset + index) != VOLUME_MAGIC[index])
-                return false;
-        }
-        return true;
-    }
-
-    /** whether a name is one to write in the maps folder: no path, no "." or
-     * "..", and only printable ASCII that every file system takes as a plain
-     * name (a disc's maps folder holds .map files and loading.tga) */
-    static boolean isPlainName(String name) {
-        if (name.isEmpty() || name.equals(".") || name.equals(".."))
-            return false;
-        for (int index = 0; index < name.length(); index++) {
-            char c = name.charAt(index);
-            if (c < 0x20 || c > 0x7E || "/\\:*?\"<>|".indexOf(c) >= 0)
-                return false;
-        }
-        return true;
-    }
-
-    /** the partition's volume descriptor: the root directory's sector and size */
-    private long[] findVolume() throws IOException {
-        for (long offset : PARTITION_OFFSETS) {
-            ByteBuffer descriptor = ByteBuffer.allocate(SECTOR_SIZE).order(ByteOrder.LITTLE_ENDIAN);
-
-            try {
-                readAt(offset + VOLUME_DESCRIPTOR_OFFSET, descriptor);
-            } catch (IOException e) {
+        for (long start : PARTITION_STARTS) {
+            if (start + DESCRIPTOR_OFFSET + SECTOR_SIZE > imageSize)
                 continue;
-            }
-            if (!magicAt(descriptor, 0) || !magicAt(descriptor, 0x7EC))
+            descriptor.clear();
+            if (!readFully(image, descriptor, start + DESCRIPTOR_OFFSET))
                 continue;
-            partition = offset;
-            return new long[] {
-                descriptor.getInt(20) & 0xFFFFFFFFL, descriptor.getInt(24) & 0xFFFFFFFFL,
-            };
+            byte[] bytes = descriptor.array();
+            if (!hasMagic(bytes, 0) || !hasMagic(bytes, SECOND_MAGIC_OFFSET))
+                continue;
+            partition = start;
+            rootSector = u32(bytes, 0x14);
+            rootSize = u32(bytes, 0x18);
+            break;
         }
-        throw new ExtractException("This is not an Xbox disc image.");
-    }
+        if (partition < 0)
+            throw new ExtractException("This is not an Xbox disc image.");
 
-    /** a directory's table, read whole */
-    private ByteBuffer readDirectory(long sector, long size, String what) throws IOException {
-        if (size <= 0 || size > MAXIMUM_DIRECTORY_SIZE)
-            throw new ExtractException(what);
-        ByteBuffer table = ByteBuffer.allocate((int) size).order(ByteOrder.LITTLE_ENDIAN);
-        readAt(partition + sector * SECTOR_SIZE, table);
-        return table;
-    }
-
-    /**
-     * collects the entries of the subtree at offset (4-byte units), files or
-     * directories as asked
-     */
-    private static void walk(ByteBuffer table, long offset, int depth, boolean directories, List<Entry> out,
-        int[] visited) {
-        offset *= 4;
-        /* a malformed table must not loop or run off its end */
-        if (depth > 64 || ++visited[0] > 4096 || offset + ENTRY_HEADER_SIZE > table.limit())
-            return;
-        int at = (int) offset;
-        int left = table.getShort(at) & 0xFFFF;
-        int right = table.getShort(at + 2) & 0xFFFF;
-        /* 0xFFFF: padding, an empty directory */
-        if (left == 0xFFFF)
-            return;
-        int nameLength = table.get(at + 13) & 0xFF;
-        if (left != 0)
-            walk(table, left, depth + 1, directories, out, visited);
-        boolean isDirectory = (table.get(at + 12) & ATTRIBUTE_DIRECTORY) != 0;
-        if (at + ENTRY_HEADER_SIZE + nameLength <= table.limit() && nameLength > 0 && isDirectory == directories
-            && out.size() < MAXIMUM_FILES) {
-            byte[] bytes = new byte[nameLength];
-            for (int index = 0; index < nameLength; index++)
-                bytes[index] = table.get(at + ENTRY_HEADER_SIZE + index);
-            String name = new String(bytes, StandardCharsets.ISO_8859_1);
-            /* (as extract-xiso refuses them: no name may leave the folder, and
-            none but a plain file name is written) */
-            if (isPlainName(name))
-                out.add(new Entry(name, table.getInt(at + 4) & 0xFFFFFFFFL, table.getInt(at + 8) & 0xFFFFFFFFL));
-        }
-        if (right != 0)
-            walk(table, right, depth + 1, directories, out, visited);
-    }
-
-    private void extract(File destination, Progress progress) throws IOException {
-        long[] root = findVolume();
-
-        /* the root's maps folder */
-        ByteBuffer table = readDirectory(root[0], root[1], "The disc image's file system is damaged.");
-        List<Entry> directories = new ArrayList<>();
-        walk(table, 0, 0, true, directories, new int[1]);
+        // the root's maps folder
+        byte[] root = readTable(image, partition, rootSector, rootSize, "The disc image's file system is damaged.");
         Entry maps = null;
+        Entry xbe = null;
+        for (Entry entry : walkTable(root, false)) {
+            if (entry.name.equalsIgnoreCase("default.xbe"))
+                xbe = entry;
+        }
+        List<Entry> directories = walkTable(root, true);
         for (Entry entry : directories) {
-            if (entry.name.equalsIgnoreCase("maps"))
+            if (entry.name.equalsIgnoreCase("maps")) {
                 maps = entry;
+                break;
+            }
+        }
+        // (Mjolnir VR: a European disc in two languages, Spanish and Italian,
+        // has no maps folder but one for each, maps_es and maps_it: the
+        // device's language's is taken, else English's, else the first, and
+        // its language written to maps/language.txt, which the game asks the
+        // Xbox for while game.language is unset: port/linux/src/xbox_xapi.c)
+        String language = null;
+        if (maps == null) {
+            String wanted = Locale.getDefault().getLanguage();
+            Entry english = null, first = null;
+
+            for (Entry entry : walkTable(root, true)) {
+                String code = mapsLanguage(entry.name);
+
+                if (code == null)
+                    continue;
+                if (code.equals(wanted) && maps == null)
+                    maps = entry;
+                if (code.equals("en") && english == null)
+                    english = entry;
+                if (first == null)
+                    first = entry;
+            }
+            if (maps == null)
+                maps = english != null ? english : first;
+            if (maps != null)
+                language = mapsLanguage(maps.name);
         }
         if (maps == null)
             throw new ExtractException("The disc image has no maps folder: it is not a Halo disc.");
 
-        /* its files */
-        table = readDirectory(maps.sector, maps.size, "The disc image's maps folder is damaged.");
-        List<Entry> files = new ArrayList<>();
-        walk(table, 0, 0, false, files, new int[1]);
-        long total = 0;
-        boolean hasUi = false;
+        // its files
+        byte[] table = readTable(image, partition, maps.sector, maps.size, "The disc image's maps folder is damaged.");
+        List<Entry> files = walkTable(table, false);
+        Entry userInterface = null;
+        boolean hasLoading = false;
         for (Entry file : files) {
-            total += file.size;
-            hasUi |= file.name.equalsIgnoreCase("ui.map");
+            if (file.name.equalsIgnoreCase("ui.map"))
+                userInterface = file;
+            hasLoading |= file.name.equalsIgnoreCase(LOADING_PICTURE);
         }
-        if (!hasUi)
+        if (userInterface == null)
             throw new ExtractException("The disc image's maps folder has no ui.map: it is not a Halo disc.");
-
-        File partial = new File(destination, "maps.partial");
-        File finished = new File(destination, "maps");
-        if (!partial.isDirectory() && !partial.mkdirs())
-            throw new ExtractException("Could not create " + partial + ".");
-        ByteBuffer buffer = ByteBuffer.allocateDirect(COPY_BUFFER_SIZE);
-        long done = 0;
+        // (an image that ends before a file does is refused before anything
+        // is written; an empty file's sector need not be anywhere)
+        long total = 0;
         for (Entry file : files) {
-            File path = new File(partial, file.name);
-            long offset = partition + file.sector * SECTOR_SIZE;
-            long remaining = file.size;
+            if (file.size > 0 && partition + file.sector * SECTOR_SIZE + file.size > imageSize)
+                throw new ExtractException(readFailure(file));
+            total += file.size;
+        }
 
-            try (FileOutputStream out = new FileOutputStream(path)) {
-                FileChannel output = out.getChannel();
+        // the copy, to maps.partial
+        File partial = new File(destination, PARTIAL_DIRECTORY);
+        if (partial.isDirectory()) {
+            File[] leftovers = partial.listFiles();
+            if (leftovers != null) {
+                for (File leftover : leftovers)
+                    leftover.delete();
+            }
+        } else {
+            partial.delete();
+            partial.mkdirs();
+        }
+        if (!partial.isDirectory())
+            throw new ExtractException("Could not create " + partial.getPath() + ".");
+        ByteBuffer buffer = ByteBuffer.allocate(COPY_CHUNK);
+        long done = 0;
+        for (Entry file : files)
+            done = copyFile(image, partition, file, new File(partial, file.name), buffer, done, total, progress);
+        if (!hasLoading && writeLoadingPicture(image, imageSize, partition, xbe, new File(partial, LOADING_PICTURE)))
+            files.add(new Entry(LOADING_PICTURE, 0, 0));
 
-                while (remaining > 0) {
-                    buffer.clear();
-                    buffer.limit((int) Math.min(remaining, COPY_BUFFER_SIZE));
-                    readAt(offset, buffer);
-                    int count = buffer.remaining();
-                    while (buffer.hasRemaining())
-                        output.write(buffer);
-                    offset += count;
-                    remaining -= count;
-                    done += count;
-                    progress.report(file.name, done, total);
-                }
-            } catch (ExtractException e) {
-                throw new ExtractException("Could not read " + file.name + " from the disc image (is it complete?).");
+        // then into maps, ui.map (the app's sign that the data is there) last
+        File mapsFolder = new File(destination, "maps");
+        if (!mapsFolder.isDirectory() && !mapsFolder.mkdirs() && !mapsFolder.isDirectory())
+            throw new ExtractException("Could not create " + mapsFolder.getPath() + ".");
+        // (the language of a language's maps folder: before ui.map is there)
+        File languageFile = new File(mapsFolder, "language.txt");
+        languageFile.delete();
+        if (language != null) {
+            try (FileOutputStream out = new FileOutputStream(languageFile)) {
+                out.write((language + "\n").getBytes(StandardCharsets.US_ASCII));
             } catch (IOException e) {
-                throw new ExtractException("Could not write " + path + " (is the storage full?).");
+                throw new ExtractException("Could not write " + languageFile.getPath() + " (is the storage full?).");
             }
         }
-
-        /* (the maps folder may be there, empty: the app makes it for adb) */
-        if (!finished.isDirectory() && !finished.mkdirs())
-            throw new ExtractException("Could not create " + finished + ".");
-        for (Entry file : files) {
-            File from = new File(partial, file.name);
-            File to = new File(finished, file.name);
-
-            to.delete();
-            if (!from.renameTo(to))
-                throw new ExtractException("Could not move " + file.name + " into " + finished + ".");
+        List<Entry> order = new ArrayList<>(files);
+        order.remove(userInterface);
+        order.add(userInterface);
+        for (Entry file : order) {
+            File target = new File(mapsFolder, file.name);
+            target.delete();
+            if (!new File(partial, file.name).renameTo(target))
+                throw new ExtractException("Could not move " + file.name + " into " + mapsFolder.getPath() + ".");
         }
         partial.delete();
     }
+
+    /** a language's maps folder's language ("maps_it": "it"), else null */
+    static String mapsLanguage(String name) {
+        if (name.length() != 7 || !name.regionMatches(true, 0, "maps_", 0, 5))
+            return null;
+        String code = name.substring(5).toLowerCase(Locale.ROOT);
+        return Character.isLetter(code.charAt(0)) && Character.isLetter(code.charAt(1)) ? code : null;
+    }
+
+    /** No path, no . or .., and only printable ASCII that every file system takes as a plain name. */
+    static boolean isPlainName(String name) {
+        if (name == null || name.isEmpty() || name.equals(".") || name.equals(".."))
+            return false;
+        for (int index = 0; index < name.length(); index++) {
+            char character = name.charAt(index);
+
+            if (character < 0x20 || character > 0x7E || "/\\:*?\"<>|".indexOf(character) >= 0)
+                return false;
+        }
+        return true;
+    }
+
+    /* ---------- the image */
+
+    private static long u16(byte[] bytes, int offset) {
+        return (bytes[offset] & 0xFF) | (bytes[offset + 1] & 0xFF) << 8;
+    }
+
+    private static long u32(byte[] bytes, int offset) {
+        return u16(bytes, offset) | u16(bytes, offset + 2) << 16;
+    }
+
+    private static boolean hasMagic(byte[] bytes, int offset) {
+        for (int index = 0; index < MAGIC.length; index++) {
+            if (bytes[offset + index] != MAGIC[index])
+                return false;
+        }
+        return true;
+    }
+
+    /** Fills buffer from the image at position; false if the image ends first. */
+    private static boolean readFully(FileChannel image, ByteBuffer buffer, long position) throws IOException {
+        while (buffer.hasRemaining()) {
+            int count = image.read(buffer, position);
+
+            if (count <= 0)
+                return false;
+            position += count;
+        }
+        return true;
+    }
+
+    private static byte[] readTable(FileChannel image, long partition, long sector, long size, String damaged)
+            throws IOException {
+        if (size == 0 || size > MAXIMUM_TABLE_SIZE)
+            throw new ExtractException(damaged);
+        ByteBuffer table = ByteBuffer.allocate((int) size);
+        if (!readFully(image, table, partition + sector * SECTOR_SIZE))
+            throw new ExtractException("Could not read the disc image (is it complete?).");
+        return table.array();
+    }
+
+    /* ---------- directory tables */
+
+    private static final class Walk {
+        final byte[] table;
+        final boolean directories;
+        final BitSet visited = new BitSet();
+        final List<Entry> entries = new ArrayList<>();
+        int visits;
+        boolean stopped;
+
+        Walk(byte[] table, boolean directories) {
+            this.table = table;
+            this.directories = directories;
+        }
+    }
+
+    /** The folders (or the files) of a table with plain names, in the tree's order. */
+    private static List<Entry> walkTable(byte[] table, boolean directories) {
+        Walk walk = new Walk(table, directories);
+
+        walkEntry(walk, 0, 0);
+        return walk.entries;
+    }
+
+    /**
+     * The subtree whose root entry is at offset: its left subtree, the
+     * entry, its right subtree. A link to padding, past the table or back to
+     * an entry already visited ends that branch.
+     */
+    private static void walkEntry(Walk walk, int offset, int depth) {
+        byte[] table = walk.table;
+
+        if (walk.stopped || depth > MAXIMUM_DEPTH)
+            return;
+        if (offset >= table.length || table.length - offset < ENTRY_FIXED_SIZE)
+            return;
+        int left = (int) u16(table, offset);
+        int right = (int) u16(table, offset + 2);
+        if (left == PADDING_LINK || walk.visited.get(offset / 4))
+            return;
+        walk.visited.set(offset / 4);
+        if (walk.visits >= MAXIMUM_VISITS) {
+            walk.stopped = true;
+            return;
+        }
+        walk.visits++;
+
+        if (left != 0)
+            walkEntry(walk, left * 4, depth + 1);
+        int nameLength = table[offset + 13] & 0xFF;
+        if (nameLength != 0 && nameLength <= table.length - offset - ENTRY_FIXED_SIZE)
+            collect(walk, offset, nameLength);
+        if (right != 0)
+            walkEntry(walk, right * 4, depth + 1);
+    }
+
+    private static void collect(Walk walk, int offset, int nameLength) {
+        byte[] table = walk.table;
+        boolean directory = (table[offset + 12] & ATTRIBUTE_DIRECTORY) != 0;
+
+        if (directory != walk.directories || walk.entries.size() >= MAXIMUM_ENTRIES)
+            return;
+        String name = new String(table, offset + ENTRY_FIXED_SIZE, nameLength, StandardCharsets.ISO_8859_1);
+        if (!isPlainName(name))
+            return;
+        // (the destination's file system may ignore case)
+        for (Entry entry : walk.entries) {
+            if (entry.name.equalsIgnoreCase(name))
+                return;
+        }
+        walk.entries.add(new Entry(name, u32(table, offset + 4), u32(table, offset + 8)));
+    }
+
+    /* ---------- the loading screen's picture */
+
+    /**
+     * The loading screen's picture out of a default.xbe, as the TGA the game
+     * reads (uncompressed, 24 bits, rows from the bottom), or null. The
+     * executable holds it, 320 by 240, as runs of 4-bit greys (a byte each:
+     * the grey's high four bits in its low nibble, the run's length in its
+     * high one) after the width and height as u32s: found by those two
+     * numbers followed by runs that fill the picture exactly (a run of none,
+     * or one past the picture's end, is not it).
+     */
+    static byte[] loadingPicture(byte[] xbe) {
+        int pixels = LOADING_WIDTH * LOADING_HEIGHT;
+        byte[] greys = new byte[pixels];
+        boolean found = false;
+
+        for (int at = 0; at + 8 <= xbe.length && !found; at++) {
+            if (u32(xbe, at) != LOADING_WIDTH || u32(xbe, at + 4) != LOADING_HEIGHT)
+                continue;
+            int pixel = 0;
+            for (int next = at + 8; next < xbe.length && pixel < pixels; next++) {
+                int run = (xbe[next] & 0xFF) >> 4;
+
+                if (run == 0 || run > pixels - pixel)
+                    break;
+                Arrays.fill(greys, pixel, pixel + run, (byte) ((xbe[next] & 0x0F) << 4));
+                pixel += run;
+            }
+            found = pixel == pixels;
+        }
+        if (!found)
+            return null;
+        byte[] tga = new byte[TGA_HEADER_SIZE + pixels * 3];
+        tga[2] = 2;
+        tga[12] = (byte) (LOADING_WIDTH & 0xFF);
+        tga[13] = (byte) (LOADING_WIDTH >> 8);
+        tga[14] = (byte) (LOADING_HEIGHT & 0xFF);
+        tga[15] = (byte) (LOADING_HEIGHT >> 8);
+        tga[16] = 24;
+        for (int y = 0; y < LOADING_HEIGHT; y++) {
+            int row = (LOADING_HEIGHT - 1 - y) * LOADING_WIDTH;
+            for (int x = 0; x < LOADING_WIDTH; x++) {
+                int out = TGA_HEADER_SIZE + (y * LOADING_WIDTH + x) * 3;
+
+                tga[out] = tga[out + 1] = tga[out + 2] = greys[row + x];
+            }
+        }
+        return tga;
+    }
+
+    /**
+     * Writes default.xbe's picture to output, if it has one; whether it did.
+     * One that cannot be written whole is removed (the loading screen would
+     * read past one cut short).
+     */
+    private static boolean writeLoadingPicture(FileChannel image, long imageSize, long partition, Entry xbe,
+            File output) {
+        if (xbe == null || xbe.size <= 0 || xbe.size > MAXIMUM_XBE_SIZE
+                || partition + xbe.sector * SECTOR_SIZE + xbe.size > imageSize)
+            return false;
+        try {
+            ByteBuffer bytes = ByteBuffer.allocate((int) xbe.size);
+            if (!readFully(image, bytes, partition + xbe.sector * SECTOR_SIZE))
+                return false;
+            byte[] tga = loadingPicture(bytes.array());
+            if (tga == null)
+                return false;
+            try (FileOutputStream stream = new FileOutputStream(output)) {
+                stream.write(tga);
+            }
+            return true;
+        } catch (IOException | OutOfMemoryError exception) {
+            output.delete();
+            return false;
+        }
+    }
+
+    /* ---------- the copy */
+
+    private static String readFailure(Entry file) {
+        return "Could not read " + file.name + " from the disc image (is it complete?).";
+    }
+
+    /** Copies one file of the image to output; returns the bytes copied of all the files so far. */
+    private static long copyFile(FileChannel image, long partition, Entry file, File output, ByteBuffer buffer,
+            long done, long total, Progress progress) throws IOException {
+        String writeFailure = "Could not write " + output.getPath() + " (is the storage full?).";
+        long position = partition + file.sector * SECTOR_SIZE;
+        long remaining = file.size;
+        FileOutputStream stream = null;
+
+        try {
+            stream = new FileOutputStream(output);
+            FileChannel channel = stream.getChannel();
+            while (remaining > 0) {
+                int count = (int) Math.min(remaining, COPY_CHUNK);
+                boolean read;
+
+                buffer.clear();
+                buffer.limit(count);
+                try {
+                    read = readFully(image, buffer, position);
+                } catch (IOException exception) {
+                    read = false;
+                }
+                if (!read)
+                    throw new ExtractException(readFailure(file));
+                buffer.flip();
+                while (buffer.hasRemaining()) {
+                    if (channel.write(buffer) <= 0)
+                        throw new ExtractException(writeFailure);
+                }
+                position += count;
+                remaining -= count;
+                done += count;
+                if (progress != null)
+                    progress.report(file.name, done, total);
+            }
+            FileOutputStream closing = stream;
+            stream = null;
+            closing.close();
+        } catch (ExtractException exception) {
+            throw exception;
+        } catch (IOException exception) {
+            throw new ExtractException(writeFailure);
+        } finally {
+            if (stream != null) {
+                try {
+                    stream.close();
+                } catch (IOException ignored) {
+                    // (the copy failed already)
+                }
+            }
+        }
+        return done;
+    }
 }

port/android/app/src/main/res/values/strings.xml

@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <resources>
-    <string name="app_name">Ringfall: Mjolnir VR</string>
+    <string name="app_name">Mjolnir VR</string>
 </resources>

port/android/guest/runtime/guest_host.h

@@ -75,6 +75,10 @@ void host_sdl_scancode_name(int scancode, char *buffer, unsigned int size);
 int host_sdl_scancode_from_name(const char *name);
 int host_sdl_show_toast(const char *message, int duration, int gravity, int x, int y);
 int host_sdl_show_simple_message_box(unsigned int flags, const char *title, const char *message);
+/* SDL_ShowMessageBox of up to three buttons (SDL_MessageBoxData has not the
+guest's layout): the index of the one chosen, else -1 */
+int host_sdl_show_message_box(unsigned int flags, const char *title, const char *message, int default_index,
+	const char *button0, const char *button1, const char *button2);
 int host_sdl_get_gamepads(unsigned int *ids, int capacity);
 unsigned int host_sdl_open_gamepad(unsigned int id);
 unsigned int host_sdl_gamepad_from_id(unsigned int id);
@@ -194,4 +198,12 @@ void host_touch_scene(int scene);
 for the overlay's labels */
 void host_touch_bindings(const int *controls);
 
+/* ---------- the server browser's master servers (host_https.c) */
+
+/* a GET of an https:// url (port/linux/src/master_list.c): 1 with the
+status, the headers ("Name: value" lines) and up to body_capacity bytes of
+the body (its size in body_size), else 0 and why in error */
+int host_https_get(const char *url, int *status, char *headers, int headers_size, char *body, int body_capacity,
+	int *body_size, char *error, int error_size);
+
 #endif

port/android/guest/runtime/guest_sdl.c

@@ -95,6 +95,31 @@ bool SDL_ShowSimpleMessageBox(SDL_MessageBoxFlags flags, const char *title, cons
 	return host_sdl_show_simple_message_box((unsigned int)flags, title, message) != 0;
 }
 
+/* (up to three buttons, their ids those of the guest's) */
+bool SDL_ShowMessageBox(const SDL_MessageBoxData *data, int *buttonid)
+{
+	const char *labels[3] = { NULL, NULL, NULL };
+	int default_index = -1;
+	int index;
+	int chosen;
+
+	if (!data || data->numbuttons < 1 || data->numbuttons > 3)
+		return false;
+	for (index = 0; index < data->numbuttons; index++)
+	{
+		labels[index] = data->buttons[index].text;
+		if (data->buttons[index].flags & SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT)
+			default_index = index;
+	}
+	chosen = host_sdl_show_message_box((unsigned int)data->flags, data->title, data->message, default_index,
+		labels[0], labels[1], labels[2]);
+	if (chosen < 0 || chosen >= data->numbuttons)
+		return false;
+	if (buttonid)
+		*buttonid = data->buttons[chosen].buttonID;
+	return true;
+}
+
 void SDL_Delay(Uint32 milliseconds)
 {
 	struct timespec duration;

port/android/host/host_https.c

@@ -0,0 +1,35 @@
+/*
+HOST_HTTPS.C
+
+The server browser's requests to the master servers (host_https_get,
+port/android/guest/runtime/guest_host.h; port/linux/src/master_list.c), made
+in the host with the desktop's HTTPS client (port/linux/src/posix_update.c's
+update_https_request, Mbed TLS, the system's certificate authorities): the
+guest has no TLS of its own, and its memory is the host's to read and write.
+*/
+
+#include "host.h"
+#include "../../linux/src/update.h"
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+int host_https_get(const char *url, int *status, char *headers, int headers_size, char *body, int body_capacity,
+	int *body_size, char *error, int error_size)
+{
+	struct update_response response;
+
+	*status = 0;
+	*body_size = 0;
+	if (!update_https_request("GET", url, NULL, NULL, 0, (unsigned long)body_capacity, &response, error, error_size))
+		return 0;
+	*status = response.status;
+	snprintf(headers, (size_t)headers_size, "%s", response.headers);
+	if (response.body_size > (unsigned long)body_capacity)
+		response.body_size = (unsigned long)body_capacity;
+	memcpy(body, response.body, response.body_size);
+	*body_size = (int)response.body_size;
+	free(response.body);
+	return 1;
+}

port/android/host/host_main.c

@@ -65,7 +65,7 @@ void host_fatal(const char *format, ...)
 	vsnprintf(message, sizeof(message), format, arguments);
 	va_end(arguments);
 	__android_log_write(ANDROID_LOG_FATAL, "halo", message);
-	SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "Ringfall: Mjolnir VR", message, NULL);
+	SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "Mjolnir VR", message, NULL);
 	_exit(1);
 }
 
@@ -540,7 +540,7 @@ int main(int argc, char *argv[])
 {
 	(void)argc;
 	(void)argv;
-	host_logf(HOST_LOG_INFO, "Ringfall: Mjolnir VR starting");
+	host_logf(HOST_LOG_INFO, "Mjolnir VR starting");
 	host_install_signal_handlers();
 	if (host_native_thread_create(game_main, NULL, MAIN_STACK_SIZE) != 0)
 		host_fatal("cannot start the game thread");

port/android/host/host_memory.c

@@ -834,6 +834,10 @@ long host_guest_mprotect(uint64_t address, uint64_t size, int protection)
 
 #define WATCH_PAGE_COUNT (HALO_GUEST_WINDOW_SIZE / PAGE)
 
+/* (each page: 0 not watched, 1 watched and read-only, 2 made writable by a
+watched write. A fault on a page at 2 is a write another thread made as
+this one was making the page writable, and is made again; one on a page at
+0, freed memory or none of the watch's, is a crash) */
 static uint8_t page_protected[WATCH_PAGE_COUNT];
 static uint32_t page_generation[WATCH_PAGE_COUNT];
 static volatile uint32_t current_generation = 1;
@@ -867,7 +871,7 @@ static uint64_t watch_page(uint64_t address)
 static void mark_written(uint64_t page)
 {
 	page_generation[page] = __sync_add_and_fetch(&current_generation, 1);
-	page_protected[page] = 0;
+	page_protected[page] = 2;
 	mprotect((void *)(HALO_GUEST_WINDOW_BASE + page * PAGE), PAGE, PROT_READ | PROT_WRITE);
 }
 
@@ -934,11 +938,13 @@ static void segv_handler(int signal_number, siginfo_t *information, void *contex
 	{
 		uint64_t page = watch_page(address);
 
-		if (page_protected[page])
+		if (page_protected[page] == 1)
 		{
 			mark_written(page);
 			return;
 		}
+		if (page_protected[page] == 2)
+			return;
 	}
 	report_crash(signal_number, information, context);
 	chain(&previous_segv, signal_number, information, context);
@@ -1001,7 +1007,7 @@ void host_memory_watch_protect(uint32_t address, uint32_t size)
 	}
 	for (page = first; page <= last; page++)
 	{
-		if (!page_protected[page])
+		if (page_protected[page] != 1)
 		{
 			page_protected[page] = 1;
 			mprotect((void *)(HALO_GUEST_WINDOW_BASE + page * PAGE), PAGE, PROT_READ);
@@ -1056,7 +1062,7 @@ void host_memory_watch_prepare_write(uint32_t address, uint32_t size)
 		last = WATCH_PAGE_COUNT - 1;
 	for (page = first; page <= last; page++)
 	{
-		if (page_protected[page])
+		if (page_protected[page] == 1)
 			mark_written(page);
 	}
 }

port/android/host/host_sdl.c

@@ -514,3 +514,35 @@ int host_sdl_show_simple_message_box(uint32_t flags, const char *title, const ch
 {
 	return SDL_ShowSimpleMessageBox((SDL_MessageBoxFlags)flags, title, message, NULL) ? 1 : 0;
 }
+
+/* ---------- a question for the player (the mods at startup: port_mods.c) */
+
+int host_sdl_show_message_box(uint32_t flags, const char *title, const char *message, int default_index,
+	const char *button0, const char *button1, const char *button2)
+{
+	const char *labels[3] = { button0, button1, button2 };
+	SDL_MessageBoxButtonData buttons[3];
+	SDL_MessageBoxData question;
+	int count = 0;
+	int answer = -1;
+	int index;
+
+	for (index = 0; index < 3; index++)
+	{
+		if (!labels[index])
+			continue;
+		buttons[count].flags = index == default_index ?
+			SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT | SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT : 0;
+		buttons[count].buttonID = index;
+		buttons[count].text = labels[index];
+		count++;
+	}
+	question.flags = (SDL_MessageBoxFlags)flags;
+	question.window = NULL;
+	question.title = title;
+	question.message = message;
+	question.numbuttons = count;
+	question.buttons = buttons;
+	question.colorScheme = NULL;
+	return SDL_ShowMessageBox(&question, &answer) ? answer : -1;
+}

port/android/host/host_xr.c

@@ -1256,7 +1256,7 @@ with vr.log_performance: host_main.c) */
 	android.applicationVM = machine;
 	android.applicationActivity = activity;
 	instance.next = &android;
-	strcpy(instance.applicationInfo.applicationName, "Ringfall Mjolnir VR");
+	strcpy(instance.applicationInfo.applicationName, "Mjolnir VR");
 	instance.applicationInfo.applicationVersion = 1;
 	strcpy(instance.applicationInfo.engineName, "halo-ce-universal");
 	instance.applicationInfo.engineVersion = 1;
@@ -2275,7 +2275,7 @@ void host_xr_test(void)
 	SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_ES);
 	SDL_GL_SetAttribute(SDL_GL_CONTEXT_MAJOR_VERSION, 3);
 	SDL_GL_SetAttribute(SDL_GL_CONTEXT_MINOR_VERSION, 2);
-	window = SDL_CreateWindow("Ringfall: Mjolnir VR", 640, 480, SDL_WINDOW_OPENGL | SDL_WINDOW_FULLSCREEN);
+	window = SDL_CreateWindow("Mjolnir VR", 640, 480, SDL_WINDOW_OPENGL | SDL_WINDOW_FULLSCREEN);
 	context = window ? SDL_GL_CreateContext(window) : NULL;
 	if (!context || !SDL_GL_MakeCurrent(window, context))
 		host_fatal("VR test: no OpenGL ES context: %s", SDL_GetError());

port/android/host_imports.list

@@ -32,6 +32,7 @@ host_sdl_set_clipboard_text
 host_sdl_get_clipboard_text
 host_sdl_show_toast
 host_sdl_show_simple_message_box
+host_sdl_show_message_box
 host_sdl_get_gamepads
 host_sdl_open_gamepad
 host_sdl_gamepad_from_id
@@ -84,5 +85,6 @@ host_touch_look_read
 host_touch_rumble
 host_touch_scene
 host_touch_bindings
+host_https_get
 
 host_errno

port/android/steam_frame_install.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
-# Ringfall: Mjolnir VR's installer for the Steam Frame, run in its Desktop
-# Mode from the bundle the release's "Install Ringfall: Mjolnir VR" desktop
+# Mjolnir VR's installer for the Steam Frame, run in its Desktop
+# Mode from the bundle the release's "Install Mjolnir VR" desktop
 # file downloads (steam_frame_installer.desktop; the bundle: this script,
 # RingfallMjolnirVR.apk, ringfall-mjolnir-vr.sh = steam_frame_launch.sh,
 # steam_frame_xiso.py and the library pictures in grid/). Everything is
@@ -19,28 +19,31 @@
 #   Steam Frame Desktop Mode runs inside Gaming Mode's session, which ends
 #   with Steam. The shortcut of the builds before the name ("Halo VR") is
 #   left for the player to remove (Steam would write it back).
-# RINGFALL_UNATTENDED=1 answers every question with its default and prints
-# instead of showing dialogs (RINGFALL_IMAGE: the disc image to use), for
+# MJOLNIR_UNATTENDED=1 answers every question with its default and prints
+# instead of showing dialogs (MJOLNIR_IMAGE: the disc image to use), for
 # testing over adb; it never closes Steam.
 
 BUNDLE="$(cd "$(dirname "$0")" && pwd)"
 GAME_DIR="$HOME/Documents/RingfallMjolnirVR"
 STEAM_DIR="$HOME/.local/share/Steam"
 LEPTON="$STEAM_DIR/steamapps/common/Lepton/lepton"
-TITLE="Ringfall: Mjolnir VR"
-NAME="Ringfall: Mjolnir VR"
+TITLE="Mjolnir VR"
+NAME="Mjolnir VR"
 APK_NAME="RingfallMjolnirVR.apk"
 LAUNCHER="ringfall-mjolnir-vr.sh"
 EXE="\"$GAME_DIR/$LAUNCHER\""
 # (the desktop file Steam adds the game from)
-NAME_FILE="Ringfall Mjolnir VR"
+NAME_FILE="Mjolnir VR"
 # the builds before the name: their folder and Steam shortcut
 OLD_DIR="$HOME/Documents/HaloCE"
 OLD_NAME="Halo VR"
+# the name of builds 302 to 313, which their shortcut keeps (Steam writes
+# its shortcuts back from memory: the player renames it)
+FORMER_NAME="Ringfall: Mjolnir VR"
 
 # what the installer did, for looking into problems: written to /tmp while
 # it runs, then kept beside the game as install.log
-LOG="/tmp/ringfall-mjolnir-vr-install.log"
+LOG="/tmp/mjolnir-vr-install.log"
 : > "$LOG"
 log() { echo "$(date '+%F %T') $*" >> "$LOG"; }
 keep_log() { [ -d "$GAME_DIR" ] && cp -f "$LOG" "$GAME_DIR/install.log" 2>/dev/null; }
@@ -59,7 +62,7 @@ steam_running()
     pgrep -f 'ubuntu12_32/steam( |$)' >/dev/null || pgrep -x steam >/dev/null
 }
 
-unattended() { [ "${RINGFALL_UNATTENDED:-0}" = 1 ] || ! command -v zenity >/dev/null; }
+unattended() { [ "${MJOLNIR_UNATTENDED:-0}" = 1 ] || ! command -v zenity >/dev/null; }
 
 info()
 {
@@ -185,7 +188,7 @@ PYTHON
 # must run), from a desktop file beside the game; then its pictures
 add_shortcut()
 {
-    local desktop="$GAME_DIR/$NAME_FILE.desktop" url file id
+    local desktop="$GAME_DIR/$NAME_FILE.desktop" url
     printf '[Desktop Entry]\nType=Application\nName=%s\nExec=%s\nPath=%s\nIcon=steam\nTerminal=false\n' \
         "$NAME" "$GAME_DIR/$LAUNCHER" "$GAME_DIR" > "$desktop" && chmod 755 "$desktop" || return 1
     url="steam://addnonsteamgame/$(python3 -c 'import sys, urllib.parse; print(urllib.parse.quote(sys.argv[1], safe=""))' "$desktop")"
@@ -195,6 +198,16 @@ add_shortcut()
     steam "$url" >/dev/null 2>&1 &
     for _ in $(seq 30); do have_shortcut && break; sleep 1; done
     have_shortcut || return 1
+    add_pictures
+    return 0
+}
+
+# the library pictures of the game's shortcut, for every Steam user who has
+# it (again on an update: the builds before the name "Mjolnir VR" had
+# Ringfall's)
+add_pictures()
+{
+    local file id
     while read -r file; do
         id="$(shortcut_id "$file" "$EXE")" || continue
         log "shortcut $id in $file"
@@ -204,7 +217,6 @@ add_shortcut()
         cp "$BUNDLE/grid/library_hero.png" "$(dirname "$file")/grid/${id}_hero.png"
         cp "$BUNDLE/grid/library_logo.png" "$(dirname "$file")/grid/${id}_logo.png"
     done < <(shortcut_files)
-    return 0
 }
 
 # --- the game
@@ -237,11 +249,15 @@ cp "$BUNDLE/$LAUNCHER" "$GAME_DIR/$LAUNCHER.tmp" && chmod 755 "$GAME_DIR/$LAUNCH
 cp "$BUNDLE/$APK_NAME" "$GAME_DIR/$APK_NAME.tmp" && chmod 666 "$GAME_DIR/$APK_NAME.tmp" &&
     mv -f "$GAME_DIR/$APK_NAME.tmp" "$GAME_DIR/$APK_NAME" && touch "$GAME_DIR/$APK_NAME" ||
     fail "Could not write $GAME_DIR/$APK_NAME (is the storage full?)."
+# (the build's number: the launcher updates from it, steam_frame_launch.sh;
+# an update fetched for an older build is dropped)
+cp "$BUNDLE/build.txt" "$GAME_DIR/build.txt" 2>/dev/null || rm -f "$GAME_DIR/build.txt"
+rm -rf "$GAME_DIR/update"
 
 # --- the game data
 
 if [ ! -f "$GAME_DIR/maps/ui.map" ]; then
-    image="${RINGFALL_IMAGE:-}"
+    image="${MJOLNIR_IMAGE:-}"
     if [ -z "$image" ]; then
         mapfile -t images < <(find_images)
         for candidate in "${images[@]}"; do
@@ -267,6 +283,7 @@ fi
 
 if have_shortcut; then
     log "the Steam shortcut is there"
+    add_pictures
 elif unattended; then
     echo "info: the Steam shortcut is missing (not added unattended)"
 elif ! steam_running; then
@@ -282,6 +299,9 @@ fi
 if have_shortcut_to "$OLD_DIR/halo-vr.sh"; then
     info "The library still shows the old \"$OLD_NAME\" from before the game's new name. It no longer starts: remove it in Steam (its gear or Manage > Remove non-Steam game)."
 fi
+if have_shortcut_to "$FORMER_NAME"; then
+    info "The library shows the game by its former name, \"$FORMER_NAME\". To call it $NAME there: its gear > Properties, then its name at the top."
+fi
 if ask "$NAME is installed.${image_note:-}\n\nSwitch to Gaming Mode now? Start $NAME from your library there (its pictures may show once Steam starts again)." yes; then
     steamos-session-select gamescope >/dev/null 2>&1 ||
         info "Switch to Gaming Mode yourself (the \"Return to Gaming Mode\" icon or the power menu)."

port/android/steam_frame_installer.desktop

@@ -1,14 +1,14 @@
 [Desktop Entry]
-# Ringfall: Mjolnir VR's installer for the Steam Frame
+# Mjolnir VR's installer for the Steam Frame
 # (port/android/STEAM_FRAME.md): a release asset,
-# "Install-Ringfall-Mjolnir-VR.desktop", opened in Desktop Mode. It downloads
+# "Install-Mjolnir-VR.desktop", opened in Desktop Mode. It downloads
 # the latest release's bundle (tools/steam_frame_bundle.py, which fills in
 # the repository) and runs its installer, steam_frame_install.sh.
 # (no "$", "\" or "%" in Exec: the desktop entry format would need them
 # escaped)
 Type=Application
-Name=Install Ringfall: Mjolnir VR
-Comment=Installs Ringfall: Mjolnir VR for the Steam Frame, or updates it
+Name=Install Mjolnir VR
+Comment=Installs Mjolnir VR for the Steam Frame, or updates it
 Icon=steam
 Terminal=false
-Exec=bash -c "if curl -fL --retry 3 -o /tmp/ringfall-mjolnir-vr-steam-frame.zip https://github.com/@REPOSITORY@/releases/latest/download/ringfall-mjolnir-vr-steam-frame.zip && rm -rf /tmp/ringfall-mjolnir-vr-install && python3 -m zipfile -e /tmp/ringfall-mjolnir-vr-steam-frame.zip /tmp/ringfall-mjolnir-vr-install; then exec bash /tmp/ringfall-mjolnir-vr-install/install.sh; else zenity --error --width=460 --title='Ringfall: Mjolnir VR' --text='Ringfall: Mjolnir VR could not be downloaded. Is the Steam Frame online?'; fi"
+Exec=bash -c "if curl -fL --retry 3 -o /tmp/mjolnir-vr-steam-frame.zip https://github.com/@REPOSITORY@/releases/latest/download/mjolnir-vr-steam-frame.zip && rm -rf /tmp/mjolnir-vr-install && python3 -m zipfile -e /tmp/mjolnir-vr-steam-frame.zip /tmp/mjolnir-vr-install; then exec bash /tmp/mjolnir-vr-install/install.sh; else zenity --error --width=460 --title='Mjolnir VR' --text='Mjolnir VR could not be downloaded. Is the Steam Frame online?'; fi"

port/android/steam_frame_launch.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# Ringfall: Mjolnir VR on the Steam Frame: Lepton runs the APK in a container of its own,
+# Mjolnir VR on the Steam Frame: Lepton runs the APK in a container of its own,
 # and installs it anew whenever the APK is newer than the installed one
 # (port/android/STEAM_FRAME.md). The game's data: ~/Documents/RingfallMjolnirVR.
 # (a container of its own, not the shortcut's id: with that, SteamVR's
@@ -70,6 +70,75 @@ run()
     child=0
 }
 
+# Updates (update.auto in config.toml; the game's own updater, the Quest's,
+# does nothing here: Lepton installs the APK in this folder each start).
+# While the game runs, the latest release is looked for; a newer one's
+# bundle is fetched into update/, checked, and put in place as the next
+# start begins, before Lepton runs the APK (it installs the newer one).
+# A build that knows no number of its own (build.txt: a local one) never
+# looks. Nothing changes without the internet, or when anything fails.
+REPOSITORY="@REPOSITORY@"
+UPDATE="$DATA/update"
+BUILD_FILE="$DATA/build.txt"
+SELF="$DATA/ringfall-mjolnir-vr.sh"
+
+update_apply()
+{
+    local new="$UPDATE/bundle" build
+    [ -f "$UPDATE/ready" ] || { rm -rf "$UPDATE"; return 0; }
+    build=$(cat "$new/build.txt" 2>/dev/null)
+    # (the launcher renamed over this one: bash goes on reading its own copy)
+    if cp "$new/ringfall-mjolnir-vr.sh" "$SELF.tmp" && chmod 755 "$SELF.tmp" &&
+        cp "$new/RingfallMjolnirVR.apk" "$APK.tmp" && chmod 666 "$APK.tmp" &&
+        mv -f "$SELF.tmp" "$SELF" && mv -f "$APK.tmp" "$APK" && touch "$APK" &&
+        cp "$new/build.txt" "$BUILD_FILE"
+    then
+        log "update: build $build put in place"
+    else
+        log "update: build $build could not be put in place"
+        rm -f "$SELF.tmp" "$APK.tmp"
+    fi
+    rm -rf "$UPDATE"
+}
+
+update_wanted()
+{
+    # (update.auto = false in config.toml's [update]: never)
+    ! awk '/^\[/ { section = $0 } section == "[update]" && /^[ \t]*auto[ \t]*=/ { print $3 }' \
+        "$DATA/config.toml" 2>/dev/null | grep -q false
+}
+
+update_check()
+{
+    local installed latest
+    installed=$(cat "$BUILD_FILE" 2>/dev/null)
+    [[ "$installed" =~ ^[0-9]+$ ]] && (( installed > 0 )) || return 0
+    update_wanted || return 0
+    latest=$(curl -fsSL --max-time 20 -H "Accept: application/vnd.github+json" \
+        "https://api.github.com/repos/$REPOSITORY/releases/latest" |
+        python3 -I -c 'import json, sys; print(json.load(sys.stdin)["tag_name"].rpartition("-")[2])' 2>/dev/null)
+    [[ "$latest" =~ ^[0-9]+$ ]] && (( latest > installed )) || return 0
+    log "update: build $latest found (this is $installed), fetching it"
+    rm -rf "$UPDATE" && mkdir -p "$UPDATE" || return 0
+    if curl -fsSL --retry 2 --max-time 900 -o "$UPDATE/bundle.zip" \
+            "https://github.com/$REPOSITORY/releases/download/build-$latest/mjolnir-vr-steam-frame.zip" &&
+        python3 -I -m zipfile -e "$UPDATE/bundle.zip" "$UPDATE/bundle" &&
+        [ "$(cat "$UPDATE/bundle/build.txt" 2>/dev/null)" = "$latest" ] &&
+        [ -s "$UPDATE/bundle/RingfallMjolnirVR.apk" ] && [ -s "$UPDATE/bundle/ringfall-mjolnir-vr.sh" ]
+    then
+        rm -f "$UPDATE/bundle.zip"
+        touch "$UPDATE/ready"
+        log "update: build $latest fetched, put in place at the next start"
+    else
+        log "update: build $latest could not be fetched"
+        rm -rf "$UPDATE"
+    fi
+}
+
+update_apply
+update_check </dev/null >/dev/null 2>&1 &
+updater=$!
+
 # (a new APK is only installed on its first start, not started; and a start
 # right after a game that was ended hard can fail in SteamVR, which then
 # needs a moment: again, up to three times, while it ends within 30 s)
@@ -83,4 +152,7 @@ for attempt in 1 2 3; do
     sleep 5
 done
 rm -f "$QUIT"
+# (a fetch still under way is given up: the next start looks again)
+pkill -P "$updater" 2>/dev/null
+kill "$updater" 2>/dev/null
 log "end"

port/android/steam_frame_xiso.py

@@ -1,66 +1,50 @@
 #!/usr/bin/env python3
 """
-Copies the maps folder out of an Xbox disc image (an "xiso", or a whole
-disc's ".iso") on the Steam Frame's SteamOS side, for its installer
-(steam_frame_install.sh). It reads the image as the app's own import does
+Copies the maps folder out of the player's Xbox disc image of Halo (an
+"xiso", or a whole disc's ".iso") on the Steam Frame's SteamOS side, for
+its installer (steam_frame_install.sh), as the app's own import does
 (app/src/main/java/com/halo/decomp/XisoExtractor.java, which this follows;
 the desktop games' is port/linux/src/xiso.c).
 
     steam_frame_xiso.py <image> <destination>
 
-writes <destination>/maps (through maps.partial, so an interrupted copy
-never leaves maps/ui.map behind) and prints its progress for zenity
---progress: a percentage on a line of its own, and "# <text>" lines. On
-failure it prints "error: <reason the player can act on>" to stderr and
-exits 1.
+writes <destination>/maps (through maps.partial, ui.map moved in last, so
+an interrupted copy never leaves maps/ui.map behind) and prints its
+progress for zenity --progress: a percentage on a line of its own, and
+"# <text>" lines. On failure it prints "error: <reason the player can act
+on>" to stderr and exits 1.
 
-The image's file system is XDVDFS, read as extract-xiso does
-(https://github.com/XboxDev/extract-xiso, extract-xiso.c, whose format
-handling this follows; its license is below and in
-port/third_party/extract-xiso/LICENSE.TXT): 2048-byte sectors; a volume
-descriptor at 0x10000 that starts and ends with "MICROSOFT*XBOX*MEDIA" and
-gives the root directory's sector and size; and directories whose entries
-form a binary tree (each entry: left and right subtree offsets in 4-byte
-units, the start sector, the size, attributes, the name's length and the
-name). Images made from a whole disc put the game partition further in, at
-one of the offsets below.
+Written from a description of the Xbox's disc file system, XDVDFS
+(xboxdevwiki's XDVDFS page, https://xboxdevwiki.net/XDVDFS), as
+XisoExtractor.java is:
 
-Some parts of this code are copyright in@fishtank.com. This product
-includes software developed by in <in@fishtank.com>.
+- Sectors are 2048 bytes and integers little-endian. Sector numbers count
+  from the start of the game partition: an image of the partition alone has
+  it at 0, an image of a whole disc further in (PARTITION_STARTS, tried in
+  that order).
+- The volume descriptor is the partition's sector 32 (at 0x10000). It holds
+  "MICROSOFT*XBOX*MEDIA" at its start and again at 0x7EC, and the root
+  directory table's start sector (u32 at 0x14) and size in bytes (u32 at
+  0x18).
+- A directory table is a binary tree of entries whose root is the entry at
+  offset 0. An entry is a left and a right subtree link (u16 each, in 4-byte
+  units from the table's start, 0 for none), the start sector and the size
+  of the file or of the subdirectory's table (u32 each), the attributes (u8,
+  0x10 for a directory), the name's length (u8) and the name. Unused bytes
+  are 0xFF, so a left link of 0xFFFF is padding, not an entry.
+- A file is one contiguous run of bytes from the start of its sector.
 
-Copyright (c) 2003 in <in@fishtank.com>
-All rights reserved.
+The image is the player's file and nothing read from it is trusted: only
+the root's table and the maps folder's are read, each whole and at most
+4 MB; a table's walk visits each offset once, goes at most 64 links deep
+and looks at most 4096 entries; and a file is written only under a plain
+name that no file before it had (ignoring case).
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-
-1. Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in the
-   documentation and/or other materials provided with the distribution.
-
-3. All advertising materials mentioning features or use of this software
-   must display the following acknowledgement:
-
-   This product includes software developed by in <in@fishtank.com>.
-
-4. Neither the name of "in" nor the email address "in@fishtank.com"
-   may be used to endorse or promote products derived from this software
-   without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED `AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES
-INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
-FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
-AUTHOR OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
-OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
-OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
-ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+A European disc in two languages (Spanish and Italian) has no maps folder
+but one for each, maps_es and maps_it: the one for the language asked for
+(MJOLNIR_LANGUAGE, else the system's) is taken, else English's, else the
+first, and its language written to maps/language.txt, which the game takes
+as the Xbox's language while game.language is unset.
 """
 
 import os
@@ -68,117 +52,170 @@ import struct
 import sys
 
 SECTOR_SIZE = 2048
-VOLUME_DESCRIPTOR_OFFSET = 0x10000
-ENTRY_HEADER_SIZE = 14
+DESCRIPTOR_OFFSET = 0x10000
+MAGIC = b"MICROSOFT*XBOX*MEDIA"
+SECOND_MAGIC_OFFSET = 0x7EC
+ENTRY_FIXED_SIZE = 14
 ATTRIBUTE_DIRECTORY = 0x10
+PADDING_LINK = 0xFFFF
+# where the game partition may start: an image of the partition alone, a
+# whole XGD2, XGD3 and XGD1 (the original Xbox's) disc
+PARTITION_STARTS = (0x00000000, 0x0FD90000, 0x02080000, 0x18300000)
 # directory tables are a few sectors; anything much larger is not one
-MAXIMUM_DIRECTORY_SIZE = 4 << 20
-MAXIMUM_FILES = 256
-COPY_BUFFER_SIZE = 1 << 20
-VOLUME_MAGIC = b"MICROSOFT*XBOX*MEDIA"
-# where the game partition starts: a plain image, and whole-disc images
-# (extract-xiso's GLOBAL, XGD3 and XGD1 offsets)
-PARTITION_OFFSETS = (0, 0x0FD90000, 0x02080000, 0x18300000)
+MAXIMUM_TABLE_SIZE = 4 << 20
+MAXIMUM_DEPTH = 64
+MAXIMUM_VISITS = 4096
+MAXIMUM_ENTRIES = 256
+COPY_CHUNK = 1 << 20
+PARTIAL_DIRECTORY = "maps.partial"
 
 
 class ExtractError(Exception):
     """a reason the player can act on"""
 
 
-def read_at(image, offset, size):
-    image.seek(offset)
+def read_exactly(image, position, size):
+    """size bytes of the image from position; None if it ends first"""
+    image.seek(position)
     data = image.read(size)
-    if len(data) != size:
-        raise ExtractError("Could not read the disc image (is it complete?).")
-    return data
+    return data if len(data) == size else None
 
 
-def find_volume(image):
-    """the game partition's offset, and the root directory's sector and size"""
-    for offset in PARTITION_OFFSETS:
-        try:
-            descriptor = read_at(image, offset + VOLUME_DESCRIPTOR_OFFSET, SECTOR_SIZE)
-        except ExtractError:
+def find_partition(image, image_size):
+    """the game partition's start, and the root table's sector and size"""
+    for start in PARTITION_STARTS:
+        if start + DESCRIPTOR_OFFSET + SECTOR_SIZE > image_size:
             continue
-        if descriptor[:20] != VOLUME_MAGIC or descriptor[0x7EC:0x7EC + 20] != VOLUME_MAGIC:
+        descriptor = read_exactly(image, start + DESCRIPTOR_OFFSET, SECTOR_SIZE)
+        if (descriptor is None or descriptor[:len(MAGIC)] != MAGIC or
+                descriptor[SECOND_MAGIC_OFFSET:SECOND_MAGIC_OFFSET + len(MAGIC)] != MAGIC):
             continue
-        sector, size = struct.unpack_from("<II", descriptor, 20)
-        return offset, sector, size
+        sector, size = struct.unpack_from("<II", descriptor, 0x14)
+        return start, sector, size
     raise ExtractError("This is not an Xbox disc image.")
 
 
-def read_directory(image, partition, sector, size, what):
-    if size <= 0 or size > MAXIMUM_DIRECTORY_SIZE:
-        raise ExtractError(what)
-    return read_at(image, partition + sector * SECTOR_SIZE, size)
+def read_table(image, partition, sector, size, damaged):
+    if size == 0 or size > MAXIMUM_TABLE_SIZE:
+        raise ExtractError(damaged)
+    table = read_exactly(image, partition + sector * SECTOR_SIZE, size)
+    if table is None:
+        raise ExtractError("Could not read the disc image (is it complete?).")
+    return table
 
 
-def walk(table, offset, depth, directories, out, visited):
-    """collects the entries (name, sector, size) of the subtree at offset
-    (4-byte units), files or directories as asked"""
-    at = offset * 4
-    # a malformed table must not loop or run off its end
-    visited[0] += 1
-    if depth > 64 or visited[0] > 4096 or at + ENTRY_HEADER_SIZE > len(table):
-        return
-    left, right, sector, size, attributes, name_length = struct.unpack_from("<HHIIBB", table, at)
-    # 0xFFFF: padding, an empty directory
-    if left == 0xFFFF:
-        return
-    if left:
-        walk(table, left, depth + 1, directories, out, visited)
-    is_directory = bool(attributes & ATTRIBUTE_DIRECTORY)
-    if (at + ENTRY_HEADER_SIZE + name_length <= len(table) and name_length > 0
-            and is_directory == directories and len(out) < MAXIMUM_FILES):
-        name = table[at + ENTRY_HEADER_SIZE:at + ENTRY_HEADER_SIZE + name_length].decode("latin-1")
-        # (as extract-xiso refuses them: no name may leave the folder)
-        if name not in (".", "..") and "/" not in name and "\\" not in name:
-            out.append((name, sector, size))
-    if right:
-        walk(table, right, depth + 1, directories, out, visited)
+def is_plain_name(name):
+    """no path, no . or .., and only printable ASCII that every file system
+    takes as a plain name"""
+    if not name or name in (".", ".."):
+        return False
+    return all(0x20 <= ord(character) <= 0x7E and character not in '/\\:*?"<>|' for character in name)
+
+
+def walk_table(table, directories):
+    """the folders (or the files) of a table with plain names, as (name,
+    sector, size), in the tree's order: each entry's left subtree, the entry,
+    its right subtree; a link to padding, past the table or back to an entry
+    already visited ends that branch"""
+    entries, visited = [], set()
+    visits = [0]
+
+    def walk(offset, depth):
+        if depth > MAXIMUM_DEPTH or visits[0] >= MAXIMUM_VISITS:
+            return
+        if offset >= len(table) or len(table) - offset < ENTRY_FIXED_SIZE:
+            return
+        left, right = struct.unpack_from("<HH", table, offset)
+        if left == PADDING_LINK or offset // 4 in visited:
+            return
+        visited.add(offset // 4)
+        visits[0] += 1
+        if left:
+            walk(left * 4, depth + 1)
+        name_length = table[offset + 13]
+        if name_length and name_length <= len(table) - offset - ENTRY_FIXED_SIZE:
+            is_directory = bool(table[offset + 12] & ATTRIBUTE_DIRECTORY)
+            name = table[offset + ENTRY_FIXED_SIZE:offset + ENTRY_FIXED_SIZE + name_length].decode("latin-1")
+            # (the destination's file system may ignore case)
+            if (is_directory == directories and len(entries) < MAXIMUM_ENTRIES and is_plain_name(name) and
+                    all(entry[0].lower() != name.lower() for entry in entries)):
+                sector, size = struct.unpack_from("<II", table, offset + 4)
+                entries.append((name, sector, size))
+        if right:
+            walk(right * 4, depth + 1)
+
+    walk(0, 0)
+    return entries
+
+
+def maps_language(name):
+    """a language's maps folder's language ("maps_it": "it"), else None"""
+    if len(name) == 7 and name[:5].lower() == "maps_" and name[5:].isalpha():
+        return name[5:].lower()
+    return None
+
+
+def choose_maps(folders):
+    """the maps folder, and its language (None for a plain "maps")"""
+    for folder in folders:
+        if folder[0].lower() == "maps":
+            return folder, None
+    languages = [(maps_language(folder[0]), folder) for folder in folders if maps_language(folder[0])]
+    wanted = (os.environ.get("MJOLNIR_LANGUAGE") or os.environ.get("LC_ALL") or
+        os.environ.get("LC_MESSAGES") or os.environ.get("LANG") or "")[:2].lower()
+    for preferred in (wanted, "en"):
+        for language, folder in languages:
+            if language == preferred:
+                return folder, language
+    if languages:
+        return languages[0][1], languages[0][0]
+    raise ExtractError("The disc image has no maps folder: it is not a Halo disc.")
 
 
 def extract(image_path, destination):
     with open(image_path, "rb") as image:
-        partition, root_sector, root_size = find_volume(image)
+        image_size = os.fstat(image.fileno()).st_size
+        partition, root_sector, root_size = find_partition(image, image_size)
 
         # the root's maps folder
-        table = read_directory(image, partition, root_sector, root_size,
-            "The disc image's file system is damaged.")
-        directories = []
-        walk(table, 0, 0, True, directories, [0])
-        maps = [entry for entry in directories if entry[0].lower() == "maps"]
-        if not maps:
-            raise ExtractError("The disc image has no maps folder: it is not a Halo disc.")
+        root = read_table(image, partition, root_sector, root_size, "The disc image's file system is damaged.")
+        (_, maps_sector, maps_size), language = choose_maps(walk_table(root, True))
 
         # its files
-        table = read_directory(image, partition, maps[-1][1], maps[-1][2],
-            "The disc image's maps folder is damaged.")
-        files = []
-        walk(table, 0, 0, False, files, [0])
-        if not any(name.lower() == "ui.map" for name, _, _ in files):
+        table = read_table(image, partition, maps_sector, maps_size, "The disc image's maps folder is damaged.")
+        files = walk_table(table, False)
+        user_interface = next((file for file in files if file[0].lower() == "ui.map"), None)
+        if user_interface is None:
             raise ExtractError("The disc image's maps folder has no ui.map: it is not a Halo disc.")
+        # (an image that ends before a file does is refused before anything
+        # is written; an empty file's sector need not be anywhere)
+        for name, sector, size in files:
+            if size and partition + sector * SECTOR_SIZE + size > image_size:
+                raise ExtractError("Could not read %s from the disc image (is it complete?)." % name)
         total = sum(size for _, _, size in files) or 1
 
-        partial = os.path.join(destination, "maps.partial")
-        finished = os.path.join(destination, "maps")
+        # the copy, to maps.partial (emptied of what an earlier attempt left)
+        partial = os.path.join(destination, PARTIAL_DIRECTORY)
         try:
             os.makedirs(partial, exist_ok=True)
+            for leftover in os.listdir(partial):
+                os.remove(os.path.join(partial, leftover))
         except OSError:
             raise ExtractError("Could not create %s." % partial)
-        done = 0
-        shown = -1
+        done, shown = 0, -1
         for name, sector, size in files:
             path = os.path.join(partial, name)
-            offset = partition + sector * SECTOR_SIZE
-            remaining = size
+            position, remaining = partition + sector * SECTOR_SIZE, size
             print("# Copying maps/%s" % name, flush=True)
             try:
                 with open(path, "wb") as out:
                     while remaining > 0:
-                        count = min(remaining, COPY_BUFFER_SIZE)
-                        out.write(read_at(image, offset, count))
-                        offset += count
+                        count = min(remaining, COPY_CHUNK)
+                        data = read_exactly(image, position, count)
+                        if data is None:
+                            raise ExtractError("Could not read %s from the disc image (is it complete?)." % name)
+                        out.write(data)
+                        position += count
                         remaining -= count
                         done += count
                         # (zenity closes at 100: that is left to the caller)
@@ -186,15 +223,22 @@ def extract(image_path, destination):
                         if percent != shown:
                             print(percent, flush=True)
                             shown = percent
-            except ExtractError:
-                raise ExtractError("Could not read %s from the disc image (is it complete?)." % name)
             except OSError:
                 raise ExtractError("Could not write %s (is the storage full?)." % path)
 
-    # (the maps folder may be there, empty)
+    # then into maps (which may be there, empty), the language before and
+    # ui.map (the sign that the data is there) last
+    finished = os.path.join(destination, "maps")
     try:
         os.makedirs(finished, exist_ok=True)
-        for name, _, _ in files:
+        language_file = os.path.join(finished, "language.txt")
+        if os.path.exists(language_file):
+            os.remove(language_file)
+        if language:
+            with open(language_file, "w") as out:
+                out.write(language + "\n")
+        order = [file for file in files if file is not user_interface] + [user_interface]
+        for name, _, _ in order:
             os.replace(os.path.join(partial, name), os.path.join(finished, name))
         os.rmdir(partial)
     except OSError as error:

port/android/tests/mirror_upload_test.c

@@ -0,0 +1,223 @@
+/* Real mirror decisions with a delayed, renaming GPU. No API failures. */
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+typedef int BOOL;
+typedef unsigned GLuint, GLenum;
+#define TRUE 1
+#define FALSE 0
+#ifndef TEST_DESKTOP
+#define HALO_GLES 1
+#endif
+#define STREAM_BUFFER_RING 3
+#define GL_COPY_WRITE_BUFFER 1
+#define GL_DYNAMIC_DRAW 2
+#define SEGMENT_SIZE 0x400000u
+#define PLATFORM_CONTIGUOUS_SIZE (2 * SEGMENT_SIZE)
+static unsigned char cpu[PLATFORM_CONTIGUOUS_SIZE];
+#define PLATFORM_CONTIGUOUS_BASE ((unsigned long)cpu)
+#define CHECK(x) do { if (!(x)) { fprintf(stderr, "line %d: %s\n", __LINE__, #x); exit(1); } } while (0)
+static struct { unsigned long frame, buffer_ring; } device;
+static struct { unsigned long mirrored_bytes; } stats;
+static unsigned long generations[PLATFORM_CONTIGUOUS_SIZE / 4096], serial;
+static unsigned mapped, subdata, overlaps, draws, mismatches, uploads;
+static unsigned watch_reads, protections;
+
+/* A subdata update may rename storage immediately and queue preservation
+of the old store plus its changed bytes. A later unsynchronized write to
+the new store can then be overwritten, even at a disjoint offset. */
+static unsigned char *stores[2];
+static GLuint bound, next_buffer;
+struct command
+{
+    struct command *next;
+    unsigned char *source, *destination, *expected;
+    unsigned long offset, size, sequence;
+};
+static struct command *head, *tail;
+static unsigned long submitted, fences[STREAM_BUFFER_RING];
+
+static void enqueue(unsigned char *source, unsigned char *destination,
+    unsigned char *expected, unsigned long offset, unsigned long size)
+{
+    struct command *command = calloc(1, sizeof(*command));
+    CHECK(command);
+    command->source = source;
+    command->destination = destination;
+    command->expected = expected;
+    command->offset = offset;
+    command->size = size;
+    command->sequence = ++submitted;
+    if (tail) tail->next = command;
+    else head = command;
+    tail = command;
+}
+
+static void complete(unsigned long sequence)
+{
+    while (head && head->sequence <= sequence)
+    {
+        struct command *command = head;
+        if (command->expected)
+        {
+            draws++;
+            if (memcmp(command->source + command->offset, command->expected, command->size)) mismatches++;
+            free(command->expected);
+        }
+        else
+        {
+            memcpy(command->destination + command->offset, command->source, command->size);
+            free(command->source);
+        }
+        head = command->next;
+        free(command);
+    }
+    if (!head) tail = NULL;
+}
+
+static void host_gl_fence_frame(unsigned slot) { fences[slot] = submitted; }
+static void host_gl_wait_frame(unsigned slot) { complete(fences[slot]); }
+
+static void next_frame(void)
+{
+    /* The actual fence/rotation/wait statements from Present. */
+#include "rotation.inc"
+    device.frame++;
+}
+
+static unsigned long memory_watch_generation(unsigned long address, unsigned long size)
+{
+    unsigned long page = (address - PLATFORM_CONTIGUOUS_BASE) / 4096;
+    unsigned long last = (address - PLATFORM_CONTIGUOUS_BASE + size - 1) / 4096, newest = 0;
+    watch_reads++;
+    for (; page <= last; page++) if (generations[page] > newest) newest = generations[page];
+    return newest;
+}
+static void memory_watch_protect(unsigned long address, unsigned long size) { (void)address; (void)size; protections++; }
+static void write_pages(unsigned first, unsigned count, unsigned char value)
+{
+    unsigned page;
+    for (page = first; page < first + count; page++) generations[page] = ++serial;
+    memset(cpu + first * 4096, value, count * 4096);
+}
+static void glGenBuffers(int count, GLuint *buffer) { CHECK(count == 1 && next_buffer < 2); *buffer = ++next_buffer; }
+static void glBindBuffer(GLenum target, GLuint buffer) { CHECK(target == GL_COPY_WRITE_BUFFER && buffer && buffer <= 2); bound = buffer - 1; }
+static void glBufferData(GLenum target, unsigned long size, const void *data, GLenum usage)
+{
+    CHECK(target == GL_COPY_WRITE_BUFFER && size == SEGMENT_SIZE && !data && usage == GL_DYNAMIC_DRAW);
+    stores[bound] = calloc(1, size);
+    CHECK(stores[bound]);
+}
+static void buffer_upload(GLenum target, unsigned long offset, unsigned long size, const void *data)
+{
+    unsigned char *old = stores[bound], *copy = malloc(size);
+    CHECK(target == GL_COPY_WRITE_BUFFER && offset + size <= SEGMENT_SIZE && copy);
+    stores[bound] = calloc(1, SEGMENT_SIZE);
+    CHECK(stores[bound]);
+    memcpy(copy, data, size);
+    enqueue(old, stores[bound], NULL, 0, SEGMENT_SIZE);
+    enqueue(copy, stores[bound], NULL, offset, size);
+    subdata++;
+    uploads++;
+}
+static void host_gl_buffer_write(GLenum target, unsigned offset, unsigned size, const void *data)
+{
+    struct command *command;
+    CHECK(target == GL_COPY_WRITE_BUFFER && offset + size <= SEGMENT_SIZE);
+    for (command = head; command; command = command->next)
+    {
+        if (command->destination == stores[bound] && offset < command->offset + command->size &&
+            command->offset < offset + size) overlaps++;
+        if (command->expected && command->source == stores[bound] && offset < command->offset + command->size &&
+            command->offset < offset + size) overlaps++;
+    }
+    memcpy(stores[bound] + offset, data, size);
+    mapped++;
+    uploads++;
+}
+
+#include "mirror.inc"
+
+static int draw_pages(unsigned first, unsigned count)
+{
+    GLuint buffer;
+    unsigned long offset;
+    unsigned char *expected;
+    if (!mirror_range(PLATFORM_CONTIGUOUS_BASE + first * 4096, count * 4096, &buffer, &offset, NULL)) return 0;
+    expected = malloc(count * 4096);
+    CHECK(expected);
+    memcpy(expected, cpu + first * 4096, count * 4096);
+    enqueue(stores[buffer - 1], NULL, expected, offset, count * 4096);
+    return 1;
+}
+
+int main(int argc, char **argv)
+{
+    unsigned index, old_uploads;
+    int rollover = argc > 1 && !strcmp(argv[1], "rollover");
+    device.frame = rollover ? ~0UL - 1 : 100;
+#ifdef HALO_ANDROID
+    /* First-use and reused ranges must always go to the caller's existing
+    streaming path, without creating GPU storage or consulting tracking. */
+    for (index = 0; index < 1200; index++)
+    {
+        GLuint buffer = 99;
+        unsigned long offset = 77, generation = 55;
+        write_pages(0, 300, (unsigned char)index);
+        CHECK(!mirror_range(PLATFORM_CONTIGUOUS_BASE, 300 * 4096, &buffer, &offset, &generation));
+        CHECK(buffer == 99 && offset == 77 && generation == 55);
+        CHECK(!draw_pages(0, 1));
+        CHECK(!draw_pages(1023, 2));
+        CHECK(!draw_pages(1024, 1));
+        next_frame();
+    }
+    CHECK(!next_buffer && !uploads && !watch_reads && !protections && !stats.mirrored_bytes);
+    fprintf(stderr, "bypassed=4800 allocations=0 uploads=0 watch_reads=0 protections=0\n");
+    return 0;
+#endif
+    write_pages(0, 1, 1);
+    CHECK(draw_pages(0, 1));
+    CHECK(watch_reads && protections);
+    next_frame();
+    /* An ordinary reused allocation: some previously mirrored pages and
+    some first-time pages. 300 pages also crosses the 256-page refresh chunk. */
+    write_pages(0, 300, 2);
+    CHECK(draw_pages(0, 300));
+    CHECK(draw_pages(0, 1));
+    next_frame();
+    write_pages(300, 1, 3);
+    CHECK(draw_pages(300, 1));
+    next_frame();
+    write_pages(301, 1, 4);
+    CHECK(draw_pages(301, 1));
+    /* A different segment has no pending preservation copy. */
+    write_pages(1024, 1, 5);
+    CHECK(draw_pages(1024, 1));
+    CHECK(!draw_pages(1023, 2)); /* segment boundary streams instead */
+    for (index = 0; index < STREAM_BUFFER_RING; index++) next_frame();
+    index = mapped;
+    write_pages(302, 1, 6);
+    CHECK(draw_pages(302, 1));
+#if defined(HALO_ANDROID) || defined(TEST_DESKTOP)
+    CHECK(mapped == 0); /* every persistent-cache upload is ordered */
+#else
+    CHECK(mapped == index + 1); /* fast path returns after the fence */
+#endif
+    complete(submitted);
+    old_uploads = uploads;
+    /* CPU generations are unchanged: any GPU damage is retained. */
+    for (index = 0; index < 1200; index++)
+    {
+        CHECK(draw_pages(256, 1));
+        next_frame();
+    }
+    complete(submitted);
+    CHECK(uploads == old_uploads);
+    fprintf(stderr, "mapped=%u subdata=%u overlaps=%u bad_draws=%u draws=%u repair_uploads=%u\n",
+        mapped, subdata, overlaps, mismatches, draws, uploads - old_uploads);
+    for (index = 0; index < 2; index++) free(stores[index]);
+    CHECK(overlaps == 0 && mismatches == 0);
+    return 0;
+}

port/assets/buttons/buttons.json

@@ -207,6 +207,320 @@
      ]
     }
    ]
+  },
+  {
+   "name": "black_butn__0",
+   "tag": "ui\\shell\\bitmaps\\black_butn",
+   "bitmap": 0,
+   "width": 32,
+   "height": 32,
+   "format": "dxt3",
+   "scale": 8,
+   "crc": 0,
+   "svg": "black_butn.svg",
+   "place": [
+    1,
+    0,
+    0
+   ]
+  },
+  {
+   "name": "white_butn__0",
+   "tag": "ui\\shell\\bitmaps\\white_butn",
+   "bitmap": 0,
+   "width": 32,
+   "height": 32,
+   "format": "dxt3",
+   "scale": 8,
+   "crc": 0,
+   "svg": "white_butn.svg",
+   "place": [
+    1,
+    0,
+    0
+   ]
+  },
+  {
+   "name": "classic_a__0",
+   "tag": "ui\\hud\\buttons\\classic_a",
+   "bitmap": 0,
+   "width": 32,
+   "height": 32,
+   "format": "dxt3",
+   "scale": 8,
+   "crc": 0,
+   "svg": "a_butn.svg",
+   "place": [
+    1,
+    0,
+    0
+   ],
+   "classic": "#40eb40",
+   "letter": [
+    0.1685,
+    0.1119
+   ]
+  },
+  {
+   "name": "classic_b__0",
+   "tag": "ui\\hud\\buttons\\classic_b",
+   "bitmap": 0,
+   "width": 32,
+   "height": 32,
+   "format": "dxt3",
+   "scale": 8,
+   "crc": 0,
+   "svg": "b_butn.svg",
+   "place": [
+    1,
+    0,
+    0
+   ],
+   "classic": "#fa5946",
+   "letter": [
+    0.696,
+    0.1204
+   ]
+  },
+  {
+   "name": "classic_x__0",
+   "tag": "ui\\hud\\buttons\\classic_x",
+   "bitmap": 0,
+   "width": 32,
+   "height": 32,
+   "format": "dxt3",
+   "scale": 8,
+   "crc": 0,
+   "svg": "x_butn.svg",
+   "place": [
+    1,
+    0,
+    0
+   ],
+   "classic": "#3998fa",
+   "letter": [
+    0.3363,
+    2.4589
+   ]
+  },
+  {
+   "name": "classic_y__0",
+   "tag": "ui\\hud\\buttons\\classic_y",
+   "bitmap": 0,
+   "width": 32,
+   "height": 32,
+   "format": "dxt3",
+   "scale": 8,
+   "crc": 0,
+   "svg": "y_butn.svg",
+   "place": [
+    1,
+    0,
+    0
+   ],
+   "classic": "#f9e928",
+   "letter": [
+    -0.4376,
+    2.2898
+   ]
+  },
+  {
+   "name": "classic_black__0",
+   "tag": "ui\\hud\\buttons\\classic_black",
+   "bitmap": 0,
+   "width": 32,
+   "height": 32,
+   "format": "dxt3",
+   "scale": 8,
+   "crc": 0,
+   "svg": "black_butn.svg",
+   "place": [
+    1,
+    0,
+    0
+   ],
+   "classic": "#000000"
+  },
+  {
+   "name": "classic_white__0",
+   "tag": "ui\\hud\\buttons\\classic_white",
+   "bitmap": 0,
+   "width": 32,
+   "height": 32,
+   "format": "dxt3",
+   "scale": 8,
+   "crc": 0,
+   "svg": "white_butn.svg",
+   "place": [
+    1,
+    0,
+    0
+   ],
+   "classic": "#ffffff"
+  },
+  {
+   "name": "gem_a__0",
+   "tag": "ui\\hud\\buttons\\gem_a",
+   "bitmap": 0,
+   "width": 32,
+   "height": 32,
+   "format": "dxt3",
+   "scale": 8,
+   "crc": 0,
+   "source_png": "source/a_gem.png"
+  },
+  {
+   "name": "gem_b__0",
+   "tag": "ui\\hud\\buttons\\gem_b",
+   "bitmap": 0,
+   "width": 32,
+   "height": 32,
+   "format": "dxt3",
+   "scale": 8,
+   "crc": 0,
+   "source_png": "source/b_gem.png"
+  },
+  {
+   "name": "gem_x__0",
+   "tag": "ui\\hud\\buttons\\gem_x",
+   "bitmap": 0,
+   "width": 32,
+   "height": 32,
+   "format": "dxt3",
+   "scale": 8,
+   "crc": 0,
+   "source_png": "source/x_gem.png"
+  },
+  {
+   "name": "gem_y__0",
+   "tag": "ui\\hud\\buttons\\gem_y",
+   "bitmap": 0,
+   "width": 32,
+   "height": 32,
+   "format": "dxt3",
+   "scale": 8,
+   "crc": 0,
+   "source_png": "source/y_gem.png"
+  },
+  {
+   "name": "trigger_left__0",
+   "tag": "ui\\hud\\buttons\\trigger_left",
+   "bitmap": 0,
+   "width": 64,
+   "height": 64,
+   "format": "a8r8g8b8",
+   "scale": 8,
+   "crc": 0,
+   "source_png": "source/trigger_left.png",
+   "control_cell": [
+    50,
+    35
+   ]
+  },
+  {
+   "name": "trigger_right__0",
+   "tag": "ui\\hud\\buttons\\trigger_right",
+   "bitmap": 0,
+   "width": 64,
+   "height": 64,
+   "format": "a8r8g8b8",
+   "scale": 8,
+   "crc": 0,
+   "source_png": "source/trigger_right.png",
+   "control_cell": [
+    50,
+    35
+   ]
+  },
+  {
+   "name": "thumbstick_left__0",
+   "tag": "ui\\hud\\buttons\\thumbstick_left",
+   "bitmap": 0,
+   "width": 64,
+   "height": 64,
+   "format": "a8r8g8b8",
+   "scale": 8,
+   "crc": 0,
+   "source_png": "source/thumbstick_left.png",
+   "control_cell": [
+    36,
+    40
+   ]
+  },
+  {
+   "name": "thumbstick_right__0",
+   "tag": "ui\\hud\\buttons\\thumbstick_right",
+   "bitmap": 0,
+   "width": 64,
+   "height": 64,
+   "format": "a8r8g8b8",
+   "scale": 8,
+   "crc": 0,
+   "source_png": "source/thumbstick_right.png",
+   "control_cell": [
+    36,
+    40
+   ]
+  },
+  {
+   "name": "thumbstick-halfway_left__0",
+   "tag": "ui\\hud\\buttons\\thumbstick-halfway_left",
+   "bitmap": 0,
+   "width": 64,
+   "height": 64,
+   "format": "a8r8g8b8",
+   "scale": 8,
+   "crc": 0,
+   "source_png": "source/thumbstick-halfway_left.png",
+   "control_cell": [
+    36,
+    40
+   ]
+  },
+  {
+   "name": "thumbstick-halfway_right__0",
+   "tag": "ui\\hud\\buttons\\thumbstick-halfway_right",
+   "bitmap": 0,
+   "width": 64,
+   "height": 64,
+   "format": "a8r8g8b8",
+   "scale": 8,
+   "crc": 0,
+   "source_png": "source/thumbstick-halfway_right.png",
+   "control_cell": [
+    36,
+    40
+   ]
+  },
+  {
+   "name": "thumbstick-full_left__0",
+   "tag": "ui\\hud\\buttons\\thumbstick-full_left",
+   "bitmap": 0,
+   "width": 64,
+   "height": 64,
+   "format": "a8r8g8b8",
+   "scale": 8,
+   "crc": 0,
+   "source_png": "source/thumbstick-full_left.png",
+   "control_cell": [
+    36,
+    40
+   ]
+  },
+  {
+   "name": "thumbstick-full_right__0",
+   "tag": "ui\\hud\\buttons\\thumbstick-full_right",
+   "bitmap": 0,
+   "width": 64,
+   "height": 64,
+   "format": "a8r8g8b8",
+   "scale": 8,
+   "crc": 0,
+   "source_png": "source/thumbstick-full_right.png",
+   "control_cell": [
+    36,
+    40
+   ]
   }
  ]
 }