COALITION Wiki Difference between revisions of "Reforger Mission Making"

Difference between revisions of "Reforger Mission Making"

From COALITION Wiki
(add picture)
m
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''[WORK IN PROGRESS]'''
'''<big>[WORK IN PROGRESS]</big>'''
= Mission Making =


The purpose of this page is to show how to develop a mission in ArmA Reforger.  
The purpose of this page is to show how to develop a mission in ArmA Reforger.  


It will include:
The Coalition Reforger Framework (CRF) is a tool, made by Coalition, to help with mission making (called situations in-game) by providing presets and other assets including game modes, briefings, unit groups and more to help streamline the mission making process. It is also used in-game to load the missions on the fly. By the end of this page, you should be able to fully create a mission in the Arma Reforger Tools and, through pull requests, have it played at CFC!


* How to set up a symlink for the addons.
To see how the other tools in the Workbench work, check the biki (BI Wiki) [https://community.bistudio.com/wiki/Category:Arma_Reforger/Modding/Official_Tools here].
*How to setup GitHub Desktop and clone the Coalition Reforger Framework repository.
* How to open a world file.
* How to create a sub-scene which will allow for editing.
* How to place AIWorld and Lobby_CRF_Mode.
* How to create layers.
* How to place units and vehicles.


And more! By the end of this page, you should be able to fully create a mission in the Arma Reforger Tools and, through pull requests, have it played at CFC!
If you ever need any help, you can ask in the #development channel in the discord, linked [https://discord.com/channels/237991125523103747/468879945293234177 here].


To see how the other tools in the Workbench work, check the biki (BI Wiki) [https://community.bistudio.com/wiki/Category:Arma_Reforger/Modding/Official_Tools here]
== Prerequisites: ==
 
# Download git here: https://git-scm.com/downloads
# follow this guide first: https://docs.github.com/en/get-started/getting-started-with-git/setting-your-username-in-git
# then follow this guide: https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address
 
This is so you can use command prompt in github desktop as seen later in this guide.
 
Arma Reforger Tools: https://store.steampowered.com/app/1874910/Arma_Reforger_Tools/  
 
You can also find it in your library by searching for it. (see below)[[File:Armareforgertoolspageonsteam.png|frameless|663x663px]]


== How to setup the ArmA Reforger Tools folder: ==
== How to setup the ArmA Reforger Tools folder: ==
Step 1:
'''Alert''': Steps 2, 3 and 4 do not work if you are using OneDrive as your primary Documents Folder. You will have to manually move your addons every time.
 
<big>'''''<u>Step 1</u>:'''''</big>


Open ArmA Reforger (the game, not the tools) and download the server mods.
Open ArmA Reforger (the game, not the tools) and download the server mods.


Step 2:
'''<big>''<u>Step 2</u>:''</big>'''


Open "Command Prompt" (in administrator).
Open "Command Prompt" (in administrator).


Step 3:
'''''<u><big>Step 3</big></u><big>:</big>'''''


type:  
type:  
  mklink /D "USERNAME\Documents\My Games\ArmaReforgerWorkbench\addons" "USERNAME\Documents\My Games\ArmaReforger\addons"
  mklink /D "USERNAME\Documents\My Games\ArmaReforgerWorkbench\addons\" "USERNAME\Documents\My Games\ArmaReforger\addons"
  pause
  pause
'''IMPORTANT! do not have an "addons" folder in your workbench folder else this will not work.'''
'''<big>IMPORTANT!</big> do not have an "addons" folder in your workbench folder else this will not work.'''


Step 4:
'''<big><u>''Step 4''</u>'':''</big>'''


If it doesn't error out, check it has completed by going back to "Documents\My Games\ArmaReforgerWorkbench\", you can tell if it has done it correctly as it will look like the following image.[[File:Addons folder.png|frameless]]
If it doesn't error out, check it has completed by going back to "Documents\My Games\ArmaReforgerWorkbench\", you can tell if it has done it correctly as it will look like the following images.


Step 5:
''<u>Windows 10</u>''':'''''[[File:Addons folder.png|frameless]]''<u>Windows 11</u>''':'''''[[File:Addons11.png|frameless]]
 
'''''<big><u>Step 5</u>:</big>'''''


In the "Documents\My Games\ArmaReforgerWorkbench\" folder, create a folder called "Projects".
In the "Documents\My Games\ArmaReforgerWorkbench\" folder, create a folder called "Projects".
Line 43: Line 52:
'''This section is now complete, and you are ready to begin making missions!'''
'''This section is now complete, and you are ready to begin making missions!'''


== How to download and setup GitHub Desktop and the CRF and create a branch: ==
== Download and Setup GitHub Desktop and CRF: ==
Step 1:
'''<big>''<u>Step 1</u>:''</big>'''


Go to https://desktop.github.com/ and download GitHub Desktop, follow the instructions when installing and, when it is finished, open it.
Go to https://desktop.github.com/ and download GitHub Desktop, follow the instructions when installing and, when it is finished, open it.


Step 2:
'''''<u><big>Step 2</big></u><big>:</big>'''''


When you have GitHub Desktop open, click on "file" (top right), then "Clone Repository". Then in the popup box that appears, click URL, copy and paste the following link:
When you have GitHub Desktop open, click on "file" (top right), then "Clone Repository". Then in the popup box that appears, click URL, copy the following link:


https://github.com/CoalitionArma/Coalition-Reforger-Framework
https://github.com/CoalitionArma/Coalition-Reforger-Framework


Into the URL bar and ensure the local path is the "Documents\My Games\ArmaReforgerWorkbench\Projects\" path you set up earlier.
Paste it into the URL bar and ensure the local path is the "Documents\My Games\ArmaReforgerWorkbench\Projects\" path you set up earlier.


When complete, it should look like this:[[File:Crf in folder.png|frameless|546x546px]]
When complete, it should look like this:[[File:Crf in folder.png|frameless|546x546px]]


Step 3:
'''<big>''<u>Step 3</u>:''</big>'''


When thats done, you should have a screen like this:[[File:Github desktop.png|frameless|947x947px]]
When that is done, you should have a screen like this:[[File:Github desktop.png|frameless|947x947px]]
[[File:Branch list.png|left|frameless|516x516px]]
[[File:Branch list.png|left|frameless|516x516px]]
'''IMPORTANT! Ensure the selected branch is "release".'''
'''<big>IMPORTANT!</big> Ensure the selected branch is <big>"release"</big>.'''


Click on "current branch", then "New Branch", then name the branch "mission/<missionname>". Then you should be redirected to a screen where the following is displayed:[[File:Github desktop 2.png|frameless|652x652px]]
Click on "current branch", then "New Branch", then name the branch "mission/<missionname>". Then you should be redirected to a screen where the following is displayed:[[File:Github desktop 2.png|frameless|652x652px]]


This is where we are done with GitHub Desktop for now.
This is where we are done with GitHub Desktop for now. However, if there is ever a commit to the release branch (check [https://github.com/CoalitionArma/Coalition-Reforger-Framework here] or in the development channel in the discord), go to your branch and:
 
'''Option 1''': click on the Repository button (top right, near file), click open in command prompt and type:
git pull origin release
'''Option 2:''' Click on the Branch button and click "Update from release".
 
These methods are interchangeable. This will update your branch to the most up-to-date version of the CRF.


== Opening the Tools, the CRF and laying out the foundation for mission making: ==
== The Tools, the CRF and Mission Making: ==
[[File:Landing page for tools.png|thumb|358x358px]]
[[File:Landing page for tools.png|thumb|453x453px]]
Step 1:


<big>''<u>'''Step 1'''</u>''':'''''</big>
Open Steam, go to search and type in "arma reforger tools". Then click on the tools and open them.  
Open Steam, go to search and type in "arma reforger tools". Then click on the tools and open them.  


Step 2:
<big>''<u>'''Step 2'''</u>''':'''''</big>
You will see the "Enfusion Workbench Launcher" window, you can either click on the project called "COALITION Framework" and then click open, or double click on the project, both methods will open the project in the workbench proper.


You will see the "Enfusion Workbench Launcher" window, you can either click on the project called "COALITION Framework" and then click open, or double click on the project, both methods will open the project in the workbench proper.  
<big>''<u>'''Step 2a'''</u>''':'''''</big>
If you don't have "COALITION Framework" as an option, click the "Add Project" button, then click "Add Existing Project" and navigate to your projects folder, select the "Coalition-Reforger-Framework" Folder then click on "addon.gproj" and it will import it into the Enfusion Workbench Launcher. Then follow Step 2 again.  
[[File:Resourcebrowser1.png|left|thumb|559x559px]]
[[File:Resourcebrowser1.png|left|thumb|559x559px]]
Step 3:


Ignoring the majority of what is displayed, go to the "Resource Browser" on the right, click on the "ArmaReforger" folder (either by clicking directly on it or on the arrow to it's left), then click on the "worlds" folder.
''<u><big>'''Step 3'''</big></u>'''<big>:</big>'''''
 
Ignoring the majority of what is displayed, go to the "Resource Browser" on the left, click on the "ArmaReforger" folder (either by clicking directly on it or on the arrow to it's left), then click on the "worlds" folder.
Step 3a:


''<u>Step 3a</u>''':'''''
For Everon, click on the "Eden" folder, then "Eden.ent" file in the bottom box (the first file with the globe, "EmptyEden.ent" is just an empty version of Everon and not worth using.)
For Everon, click on the "Eden" folder, then "Eden.ent" file in the bottom box (the first file with the globe, "EmptyEden.ent" is just an empty version of Everon and not worth using.)


Step 3b:
''<u>Step 3b</u>''':'''''
 
For Arland, click on the "Arland" folder, then on "Arland.ent" file in the bottom box.
For Arland, click on the "Arland" folder, then on "Arland.ent" file in the bottom box.


Step 3c:
''<u>Step 3c</u>:''
For other world files added by mods, either click through their respective folders until you find their .ent file or search for the file by typing the map name with no spaces and .ent at the end in the search box at the top. (For example: "WorthyIslands.ent")


For other world files, either click through their respective folders until you find their .ent file or search for the file by typing the map name with no spaces and .ent at the end in the search box at the top. (For example: "WorthyIslands.ent")
'''<big><u>''Step 4:''</u></big>'''
 
Step 4:
[[File:Createnewworld.png|thumb]]
[[File:Createnewworld.png|thumb]]
After it has loaded up, click the page icon in the top right labeled "Create New World", it should open a box with 2 options, "Base Scene" and "Sub-Scene (of current world)". Click "Sub-Scene" and that will load again as it creates the sub-scene.
After it has loaded up, click the page icon in the top right labeled "Create New World", it should open a box with 2 options, "Base Scene" and "Sub-Scene (of current world)". Click "Sub-Scene" and that will load again as it creates the sub-scene.


Step 5:
'''''<big><u>Step 5</u>:</big>'''''
After creating the sub scene, right click on the "default" layer (in the hierarchy, it has a yellow, blue and red icon) and click rename, rename it to "aainit" and press OK.
 
'''<big>''<u>Step 6</u>:''</big>'''
in the Resource Browser at the bottom, scroll to the "COALITIONFramework" folder, expand it (click the blue arrow), then expand "Prefabs", expand "MP", expand "Modes", then and click Lobby to open it in the right panel of the Resource Browser. Click and hold on the file called "CRF_Lobby.et" and drag it into the game frame in the center.[[File:CRF Lobby.png|frameless|786x786px]]
 
'''<big>''<u>Step 7</u>:''</big>'''
Go to the search bar at the top and type in "AIWorld", click on the "ArmaReforger" folder and it will open on the right panel, drag in the AIWorld for the map you are using. Eden/Everon and Arland have their own AIWorlds provided by BI. Other terrains, like Barzan may have their own in their folder (BarzanRemake, for example). If it does not have it's own AIWorld in it's own folder, use the default AIWorld (no world name at the end) as this is a basic prefab and will be fine for the mission you are making.[[File:Aiworldsearch.png|frameless|819x819px]]
 
<big>''<u>'''Step 8'''</u>''':'''''</big>
Save your mission as the mission name you have defined in your branch in GitHub Desktop. (for example if your github desktop branch name is "Mission1", then name the world file "Mission1".) This allows us to easily identify what mission has been made for QA testing.-
 
'''<big>''<u>Step 9</u>:''</big>'''
Right click on the hierarchy entry named after the mission and click "Create Layer".[[File:LayersNEW.png|thumb]]
Add layers for:
 
* Area markers
*BLUFOR
*BLUFOR Vehicles
*BLUFOR Markers
*OPFOR
*OPFOR Vehicles
*OPFOR Markers
*Fortifications
*Objectives
*Markers (if needed, not in the example.)
The included example on the right is from a completed mission but layers may vary between mission types.


After creating the sub scene, right click on the "default" layer (in the hierarchy, it has a yellow, blue and red icon) and click rename, rename it to "init" and press OK.
Save your changes and then follow the next steps.


Step 6:
==Next Steps:==
Congratulations! You have the basics of making a mission down.
Please check out the [[Extra Mission Making Information]] as this contains important information at the top of the page and is recommended to setup before you check out the final steps otherwise you will have to do it later.


in the Resource Browser at the bottom, scroll to the "COALITIONFramework" folder, expand it (click the blue arrow), then expand "Prefabs", expand "MP", expand "Modes" and click Lobby to open it in the right panel of the Resource Browser. Click and hold on the file called "Lobby_CRF_Mode.et" and drag it into the game frame in the centre.[[File:Lobbycrfmode.png|frameless|813x813px]]
The following guides will walk you through each mission type:
*[[Breakthrough]]
*[[Search & Destroy]]
*[[Cache Hunt]]
*[[Uplink]]
*[[High-Value Target]]


Step 7:
The link [[Final Steps|here]] will take you to the final part of the guide, explaining how to create a pull request and have your mission QA'd before being added to the CRF!


Go to the search bar at the top and type in "AIWorld", click on the "ArmaReforger" folder and it will open on the right panel, drag in the AIWorld for the map you are using. Eden/Everon and Arland have their own AIWorlds provided by BI. Barzan has it's own in the "BarzanRemake" folder. If it does not have it's own AIWorld in it's own folder, use the default AIWorld (no world name at the end) as this is a basic prefab and will be fine for the mission you are making.[[File:Aiworldsearch.png|frameless|819x819px]]
If you want to see some of the more intricate parts of mission making, check out the Advanced Mission Making guide [[Advanced Mission Making|here]]


Step 8:
There is more than just entities and mission configs to making a CRF mission, for more, check out the pages below.


Save your mission as the mission name you have defined in your branch in GitHub Desktop. (for example if your github desktop branch name is "Mission1", then name the world file "Mission1".)
*[[Images]]
*[[Editing Entities]]
*[[Setting up Peer Tool]]
*[[Setting up Dedicated Server Tool]]
*[[Quality Assurance Guide]]
*[[Safe and Risky Compositions]]
*[[Gamezone Framework and Forward Deploy]]

Latest revision as of 23:14, 7 January 2025

[WORK IN PROGRESS]

Mission Making

The purpose of this page is to show how to develop a mission in ArmA Reforger.

The Coalition Reforger Framework (CRF) is a tool, made by Coalition, to help with mission making (called situations in-game) by providing presets and other assets including game modes, briefings, unit groups and more to help streamline the mission making process. It is also used in-game to load the missions on the fly. By the end of this page, you should be able to fully create a mission in the Arma Reforger Tools and, through pull requests, have it played at CFC!

To see how the other tools in the Workbench work, check the biki (BI Wiki) here.

If you ever need any help, you can ask in the #development channel in the discord, linked here.

Prerequisites:

  1. Download git here: https://git-scm.com/downloads
  2. follow this guide first: https://docs.github.com/en/get-started/getting-started-with-git/setting-your-username-in-git
  3. then follow this guide: https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address

This is so you can use command prompt in github desktop as seen later in this guide.

Arma Reforger Tools: https://store.steampowered.com/app/1874910/Arma_Reforger_Tools/

You can also find it in your library by searching for it. (see below)Armareforgertoolspageonsteam.png

How to setup the ArmA Reforger Tools folder:

Alert: Steps 2, 3 and 4 do not work if you are using OneDrive as your primary Documents Folder. You will have to manually move your addons every time.

Step 1:

Open ArmA Reforger (the game, not the tools) and download the server mods.

Step 2:

Open "Command Prompt" (in administrator).

Step 3:

type:

mklink /D "USERNAME\Documents\My Games\ArmaReforgerWorkbench\addons\" "USERNAME\Documents\My Games\ArmaReforger\addons"
pause

IMPORTANT! do not have an "addons" folder in your workbench folder else this will not work.

Step 4:

If it doesn't error out, check it has completed by going back to "Documents\My Games\ArmaReforgerWorkbench\", you can tell if it has done it correctly as it will look like the following images.

Windows 10:Addons folder.pngWindows 11:Addons11.png

Step 5:

In the "Documents\My Games\ArmaReforgerWorkbench\" folder, create a folder called "Projects".

This section is now complete, and you are ready to begin making missions!

Download and Setup GitHub Desktop and CRF:

Step 1:

Go to https://desktop.github.com/ and download GitHub Desktop, follow the instructions when installing and, when it is finished, open it.

Step 2:

When you have GitHub Desktop open, click on "file" (top right), then "Clone Repository". Then in the popup box that appears, click URL, copy the following link:

https://github.com/CoalitionArma/Coalition-Reforger-Framework

Paste it into the URL bar and ensure the local path is the "Documents\My Games\ArmaReforgerWorkbench\Projects\" path you set up earlier.

When complete, it should look like this:Crf in folder.png

Step 3:

When that is done, you should have a screen like this:Github desktop.png

Branch list.png

IMPORTANT! Ensure the selected branch is "release".

Click on "current branch", then "New Branch", then name the branch "mission/<missionname>". Then you should be redirected to a screen where the following is displayed:Github desktop 2.png

This is where we are done with GitHub Desktop for now. However, if there is ever a commit to the release branch (check here or in the development channel in the discord), go to your branch and:

Option 1: click on the Repository button (top right, near file), click open in command prompt and type:

git pull origin release

Option 2: Click on the Branch button and click "Update from release".

These methods are interchangeable. This will update your branch to the most up-to-date version of the CRF.

The Tools, the CRF and Mission Making:

Landing page for tools.png

Step 1: Open Steam, go to search and type in "arma reforger tools". Then click on the tools and open them.

Step 2: You will see the "Enfusion Workbench Launcher" window, you can either click on the project called "COALITION Framework" and then click open, or double click on the project, both methods will open the project in the workbench proper.

Step 2a: If you don't have "COALITION Framework" as an option, click the "Add Project" button, then click "Add Existing Project" and navigate to your projects folder, select the "Coalition-Reforger-Framework" Folder then click on "addon.gproj" and it will import it into the Enfusion Workbench Launcher. Then follow Step 2 again.

Resourcebrowser1.png

Step 3: Ignoring the majority of what is displayed, go to the "Resource Browser" on the left, click on the "ArmaReforger" folder (either by clicking directly on it or on the arrow to it's left), then click on the "worlds" folder.

Step 3a: For Everon, click on the "Eden" folder, then "Eden.ent" file in the bottom box (the first file with the globe, "EmptyEden.ent" is just an empty version of Everon and not worth using.)

Step 3b: For Arland, click on the "Arland" folder, then on "Arland.ent" file in the bottom box.

Step 3c: For other world files added by mods, either click through their respective folders until you find their .ent file or search for the file by typing the map name with no spaces and .ent at the end in the search box at the top. (For example: "WorthyIslands.ent")

Step 4:

Createnewworld.png

After it has loaded up, click the page icon in the top right labeled "Create New World", it should open a box with 2 options, "Base Scene" and "Sub-Scene (of current world)". Click "Sub-Scene" and that will load again as it creates the sub-scene.

Step 5: After creating the sub scene, right click on the "default" layer (in the hierarchy, it has a yellow, blue and red icon) and click rename, rename it to "aainit" and press OK.

Step 6: in the Resource Browser at the bottom, scroll to the "COALITIONFramework" folder, expand it (click the blue arrow), then expand "Prefabs", expand "MP", expand "Modes", then and click Lobby to open it in the right panel of the Resource Browser. Click and hold on the file called "CRF_Lobby.et" and drag it into the game frame in the center.CRF Lobby.png

Step 7: Go to the search bar at the top and type in "AIWorld", click on the "ArmaReforger" folder and it will open on the right panel, drag in the AIWorld for the map you are using. Eden/Everon and Arland have their own AIWorlds provided by BI. Other terrains, like Barzan may have their own in their folder (BarzanRemake, for example). If it does not have it's own AIWorld in it's own folder, use the default AIWorld (no world name at the end) as this is a basic prefab and will be fine for the mission you are making.Aiworldsearch.png

Step 8: Save your mission as the mission name you have defined in your branch in GitHub Desktop. (for example if your github desktop branch name is "Mission1", then name the world file "Mission1".) This allows us to easily identify what mission has been made for QA testing.-

Step 9:

Right click on the hierarchy entry named after the mission and click "Create Layer".

LayersNEW.png

Add layers for:

  • Area markers
  • BLUFOR
  • BLUFOR Vehicles
  • BLUFOR Markers
  • OPFOR
  • OPFOR Vehicles
  • OPFOR Markers
  • Fortifications
  • Objectives
  • Markers (if needed, not in the example.)

The included example on the right is from a completed mission but layers may vary between mission types.

Save your changes and then follow the next steps.

Next Steps:

Congratulations! You have the basics of making a mission down. Please check out the Extra Mission Making Information as this contains important information at the top of the page and is recommended to setup before you check out the final steps otherwise you will have to do it later.

The following guides will walk you through each mission type:

The link here will take you to the final part of the guide, explaining how to create a pull request and have your mission QA'd before being added to the CRF!

If you want to see some of the more intricate parts of mission making, check out the Advanced Mission Making guide here

There is more than just entities and mission configs to making a CRF mission, for more, check out the pages below.