Scenario Creator

From Supreme Ruler Wiki
Jump to: navigation, search

Contents

Setup[edit | edit source]


Options[edit | edit source]

When the application starts the first thing to do is set the options. Options are persistent and will be remembered every time the application launches. Below is a list of options and what they do.

Change Working Directory[edit | edit source]

Setting the game directory will allow the application to know which directory your Supreme Ruler game install is located. This is used to import/export files into the correct sub-folders, as well as compiling the list of auto-completes.

Manage Directories...[edit | edit source]

Selecting "Manage Directories..." will open a pop up window allowing you to set custom game install locations, and add them to the list of possible working directories.

Export Scenario To[edit | edit source]

Setting this option will tell the application which sub-folders you would like to export the .SCENARIO file into. The available choices are "Custom Scenario", "Sandbox", and "Multiplayer". As each of the options are enabled a check mark will appear to the left to indicate the folder is selected for export.

Clear Current Panel[edit | edit source]

Selecting this option will clear all information from the current panel, wiping away all data that has been entered. This will not effect any fields not currently visible.

Open Working Directory[edit | edit source]

Selecting this option will open up the current working directory in the operating systems file explorer. This will allow you to see what directory you are currently exporting to.

Launch Map Editor[edit | edit source]

Selecting this option will launch the Map Editor, from your current working directory.

Launch Game[edit | edit source]

Selecting this option will launch the game, from your current working directory.


Help[edit | edit source]

Show Starting Help[edit | edit source]

Selecting this option toggle the "Help" page from showing on application startup, if not currently enabled it will bring you to the "Help" page.

Documentation[edit | edit source]

Selecting this option will bring you to this GamePedia page.


Editable File Types[edit | edit source]

CVP[edit | edit source]

  • This file contains all the information that makes each region unique.

REGIONINCL[edit | edit source]

  • This file contains all the region id numbers that are included in the scenario.

WMDATA[edit | edit source]

  • This file contains all the world economy, resource, and other misc data.

OOB[edit | edit source]

  • This file contains all the military units owned by each region.



Screens[edit | edit source]


Help[edit | edit source]

Help.png Discord[edit | edit source]

  • The #modding channel on the BattleGoat Discord server can be used to ask questions about the ScenarioCreator

Steam Forums[edit | edit source]

BGForums[edit | edit source]

  • BattleGoat Studios has it's own web forum which can be used to ask questions about the Scenario Creator.

Do Not Show Again[edit | edit source]

Selecting this option will disable the "Help" screen from showing on application startup. This can be enabled again by the "Options" file menu, and selecting "Show Starting Help".

Scenario[edit | edit source]

Scenario Information.png

Scenario Information[edit | edit source]

Scenario Name[edit | edit source]
  • This is the name given to the scenario, it can be anything you like.
  • Selecting an option from the drop down menu will import that scenario and all included files.
Cache Name[edit | edit source]
  • This is the name of the file used for caching the scenario, it should end in .SAV
  • The checkbox beside this field "Same As Scenario Name" will auto fill in this field using the given scenario name.
  • You can select from an existing cache file by using the drop down menu.
  • See also Creating a Cache



Data Files[edit | edit source]

These data files are not editable using the Scenario Creator, but can be edited using the Asset Manager.

It is recommended to use the default files if you are not sure what they do.

Selecting the "#" button to the right of the file name will open that file using the Asset Manager, allowing you to modify and save the file.

UNIT[edit | edit source]
  • This is the Equipment List file, it contains all the data relating to individual units and facilities.
  • The name of the file you would like to use goes in this field, and should be located in the MAPS/DATA/ directory of your game install
  • The default file name is "DEFAULT.UNIT"
PPLX[edit | edit source]
  • This is the People List file, it contains all the data relating to Leaders and Cabinet Ministers.
  • The name of the file you would like to use goes in this field, and should be located in the MAPS/DATA/ directory of your game install
  • The default file name is "DEFAULT.PPLX"
  • See also Mod Cabinet Ministers
TTRX[edit | edit source]
  • This is the Technology Tree file, it contains all the data relating to technology and tech effects.
  • The name of the file you would like to use goes in this field, and should be located in the MAPS/DATA/ directory of your game install.
  • The default file name is "DEFAULT.TTRX".
TERX[edit | edit source]
  • This is the Terrain file, it contains all the data relating to terrain types.
  • The name of the file you would like to use goes in this field, and should be located in the MAPS/DATA/ directory of your game install.
  • The default file name is "DEFAULT.TERX".
NEWSITEMS[edit | edit source]
  • This is the Newsitems file, it contains all the data relating to in-game messages and alerts.
  • The name of the file you would like to use goes in this field, and should be located in the MAPS/DATA/ directory of your game install.
  • The default file name is "DEFAULT.NEWSITEMS".
PROFILE[edit | edit source]
  • This is the Profiles file, it contains references to the various files needed for procedural generation of maps.
    • Region Profile
    • Planet Profile
    • Name Set
  • The name of the file you would like to use goes in this field, and should be located in the MAPS/DATA/ directory of your game install.
  • The default file name is "DEFAULT.PRF".



Map Files[edit | edit source]

These files are not editable using the Scenario Creator, but can be edited using the Map Editor.

The map editor can be launched by selecting the Options file menu item "Launch Map Editor", or by selecting the checkbox "Launch Map Editor After Creation" which will launch the map editor after scenario is exported.

MAPX[edit | edit source]
  • This is the Map file, it contains all the data relating to hex data (ownership, loyalty, terrain, etc..).
OOF[edit | edit source]
  • This is the Facility file, it contains all the data relating to on map upgrades and facilities.
See also: Map Editor[edit | edit source]



Editable Data Files[edit | edit source]

CVP[edit | edit source]
  • This is the Country Variables / Player file, it contains all the data relating to regional data.
  • The name of the file you would like to use goes in this field, and should be located in the MAPS/ directory of your game install.
  • There is no default file for this field.
  • Selecting the "Modify" checkbox beside this field will add the "Theatres" and "Regions" pages to the application, and allow you to modify the data on each respective page.
    • It will also export a new CVP file using the name inside the text field, located in the MAPS/ directory.
WMDATA:[edit | edit source]
  • This is the World Market Data file, it contains all the data relating to the world market and commodity information.
  • The name of the file you would like to use goes in this field, and should be located in the MAPS/DATA/ directory of your game install.
  • The default file name is "DEFAULT.WMDATA".
  • Selecting the "Modify" checkbox beside this field will add the "Resources" and "World Market" pages to the application, and allow you to modify the data on each respective page.
    • It will also export a new WMDATA file using the name inside the text field, located in the MAPS/ directory.
OOB:[edit | edit source]
  • This is the Orbat file, it contains all the data relating to military units owned by regions in the scenario.
  • The name of the file you would like to use goes in this field, and should be located in the MAPS/ORBATS/ directory of your game install.
  • There is no default file for this field.
  • Selecting the "Modify" checkbox beside this field will add the "Orbat" page to the application, and allow you to modify the data on that page.
    • It will also export a new OOB file using the name inside the text field, located in the MAPS/ORBATS/ directory.
Pre-Cache:[edit | edit source]
  • This is an extra file that is added to the scenario and "baked" into the cache file. It will not be applied to the scenario unless it is re-cached.
    • Only a single pre-cache file is supported at this time.
  • See also Creating a Cache
Post-Cache:[edit | edit source]
  • This is an extra file that is added to the scenario and loaded each time the scenario is started. It does not require the scenario to be re-cached.
    • Only a single post-cache file is supported at this time.
  • See also Creating a Cache



Settings[edit | edit source]

Scenario Settings.png

Starting Date[edit | edit source]

Starting Date[edit | edit source]
  • This is the date the scenario will begin on, before any fast forwarding (if any) .
Fast Forward[edit | edit source]
  • Selecting this option tells the scenario to move forward in time once the scenario starts, once selected it will show a new input, labeled "Days".
Days[edit | edit source]
  • This option in only visible if "Fast Forward" is selected, it is the number of days to jump forward from "Starting Date"

Difficulty[edit | edit source]

Military Difficulty[edit | edit source]
Economic Difficulty[edit | edit source]
Diplomatic Difficulty[edit | edit source]

Victory Conditions[edit | edit source]

Game Length[edit | edit source]
Victory[edit | edit source]

Starting Conditions[edit | edit source]

Resources[edit | edit source]
Funds[edit | edit source]

AI Settings[edit | edit source]

AI Stance[edit | edit source]
Nuke Effect[edit | edit source]
Approval[edit | edit source]

Graphics Options[edit | edit source]

GUI Level[edit | edit source]
Map Splash[edit | edit source]

Scenario Options[edit | edit source]

Fixed Capitals[edit | edit source]
No Loyalty Penalty[edit | edit source]
Critical UN[edit | edit source]
Missile Limit[edit | edit source]
Allow Nukes[edit | edit source]
Reserve Limit[edit | edit source]
Allied Victory[edit | edit source]
Group Loyalty Merge[edit | edit source]
No Debt[edit | edit source]
Group Research Merge[edit | edit source]
Limit DAR Effect[edit | edit source]
Limit MAR Effect[edit | edit source]
Limit Regions In Scenario[edit | edit source]



Theatres[edit | edit source]

Theatres.png

Do Not Include Theatres[edit | edit source]

ID[edit | edit source]

Theatre Name[edit | edit source]

Theatre Code[edit | edit source]

Culture[edit | edit source]

Theatre Transfer[edit | edit source]

X Location[edit | edit source]

Y Location[edit | edit source]



Regions[edit | edit source]

Regions.png

Create New Region[edit | edit source]

Merge From CVP[edit | edit source]



Create New Region[edit | edit source]

Create Region.png

Region Identification[edit | edit source]

ID[edit | edit source]
Region Name[edit | edit source]
Prefix[edit | edit source]

Region Codes[edit | edit source]

World Availability[edit | edit source]
Arms Availability[edit | edit source]

Economy[edit | edit source]

GDPC[edit | edit source]
Debt[edit | edit source]
Treasury[edit | edit source]

Customization[edit | edit source]

Region Number[edit | edit source]
Flag Number[edit | edit source]
Music Number[edit | edit source]

Government[edit | edit source]

Government Type[edit | edit source]
Political Leaning[edit | edit source]

Population[edit | edit source]

Population[edit | edit source]
Army Population[edit | edit source]
Reserve Population[edit | edit source]

Merge From CVP[edit | edit source]

Merge CVP.png

Block[edit | edit source]

Name[edit | edit source]

Include Groups[edit | edit source]

Region Data[edit | edit source]

  • Same as the CVP data found on the "Regions" screen.

Colony[edit | edit source]

Include Parent[edit | edit source]
Remove Parent[edit | edit source]
Do Nothing[edit | edit source]

Grouping[edit | edit source]

Include Children[edit | edit source]
Remove Children[edit | edit source]
Do Nothing[edit | edit source]

Merge[edit | edit source]



Resources[edit | edit source]

Resources Screen.png

Resources[edit | edit source]

Cost[edit | edit source]

Base Cost[edit | edit source]
Full Cost[edit | edit source]
Margin[edit | edit source]

Production[edit | edit source]

Node Production[edit | edit source]
Max Production Per Person[edit | edit source]
Min Production Per Person[edit | edit source]
City Production[edit | edit source]

Produced From[edit | edit source]



World Market[edit | edit source]

World Market.png

Settings[edit | edit source]

Level[edit | edit source]
Duration[edit | edit source]
Base GDPC[edit | edit source]
Prime Rate[edit | edit source]
Social Adjustment[edit | edit source]
World Market Rate[edit | edit source]

Weather[edit | edit source]

Days[edit | edit source]
Weather Offset[edit | edit source]
Weather Speed[edit | edit source]

Military[edit | edit source]

Garrison Progression[edit | edit source]
Battalion Size[edit | edit source]

Economic[edit | edit source]

On Hex Resource Multipliers[edit | edit source]
Social Spending Defaults[edit | edit source]



Orbat[edit | edit source]

Orbats.png

Selected Region[edit | edit source]

ID[edit | edit source]
Name[edit | edit source]
Units[edit | edit source]

Options[edit | edit source]

Branch[edit | edit source]
Class[edit | edit source]
Show Known Designs[edit | edit source]
Show Regional Units[edit | edit source]
Add To All Regions[edit | edit source]
Add By[edit | edit source]

Unit List[edit | edit source]

ID[edit | edit source]
Name[edit | edit source]
Units[edit | edit source]

[edit | edit source]