Startup Parameters – Arma Reforger

From Bohemia Interactive Community
Jump to navigation Jump to search
(Add client, window, posX/Y, forceUpdate, noFocus, screenWidth/Height, language, GPUAdapter, noBackend, noSound, profile)
Line 13: Line 13:
* Sub-directory name (fallback solution)
* Sub-directory name (fallback solution)
}}
}}
;Example: {{hl|ArmaReforger.exe -addons 88037E46AD234C72,88037E46AD234C73}}
; Example
ArmaReforgerSteam.exe -addons 88037E46AD234C72,88037E46AD234C73


=== addonsDir ===
=== addonsDir ===
Line 24: Line 25:
}}
}}
{{Feature|important|It is recommended to use ''absolute'' paths to Mod directories even though the provided path ''can'' be relative to the executable location.}}
{{Feature|important|It is recommended to use ''absolute'' paths to Mod directories even though the provided path ''can'' be relative to the executable location.}}
;Example: {{hl|ArmaReforger.exe -addonsDir D:\DownloadedMods,Addons}}
; Example
ArmaReforgerSteam.exe -addonsDir D:\DownloadedMods,Addons


=== addonDownloadDir ===
=== addonDownloadDir ===
Line 30: Line 32:
{{hl|-addonDownloadDir}} specifies where the game and the Workshop should download addons.
{{hl|-addonDownloadDir}} specifies where the game and the Workshop should download addons.
{{Feature|important|It is recommended to use ''absolute'' paths to Mod directories even though the provided path ''can'' be relative to the executable location.}}
{{Feature|important|It is recommended to use ''absolute'' paths to Mod directories even though the provided path ''can'' be relative to the executable location.}}
;Example: {{hl|ArmaReforger.exe -addonDownloadDir D:\DownloadedMods}}
; Example
ArmaReforgerSteam.exe -addonDownloadDir D:\DownloadedMods
 
=== GPUAdapter ===
 
{{hl|-GPUAdapter}} forcecs to use the graphic card at the provided index. GPU index can be found using [https://support.microsoft.com/en-us/windows/open-and-run-dxdiag-exe-dad7792c-2ad5-f6cd-5a37-bf92228dfd85 DxDiag].
; Example
ArmaReforgerSteam.exe -GPUAdapter=0
 
=== language ===
 
{{hl|-language}} sets the game language by language code - supported language codes depends on StringTable which is set in gproj. {{armaR}} supported languages are:
* {{hl|en_us}} - English
* {{hl|fr_fr}} - French
* {{hl|it_it}} - Italian
* {{hl|de_de}} - German
* {{hl|es_es}} - Spanish
* {{hl|cs_cz}} - Czech
* {{hl|pl_pl}} - Polish
* {{hl|ru_ru}} - Russian
* {{hl|ja_jp}} - Japanese
* {{hl|ko_kr}} - Korean
* {{hl|pt_br}} - Portuguese
* {{hl|zh_cn}} - Mandarin


=== noSplash ===
=== noSplash ===


{{hl|-noSplash}} skips splash screens on game load.
{{hl|-noSplash}} skips splash screens on game load.
;Example: {{hl|ArmaReforger.exe -noSplash}}
; Example
ArmaReforgerSteam.exe -noSplash
 
=== noBackend ===
 
{{hl|-noBackend}} disables backend-related http communication.
; Example
ArmaReforgerSteam.exe -noBackend
 
=== noSound ===
 
{{hl|-noSound}} disables the sound system processing.
; Example
ArmaReforgerSteam.exe -noSound
 
=== profile ===
 
{{hl|-profile}} defines the profile to be used - located in the {{hl|%userprofile%\My Documents\My Games\<name>}} directory.
; Example
ArmaReforgerSteam.exe -profile "David Armstrong"
 
 
== Window ==
 
=== window ===
 
{{hl|-window}} starts the game windowed (fullscreen by default).
; Example
ArmaReforgerSteam.exe -window
 
=== posX ===
=== posY ===
 
{{hl|-posX}} and {{hl|-posY}} define the initial window position. They must be used with {{hl|-window}}.<br>
posX 0 is left of the screen,<br>
posY 0 is top of the screen.
 
; Example
ArmaReforgerSteam.exe -window -posX 0 -posY 64
 
=== screenWidth ===
=== screenHeight ===
 
{{hl|-screenWidth}} and {{hl|-screenHeight}} define the window's size (and not its render ''resolution''). They must be used with {{hl|-window}}.
; Example
ArmaReforgerSteam.exe -window -screenWidth 1024 -screenHeight 578
 
=== forceUpdate ===
 
{{hl|-forceUpdate}} forces the application to render and update even when the window is out of focus.
; Example
ArmaReforgerSteam.exe -forceUpdate
 
 
=== noFocus ===
 
{{hl|-noFocus}} prevents window focus stealing on game initialization.
; Example
ArmaReforgerSteam.exe -noFocus
 


== Workbench ==
== Workbench ==
==== packAddon ====
 
{{Feature|important|These parameters apply to the Workbench executable.}}
 
=== packAddon ===
 
Main parameter used for addon packing.
Main parameter used for addon packing.


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 packing an addon for the first time, a new directory is automatically created in the same dir as {{hl|profile}}.
;Example:  
; Example:  
  ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -packAddon
  ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -packAddon


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


==== publishAddon ====
{{hl|-publishAddon}} is main parameter used for addon publishing.
{{hl|-publishAddon}} is main parameter used for addon publishing.


Line 60: Line 150:


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:
; Example
  ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -publishAddon
  ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -publishAddon


==== publishAddonDir ====
=== 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 ====
{{hl|-publishAddonDir}} specifies the pre-packed data directory (obtained by the {{hl|-packAddon}} parameter above).
Optional parameter by which you can specify version number.
When not specified, directory from the last session is used.
 
=== publishAddonVersion ===
 
{{hl|-publishAddonVersion}} specifies the mod's version number.
When not specified, newest version found on back-end is used and it's last digit is automatically incremented.
When not specified, newest version found on back-end is used and it's last digit is automatically incremented.


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


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


==== 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:  
; Example:  
  ArmaReforgerWorkbench.exe -wbBackendLogin myEmail@bistudio.com myPassword
  ArmaReforgerWorkbench.exe -wbBackendLogin myEmail@bistudio.com myPassword


== Hosting ==
== Hosting ==
{{Feature|important|These parameters apply to the Server executable.}}


=== a2sIpAddress ===
=== a2sIpAddress ===


{{hl|-a2sIpAddress}}
{{hl|-a2sIpAddress}}
; Example: {{hl|ArmaReforgerServer.exe -a2sIpAddress 192.168.1.10}}
; Example
ArmaReforgerServer.exe -a2sIpAddress 192.168.1.10


=== a2sPort ===
=== a2sPort ===


{{hl|-a2sPort}}
{{hl|-a2sPort}}
; Example: {{hl|ArmaReforgerServer.exe -a2sPort 7777}}
; Example
ArmaReforgerServer.exe -a2sPort 7777


=== bindIP ===
=== bindIP ===


{{hl|-bindIP}} can be used to override both [[Arma Reforger:Server Hosting#gameHostBindAddress|gameHostBindAddress]] and [[Arma Reforger:Server Hosting#gameHostRegisterBindAddress|gameHostRegisterBindAddress]] values present in [[Arma Reforger:Server Hosting#Configuration File|server config]].
{{hl|-bindIP}} can be used to override both [[Arma Reforger:Server Hosting#gameHostBindAddress|gameHostBindAddress]] and [[Arma Reforger:Server Hosting#gameHostRegisterBindAddress|gameHostRegisterBindAddress]] values present in [[Arma Reforger:Server Hosting#Configuration File|server config]].
; Example: {{hl|ArmaReforgerServer.exe -bindIP 192.168.1.42}}
; Example
ArmaReforgerServer.exe -bindIP 192.168.1.42


=== bindPort ===
=== bindPort ===


{{hl|-bindPort}} can be used to override both [[Arma Reforger:Server Hosting#gameHostBindPort|gameHostBindPort]] and [[Arma Reforger:Server Hosting#gameHostRegisterBindPort|gameHostRegisterBindPort]] values present in [[Arma Reforger:Server Hosting#Configuration File|server config]].
{{hl|-bindPort}} can be used to override both [[Arma Reforger:Server Hosting#gameHostBindPort|gameHostBindPort]] and [[Arma Reforger:Server Hosting#gameHostRegisterBindPort|gameHostRegisterBindPort]] values present in [[Arma Reforger:Server Hosting#Configuration File|server config]].
; Example: {{hl|ArmaReforgerServer.exe -bindPort 2302}}
; Example
ArmaReforgerServer.exe -bindPort 2302
 
=== client ===
 
{{hl|-client}} starts up an RplSession in local client mode. The session tries to connect to the provided IP.
; Example
ArmaReforgerSteam.exe -client 127.0.0.1
 


=== config ===
=== config ===
Line 108: Line 217:
{{hl|-config}} is used by servers to point to a JSON server configuration.
{{hl|-config}} is used by servers to point to a JSON server configuration.
{{Feature|informative|See [[Arma Reforger: Server Hosting| Server Hosting]] for more information.}}
{{Feature|informative|See [[Arma Reforger: Server Hosting| Server Hosting]] for more information.}}
;Example: {{hl|ArmaReforgerServer.exe -config myConfigFile.json}}
; Example
ArmaReforgerServer.exe -config myConfigFile.json


=== listScenarios ===
=== listScenarios ===


{{hl|-listScenarios}} prints to game logs the scenario .conf file paths.<br>
{{hl|-listScenarios}} prints to game logs the scenario .conf file paths.<br>
;Example: {{hl|ArmaReforgerServer.exe -listScenarios}}
; Example
ArmaReforgerServer.exe -listScenarios
; Result: e.g
; Result: e.g
<pre style="font-size: 0.9em">
<pre style="font-size: 0.9em">
Line 139: Line 250:


{{hl|-logStats}} allows to log performance statistics every (optionally) defined interval (in milliseconds).
{{hl|-logStats}} allows to log performance statistics every (optionally) defined interval (in milliseconds).
;Example
; Example
: {{hl|ArmaReforgerServer.exe -logStats}} - logs every seconds
: {{hl|ArmaReforgerServer.exe -logStats}} - logs every seconds
: {{hl|ArmaReforgerServer.exe -logStats 10000}} - only logs every 10s
: {{hl|ArmaReforgerServer.exe -logStats 10000}} - only logs every 10s
;Result
; Result
: <code>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</code>
: <code>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</code>


Line 149: Line 260:
{{hl|-maxFPS}} sets max FPS limit - useful for a server, or to force a client's max FPS.
{{hl|-maxFPS}} sets max FPS limit - useful for a server, or to force a client's max FPS.
{{Feature|informative|Also works on clients, even though the Video Settings FPS limitation option is preferred.}}
{{Feature|informative|Also works on clients, even though the Video Settings FPS limitation option is preferred.}}
;Example: {{hl|ArmaReforgerServer.exe -maxFPS 30}}
; Example
ArmaReforgerServer.exe -maxFPS 30
 


== Debug ==
== Debug ==
=== logAppend ===
{{hl|-logAppend}} makes logs to not be emptied on game start, keeping the history.
; Example
ArmaReforgerSteam.exe -logAppend


=== logLevel ===
=== logLevel ===
Line 166: Line 285:
* fatal
* fatal


Example: {{hl|ArmaReforger.exe -logLevel warning}}
; Example
ArmaReforgerSteam.exe -logLevel warning




{{GameCategory|armaR|Support}}
{{GameCategory|armaR|Support}}

Revision as of 14:07, 30 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
ArmaReforgerSteam.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
ArmaReforgerSteam.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
ArmaReforgerSteam.exe -addonDownloadDir D:\DownloadedMods

GPUAdapter

-GPUAdapter forcecs to use the graphic card at the provided index. GPU index can be found using DxDiag.

Example
ArmaReforgerSteam.exe -GPUAdapter=0

language

-language sets the game language by language code - supported language codes depends on StringTable which is set in gproj. Arma Reforger supported languages are:

  • en_us - English
  • fr_fr - French
  • it_it - Italian
  • de_de - German
  • es_es - Spanish
  • cs_cz - Czech
  • pl_pl - Polish
  • ru_ru - Russian
  • ja_jp - Japanese
  • ko_kr - Korean
  • pt_br - Portuguese
  • zh_cn - Mandarin

noSplash

-noSplash skips splash screens on game load.

Example
ArmaReforgerSteam.exe -noSplash

noBackend

-noBackend disables backend-related http communication.

Example
ArmaReforgerSteam.exe -noBackend

noSound

-noSound disables the sound system processing.

Example
ArmaReforgerSteam.exe -noSound

profile

-profile defines the profile to be used - located in the %userprofile%\My Documents\My Games\<name> directory.

Example
ArmaReforgerSteam.exe -profile "David Armstrong"


Window

window

-window starts the game windowed (fullscreen by default).

Example
ArmaReforgerSteam.exe -window

posX

posY

-posX and -posY define the initial window position. They must be used with -window.
posX 0 is left of the screen,
posY 0 is top of the screen.

Example
ArmaReforgerSteam.exe -window -posX 0 -posY 64

screenWidth

screenHeight

-screenWidth and -screenHeight define the window's size (and not its render resolution). They must be used with -window.

Example
ArmaReforgerSteam.exe -window -screenWidth 1024 -screenHeight 578

forceUpdate

-forceUpdate forces the application to render and update even when the window is out of focus.

Example
ArmaReforgerSteam.exe -forceUpdate


noFocus

-noFocus prevents window focus stealing on game initialization.

Example
ArmaReforgerSteam.exe -noFocus


Workbench

These parameters apply to the Workbench executable.

packAddon

Main parameter used for addon packing.

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

When packing an addon for the first time, a new directory is automatically created in the same dir as profile.

Example
ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -packAddon

packAddonDir

-packAddonDirspecifies 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

-publishAddonDir specifies the pre-packed data directory (obtained by the -packAddon parameter above). When not specified, directory from the last session is used.

publishAddonVersion

-publishAddonVersion specifies the mod's 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

These parameters apply to the Server executable.

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

client

-client starts up an RplSession in local client mode. The session tries to connect to the provided IP.

Example
ArmaReforgerSteam.exe -client 127.0.0.1


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

logAppend

-logAppend makes logs to not be emptied on game start, keeping the history.

Example
ArmaReforgerSteam.exe -logAppend

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
ArmaReforgerSteam.exe -logLevel warning