Configuration

QuakeServer

Each server is a QuakeServer. Every field is optional:

apiVersion: quake.kube/v1
kind: QuakeServer
metadata:
  name: quake
spec:
  # Defaults for maps that don't set their own.
  fragLimit: 25
  timeLimit: 15m
  bot:
    minPlayers: 4
    noChat: true
  game:
    # Game type of maps that don't set their own: FreeForAll, Tournament,
    # SinglePlayer, TeamDeathmatch or CaptureTheFlag, or a mod's g_gametype
    # number.
    type: FreeForAll
    motd: "Welcome to Quake Kube"
    password: "letmein"
    forceRespawn: false
    # Idle players are kicked after this long.
    inactivity: 10m
    quadFactor: 3
    # Seconds.
    weaponRespawn: 3
    singlePlayerSkill: 2
  server:
    # Defaults to the QuakeServer's name.
    hostname: "Quake Kube"
    maxClients: 12
  # The map rotation, played in order.
  maps:
    - name: q3dm7
    - name: q3dm17
      fragLimit: 30
      timeLimit: 20m
    - name: q3tourney2
      type: Tournament
  # Console commands run once the first map has loaded.
  commands:
    - addbot sarge 2
  # Cvars set before the first map loads.
  cvars:
    sv_fps: "30"

Without maps, the server plays q3dm7 and q3dm17. The Quake 3 demo only has q3dm1, q3dm7, q3dm17 and q3tourney2. Others need content (see Add Mods And Maps), which is also where game.fsGame, game.native and content are covered.

A map’s fragLimit, timeLimit and captureLimit apply from that map on. Mods number their game types differently, so captureLimit is set for any type, such as Capture The Flag:

maps:
  - name: q3wctf3
    type: CaptureTheFlag
    captureLimit: 8

Changes to the spec are applied to the running server, which restarts with the new configuration. Changing the content or the mod replaces the server’s pod.

The chart

The chart’s values.yaml documents its settings, including:

• gateway.presets: the games the web app offers (see Add Mods And Maps)
• gateway.imagePresets: whether to offer the presets with content images, which need Kubernetes 1.35
• gateway.auth: how the gateway knows who people are, for server owners and admins (see Authentication)
• gateway.namespace: where the web app creates servers, the release namespace by default. The gateway reads Secrets there, for servers’ rcon passwords, so changes made from the web app apply right away, and runs the pods that make thumbnails of each game’s maps, which it keeps in ConfigMaps. Use a namespace of its own if the release namespace has other Secrets.
• gateway.maxServers: how many servers the web app can create, or 0 to turn creating servers off
• gateway.maxServersPerUser: how many each person can have, with authentication
• gateway.idleTimeout: how long a server created from the web app can go without players before it’s deleted (30m by default), or empty to keep servers until someone deletes them
• gameServers.exposure: how native clients reach game servers, and the port range servers get their external ports from when they share an address
• master.service: how native clients reach the master server