Startup Parameters – Arma Reforger

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
Line 40: Line 40:
==== packAddon ====
==== packAddon ====
Main parameter used for addon packing.
Main parameter used for addon packing.
Uses XPacker to pack all data of current addon into an output directory.


When no directory is specified (by using '''packAddonDir'''), a directory from last session is used.
When no directory is specified (by using '''packAddonDir'''), a directory from last session is used.


When you're packing the addon for the first time, a new folder is automatically created in the same dir as profile folder.
When you're packing the addon for the first time, a new folder is automatically created in the same dir as profile folder.
;Example: {{hl|ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -packAddon}}
;Example:  
ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -packAddon


==== packAddonDir ====
==== packAddonDir ====
Optional parameter by which you can specify the output directory where resulting PAKs will be saved.
Optional parameter by which you can specify the output directory where resulting PAKs will be saved.
;Example: {{hl|ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -packAddon -packAddonDir "D:/build/Green"}}
;Example:  
ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -packAddon -packAddonDir "D:/build/Green"


==== publishAddon ====
==== publishAddon ====
Line 60: Line 60:


When no directory is specified (by using '''publishAddonDir''') a directory from last session is used.
When no directory is specified (by using '''publishAddonDir''') a directory from last session is used.
;Example: {{hl|ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -publishAddon}}
;Example:  
ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -publishAddon


==== publishAddonDir ====
==== publishAddonDir ====
Line 78: Line 79:
==== wbBackendLogin ====
==== wbBackendLogin ====
Optional parameter by which you can force other user to be logged in. Password is hidden console log
Optional parameter by which you can force other user to be logged in. Password is hidden console log
;Example: {{hl|ArmaReforgerWorkbench.exe -wbBackendLogin myEmail@bistudio.com myPassword}}
;Example:  
 
ArmaReforgerWorkbench.exe -wbBackendLogin myEmail@bistudio.com myPassword


== Hosting ==
== Hosting ==

Revision as of 15:49, 25 May 2022

Startup parameters' names are case-insensitive - e.g -logstats and -LogSTATS are identical.

General

addons

-addons takes a list of mod IDs (specified in their gproj files, without brackets) to be loaded on game start, separated by a comma ,.
Mods are searched in profile/addons, in <executableDir>/addons and in directories specified by -addonsDir (see below).

Mod IDs can be:
  • GUIDs (preferred - found in .gproj)
  • Project ID (found in .gproj)
  • Sub-directory name (fallback solution)
Example
ArmaReforger.exe -addons 88037E46AD234C72,88037E46AD234C73

addonsDir

-addonsDir specifies additional directories in which the game must look for mods to load, separated by a comma ,.

By default, the game looks into:
  • Documents/My Games/ArmaReforger/profile/addons
  • <executableDir>/addons
It is recommended to use absolute paths to Mod directories even though the provided path can be relative to the executable location.
Example
ArmaReforger.exe -addonsDir D:\DownloadedMods,Addons

addonDownloadDir

-addonDownloadDir specifies where the game and the Workshop should download addons.

It is recommended to use absolute paths to Mod directories even though the provided path can be relative to the executable location.
Example
ArmaReforger.exe -addonDownloadDir D:\DownloadedMods

noSplash

-noSplash skips splash screens on game load.

Example
ArmaReforger.exe -noSplash

Workbench

packAddon

Main parameter used for addon packing.

When no directory is specified (by using packAddonDir), a directory from last session is used.

When you're packing the addon for the first time, a new folder is automatically created in the same dir as profile folder.

Example
ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -packAddon

packAddonDir

Optional parameter by which you can specify the output directory where resulting PAKs will be saved.

Example
ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -packAddon -packAddonDir "D:/build/Green"

publishAddon

-publishAddon is main parameter used for addon publishing.

It should be used only for publishing addon updates, and not for the initial publish because data from last session are used to fill in the blanks.

It can be used on its own, in combination with packAddon or in combination with parameters starting with "publishAddon".

When no directory is specified (by using publishAddonDir) a directory from last session is used.

Example
ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -publishAddon

publishAddonDir

Optional parameter by which you can specify the folder containing pre-packed data (obtained by packAddon param). When not specified, folder from last session is used

publishAddonVersion

Optional parameter by which you can specify version number. When not specified, newest version found on back-end is used and it's last digit is automatically incremented.

publishAddonChangeNote

Optional parameter by which you can specify change note of this update.

publishAddonChangeNoteFile

Optional parameter by which you can specify change note of this update, which will be loaded from given file.

wbBackendLogin

Optional parameter by which you can force other user to be logged in. Password is hidden console log

Example
ArmaReforgerWorkbench.exe -wbBackendLogin myEmail@bistudio.com myPassword

Hosting

a2sIpAddress

-a2sIpAddress

Example
ArmaReforgerServer.exe -a2sIpAddress 192.168.1.10

a2sPort

-a2sPort

Example
ArmaReforgerServer.exe -a2sPort 7777

bindIP

-bindIP can be used to override both gameHostBindAddress and gameHostRegisterBindAddress values present in server config.

Example
ArmaReforgerServer.exe -bindIP 192.168.1.42

bindPort

-bindPort can be used to override both gameHostBindPort and gameHostRegisterBindPort values present in server config.

Example
ArmaReforgerServer.exe -bindPort 2302

config

-config is used by servers to point to a JSON server configuration.

See Server Hosting for more information.
Example
ArmaReforgerServer.exe -config myConfigFile.json

listScenarios

-listScenarios prints to game logs the scenario .conf file paths.

Example
ArmaReforgerServer.exe -listScenarios
Result
e.g
: --------------------------------------------------
: Official scenarios (3 entries)
: --------------------------------------------------
: {90F086877C27B6F6}Missions/99_Tutorial.conf (Tutorial)
: {ECC61978EDCC2B5A}Missions/23_Campaign.conf (Conflict)
: {59AD59368755F41A}Missions/21_GM_Eden.conf (Game Master - Everon)
: --------------------------------------------------
: Workshop scenarios (8 entries)
: --------------------------------------------------
: {6EA2E454519E5869}Missions/CAH_Military_Base.conf
: {7C491B1FCC0FF0E1}Missions/CAH_LeMoule.conf
: {F1A1BEA67132113E}Missions/CAH_Castle.conf
: {589945FB9FA7B97D}Missions/CAH_Concrete_Plant.conf
: {2B4183DF23E88249}Missions/CAH_Morton.conf
: {3F2E005F43DBD2F8}Missions/CAH_Briars_Coast.conf
: {9405201CBD22A30C}Missions/CAH_Factory.conf
: {1CD06B409C6FAE56}Missions/CAH_Forest.conf
: --------------------------------------------------

logStats

-logStats allows to log performance statistics every (optionally) defined interval (in milliseconds).

Example
ArmaReforgerServer.exe -logStats - logs every seconds
ArmaReforgerServer.exe -logStats 10000 - only logs every 10s
Result
FPS: 2514.2, frame time (avg: 0.4 ms, min: 0.3 ms, max: 8.8 ms), Mem: 2864890 kB, Player: 0, AI: 0, Veh: 0 (0), Proj (S: 0, M: 0, G: 0 | 0), RplItemsS: 1

maxFPS

-maxFPS sets max FPS limit - useful for a server, or to force a client's max FPS.

Also works on clients, even though the Video Settings FPS limitation option is preferred.
Example
ArmaReforgerServer.exe -maxFPS 30

Debug

logLevel

-logLevel allows for different log levels. Possible values range from normal (where everything is logged) to fatal (where only extreme issues are logged):

  • normal
  • warning
  • error
  • fatal

Example: ArmaReforger.exe -logLevel warning