Mod Project Setup – Arma Reforger

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
No edit summary
Line 12: Line 12:
There are two ways how to prepare Workbench for creation of the addon - automatic & manual - which are described below
There are two ways how to prepare Workbench for creation of the addon - automatic & manual - which are described below


=== Automatic Method ===
=== Preparing Data ===


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


{{Feature|important|This method is not recommended. Also, the link to game project might be broken if game data is moved in Steam.}}
It might happen though, that automatic detection is not working (f.e. installation dir was moved) and because of that, '''it is recommended to manually add ArmaReforger.gproj''' to Project list


=== Manual Method ===
==== Adding Arma Reforger Project ====


# Open Enfusion Workbench Launcher<br>[[File:armareforger_modsetup-launcherwindow-reforgernotfound.png]]
# Start the Workbench either through Steam ({{hl|Tools > Arma Reforger Tools > START}}) or by double-clicking '''ArmaReforgerWorkbenchSteam.exe''' located in the Workbench installation directory.<br>The following screen will appear:<br>[[File:armareforger_modsetup-launcherwindow-reforgernotfound.png]]
# Click "Add Existing" button
# Click "Add Existing" button
# Browse to {{hl|ArmaReforger.gproj}} (located in {{hl|&lt;{{armaR}} installation directory&gt;\addons\data\ArmaReforger.gproj}}) and select it
# Browse to {{hl|ArmaReforger.gproj}} (located in {{hl|&lt;{{armaR}} installation directory&gt;\addons\data\ArmaReforger.gproj}}) and select it
#{{armaR}} project is now listed in the Projects window.<br>[[File:armareforger_modsetup-launcherwindow-reforgerfound.png]]
#{{armaR}} project is now listed in the Projects window.<br>[[File:armareforger_modsetup-launcherwindow-reforgerfound.png]]


==== Adding Other Existing Projects ====
Other projects, like dependencies, can be added one by one via '''Add Existing Project''' as described above or by using '''Scan for Projects''' button. {{Feature|informative|'''Scan for Projects''' is part of 1.0.0 version of the game}}


* Click on '''+ Add Project''' button
* Select '''Scan for Projects''' from the list
* Select folder where you have addons located, which you want to use as dependencies
* Confirm selection
Now you can either try to launch one of those mods or use them as dependencies
{{Feature|informative|Projects list is stored in user profile. You can use different profile via [[Arma_Reforger:Startup_Parameters#profile|-profile]] command line parameter, allowing you to have '''set of mods''' for various occasions or for '''different version of game'''.}}
== Project Creation ==
== Project Creation ==


* Start the Workbench either through Steam ({{hl|Tools > Arma Reforger Tools > START}}) or by double-clicking '''ArmaReforgerWorkbenchSteam.exe''' located in the Workbench installation directory.<br>The following screen will appear:<br><!--
* Open Enfusion Workbench Launcher if you don't have it already open.<br><!-- -->[[File:armareforger_modsetup-launcherwindow-reforgerfound.png]]<br><!-- -->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.
-->[[File:armareforger_modsetup-launcherwindow-reforgerfound.png]]<br><!--
-->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
* Click "'''Create New'''" to open the project creation interface
{|
{|
Line 65: Line 73:


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 19:13, 23 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

Preparing Data

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

It might happen though, that automatic detection is not working (f.e. installation dir was moved) and because of that, it is recommended to manually add ArmaReforger.gproj to Project list

Adding Arma Reforger Project

  1. 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-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

Adding Other Existing Projects

Other projects, like dependencies, can be added one by one via Add Existing Project as described above or by using Scan for Projects button.

Scan for Projects is part of 1.0.0 version of the game
  • Click on + Add Project button
  • Select Scan for Projects from the list
  • Select folder where you have addons located, which you want to use as dependencies
  • Confirm selection

Now you can either try to launch one of those mods or use them as dependencies

Projects list is stored in user profile. You can use different profile via -profile command line parameter, allowing you to have set of mods for various occasions or for different version of game.

Project Creation

  • Open Enfusion Workbench Launcher if you don't have it already open.
    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!