Scenario Creation Guide

= Introduction = In Rise of Industry (RoI) Scenarios are pre-made maps with custom objectives and conditions that can be easily shared with other players.

Scenario creation takes advantage of the more general Modding system of RoI. In this guide we will show how to create a new scenario and setup the mod. Once that is done you’ll be able to share it with the community using Steam Workshop or even by just handing it down to your friends.

= Creating a Scenario = Scenario creations happen in game so you’ll need to launch Roi. Once in the Main Menu you’ll have to click on the SCENARIOS box. That will open the scenario editor. In this screen you can set up a lot of different parameters that will drive the generation of the map and the things players have to do and can do.

Let’s see some of the main parameters: Once you are happy with all the parameters just click NEXT. A new map will be generated using all the parameters you specified. You’ll probably notice how you are not allowed to build anything but you can still demolish (trees) and terraform for free. Also in the terraforming menu you have the additional option of planting already grown trees. If you want to start from scratch using the same map click REGENERATE MAP. If you want to leave the game without saving your map you can just access the Main Menu as usual. In case you are happy with your creation you can save it by clicking EXPORT AND SAVE MAP. You’ll be prompted to restart the game, please do so.
 * Name: this is the Name of the Scenario. It’s what other players will see.
 * Description: here you can describe your Scenario. Other players will see this as well.
 * Unique ID: this parameter is very important but you generally don’t need (and want) to change it. Every Scenario loaded in the game has to have a unique ID. If multiple Scenarios have the same ID only one will be visible in the game. We randomly generate an ID every time you enter this screen and you should never need to change it.
 * Objectives: these are the player objectives of the Scenario. They specify what the player has to do in order to win the Scenario. At least 1 objective has to be set up to proceed with map generation. We currently have 2 types of objectives. The first one is called ASSET GENERATION. This objective requires the player to have a minimum total Assets value to win the scenario. The Assets value is given by the cost of every building owned by the player plus his current balance. The other objective type requires the player to have a given amount of a specific product stored in his buildings. You can have multiple objectives selected and to win the scenario the player will have to accomplish them all.
 * And many more! While in game you can hover any of the parameters to see its description on the right side of the screen.

= Testing the Scenario = To test your creation click the SCENARIOS box again in the Main Menu. Now click the LOAD button. You will be presented with the list of all the scenarios you can play. There are 2 categories. DEV CREATED SCENARIOS is for the scenarios that are shipped with RoI and not loaded with a Mod, USER CREATED SCENARIOS are the Scenarios that were created by you or other players (loaded from Mods created by other players). You’ll find your new scenario within the USER CREATED SCENARIOS category. To fire it up just select it and click START A SCENARIO. The game will start as usual and you can play your own scenario normally.

= Creating the Mod = If you are happy with your scenario and you want to share it with the community you will need to create a Mod. That’s very easy. Here you’ll just get the bare minimum info you need but follow this [ link] for a detailed explanation of the process. {
 * 1) Go to the installation folder of RoI. You should see a Mods subfolder.
 * 2) Inside of the Mods folder locate a folder called Exported Scenarios.
 * 3) This folder is a Mod of its own already. This Mod contains all the Scenarios you exported.
 * 4) Duplicate this folder and give it a sensible name. Probably you want to call it like the Scenario you just created.
 * 5) Move this new folder outside of the Mods one, anywhere you like (for example move it to your desktop).
 * 6) Now go inside of it and:
 * 7) Open the desc.json file with any text editor (for example notedpad++)
 * 8) Set author, name and description as you like, set version to 1 (without quotes), versionString to “1.0” (with the quotes) and leave dependencies set to null.
 * 9) Go into the content and assets folder and make sure only the Scenarios you want to export are present in there. Notice how for each Scenario you have two files. The first one is found in the assets folder of the Mod. This is a *.world file that represents the map you exported. The second file is found in the content folder and it’s a JSON file with all the details of the scenario you created. Both files are named by the ID of the Scenario. If you are exporting a single Scenario you should have only one file in each folder.
 * 10) (Optional) If you want to upload this Mod to the Steam Workshop you will need to create a new json file called upload.json (you can use any name, upload.json is just an example) and edit it like in the following example:

"title": "Name of my Mod",

"description": "Description of my Mod",

"visibility": "PUBLIC",

"contentFolder": "path/to/my_mod_folder",

"mainPreview": "path/to/preview_image.png"

}

This file can be located anywhere on your computer but make sure to keep it around because you’ll need it if you want to update your mod. To finally upload your mod you just need to drag the upload.json file on the upload utility *.exe that can be downloaded from [link].