Codex documentstion created

docs/modules/MODULE_INDEX.md

@@ -0,0 +1,68 @@
+# Module Index
+
+This is the current Panel module inventory. It is intentionally concise so future Codex sessions can decide which module to inspect in code.
+
+| Module | Purpose | Current State | Dependencies | Notes |
+|---|---|---|---|---|
+| `TS3Admin` | Teamspeak 3 admin interface | Required, legacy niche | TS3 admin files | Keep if TS3 hosting is sold. |
+| `addonsmanager` | Server Content Manager | Required, actively evolving | DB tables, game XML, agent install scripts | Best current home for mods, add-ons, Workshop, and content installs. |
+| `administration` | Admin utilities | Required | Core admin pages | Includes logger/watch tools. |
+| `backup-restore` | Backup/restore UI | Optional, broken/testing | Hard-coded backup host/path logic | Hide until replaced. |
+| `billing` | Billing, provisioning, commerce | Optional, large custom module | Payment gateways, invoices, shop/provisioning docs | Important for commercial hosting. |
+| `circular` | Notification/circular messages | Optional | Panel UI | Good candidate for maintenance and announcement notices. |
+| `config_games` | Game XML definitions and CLI builder | Required | XML schema/parser | Critical for startup templates, queries, custom fields, and game capabilities. |
+| `cron` | Scheduler / CRON | Required | Agent scheduler methods, Panel action selection | Needs safe action registry and task history. |
+| `dashboard` | Main landing dashboard | Required | Panel auth and server summaries | Should surface status, support, billing, and alerts. |
+| `dsi` | Dynamic Server Image | Optional | Game imagery and cached assets | Useful for server cards and branding. |
+| `editconfigfiles` | Config file shortcuts | Optional | Game config metadata | Good for surfacing common editable files. |
+| `faq` | FAQ/help | Required | Site docs/content | Should link to game docs and common workflows. |
+| `fast_download` | FastDL support | Required | Source/GoldSrc-style web distribution | Still useful for older Source engine communities. |
+| `ftp` | FTP admin | Required | File transfer service, access rights | Needs security review but remains important. |
+| `gamemanager` | Server monitor, lifecycle, logs, RCON | Required | Agent RPC, game XML, query libraries | Core customer workflow module. |
+| `lgsl_with_img_mod` | LGSL server status images | Optional legacy | Query/image cache data | Secondary to agent truth. |
+| `litefm` | In-panel file manager | Required | File system access rights | Should be the preferred in-panel file tool. |
+| `lostpwd` | Password recovery | Required | Auth/account flow | Basic account support. |
+| `modulemanager` | Module installation/configuration | Required | Module metadata | Admin maintenance tool. |
+| `mysql` | MySQL hosting/admin | Required | MySQL service setup | Good future product tie-in for databases. |
+| `news` | Legacy news/announcements | Optional legacy | Old CMS-like data | Consider hiding unless modernized. |
+| `rcon` | RCON admin tool | Required | Server protocol support | Useful for commands, warnings, and scheduler integration. |
+| `register` | Account registration | Required | Auth flow | Basic customer onboarding. |
+| `server` | Server manager | Required | Agent/node management | Admin-facing node controls. |
+| `settings` | Global settings | Required | Auth, site config | Admin configuration area. |
+| `status` | Status page | Optional alpha | Status data | Not ready for customer-facing critical use. |
+| `steam_workshop` | Legacy Workshop module | Optional deprecated | Workshop DB helpers | Hidden/deprecated in favor of `addonsmanager`. |
+| `subusers` | Subuser permissions | Required | Authorization model | Important for commercial teams and communities. |
+| `support` | Support landing page | Required | Ticketing/docs | Better as an entry point than the full ticket workflow. |
+| `teamspeak3` | Teamspeak 3 web interface | Required if sold | TS3 service | Hide if not part of the product offering. |
+| `tickets` | Support ticket system | Optional but useful | DB tables, attachments, notifications | Stronger support workflow than `support` alone. |
+| `tshock` | Terraria/TShock utilities | Optional niche | Terraria/TShock game support | Expose only for supported games. |
+| `update` | Panel updates | Required admin tool | Patch/update system | Admin-only maintenance. |
+| `user_admin` | User management | Required | Auth/admin roles | Important for staff administration. |
+| `user_games` | Server provisioning and assignment | Required | Game homes, ports, billing integration | Core provisioning path. |
+| `util` | Utility tools | Required | Misc tools | Keep useful tools, hide legacy helpers that are not maintained. |
+
+## Dependency Notes
+
+Common dependencies across many modules:
+
+- `includes/lib_remote.php`
+- auth/session and role checks
+- `config_games` XML parsing
+- DB access helpers
+- server home and IP/port records
+
+## High-Value Modules
+
+The modules most likely to matter in future investigations are:
+
+1. `gamemanager`
+2. `config_games`
+3. `user_games`
+4. `addonsmanager`
+5. `cron`
+6. `litefm`
+7. `ftp`
+8. `billing`
+9. `tickets`
+10. `subusers`
+