Mod Project Setup – Arma Reforger

From Bohemia Interactive Community
Jump to navigation Jump to search
(→‎Project Creation: fixed typo in link)
m (Some wiki formatting)
Line 4: Line 4:
* {{GameCategory|armaR|link= y}} installed
* {{GameCategory|armaR|link= y}} installed
* [[Arma Reforger:Workbench|Workbench]] installed
* [[Arma Reforger:Workbench|Workbench]] installed
== Setting Up Workbench Launcher ==
 
 
== Workbench Launcher Setup ==


Before creating a new project, it is necessary to set Enfusion Workbench Launcher so it knows where Reforger data is located. Reforger data is essential for Workbench to function correctly so its important
Before creating a new project, it is necessary to set Enfusion Workbench Launcher so it knows where Reforger data is located. Reforger data is essential for Workbench to function correctly so its important
Line 50: Line 52:
''Et voilà !'' The project is created and the Workbench [[Arma Reforger:Resource Manager|'''Resource Manager''']] is waiting for input.
''Et voilà !'' The project is created and the Workbench [[Arma Reforger:Resource Manager|'''Resource Manager''']] is waiting for input.


{{Feature|informative|The {{hl|addon.gproj}} file can be renamed to have a more fitting name; the project will then need to be re-added to the Projects list on Workbench opening.}}{{Messagebox|'''Recommended read''':  
{{Feature|informative|The {{hl|addon.gproj}} file can be renamed to have a more fitting name; the project will then need to be re-added to the Projects list on Workbench opening.}}
* [https://community.bistudio.com/wiki/Category:Arma_Reforger/Modding/Official_Tools Tools Documentation] - for general knowledge about using Workbench
{{Messagebox|'''Recommended read''':  
* [https://community.bistudio.com/wiki/Category:Arma_Reforger/Modding/Tutorials/Assets Asset Creation Tutorials- if you intend to create or modify assets, like changing weapon parameters or adding new vehicle
* {{GameCategory|armaR|Modding|Official Tools|text= Tools Documentation}} - for general knowledge about using Workbench
* [https://community.bistudio.com/wiki/Category:Arma_Reforger/Modding/Tutorials/Scripting Scripting Tutorials] - this category contains various pages explaining how to create your first script
* {{GameCategory|armaR|Modding|Tutorials|Assets|text= Asset Creation Tutorials}} - if you intend to create or modify assets, like changing weapon parameters or adding new vehicle
* [https://community.bistudio.com/wiki/Category:Arma_Reforger/Modding/Tutorials/Scenario Scenario Creation Tutorials] - tutorials explaining how to create your first scenario in World Editor
* {{GameCategory|armaR|Modding|Tutorials|Scripting|text= Scripting Tutorials}} - this category contains various pages explaining how to create your first script
* [https://community.bistudio.com/wiki/Category:Arma_Reforger/Modding/Tutorials/Terrains Terrain Tutorials] - tutorials containing information how to create your first terrain|📖|lightgrey}}
* {{GameCategory|armaR|Modding|Tutorials|Scenario|text= Scenario Creation Tutorials}} - tutorials explaining how to create your first scenario in World Editor
* {{GameCategory|armaR|Modding|Tutorials|Terrains|text= Terrain Tutorials}} - tutorials containing information how to create your first terrain
|📖|lightgrey}}
 


== Experimental Branch ==
== Experimental Branch ==
It is also possible to create and publish projects using Experimental Branch of the tools. For more info, head out to [[Arma Reforger:Experimental Branch|'''Experimental Branch''']] page.
It is also possible to create and publish projects using Experimental Branch of the tools. For more info, head out to [[Arma Reforger:Experimental Branch|'''Experimental Branch''']] page.


== Troubleshooting ==
== Troubleshooting ==

Revision as of 14:56, 3 October 2023

Prerequisites


Workbench Launcher Setup

Before creating a new project, it is necessary to set Enfusion Workbench Launcher so it knows where Reforger data is located. Reforger data is essential for Workbench to function correctly so its important

There are two ways how to prepare Workbench for creation of the addon - automatic & manual - which are described below

Automatic Method

By default, every time Arma Reforger (game) is launched, executable will automatically add hidden link to the data ArmaReforger.gproj in Windows Register.

This method is not recommended. Also, the link to game project might be broken if game data is moved in Steam.

Manual Method

  1. Open Enfusion Workbench Launcher
    armareforger modsetup-launcherwindow-reforgernotfound.png
  2. Click "Add Existing" button
  3. Browse to ArmaReforger.gproj (located in <Arma Reforger installation directory>\addons\data\ArmaReforger.gproj) and select it
  4. Arma Reforger project is now listed in the Projects window.
    armareforger modsetup-launcherwindow-reforgerfound.png


Project Creation

  • Start the Workbench either through Steam (Tools > Arma Reforger Tools > START) or by double-clicking ArmaReforgerWorkbenchSteam.exe located in the Workbench installation directory.
    The following screen will appear:
    armareforger modsetup-launcherwindow-reforgerfound.png
    This interface displays existing projects known to Workbench and will later display the current creation; an existing project is openable by selecting it and clicking Open to edit it.
  • Click "Create New" to open the project creation interface
Vanilla Arma Reforger
Modded Arma Reforger
  • Enter the project's name
    • the project's name can only contain letters, numbers, spaces and the following symbols: - (dash) _ (underscore) and . (dot).
  • Confirm or edit the project's location
    Be sure to pick a location where the current Windows user has write permissions (e.g C:\Users\Username\Documents - not C:\Program Files).
    The default project directory's location is %userProfile%\Documents\My Games\ArmaReforgerWorkbench\addons; the default project name (and directory name) is New Enfusion Project - it can only contain letters, numbers, ampersands, spaces, dashes, dots and underscores.
  • Pick the project's dependencies:
    • dependencies are other projects (and/or mods) on which the current project relies to work
    • a project cannot be loaded if a dependency is missing
    • the dependency link is one-way: a dependency does not need the current project in order to be loaded
    • Arma Reforger is a default dependency: an Arma Reforger mod needs Arma Reforger data to run properly
  • Click "OK" to create the project.

Et voilà ! The project is created and the Workbench Resource Manager is waiting for input.

The addon.gproj file can be renamed to have a more fitting name; the project will then need to be re-added to the Projects list on Workbench opening.
📖
Recommended read:


Experimental Branch

It is also possible to create and publish projects using Experimental Branch of the tools. For more info, head out to Experimental Branch page.


Troubleshooting

Arma Reforger project is not found in the Projects window

Be sure to use the adequate Workbench to open the corresponding data. Using default Workbench to open e.g Experimental branch data may result in errors!