Skip to content

README.md

Latest commit

 

History

History
16 lines (13 loc) · 1.18 KB

README.md

File metadata and controls

16 lines (13 loc) · 1.18 KB

QuakeShack Engine Documentation

This directory contains documentation for the QuakeShack engine codebase and features.

Table of Contents

  • 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.
  • QSMAT (QuakeShack Material) Format - Details on the .qsmat.json file 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.