Documentation
Start here for Commonwealth Online project docs.
Core
| Document | Purpose |
|---|---|
setup.md |
Build, deploy, submodules, main-menu notes |
architecture.md |
Plugin, server, proxy, threading model |
protocol.md |
Message types and LAN discovery overview |
protocol/ |
Detailed packet and sync field reference |
limitations.md |
Technical limits and unsupported systems |
version-targets.md |
Supported game/F4SE versions |
ROADMAP.md |
Vertical-slice roadmap and milestones |
dev-log.md |
Milestones, testing notes, next steps |
Feature and integration guides
| Document | Purpose |
|---|---|
weapon-animation-sync.md |
Weapon animation graph reference |
f4-animation-descriptor.md |
Humanoid animation graph variable mapping |
animation-architecture-alignment.md |
Animation sync architecture notes |
animation-sync-analysis.md |
Animation sync problem analysis |
protocol-phase2-extensions.md |
Phase 2 protocol field extensions |
MainMenu_Injection.md |
Runtime main-menu Multiplayer row injection |
MainMenu_Button_Injection_Guide.md |
Full main-menu injection how-to |
pause-menu-vanilla-settings-plan.md |
Planned vanilla settings integration |
project-comparison.md |
Commonwealth Online vs DoxyCoSync |
Research and reference
| Location | Purpose |
|---|---|
research/ |
Engine notes, sync research, related projects |
reference/Interface/ |
Decompiled vanilla main-menu SWF reference (read-only) |
Outside this folder
| Document | Purpose |
|---|---|
../README.md |
Project overview and quick start |
../changelog.md |
Change history |
../server/README.md |
Relay server and dev GUI |
../plugin/setup.md |
Plugin build notes |