Codex documentstion created

This commit is contained in:
Frank Harris 2026-06-05 11:07:47 -05:00
parent 3dc017421e
commit b5dcf01a8c
27 changed files with 6648 additions and 1069 deletions

View file

@ -0,0 +1,138 @@
# Codex Guide
This file is the first stop for future Codex sessions working in this repository.
## Repository Layout
```text
/
Agent_Linux/
Agent-Windows/
Panel/
Website/
docs/
```
## What To Read First
1. `docs/architecture/REPOSITORY_OVERVIEW.md`
2. `docs/architecture/PANEL_AGENT_FLOW.md`
3. `docs/modules/MODULE_INDEX.md`
4. `docs/modules/GAMEMANAGER.md`
5. `docs/features/STATUS_SYSTEM.md`
6. `docs/features/XML_SYSTEM.md`
7. `docs/modules/SCHEDULER.md`
8. `docs/modules/SERVER_CONTENT_MANAGER.md`
## Important Files By Topic
### Startup Logic
- `Panel/modules/gamemanager/home_handling_functions.php`
- `Panel/modules/gamemanager/start_server.php`
- `Panel/modules/gamemanager/restart_server.php`
- `Panel/modules/config_games/schema_server_config.xml`
- `Panel/modules/config_games/server_config_parser.php`
- `Panel/includes/lib_remote.php`
- `Agent_Linux/ogp_agent.pl`
- `Agent-Windows/ogp_agent.pl`
### Status Logic
- `Panel/includes/lib_remote.php`
- `Panel/modules/gamemanager/home_handling_functions.php`
- `Panel/modules/gamemanager/server_monitor.php`
- `Agent_Linux/ogp_agent.pl`
- `Agent-Windows/ogp_agent.pl`
### Scheduler Logic
- `Panel/modules/cron/module.php`
- `Panel/modules/cron/cron.php`
- `Panel/modules/cron/shared_cron_functions.php`
- `Agent_Linux/ogp_agent.pl`
- `Agent-Windows/ogp_agent.pl`
### Workshop / Server Content Logic
- `Panel/modules/addonsmanager/module.php`
- `Panel/modules/addonsmanager/addons_manager.php`
- `Panel/modules/addonsmanager/user_addons.php`
- `Panel/modules/addonsmanager/workshop_content.php`
- `Panel/modules/addonsmanager/workshop_action.php`
- `Panel/modules/steam_workshop/module.php`
### XML Definitions
- `Panel/modules/config_games/schema_server_config.xml`
- `Panel/modules/config_games/xml_config_creator.php`
- `Panel/modules/config_games/set_params.php`
- `Panel/modules/config_games/cli-params.php`
- `Panel/modules/config_games/config_servers.php`
### Agent Communication
- `Panel/includes/lib_remote.php`
- `Agent_Linux/ogp_agent.pl`
- `Agent-Windows/ogp_agent.pl`
## Common Development Workflows
### Debug a start/stop/restart issue
1. Read `docs/modules/GAMEMANAGER.md`.
2. Check `Panel/includes/lib_remote.php`.
3. Check `Panel/modules/gamemanager/home_handling_functions.php`.
4. Check the matching `ogp_agent.pl`.
5. Compare session/process/port logic in both agents.
### Debug a status issue
1. Read `docs/features/STATUS_SYSTEM.md`.
2. Check `remote_server_status` in `Panel/includes/lib_remote.php`.
3. Check `server_status_without_decrypt` in both agents.
4. Check game XML query definitions in `config_games`.
### Debug scheduler behavior
1. Read `docs/modules/SCHEDULER.md`.
2. Check `Panel/modules/cron/cron.php`.
3. Check scheduler subroutines in both agents.
4. Verify whether the action is customer-safe or admin-only.
### Debug Workshop or add-on behavior
1. Read `docs/modules/SERVER_CONTENT_MANAGER.md`.
2. Check `Panel/modules/addonsmanager/module.php`.
3. Check the user/admin content pages.
4. Check whether the action should be treated as install, update, or uninstall.
## Things Already Investigated
The repository has already been mapped in these areas:
- module inventory
- panel-agent remote library
- Linux and Windows agent `screen` use
- status model direction
- game XML startup and query variables
- current Server Content Manager structure
- current scheduler structure
- module-level roles and dependency patterns
## Things Intentionally Not Yet Implemented
This documentation-only pass does not implement:
- lifecycle code changes
- status model code changes
- scheduler redesign
- Workshop/content redesign
- backup system replacement
- file manager or FTP rewrites
- billing/provisioning changes
## Practical Rule for Future Sessions
Before scanning code broadly, read the docs layer first. Only open source files when the documentation does not already answer the question.