Difference between revisions of "Arma: Mod Folders"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<tt>([^ ]*=[^ ]*)<\/tt>" to "{{hl|c= $1}}")
 
(33 intermediate revisions by 16 users not shown)
Line 1: Line 1:
===Introduction===
+
__NOTOC__ {{Feature|arma3|While most of the following information is still valid for {{arma3}}, it is recommended to use the [[Arma 3: Launcher]] for mod management.}}
  
Custom modfolders are folders that can contain theme addons for easy selection, or Data files which change general parameters of the game. If you have OFP:Resistance, your \RES folder is an example of a modfolder. This feature was added in version '''1.75''' with the Resistance upgrade, prior to the '''1.75''' upgrades addons where put in the '''addons''' folder.  
+
Custom '''mod folders''' is a concept that was introduced with {{ofp}}. It allows addon makers and players to completely change most aspects of the game.
 +
They were introduced with the release {{ofpr}}, which also became the first total conversion.
  
Some Flashpoint players prefer to put an "@" in front of each modfolder's name, so they then get listed at the beginning of the main Flashpoint folder, and can be easily separated from essential game folders.
+
{{Feature|Informative|It has become a common practice to start mod folder names with a "@" in front of the name to distinguish them from other files in the {{arma}} directory. However, this is '''optional''.}}
 +
[[File:A3 Adding Mod Folders.jpg|right|150]]
 +
=== Making it Work ===
 +
To load and use a mod folder it has to be added to the game's [[:Category: Startup Parameters| Startup Parameters]] "-mod".
 +
This is done by creating a new executable shortcut and editing the startup parameters.
  
===Making it Work===
+
If for example you are trying to load a mod named @test the startup command might look like this:  
To use Modfolders you have to create a shortcut to your OFP executable, and in the path add the following parameter: -Mod=name
 
  
"C:\Program Files\Codemasters\OperationFlashpoint\FLASHPOINTRESISTANCE.EXE"
+
{{hl|c= C:\Program Files\Codemasters\OperationFlashpoint\FLASHPOINTRESISTANCE.EXE" -mod=@test}}
    [[-nomap]] [[-nosplash]] -mod=@Editor,@Winter,@Hyk,@bas
 
  
in other words, commarise all the different mods (addons) you want for this session (often only one)
+
To load several mods separate their names with the "''';'''" character.<br>
 +
{{hl|c= C:\Program Files\Codemasters\OperationFlashpoint\FLASHPOINTRESISTANCE.EXE" -mod=@test;@test2}}
  
 +
=== How it Works ===
 +
The "-mod" parameter defines a path the engine will use to load data files when loading the game.
 +
{{Feature|Important|If running {{ofp}}, it is important to remember that the ''RES'' mod will automatically be added first to the list of mod folders.}}
  
=== Addon modfolders ===
+
A mod folder can contain all the data that your {{arma}} install folder can contain. This includes missions, campaigns, and addons subfolders, etc.
 +
The most common use of mod folders is to organize addon .pbo files.
  
One of the most useful things you can do with modfolders is separate out your, by now, humungous and ever increasing addon.pbo's. The days of just placing them in the ~Addons folder are over. No engine can cope with that load.
+
=== Addon Mod Folders ===
 +
Since most players today have a very large number of extra addons installed it has become a common practice to divide them into addon mod folders.
 +
The benefit of this practice is that the engine only has to load the addons in the mod folders specified by the player, lowering memory usage significantly.
 +
To create an addon mod folder simple pick a name and create the directories "@myname\Addons\" in the game's directory.
 +
Next place all addons you want in this mod folder into this directory and add "@myname" to your "-mod" list when these addons are needed.  
  
Here is an example of a folder tree
+
To make this easier you might wish to create several shortcuts loading different mod folders.
  
mods\
+
The main drawback of this technique is that it is hard for other players in multiplayer games to know what kind of changes you are playing with as mod folders can be used to make beneficial configuration changes to the game, in other words cheat.
mods\Bas
 
mods\Finland
 
mods\HYK
 
mods\anything you like
 
  
Selectively you can use one, or several of them for the mission(s) you want to play by just creating seperate shortcuts for each combination.
+
=== Conflicting Addons / Addon Load Order ===
 +
Since {{arma1}}, it is possible for addons to modify classes in other addons, including those in the game's core "addons". If the user installs two addons that try to modify the same property of a given class (for example, the model property of the basic soldier class), then obviously both addons can not work as intended (together in the same install, that is).
  
===Resources===
+
In these cases, there is almost nothing that the user can do to determine which addon takes "priority". Inside of the addons themselves is a property called "requiredAddons", which determines addon load order, regardless of mod folder order. See [[CfgPatches]].
Alternatively, you can use [http://www.flashpoint1985.com/cgi-bin/ikonboard311/ikonboard.cgi?act=ST;f=4;t=47702 'OFP Mod Selector'], by Operator of Dissidence.
 
  
Kegetys' launcher available [http://www.andrew.nf/OFP/Tools/launcher218.zip 'here']
+
{{GameCategory|arma1|Tips}}
 +
[[Category: Startup Parameters]]

Latest revision as of 00:23, 16 November 2021

Arma 3
While most of the following information is still valid for Arma 3, it is recommended to use the Arma 3: Launcher for mod management.

Custom mod folders is a concept that was introduced with Operation Flashpoint. It allows addon makers and players to completely change most aspects of the game. They were introduced with the release Operation Flashpoint: Resistance, which also became the first total conversion.

It has become a common practice to start mod folder names with a "@" in front of the name to distinguish them from other files in the Arma directory. However, this is 'optional.
150

Making it Work

To load and use a mod folder it has to be added to the game's Startup Parameters "-mod". This is done by creating a new executable shortcut and editing the startup parameters.

If for example you are trying to load a mod named @test the startup command might look like this:

C:\Program Files\Codemasters\OperationFlashpoint\FLASHPOINTRESISTANCE.EXE" -mod=@test

To load several mods separate their names with the ";" character.
C:\Program Files\Codemasters\OperationFlashpoint\FLASHPOINTRESISTANCE.EXE" -mod=@test;@test2

How it Works

The "-mod" parameter defines a path the engine will use to load data files when loading the game.

If running Operation Flashpoint, it is important to remember that the RES mod will automatically be added first to the list of mod folders.

A mod folder can contain all the data that your Arma install folder can contain. This includes missions, campaigns, and addons subfolders, etc. The most common use of mod folders is to organize addon .pbo files.

Addon Mod Folders

Since most players today have a very large number of extra addons installed it has become a common practice to divide them into addon mod folders. The benefit of this practice is that the engine only has to load the addons in the mod folders specified by the player, lowering memory usage significantly. To create an addon mod folder simple pick a name and create the directories "@myname\Addons\" in the game's directory. Next place all addons you want in this mod folder into this directory and add "@myname" to your "-mod" list when these addons are needed.

To make this easier you might wish to create several shortcuts loading different mod folders.

The main drawback of this technique is that it is hard for other players in multiplayer games to know what kind of changes you are playing with as mod folders can be used to make beneficial configuration changes to the game, in other words cheat.

Conflicting Addons / Addon Load Order

Since Armed Assault, it is possible for addons to modify classes in other addons, including those in the game's core "addons". If the user installs two addons that try to modify the same property of a given class (for example, the model property of the basic soldier class), then obviously both addons can not work as intended (together in the same install, that is).

In these cases, there is almost nothing that the user can do to determine which addon takes "priority". Inside of the addons themselves is a property called "requiredAddons", which determines addon load order, regardless of mod folder order. See CfgPatches.