OpenWarcraft3 Documentation

OpenWarcraft3 is a Quake-style engine and game implementation for Warcraft III, World of Warcraft, and StarCraft II data. The repository README contains build, installation, and project-overview information.

Start Here

• Architecture: runtime modules, client/server boundaries, networking, rendering, sound, UI, and fog of war.
• Coordinate-System Contract: native game axes, current WoW conversions, and the migration plan for axis-aware rendering.
• Warcraft III: target status, formats, renderer, UI, cinematics, sounds, and gameplay coverage.
• World of Warcraft: target status, ADT terrain, M2 display, DBC data, gameplay systems, and grass rendering.
• StarCraft II: target status, SC2Map loading, M3 models, catalog data, and HUD layout.
• Diagnostic Tools: bounded renderer and asset-inspection workflows.
• Docker Sandbox Dependencies: APT packages installed for building, debugging, and radare2 inspection.
• Build And Renderer Platforms: release builds, MSAA, GLES3, video modes, and low-end diagnostics.
• Flatpak And Steam Deck Packaging: x86_64 bundle layout, portal data selection, XDG state, and optional Steam shortcut integration.
• Documentation Guide: documentation placement and completion rules.

All durable documentation lives in this docs/ tree. Shared workflows are stored at the root, engine architecture under docs/architecture/, and game-specific material under docs/games/<game>/.