Difference between revisions of "Steam Workshop"

From Supreme Ruler Wiki
Jump to: navigation, search
(Created Steam Workshop information)
Tag: Visual edit
 
m
Tag: Visual edit
Line 1: Line 1:
   
  +
Steam Workshop support is being added to ''Supreme Ruler Ultimate'' effective version 9.1.286+ (March 2020 Update).
Workshop type MAPS:
 
  +
  +
Workshop items supported are MAPS and MODS, described below.
  +
 
===== Workshop type MAPS: =====
   
 
* Upload from:  \Scenario\Workshop
 
* Upload from:  \Scenario\Workshop
Line 9: Line 13:
 
** MP:  switch list as with Save games; Listbox 2907
 
** MP:  switch list as with Save games; Listbox 2907
   
Workshop type MODS:
+
===== Workshop type MODS: =====
   
 
* Upload from: ??
 
* Upload from: ??
Line 21: Line 25:
 
* ''Note:  This usage can cause conflicts with other workshop items, unexpected changes (ie flag replacements), issues with core game, etc''
 
* ''Note:  This usage can cause conflicts with other workshop items, unexpected changes (ie flag replacements), issues with core game, etc''
   
 
===== Uses of Steam Workshop =====
Game Engine initializes Steam during application startup, before main menu display
 
 
* Workshop items ''should'' be retreived before menu is called, so that graphics and haps will load through the workshop sequence.
 
* Items that load ''before'' workshop data is available:
 
** Splash screens (BltSplashScreen) - pubsplash, splash, splashme/box
 
** ''If Workshop data arrives in time, everything else should be OK''
 
 
Uses of Steam Workshop
 
   
 
* Create a new Sandbox/Scenario (MAPS)
 
* Create a new Sandbox/Scenario (MAPS)
Line 40: Line 37:
 
** Can be in any folder - Sandbox\ etc, Maps\, Graphics\, Localize\ etc
 
** Can be in any folder - Sandbox\ etc, Maps\, Graphics\, Localize\ etc
 
** Upload to Steam using ???
 
** Upload to Steam using ???
  +
  +
===== Technical Details =====
 
Game Engine initializes Steam during application startup, before main menu display
  +
 
* Workshop items ''should'' be retrieved before menu is called, so that graphics and haps will load through the workshop sequence.
 
* Items that load ''before'' workshop data is available:
 
** Splash screens (BltSplashScreen) - pubsplash, splash, splashme/box
 
**''If Workshop data arrives in time, everything else should be OK''
   
 
File Loading Sequence - stops at first found:
 
File Loading Sequence - stops at first found:

Revision as of 17:00, 6 March 2020

Steam Workshop support is being added to Supreme Ruler Ultimate effective version 9.1.286+ (March 2020 Update).

Workshop items supported are MAPS and MODS, described below.

Workshop type MAPS:
  • Upload from:  \Scenario\Workshop
  • A "Package" of a .scenario file and as many game items as necessary
  • Game items load from Workshop path if available, then check SRU path
  • Display/Select:
    • SP:  Listbox 1534
    • MP:  switch list as with Save games; Listbox 2907
Workshop type MODS:
  • Upload from: ??
  • Replacement/addition items for anything in game root path
  • Once "subscribed", will be used for file load paths
    • Search workshop paths, in order, until file found
    • If file not found, use default SRU path
  • Optional, handle file list paths (ie Sandbox) by combining all results into one
  • Could be unsubscribed from SRU
  • Optional, could query list and subscribe from within SRU
  • Note:  This usage can cause conflicts with other workshop items, unexpected changes (ie flag replacements), issues with core game, etc
Uses of Steam Workshop
  • Create a new Sandbox/Scenario (MAPS)
    • Created in \Scenario\Workshop\
    • Create a .scenario file
    • Create a folder with the same name for scenario-specific files
    • Optional: Create folders with override for default game (Maps\, Graphics\ etc)
    • Upload to Steam using Asset Tool
  • Create Mods for Core Game (MODS)
    • Create a folder structure with changed files
    • Can be in any folder - Sandbox\ etc, Maps\, Graphics\, Localize\ etc
    • Upload to Steam using ???
Technical Details

Game Engine initializes Steam during application startup, before main menu display

  • Workshop items should be retrieved before menu is called, so that graphics and haps will load through the workshop sequence.
  • Items that load before workshop data is available:
    • Splash screens (BltSplashScreen) - pubsplash, splash, splashme/box
    • If Workshop data arrives in time, everything else should be OK

File Loading Sequence - stops at first found:

  1. If MAPS: MAPS workshop path
  2. If not MAPS: Loop through each MODS path looking for Scenario Path overrides
  3. If not MAPS: Scenario Path in Default installation
  4. Default installation

For Example - loading Sandbox SR1940, looking for Default.WMData

  1. Look through all MODS : <Modpath>\Sandbox\SR1940\MAPS\Default.WMData
  2. Sandbox\SR1940\MAPS\Default.WMData
  3. MAPS\Default.WMData

For Example - Loading MAPS Workshop Scenario SRNEW, looking for Default.WMData

  1. <Mapspath>\SRNEW\MAPS\Default.WMData
  2. MAPS\Default.WMData