Initial commit

.dockerignore

@@ -0,0 +1,7 @@
+assets
+bin
+chart
+docs
+hack
+proto
+result

.envrc

@@ -0,0 +1 @@
+use flake .

.gitattributes

@@ -0,0 +1 @@
+internal/quake/client/static/ioquake3.js linguist-vendored

.github/workflows/publish-docs.yaml

@@ -0,0 +1,49 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: 'latest'
+      - run: make docs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: 'docs/book'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/push-image.yaml

@@ -0,0 +1,45 @@
+name: Push Image
+
+on:
+  push:
+    # Sequence of patterns matched against refs/tags
+    tags:
+    - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  x86_64:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - uses: cachix/install-nix-action@v21
+      - name: Build
+        run: |
+          nix build .#container
+          skopeo login --username "${{ github.actor }}" --password "${{ secrets.GITHUB_TOKEN }}" ghcr.io
+          skopeo copy docker-archive://$(readlink -f ./result) docker://ghcr.io/chrisrx/quake-kube:latest
+
+  aarch64:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - run: sudo apt-get install -y qemu-user-static
+      - uses: cachix/install-nix-action@v21
+        with:
+          extra_nix_config: |
+            system = aarch64-linux
+      - name: Build
+        run: |
+          nix build .#container
+          skopeo login --username "${{ github.actor }}" --password "${{ secrets.GITHUB_TOKEN }}" ghcr.io
+          skopeo copy docker-archive://$(readlink -f ./result) docker://ghcr.io/chrisrx/quake-kube:latest

.github/workflows/test.yaml

@@ -0,0 +1,25 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Install golang
+        uses: actions/setup-go@v2
+        with:
+          go-version: '^1.21.5' # The Go version to download (if necessary) and use.
+
+      - name: Run tests
+        run: |
+          make test

.gitignore

@@ -0,0 +1,25 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+vendor/
+
+bin/
+
+# Ignore any Quake 3 assets in the default assets directory
+assets/
+
+# Nix build file
+result
+
+.direnv

Dockerfile

@@ -0,0 +1,40 @@
+FROM alpine:3 as quake-n-bake
+
+RUN apk add --no-cache git gcc make libc-dev
+RUN git clone https://github.com/ioquake/ioq3
+RUN cd /ioq3 && make BUILD_MISSIONPACK=0 BUILD_BASEGAME=0 BUILD_CLIENT=0 BUILD_SERVER=1 BUILD_GAME_SO=0 BUILD_GAME_QVM=0 BUILD_RENDERER_OPENGL2=0 BUILD_STANDALONE=1
+RUN cp /ioq3/build/release-linux-$(uname -m)/ioq3ded.$(uname -m) /usr/local/bin/ioq3ded
+
+FROM golang:1.21 as builder
+
+WORKDIR /workspace
+COPY go.mod go.mod
+COPY go.sum go.sum
+ARG GOPROXY
+ARG GOSUMDB
+RUN go mod download
+
+COPY cmd cmd/
+COPY internal internal/
+COPY pkg pkg/
+
+# Previously, container images were being cross-compiled with buildx which uses
+# QEMU for non-native platforms, which has unfortunately had long-running
+# issues running the Go compiler:
+# * [golang/go#24656](https://github.com/golang/go/issues/24656)
+# * [https://bugs.launchpad.net/qemu/+bug/1696773](https://bugs.launchpad.net/qemu/+bug/1696773)
+#
+# This issue can be circumvented by ensuring that the Go compiler does not run
+# across multiple hardware threads by limiting the affinity. I haven't noticed
+# it since moving to nix, but keeping this line handy regardless:
+#
+# RUN CGO_ENABLED=0 GOOS=linux GO111MODULE=on taskset -c 1 /usr/local/go/bin/go build -a -o q3 ./cmd/q3
+RUN CGO_ENABLED=0 GOOS=linux GO111MODULE=on go build -a -o q3 ./cmd/q3
+
+FROM alpine:3
+
+COPY --from=builder /workspace/q3 /usr/local/bin
+COPY --from=quake-n-bake /usr/local/bin/ioq3ded /usr/local/bin
+COPY --from=quake-n-bake /lib/ld-musl-*.so.1 /lib
+
+ENTRYPOINT ["/usr/local/bin/q3"]

Dockerfile.nix

@@ -0,0 +1,34 @@
+FROM nixos/nix:latest AS builder
+
+# Copy our source and setup our working dir.
+COPY go.mod /tmp/build/go.mod
+COPY go.sum /tmp/build/go.sum
+COPY flake.nix /tmp/build/flake.nix
+COPY flake.lock /tmp/build/flake.lock
+COPY gomod2nix.toml /tmp/build/gomod2nix.toml
+COPY cmd /tmp/build/cmd/
+COPY internal /tmp/build/internal/
+COPY pkg /tmp/build/pkg/
+WORKDIR /tmp/build
+
+# Build our Nix environment
+RUN nix \
+    --extra-experimental-features "nix-command flakes" \
+    --option filter-syscalls false \
+    build
+
+# Copy the Nix store closure into a directory. The Nix store closure is the
+# entire set of Nix store values that we need for our build.
+RUN mkdir /tmp/nix-store-closure
+RUN cp -R $(nix-store -qR result/) /tmp/nix-store-closure
+
+# Final image is based on scratch. We copy a bunch of Nix dependencies
+# but they're fully self-contained so we don't need Nix anymore.
+FROM scratch
+
+WORKDIR /app
+
+# Copy /nix/store
+COPY --from=builder /tmp/nix-store-closure /nix/store
+COPY --from=builder /tmp/build/result /app
+ENTRYPOINT ["/app/bin/q3"]