complete codex docs
This commit is contained in:
parent
b5dcf01a8c
commit
3cefad183d
62 changed files with 2730 additions and 50 deletions
69
docs/modules/config_games.md
Normal file
69
docs/modules/config_games.md
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
# Config Games
|
||||
|
||||
## Purpose
|
||||
|
||||
Game XML definitions, CLI parameter generation, mod definitions, and custom field mapping.
|
||||
|
||||
## Current Status
|
||||
|
||||
- Production
|
||||
- Functional
|
||||
|
||||
## Dependencies
|
||||
|
||||
- XML schema
|
||||
- XML parser
|
||||
- gamemanager
|
||||
- user_games
|
||||
- file/config editing tools
|
||||
|
||||
## Database Tables
|
||||
|
||||
- `config_homes`
|
||||
- `config_mods`
|
||||
|
||||
## Agent Interaction
|
||||
|
||||
- drives startup command construction
|
||||
- influences query and control protocol handling
|
||||
|
||||
## User Workflow
|
||||
|
||||
- select a game definition
|
||||
- configure startup parameters
|
||||
- view/edit common CLI values
|
||||
- work with custom fields
|
||||
|
||||
## Admin Workflow
|
||||
|
||||
- create/update XML game configs
|
||||
- define mods, CLI params, ports, and custom fields
|
||||
- validate XML structure
|
||||
|
||||
## Security Concerns
|
||||
|
||||
- parameter injection
|
||||
- shell escaping
|
||||
- path validation
|
||||
|
||||
## Known Issues
|
||||
|
||||
- schema is powerful but broad
|
||||
- some capabilities are encoded implicitly instead of declaratively
|
||||
|
||||
## Missing Functionality
|
||||
|
||||
- first-class workshop/content capability declarations
|
||||
- first-class scheduler capability declarations
|
||||
- richer docs metadata
|
||||
|
||||
## Suggested Future Improvements
|
||||
|
||||
- extend XML capability model
|
||||
- document supported variables and examples more clearly
|
||||
- tie docs generation into XML
|
||||
|
||||
## Recommendation
|
||||
|
||||
- Keep / Improve
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue