Panel/docs/decisions/0004-workshop-system.md

2.4 KiB

Decision 0004: Server Content Manager Is The Workshop Layer

Status

Accepted, Phase 1 implementation active

Decision

Panel/modules/addonsmanager should remain the primary future home for Workshop items, mods, add-ons, and server content. steam_workshop should remain a deprecated compatibility layer only.

Phase 1 implements this decision by routing the user-facing Workshop install flow through addonsmanager/workshop_content.php and suppressing the standalone steam_workshop monitor button.

Reasoning

  • addonsmanager already has the richer schema and more complete product direction.
  • It supports content types beyond Steam Workshop.
  • It is a better fit for load order, enable/disable, install history, and metadata.

Alternatives Considered

  • keep steam_workshop as the main module
  • split mods, add-ons, and Workshop into separate modules

Why Those Were Not Chosen

  • steam_workshop is explicitly deprecated in the codebase.
  • Separate modules would fragment user workflows and duplicate install logic.

Implementation Notes

  • Workshop input accepts numeric IDs or Steam URLs, then stores numeric IDs only.
  • Manifests are written under the server home in gsp_server_content.
  • Bundled Linux/Cygwin scripts are copied from the Panel module to an agent-managed folder under the server home before execution.
  • Default script names are treated as bundled handlers, not as existing agent paths.
  • Missing custom scripts fall back to bundled handlers and log the fallback.
  • Generic content installs under {SERVER_ROOT}/workshop/{MOD_FOLDER} by default.
  • DayZ/Arma-style installs default to @<workshop_id> folders and copy .bikey files into keys when present.
  • Startup parameter generation remains a later phase.
  • Game XML uses the canonical workshop_support block. The schema validates this block and no longer requires loose top-level Workshop tags.
  • The Panel helpers read workshop_support first, then tolerate older direct tags only as compatibility fallbacks.
  • Arma 3 Linux and Windows configs declare Workshop app ID 107410 through workshop_support.

Validation

Current validation commands:

php Panel/modules/addonsmanager/tests/workshop_helpers_test.php
php Panel/modules/config_games/tests/validate_server_configs.php
bash -n Panel/modules/addonsmanager/scripts/workshop/generic_steam_workshop_linux.sh
bash -n Panel/modules/addonsmanager/scripts/workshop/generic_steam_workshop_windows_cygwin.sh