Documentation index#

This repository builds an open behavioral specification for Lords of the Realm 2. Start here to understand how the docs are organized.

Primary deliverable: behavioral spec#

Path	Purpose
`VISION.md`	Goals, boundaries, evidence levels, legal note
`spec/`	Normative game behavior by domain

Read spec/README.md for the domain index, authoring rules, and phased roadmap.

Supporting evidence#

These layers document how the original binary implements behavior. They cross-link to spec pages and should be updated when new evidence is recovered.

Path	Purpose
`builds.md`	Retail vs GoG builds — differences, similarities, interop
`architecture/`	Per-subsystem module maps (`MODULE.md`)
`structs/`	Recovered struct layouts and provenance
`scenes/`	Every interactive screen mode (`lotr2_game_screen_mode` catalog)
`nobles/`	AI noble archetypes (Knight, Baron, Countess, Bishop)
`protocols/`	DirectPlay session and app message wire formats
`METADATA.md`	Binary hash, Ghidra version, export dates

Reading order for new contributors#

VISION.md — project goals and compatibility bar
builds.md — retail vs GoG scope (which build for which feature)
spec/README.md — spec domains and write-order roadmap
Pick a domain under spec/; follow links to evidence docs
../AGENTS.md — workflow for adding spec pages backed by src/

Relationship#

docs/spec/          ← what the game must do (normative)
       ↓ links to
docs/architecture/  ← where symbols live (evidence)
docs/structs/       ← data layouts (evidence)
docs/scenes/        ← interactive screen catalog (evidence)
docs/nobles/        ← AI noble profiles and tables (evidence)
docs/protocols/     ← wire formats (evidence)
src/                ← annotated Ghidra decompilation (evidence)