This directory contains documentation for the QuakeShack engine codebase and features.
- Browser Verification Technique - How to drive a live headless-browser smoke test of the client (no chromium-cli/playwright dependency) for verifying UI/frontend changes.
- BSPX Support - Details on supported BSPX extensions and lumps for advanced mapping features.
- Client Server Architecture - Overview of the client-side architecture.
- Code Style Guide - Coding conventions and style rules for the QuakeShack Engine codebase.
- Console - Details regarding the console implementation.
- Dedicated Server - Information on running QuakeShack as a dedicated server in a Node.js environment.
- Events - Documentation on the engine's event bus system.
- Game Module Contract - What the engine calls on a game module, in which order, who writes which field, and how
tscchecks a game against the engine. - Menu System - Stack-based, widget-driven menu framework and the
ClientEngineAPI.MenuAPI for game code. - Post-Process Effects - Game-controlled screen-space effects (color grading, blur) and how to extend them.
- QSMAT (QuakeShack Material) Format - Details on the
.qsmat.jsonfile format used to define PBR materials for Quake BSP maps. - Traceline API - Contract and semantics of the gameplay-facing trace query used by server and client game logic.
- Volumetric Fog - Guide on creating atmospheric fog volumes in maps.
- WebRTC Implementation - Details the WebRTC implementation for peer-to-peer networking in the QuakeShack engine.