Panel/docs/modules/MODULE_INDEX.md
2026-06-08 16:09:54 -05:00

69 lines
4 KiB
Markdown

# Module Index
Workspace reference: [`GSP-WORKSPACE.md`](../../../GSP-WORKSPACE.md)
This is the master module inventory for the Panel. Use it as the first stop before opening module code.
| Module | Purpose | Status | Recommendation |
|---|---|---|---|
| [`TS3Admin`](TS3Admin.md) | Teamspeak 3 admin interface | Functional / niche | Keep or hide depending on product line |
| [`administration`](administration.md) | Admin utilities and logging helpers | Functional / legacy-leaning | Keep |
| [`addonsmanager`](SERVER_CONTENT_MANAGER.md) | Server Content Manager | Functional / actively evolving | Keep / Improve |
| [`backup-restore`](backup-restore.md) | Backup and restore UI | Broken | Remove / Replace |
| [`billing`](billing.md) | Billing, provisioning, commerce | Functional / partial | Keep / Rewrite |
| [`circular`](circular.md) | Notification and circular messages | Functional | Keep / Improve |
| [`config_games`](config_games.md) | XML game definitions and CLI builder | Production / functional | Keep / Improve |
| [`cron`](SCHEDULER.md) | Scheduler / CRON | Functional / partial | Rewrite / Improve |
| [`dashboard`](dashboard.md) | Main landing dashboard | Functional | Keep / Improve |
| [`dsi`](dsi.md) | Dynamic Server Image | Legacy / functional | Keep / Audit |
| [`editconfigfiles`](editconfigfiles.md) | Config file shortcuts | Functional / partial | Keep / Improve |
| [`faq`](faq.md) | FAQ and help content | Functional | Keep / Improve |
| [`fast_download`](fast_download.md) | FastDL support | Functional | Keep |
| [`ftp`](ftp.md) | FTP administration | Functional / legacy-heavy | Keep / Rewrite |
| [`gamemanager`](GAMEMANAGER.md) | Server monitor, lifecycle, logs, RCON | Production / functional | Keep / Improve |
| [`lgsl_with_img_mod`](lgsl_with_img_mod.md) | LGSL server status images | Legacy | Deprecate / Keep as legacy |
| [`litefm`](litefm.md) | In-panel file manager | Functional | Keep / Improve |
| [`lostpwd`](lostpwd.md) | Password recovery | Functional | Keep |
| [`modulemanager`](modulemanager.md) | Module installation and access rights | Functional | Keep |
| [`mysql`](mysql.md) | MySQL hosting/admin | Functional / future-facing | Keep / Future |
| [`news`](news.md) | Legacy news / announcements | Legacy | Deprecate / Hide unless modernized |
| [`rcon`](rcon.md) | RCON admin tool | Functional | Keep / Improve |
| [`register`](register.md) | Account registration | Functional | Keep |
| [`server`](server.md) | Remote server and node manager | Production / administrative | Keep / Improve |
| [`settings`](settings.md) | Panel settings and themes | Production | Keep |
| [`status`](status.md) | Status page | Experimental / alpha | Rewrite / Deprecate |
| [`steam_workshop`](steam_workshop.md) | Legacy Workshop module | Deprecated | Deprecate / Merge |
| [`subusers`](subusers.md) | Subuser permissions | Functional | Keep / Improve |
| [`support`](support.md) | Support landing page | Functional | Keep / Merge with tickets workflow |
| [`teamspeak3`](teamspeak3.md) | Teamspeak 3 web interface | Functional if sold | Keep or hide based on product line |
| [`tickets`](tickets.md) | Support ticket system | Production / functional | Keep / Improve |
| [`tshock`](tshock.md) | Terraria/TShock utilities | Alpha / partial | Keep conditional / Improve |
| [`update`](update.md) | Panel update tooling | Production / admin-only | Keep |
| [`user_admin`](user_admin.md) | User management | Production | Keep / Improve |
| [`user_games`](user_games.md) | Server provisioning and assignment | Production / functional | Keep / Improve |
| [`util`](util.md) | Miscellaneous utility tools | Functional / mixed | Keep / Rewrite selectively |
## Shared Dependencies
Common dependencies across many modules:
- `Panel/includes/lib_remote.php`
- auth/session and role checks
- `config_games` XML parsing
- database 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`