Panel/docs/modules/steam_workshop.md
2026-06-11 12:50:45 -05:00

2.1 KiB

Steam Workshop

Workspace reference: GSP-WORKSPACE.md

Purpose

Dedicated Steam Workshop support for game servers.

Current Status

  • Active in this repository checkout
  • User-facing Workshop module

Dependencies

  • Steam Workshop DB helpers
  • legacy helper functions

Database Tables

  • steam_workshop_game_profiles
  • steam_workshop_server_mods
  • steam_workshop_server_settings

Agent Interaction

  • workshop download/update helpers

User Workflow

  • open the Steam Workshop monitor button from Game Monitor
  • search by Workshop ID, Workshop URL, or keyword from the dedicated module
  • search results are scoped to the current game's configured Workshop App ID
  • select one or more search results with checkboxes and install them through the existing workflow
  • manual Workshop ID entry remains available as a fallback
  • install/update/uninstall Workshop items through the dedicated module

Admin Workflow

  • configure Workshop game XML files under Panel/modules/steam_workshop/game_configs/
  • use workshop_admin.php for module administration

Search Backend

  • discovery is server-side in Panel/modules/steam_workshop/main.php
  • the panel searches Steam Community Workshop browse results for the current game App ID
  • result metadata is hydrated with ISteamRemoteStorage/GetPublishedFileDetails
  • no Steam API key is currently required for the user-facing search flow
  • selected result IDs and manual IDs are deduplicated before the existing install RPC runs

UI Notes

  • the main Workshop page Back link is rendered as a real panel button
  • uninstall remains in the dedicated steam_workshop module

Security Concerns

  • should not be duplicated under addonsmanager

Known Issues

  • some repository docs still describe this module as deprecated

Missing Functionality

  • documentation cleanup so all references match the current module ownership

Suggested Future Improvements

  • keep Workshop links and workflows isolated to this module
  • remove old addonsmanager Workshop assumptions

Recommendation

  • Keep as the dedicated Workshop module