2 Module Reference
Frank Harris edited this page 2026-06-20 13:04:55 -05:00

Module Reference

This page combines the current GSP module inventory with imported upstream module documentation where that older documentation still explains the module accurately.

Inventory

Module Path Purpose Main files Notes
TS3Admin Panel/Panel/modules/TS3Admin/ TeamSpeak 3 admin integration module.php, navigation.xml Verify current scope
addonsmanager Panel/Panel/modules/addonsmanager/ Legacy add-ons and server-content workflows module.php, addons_manager.php, workshop_content.php, workshop_action.php, server_content_helpers.php Workshop should stay centered in steam_workshop
administration Panel/Panel/modules/administration/ Administration pages and utilities module.php and page files Verify current breakdown
backup-restore Panel/Panel/modules/backup-restore/ Backup and restore operations module.php Verify runtime details
billing Panel/Panel/modules/billing/ Billing and storefront integration module.php, admin pages Upstream billing docs exist
circular Panel/Panel/modules/circular/ Utility module module.php Needs verification
config_games Panel/Panel/modules/config_games/ Game template XML, schema, parser, and validation config_servers.php, server_config_parser.php, schema_server_config.xml, tests/validate_server_configs.php High-confidence module
cron Panel/Panel/modules/cron/ Scheduled jobs module.php Upstream README explains scheduling intent
dashboard Panel/Panel/modules/dashboard/ Dashboard and home experience module.php Verify current page scope
dsi Panel/Panel/modules/dsi/ Dynamic server image integration module.php Upstream README explains core feature
editconfigfiles Panel/Panel/modules/editconfigfiles/ Config file editing module.php Upstream README provides baseline behavior
faq Panel/Panel/modules/faq/ FAQ pages module.php Verify current content source
fast_download Panel/Panel/modules/fast_download/ Fast-download / HTTP redirect support module.php Upstream README explains purpose
ftp Panel/Panel/modules/ftp/ FTP-related access module.php Verify current behavior
gamemanager Panel/Panel/modules/gamemanager/ Core server lifecycle management module.php, mini_start.php, home_handling_functions.php, update_actions.php Central game management module
lgsl_with_img_mod Panel/Panel/modules/lgsl_with_img_mod/ LGSL query integration module.php Verify image/query role
litefm Panel/Panel/modules/litefm/ File manager module.php User-facing file operations
lostpwd Panel/Panel/modules/lostpwd/ Password reset flow module.php Verify current routing
mods Panel/Panel/modules/mods/ Mod-related definitions or tools module.php Needs verification
modulemanager Panel/Panel/modules/modulemanager/ Module management module.php Verify enable/disable flows
mysql Panel/Panel/modules/mysql/ MySQL helper pages module.php Verify scope
news Panel/Panel/modules/news/ News and announcements module.php Verify current usage
rcon Panel/Panel/modules/rcon/ Remote console tools module.php Verify current actions
register Panel/Panel/modules/register/ User registration module.php Verify config dependencies
reseller Panel/Panel/modules/reseller/ Reseller management module.php, navigation.xml Verify current privileges
server Panel/Panel/modules/server/ Server-specific pages module.php Verify scope
settings Panel/Panel/modules/settings/ Panel settings module.php Verify current ownership
status Panel/Panel/modules/status/ Status views module.php Verify current function
steam_workshop Panel/Panel/modules/steam_workshop/ Dedicated Steam Workshop management module.php, main.php, workshop_admin.php, functions.php, uninstall.php Active GSP Workshop module
subusers Panel/Panel/modules/subusers/ Sub-user management module.php User delegation module
support Panel/Panel/modules/support/ Support pages module.php Upstream support docs exist
teamspeak3 Panel/Panel/modules/teamspeak3/ TeamSpeak 3 integration module.php Verify relationship to TS3Admin
tickets Panel/Panel/modules/tickets/ Ticketing system module.php, navigation.xml Upstream README explains ticket purpose
tshock Panel/Panel/modules/tshock/ TShock or Terraria-oriented features module.php Needs verification
update Panel/Panel/modules/update/ Update flow module.php Verify current mechanics
user_admin Panel/Panel/modules/user_admin/ User administration module.php Admin-facing
user_games Panel/Panel/modules/user_games/ User game-server pages module.php User-facing
util Panel/Panel/modules/util/ Shared utilities module.php Cross-module support
website Panel/Panel/modules/website/ Website integration pages module.php Related to panel website features

Imported Upstream Module Notes

These notes come from upstream OGP module documentation and remain useful as first-pass descriptions unless contradicted by current GSP source.

cron

  • purpose: schedule server start, stop, restart, or other jobs
  • upstream note: designed to support both Linux and Windows job scheduling flows
  • GSP verification note: current source presence is confirmed; exact current UI and scheduler implementation should be verified in module pages

dsi

  • purpose: Dynamic Server Image generation
  • upstream note: requires PHP GD and Apache mod_rewrite
  • upstream note: depends on writable folders for generated image assets
  • GSP verification note: the module still exists; verify exact image-generation flow in current code before documenting setup details more deeply

editconfigfiles

  • purpose: edit server configuration files through panel tooling
  • upstream note: intended to simplify config editing without manual file browsing
  • GSP verification note: current module path is confirmed; exact editable file registration should be documented together with XML configuration_files

fast_download

  • purpose: configure fast-download aliases or HTTP paths for game content delivery
  • upstream note: integrates HTTP daemon aliasing or redirect-style download support
  • GSP verification note: current module exists; deployment specifics depend on the active web-server layout and should be verified before claiming full automation

steam_workshop

  • purpose: manage Steam Workshop configuration and content installs from a dedicated module
  • upstream note: upstream README describes Workshop installs using XML-generated metadata
  • GSP verification note: current GSP goes further with a dedicated admin profile page, per-game Workshop XML profiles, and schema-level workshop_support in game templates

tickets

  • purpose: support ticket module
  • upstream note: provides user-to-admin support workflow
  • GSP verification note: current module path and navigation are confirmed; exact database tables and role handling need a focused code pass

billing

  • purpose: billing and storefront workflows
  • upstream note: bundled with cron-driven recurring or timed operations
  • GSP verification note: current module exists, but exact payment-provider and automation coverage should be documented only after module-level source review

support

  • purpose: support or help workflows in the panel
  • upstream note: can be installed and exposed through module management
  • GSP verification note: current module path is confirmed; precise relationship to tickets should be reviewed

Current dedicated Workshop assets include:

  • Panel/Panel/modules/steam_workshop/game_configs/
  • Panel/Panel/modules/steam_workshop/navigation.xml
  • Panel/Panel/modules/steam_workshop/simple_admin_helper.php

Needs Verification

  • exact database tables touched by each module
  • exact navigation ownership for overlapping modules such as support, tickets, TS3Admin, and teamspeak3
  • which legacy modules remain enabled in normal GSP deployments versus retained for compatibility