afegit setup-quake

README.md

@@ -58,3 +58,48 @@ hostname_prefix = retro-alcoi-
    `/etc/network/interfaces`.
 
 Re-running with the same or a different machine number is safe (idempotent).
+
+### setup-quake
+
+Installs `ioquake3` from the Debian package manager and downloads/extracts the
+Quake 3 data files from a private server to the real user's home directory.
+
+```
+sudo ./setup-quake
+```
+
+See [`setup-quake/`](setup-quake/) for source and build instructions.
+
+#### Quick start
+
+```bash
+cd setup-quake/
+python3 -m venv .venv
+.venv/bin/pip install -r requirements.txt
+bash build.sh
+# Binary is at dist/setup-quake
+```
+
+Copy `dist/setup-quake` and `dist/config.ini` to a USB stick, then on each
+fair PC:
+
+```bash
+sudo ./setup-quake
+```
+
+#### Configuration
+
+Edit `config.ini` (alongside the binary) before distributing:
+
+```ini
+[quake]
+files_url = https://php.sustancia.synology.me/files/ioquake3-files.zip
+install_dir = .q3a
+```
+
+#### How it works
+
+1. Installs `ioquake3` via `apt-get`.
+2. Downloads the Quake 3 data files zip from the configured URL.
+3. Extracts the data files to `~/.q3a` (resolved via `$SUDO_USER` so the real
+   user's home is used, not root's).