NexQuake | Play Multiplayer Quake in Your Browser

Get Started

Overview and Quick Start

Learn what NexQuake is and get an instance running in minutes.

Overview

Product Overview

High-level product narrative, features, runtime model, and source tree.

Open Document

Guide

Quick Start

Fastest path to launch NexQuake with Docker defaults.

Open Document

Operate

Servers and Data

Data layout, game catalog, environment configuration, and live server administration.

Guide

Data and Servers

Data layout, mod installation, and servers.ini launch planning.

Open Document

Reference

Quickstart Catalog

How QUICKSTART entries and game.json bootstrap data and default servers.

Open Document

Reference

Environment Reference

Runtime variables for Nexus, networking, auth, and deployment.

Open Document

Reference

Admin Commands

Console-level administration for servers and Nexus runtime control.

Open Document

Play

Browser Client

Controls, input mapping, and the in-browser settings panel for touch, keyboard, and gamepad.

Guide

Controls

Touch, keyboard, gamepad, and video-mode guidance for browser play.

Open Document

Guide

User Interface

Use the in-browser gear panel for local files, cfg edits, and CD controls.

Open Document

System

Architecture and Components

System design and component docs for the browser client, Nexus service, and dedicated server.

Reference

Architecture

System design, runtime flow, and protocol-level behavior across the stack.

Open Document

Component

Web Client

WASM platform layer, renderer, audio, input, and browser transport internals.

Open Document

Component

Nexus Service

HTTP and WebSocket relay orchestration, boundaries, and runtime wiring.

Open Document

Component

Dedicated Server

Native nqserver build, patches, configuration, and dedicated-mode behavior.

Open Document

Internals

Build and Packages

Build pipeline, relay and extractor packages, and the upstream WinQuake bugfix catalog.

Component

Build System

Build scripts, upstream staging, and artifact generation for client and server.

Open Document

Package

Relay Package

Standalone WebSocket-to-UDP relay package and integration notes.

Open Document

Package

Shareware Extractor

Pure Go extraction flow and provenance checks for Quake 1.06 shareware.

Open Document

Reference

Bug Fix Catalog

Upstream WinQuake fixes carried by NexQuake for safety and stability.

Open Document

Reference

Indexes and Meta

Documentation index, release history, and licensing provenance.

Index

Documentation Index

Role-oriented list of every product-facing document under src/.

Open Document

Release

Release Notes

Product-visible changes organized by SemVer release.

Open Document

Legal

Attributions

GPL lineage, third-party credits, and product provenance notes.

Open Document

Layout

Source Tree

Each source directory, linked to its component documentation.

README.md

Top-level product overview and broad project narrative.

docs/

Task-oriented operator and player guides.

etc/

Game catalog and quickstart entry definitions.

client/

WASM client implementation and browser-side runtime details.

nexus/

Relay and orchestration service plus nested packages.

server/

Dedicated server build and runtime behavior.

build/

Build pipeline, upstream staging, and artifact generation.

bugfix/

Curated WinQuake patch catalog carried by NexQuake.

CHANGELOG.md

Release history for shipped product changes.

ATTRIBUTIONS.md

Licenses, provenance, and third-party credits.