workshop fix 1234
This commit is contained in:
parent
6be904e903
commit
3d7aa64db6
15 changed files with 509 additions and 484 deletions
|
|
@ -32,7 +32,7 @@ This is the master module inventory for the Panel. Use it as the first stop befo
|
|||
| [`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 |
|
||||
| [`steam_workshop`](steam_workshop.md) | Dedicated Workshop module | Functional | Keep |
|
||||
| [`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 |
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ Workspace reference: [`GSP-WORKSPACE.md`](../../../GSP-WORKSPACE.md)
|
|||
|
||||
## Current State
|
||||
|
||||
`Panel/modules/addonsmanager` is the current home of GSP's Server Content / Add-ons / Workshop work.
|
||||
`Panel/modules/addonsmanager` is the current home of GSP's Server Content / Add-ons work.
|
||||
|
||||
The module title has already been moved toward `Server Content Manager`, but the schema and some folder names remain backward-compatible.
|
||||
|
||||
|
|
@ -13,8 +13,6 @@ Important files:
|
|||
- `Panel/modules/addonsmanager/module.php`
|
||||
- `Panel/modules/addonsmanager/addons_manager.php`
|
||||
- `Panel/modules/addonsmanager/user_addons.php`
|
||||
- `Panel/modules/addonsmanager/workshop_content.php`
|
||||
- `Panel/modules/addonsmanager/workshop_action.php`
|
||||
- `Panel/modules/addonsmanager/server_content_helpers.php`
|
||||
- `Panel/modules/addonsmanager/server_content_categories.php`
|
||||
|
||||
|
|
@ -34,116 +32,21 @@ The module can already represent several content types, including:
|
|||
|
||||
- downloads/extracted packages
|
||||
- post-script driven installs
|
||||
- workshop-oriented items
|
||||
- config packs
|
||||
- future profile-type content
|
||||
|
||||
For Workshop items, the current flow lets users enter Workshop IDs or full Steam Workshop URLs and routes the install through module pages, staged manifests, and Panel-bundled scripts executed through existing agent primitives.
|
||||
|
||||
## Workshop Phase 1 Flow
|
||||
|
||||
1. Admin enables Workshop by adding a canonical `workshop_support` block to the game XML.
|
||||
2. Server Content Manager detects that capability from the selected server's XML.
|
||||
3. User opens `Server Content` from the game monitor.
|
||||
4. User selects the Steam Workshop Mods category. A Server Content template is no longer required just to expose Workshop for XML-enabled games.
|
||||
5. User enters one or more Workshop URLs or numeric IDs, searches the local catalog, or opens Steam's app-scoped Workshop search from the page.
|
||||
6. Panel parses IDs, rejects invalid entries, and records rows in `server_content_workshop`.
|
||||
7. Panel writes a manifest to `{SERVER_HOME}/gsp_server_content/workshop_manifest.json`.
|
||||
8. Panel writes a generated per-job shell script into `{SERVER_HOME}/gsp_server_content/jobs/workshop/`.
|
||||
9. The generated job script creates a temporary SteamCMD runscript containing `workshop_download_item <appid> <workshop_id> validate`.
|
||||
10. Agent executes the generated script with the manifest path through the existing authenticated `exec` RPC.
|
||||
11. Script runs SteamCMD with `+runscript`, copies Workshop content into the XML-configured target path, copies DayZ/Arma `.bikey` files when applicable, and writes a log under `gsp_server_content`.
|
||||
|
||||
The agents are intentionally generic executors in this design. New Workshop business logic should not be added to `Agent-Windows` or `Agent_Linux`; use `remote_writefile`, `exec`, log reads, and normal start/stop/restart primitives instead.
|
||||
|
||||
Current job-script behavior:
|
||||
|
||||
- Server Content Manager generates a new job script for each Workshop action.
|
||||
- Game XML does not define static Workshop script paths.
|
||||
- Default script names such as `generic_steam_workshop_windows_cygwin.sh` must not be checked as bare files on the agent.
|
||||
- Agents need only the generic `writefile` and `exec` primitives.
|
||||
|
||||
Current default install paths:
|
||||
|
||||
- Generic Steam Workshop content: `{SERVER_ROOT}/workshop/{MOD_FOLDER}`
|
||||
- DayZ / Arma strategy content: `{SERVER_ROOT}/{MOD_FOLDER}` for root `@<workshop_id>` folder compatibility
|
||||
|
||||
Game XML must use the canonical `workshop_support` block:
|
||||
|
||||
```xml
|
||||
<workshop_support>
|
||||
<enabled>1</enabled>
|
||||
<provider>steam</provider>
|
||||
<steam_app_id>107410</steam_app_id>
|
||||
<workshop_app_id>107410</workshop_app_id>
|
||||
<download_method>steamcmd</download_method>
|
||||
<install_strategy>arma_mod_folder</install_strategy>
|
||||
<install_path>{SERVER_ROOT}/{MOD_FOLDER}</install_path>
|
||||
<startup_param_format>-mod={MOD_LIST}</startup_param_format>
|
||||
<mod_separator>;</mod_separator>
|
||||
<mod_prefix>@</mod_prefix>
|
||||
<copy_keys enabled="1">
|
||||
<source_pattern>{MOD_PATH}/keys/*.bikey</source_pattern>
|
||||
<target_path>{SERVER_ROOT}/keys</target_path>
|
||||
</copy_keys>
|
||||
<post_install_action></post_install_action>
|
||||
</workshop_support>
|
||||
```
|
||||
|
||||
The Panel helper parser reads this block as the source of truth. Server Content admin forms do not collect Workshop app IDs, install paths, launch parameter additions, optional mod folder names, or static Workshop scripts.
|
||||
|
||||
SteamCMD requirements:
|
||||
|
||||
- Linux agents need SteamCMD available at the configured profile/template path, `STEAMCMD_PATH`, `/home/gameserver/steamcmd/steamcmd.sh`, or in `PATH`.
|
||||
- Windows agents currently use the existing Cygwin agent model and run the Panel-generated shell job. SteamCMD may be provided as `steamcmd.exe`, `steamcmd.sh`, an explicit configured path, or via `STEAMCMD_PATH`.
|
||||
- Missing SteamCMD should return a clear error, not a generic script failure.
|
||||
|
||||
The legacy `steam_workshop` monitor button is intentionally suppressed so users are not sent to the deprecated standalone module.
|
||||
|
||||
## Current User Controls
|
||||
|
||||
The `workshop_content.php` page supports:
|
||||
|
||||
- direct install by numeric ID or Steam Workshop URL
|
||||
- keyword/tag search against the local catalog
|
||||
- app-scoped Steam Workshop search links for the selected game
|
||||
- a list of Workshop-enabled games matching the current search terms
|
||||
- installed item list
|
||||
- enable/disable selected items
|
||||
- update selected items
|
||||
- remove selected items
|
||||
- download selected items without installing immediately
|
||||
- update all saved Workshop items
|
||||
- per-item update policy storage
|
||||
- known/common item catalog sorted by name, Workshop ID, install count, published date, last updated, or last installed
|
||||
|
||||
Update policies are stored as data for Scheduler/automation:
|
||||
|
||||
- `manual`
|
||||
- `scheduled`
|
||||
- `update_now`
|
||||
- `update_and_restart`
|
||||
- `download_only`
|
||||
- `install_on_restart`
|
||||
Steam Workshop is no longer a user-facing Server Content category. Workshop access belongs to the dedicated `steam_workshop` module.
|
||||
|
||||
## Current Limitations
|
||||
|
||||
- Workshop and content metadata is still partial.
|
||||
- Load order is tracked but not yet reorderable through a polished drag-and-drop UI.
|
||||
- Enable/disable is tracked but not wired into startup-parameter generation yet.
|
||||
- Async install job progress should be more visible.
|
||||
- Install strategies are still being broadened and need consistent game-specific rules.
|
||||
- DayZ/Arma style key-copy is implemented for Phase 1; startup-param behavior still needs a stronger canonical implementation.
|
||||
- Cache and cleanup policy need a clearer product design.
|
||||
- Direct Steam Web API keyword/tag search is not implemented yet; the current search page uses local catalog records and links out to Steam's Workshop search.
|
||||
|
||||
## Where To Start Reading
|
||||
|
||||
1. `Panel/modules/addonsmanager/module.php`
|
||||
2. `Panel/modules/addonsmanager/addons_manager.php`
|
||||
3. `Panel/modules/addonsmanager/user_addons.php`
|
||||
4. `Panel/modules/addonsmanager/workshop_content.php`
|
||||
5. `Panel/modules/addonsmanager/workshop_action.php`
|
||||
4. `Panel/modules/addonsmanager/server_content_categories.php`
|
||||
|
||||
## Important Concept
|
||||
|
||||
|
|
@ -151,14 +54,11 @@ This module is the right place for:
|
|||
|
||||
- mods
|
||||
- add-ons
|
||||
- Workshop content
|
||||
- config packs
|
||||
- script-driven installs
|
||||
- server content manifests
|
||||
- install history
|
||||
|
||||
The old `steam_workshop` module should be treated as a deprecated compatibility layer, not the main future path.
|
||||
|
||||
## Validation
|
||||
|
||||
Relevant smoke tests:
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ Current listing flow uses `remote_dirlistfm`, where agent filenames are treated
|
|||
- browse files
|
||||
- upload/download
|
||||
- edit common configs
|
||||
- use the green `Up one Level` button for parent-directory navigation on mobile and desktop
|
||||
|
||||
Special-character names are supported end-to-end in browse/navigation/actions, including:
|
||||
|
||||
|
|
@ -84,4 +85,3 @@ Path safety model:
|
|||
## Recommendation
|
||||
|
||||
- Keep / Improve
|
||||
|
||||
|
|
|
|||
|
|
@ -4,12 +4,12 @@ Workspace reference: [`GSP-WORKSPACE.md`](../../../GSP-WORKSPACE.md)
|
|||
|
||||
## Purpose
|
||||
|
||||
Legacy standalone Steam Workshop support.
|
||||
Dedicated Steam Workshop support for game servers.
|
||||
|
||||
## Current Status
|
||||
|
||||
- Deprecated
|
||||
- Compatibility only
|
||||
- Active in this repository checkout
|
||||
- User-facing Workshop module
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
|
@ -28,30 +28,48 @@ Legacy standalone Steam Workshop support.
|
|||
|
||||
## User Workflow
|
||||
|
||||
- legacy workshop path only
|
||||
- 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
|
||||
|
||||
- legacy migration / compatibility
|
||||
- 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 compete with the current Server Content Manager
|
||||
- should not be duplicated under `addonsmanager`
|
||||
|
||||
## Known Issues
|
||||
|
||||
- explicitly deprecated in code comments
|
||||
- some repository docs still describe this module as deprecated
|
||||
|
||||
## Missing Functionality
|
||||
|
||||
- modern unified Workshop/content UX
|
||||
- documentation cleanup so all references match the current module ownership
|
||||
|
||||
## Suggested Future Improvements
|
||||
|
||||
- keep only compatibility helpers
|
||||
- migrate users into `addonsmanager`
|
||||
- keep Workshop links and workflows isolated to this module
|
||||
- remove old addonsmanager Workshop assumptions
|
||||
|
||||
## Recommendation
|
||||
|
||||
- Deprecate / Merge
|
||||
|
||||
- Keep as the dedicated Workshop module
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue