¶ Introduction
Using the Arma Reforger tools, you can:
- Create your own version of Overthrow with different settings and values
- Change the prices
- Create a compatibility mod that makes another mod work with Overthrow, or sets the prices for the mod's items in stores etc
- Add a new faction that is selectable on game start with a different set of gear, soldiers, flags etc
- Add/Remove/Move bases or towns
- Port Overthrow to a different map
- Change the composition of "prefabs" such as roadblocks or buildings
- Add items that can be placed at houses, FOBs and bases
- Add buildings that can be built at bases/FOBs
- Add jobs
- Change almost anything else about your Overthrow experience
You are free to post your own versions, modifications, compatability patches etc to the Arma Reforger Workshop, and we support anyone to do so via our discord. If your modification becomes popular we may request that we include your changes in the base Overthrow, but this is completely at your discretion. We will not do it without asking you.
¶ Questions and guidance
Please use the #reforger-dev channel on discord to ask about customizing Overthrow. Someone there should be able to help you. If your question is about general editing of Arma Reforger or the use of Arma Reforger tools, you may get more response from the ARMA discord: https://discord.gg/J7V4y5xk
¶ Setup
First, install "Arma Reforger Tools" from the tools section of your Steam client. You must own the Steam (PC) version of Arma Reforger, it is not possible to create content on Xbox. Make sure the Overthrow mod is also installed into your game and is up to date before continuing.
¶ Copy Overthrow and its dependancies into your workbench folder
Copy the following folders from your My Documents\My Games\ArmaReforger\addons into My Documents\My Games\ArmaReforgerWorkbench\addons:
- Overthrow_59B657D731E2A11D
- EnfusionDatabaseFramework_5D6EA74A94173EDF
- EnfusionPersistenceFramework_5D6EBC81EB1842EF
- OLDCARSCivilianClothing_5ED8D02E6CBD7D4E
¶ Create a new Workbench Project
- Open the Arma Reforger Tools, in the Enfusion Workbench Launcher click on "Create New"
- Give the Project a name, location and choose "Overthrow" as a dependancy. Use a name that describes what you want to do in case you want to publish it. ie "Overthrow:
Your server name" or "Overthrow: Cheaper guns" etc
¶ Adapting an existing project
Only do this if you already have a workbench project created. If you created one above you dont need to do this. For an existing project you can add Overthrow as a dependancy
- Open Workbench > Settings
- Add
59B657D731E2A11Das a dependancy, this is the ID of the Overthrow mod in Reforger - Restart workbench to load the dependancies
¶ Basic Customization
Most of the values you may want to tweak are located in "config" files and prefabs. These are very easy to customize using the "override" feature of Reforger modding. When your mod is active, it will use your "overridden" versions of the files.
¶ Config/Prefab customization
- Find the config file or prefab you want to override
- Right click it, and choose
Override in <your mod> - Make the changes to your override file
¶ Changing soldier loadouts
If you want to equip the spawned soldiers with specific gear (ie from another mod) then you use the above method to override the soldier prefabs and change their loadout. If the mod comes with it's own soldier/group prefabs you can replace the vanilla ones in the faction configs under Configs\Faction
¶ Creating a new faction
If you want to add a whole new faction to Overthrow that can be selected on game start, its a little more complicated.
- Create a
FactionName.confconfig file or copy an existing one, make it the typeFaction. If you are adding a faction from a mod this file may already exist, and you can just use that in step 4 instead of creating one - Create a
FactionName_OverthrowData.confconfig file or copy an existing one, make it the typeOVT_Faction. Make sure it has the same "faction key" as the above config - Override the
Prefabs/GameMode/OVT_OverthrowFactionManagerprefab in Overthrow - Add both your configs to the faction manager, the "Faction" config goes in the factions section, the "OVT_faction" config goes in the "Overthrow Factions" section
- If you want your faction to be the default occupying faction when your mod is loaded, you can override
Prefabs\GameMode\OVT_OverthrowGameModeand setm_sDefaultOccupyingFactionto the faction key
For an example of a custom faction you can look at https://github.com/ArmaOverthrow/Overthrow.Arma4.RHS
¶ Tweaking other values
Most of the values Overthrow uses are in the "Game Mode" prefab located at Prefabs\GameMode\OVT_OverthrowGameMode. Override this file and change the values in the various "Manager" components on that prefab.
¶ Advanced Customization
¶ Script customization
If you want to customize the code in your Overthrow, you will need to "mod" the scripts.
- Find the script you want to change
- Create the same folder structure in your mod, add a "Modded" folder within that folder and put a script there with the same name
- Use
modded classat the top of your script and the same name for the class - Override the methods you need to and alter their functionality
See the BI wiki for more information on modding classes: https://community.bistudio.com/wiki/Arma_Reforger:Scripting_Modding
¶ Map Customization
If you want to change the map, add/remove/move bases/towns etc. You will need to create your own "world" that inherits an existing official Overthrow world
- In the Workbench, navigate to
Overthrow/Worlds/MP/OVT_Campaign_<Map>.entand double click it (The default Reforger map is "Eden") - In the world editor that opens, click on File > New World
- Choose "Sub-scene (of current world)"
- Go File > Save World As
- Put the new world into a folder within your project, you should see a folder (ie "MyOverthrow" or whatever you called your project)
You now have your own version of the mission that inherits from Overthrow. If we make any changes to the base world they will be reflected in your version as well. You can now add bases or change the map however you want in your sub-world.
¶ Creating your own mission
If you have created a sub-world, you will need to make your world an option from inside the actual game so you can play it outside of the Workbench. To this you create a mission config:
- Click on your mod folder, or create a "Missions" folder if you want to
- In the workbench, bottom left, click Create > Config File
- Use the name
24_OVT_<Map Name>_<Your mod name> - Choose "SCR_MissionHeader" as the base
- At the top, select your world
- Enter the other details ie name, add images if you want (see Reforger docs)
You should be able to now see your mission as an option when you open your game and make sure your workbench mod is loaded. If you want to use it on a server or in multiplayer you will need to "Publish" your mod to the Reforger workbench.
¶ Creating a new world from scratch
¶ Third-Party maps
Note: this section is very incomplete. You need to do a lot more to get Overthrow working on a new map. If you know your way around Reforger Tools then you can take a look at how the default Overthrow map is configured to try and work it out. This section will be completed later.
If you are a map creator who wants to make Overthrow work with your map, we recommend that you do NOT add Overthrow as a dependancy of your map project. Your map should be released with minimal dependancies and you instead create a separate mod called Overthrow: Your Map Name which sets both your map and Overthrow as dependancies. Release both separately and link to the Overthrow mission in your map's description if you like.
If you just want to make Overthrow work on your favourite third party map, that's also possible.
¶ Set-up
- Load the map world you want to add Overthrow to
- Click on File > New World
- Choose "Sub-scene (of current world)"
- Go File > Save World As
- Use the name
OVT_Campaign_<Map Name> - Click on the "Resource Browser" tab at bottom of world editor
- Navigate to
/Overthrow/Prefabs/GameMode - Drag in the
OVT_OverthrowGameModeandOVT_FactionManagerprefabs - Search the Resource Browser and add the following prefabs from the base Reforger install if they don't already exist on your map:
- PerceptionManager
- PreloadManager
- RadioManager
- SCR_CameraManager
- SCR_AIWorld
- ScriptedChatEntity
- LoadoutManager_Base
¶ Configuration
- Click on the SCR_CameraManager and set the options down the bottom "Default view position" and "Default view angles" to choose a beautiful camera position to show before the game starts
- Click on the LoadoutManager_Base and choose a default player loadout (only the FIA faction is needed, other factions may or may not work) or choose the loadout provided with Overthrow
- Change any other settings you want to on OVT_OverthrowGameMode and change the available factions if you need in OVT_FactionManager
- Do all the other stuff that isnt documented here yet (sorry)