Startup Parameters – Arma Reforger

From Bohemia Interactive Community
Revision as of 12:22, 13 June 2022 by Lou Montana (talk | contribs) (Add flags)
Jump to navigation Jump to search
ⓘ
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

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 forces 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:

  • flag uk.gif en_us - English
  • flag france.gif fr_fr - French
  • flag italy.gif it_it - Italian
  • flag germany.gif de_de - German
  • flag spain.gif es_es - Spanish
  • flag czechrep.gif cs_cz - Czech
  • flag poland.gif pl_pl - Polish
  • flag russia.gif ru_ru - Russian
  • flag japan.gif ja_jp - Japanese
  • flag korea.gif ko_kr - Korean
  • flag portugal.gif pt_br - Portuguese
  • flag china.gif zh_cn - Mandarin
Example
ArmaReforgerSteam.exe -language cs_cz

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"

noThrow

Disable all kinds of error message dialogs. (VME's, asserts, crashes, ...).

Example
ArmaReforgerSteam.exe -noThrow


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.

Example
ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -publishAddon -publishAddonDir "D:\build\Green"

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.

Example
ArmaReforgerWorkbench.exe -wbmodule=ResourceManager -publishAddon -publishAddonVersion "2.3.5"

publishAddonChangeNote

-publishAddonChangeNote is an optional parameter that specifies a note to the provided update.

Example
ArmaReforgerWorkbench.exe -publishAddonChangeNote "Fix shading"

publishAddonChangeNoteFile

-publishAddonChangeNoteFile is an optional parameter that specifies a note to the provided update through the provided file.

Example
ArmaReforgerWorkbench.exe -publishAddonChangeNoteFile "changelog.txt"

scrDefine

-scrDefine allows to determine a script preprocessor definition.

ⓘ
This parameter also works for Client and Server executables.
#ifdef TAG_DEBUG
	Print("The TAG_DEBUG flag is defined.");
#else
	Print("The TAG_DEBUG flag is not defined.");
#endif
Example
ArmaReforgerWorkbench.exe -scrDefine TAG_Debug
ArmaReforgerSteam.exe -scrDefine TAG_Debug
ArmaReforgerServer.exe -scrDefine TAG_Debug

wbBackendLogin

-wbBackendLogin is an optional parameter allowing to enforce a specific account to log 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: 60.0, frame time (avg: 16.7 ms, min: 9.3 ms, max: 23.7 ms), Mem: 3291106 kB, Player: 2, AI: 104, Veh: 0 (17), Proj (S: 12, M: 0, G: 0 | 12), RplItemsS: 410, RplItemsC0: 17068
  • FPS: <float> = Current Server-FPS value at the time of reporting.
  • frame time (avg: <float> ms, min: <float> ms, max: <float> ms) = The average, minimum, & maximum frame times reported by the server at the time of reporting.
  • Mem: <int> = The current memory usage in kilobytes as reported internally by the server at the time of reporting.
  • Player: <int> = Number of current players on the server at the time of reporting.
  • AI: <int> = Number of current AI spawned on the server at the time of reporting.
  • Veh <int> (<int>)= The value inside the parenthesis is the current number of vehicles spawned on the server at the time of reporting.
  • Proj:
    • S: <int> = Number of active shells on the server at the time of reporting.
    • M: <int> = Number of active missiles on the server at the time of reporting.
    • G: <int> = Number of active grenades on the server at the time of reporting.
    • | <int> = Total projectiles at the time of reporting.
  • RplItemsS: <int> = The number of dynamic (spawned during game) streams on the server at the time of reporting.
  • RplItemsC0: <int> = The number of streams open to the client at the time of reporting.

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
Retrieved from "https://community.bistudio.com/wiki?title=Arma_Reforger:Startup_Parameters&oldid=322496"