Startup Parameters Config File: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{( *)Important( *)\|" to "{{$1Feature$2|$2important$2|")
m (Some wiki formatting)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
The config file can be used to put startup parameters in, instead of specifying them at a shortcut/commandline.
{{TOC|side}}
 
The startup parameters config file can be used to put startup parameters in, instead of specifying them in a shortcut/commandline.
== Note ==
 
{{Feature|important|NOTE: low level parameters are NOT supported.}}


{{Feature|important|Low level parameters are NOT supported:<br>
.par file does not (and will not) support some low level parameters, namely:
.par file does not (and will not) support some low level parameters, namely:
* -cpuCount
* -cpuCount
* -malloc
* -malloc
* -exthreads
* -exThreads
* -maxMem=
* -maxMem
* -profiles= (confirmed on Arma 3 version 1.66.139586, options does not work from parameter file)
* -profiles (confirmed on {{arma3}} version 1.66.139586, options does not work from parameter file)
* -debug
The reason is those need to be initialized before any file operations are done.
The reason is those need to be initialized before any file operations are done.
}}


== Using ==
'''-par''' [[Arma 3 Startup Parameters|startup parameter]] lets to specify the file.


== Pre build 86060 ==
== Usage ==


=== Location ===
'''-par''' {{Link|Arma 3: Startup Parameters|startup parameter}} allows to specify the file.
Inside game folder
Whether using {{Link|#Plain Text Format}} or {{Link|#.par Format}}, '''the file is preprocessed before parsing''', allowing C++ style comments and {{hl|#define}}s to be used.
{{Feature|informative|Before {{arma2oa}} v1.60.86060, only the {{hl|{{Link|#.par Format|.par}}}} format was supported.}}
 
=== Windows ===


=== Naming ===
'''-par''' won't work being passed by cmd as variable to quotes; a specific format must be applied:
<syntaxhighlight lang="bat">
setlocal enableDelayedExpansion enableExtensions


Depending on game:
set v=!v! "-profiles=!cd!\acc"
* ArmA2.par
set v=!v! "-par=D:\par\startupParameters.txt"
* ArmA2OA.par
* TakeOnH.par


start "" "D:\arma3\arma3.exe" !v! &rem need "start" for closing cmd window;
timeout /t 1 &rem need for keeping game window (starting from logo) foreground after cmd window close;
</syntaxhighlight>


=== Format ===
<pre>class Arg
{
    startupParameter="-startupParameter"
    startupParameter2="-startupParameter2=value1;value2"
};</pre>


=== Example ===
== Plain Text Format ==
<pre>class Arg
{
    nosplash="-nosplash";
    skipIntro="-skipIntro";
    world="-world=none";
    mod="-mod=Expansion;Expansion\beta;Expansion\beta\Expansion;@cwr2";
};</pre>


== Post build 86060 ==
* The file extension must be anything '''but''' {{hl|.par}}, otherwise  the {{Link|#.par Format}} syntax will be assumed.
* The file can be located either inside or outside of the game folder for organizational purposes.
* The file must have one command line option per line.


=== Location ===
=== Location ===
Location can be defined with -par=parameterFileName startup parameter. If file extension is .par the formatting described previously is required. With any other extension (like .txt) a plain text is assumed, with one command line option per line. In both cases the file is preprocessed before parsing, allowing C++ style comments and #define-s to be used.


=== Windows ===
Location can be defined with -par=parameterFileName startup parameter.
'''-par''' won't work being passed by cmd as variable to quotes


correct .cmd|.bat
=== Format ===
setsetlocal enableDelayedExpansion enableExtensions
set v=!v! "-profiles=!cd!\acc"
set v=!v! "-par=D:\pa\startupParameters.txt"
start "" "D:\pa\arma3.exe" !v! &rem need "start" for closing cmd window;
timeout /t 1 &rem need for keeping game window (starting from logo) foreground after cmd window close;


=== Format ===
Whitespace is ignored.
The file should be named "something.txt" using the .TXT extension, and not use the ".PAR" file extension.  The ".PAR" file extension is apparently no longer read correctly on a dedicated server.  The file can be located either inside or outside of the game folder for organizational purposes.  Whitespace is ignored.
<syntaxhighlight lang="cpp">
<pre>-startupParameter
-startupParameter
-startupParameter2=value1;value2
-startupParameter2=value1;value2
MissionFileToOpenInTheEditor</pre>
MissionFileToOpenInTheEditor
</syntaxhighlight>


=== Example ===
=== Examples ===
<pre>-nosplash
 
==== Simple Example ====
<syntaxhighlight lang="cpp">
-nosplash
-skipIntro
-skipIntro
-world=none
-world=none
-mod=Expansion;Expansion\beta;Expansion\beta\Expansion;@cwr2
-mod=Expansion;Expansion\beta;Expansion\beta\Expansion;@cwr2
"c:\arma2\Users\USERNAME\missions\MissionName.Desert_E\mission.sqm"</pre>
"C:\arma2\Users\USERNAME\missions\MissionName.Desert_E\mission.sqm"
note: (not sure that this quoted line will work (most won't), but patches with spaces without the quotes, and quoted '''-mod''''s patches will);
</syntaxhighlight>
 
==== Host and Client ====
The following example allows you to launch two instances of the game with common startup parameters. One for hosting from [[:Category:Eden Editor|Eden]] and another one as a client to test for [[Multiplayer_Scripting|locality]] issues.
 
'''base.txt'''
<syntaxhighlight lang="cpp">
-mod="!Workshop\@Mod1;!Workshop\@Mod2"
-skipIntro
-noSplash
-filePatching
-noSound
-noLand
</syntaxhighlight>
 
'''host.txt'''
<syntaxhighlight lang="cpp">
#include "base.txt"
"C:\Users\USERNAME\Documents\Arma 3\missions\BIKI.VR"
</syntaxhighlight>
 
'''client.txt'''
<syntaxhighlight lang="cpp">
#include "base.txt"
-name=ClientTest
</syntaxhighlight>
 
 
== .par Format ==
 
{{Feature|warning|The {{hl|.PAR}} file extension is apparently no longer read correctly on a dedicated server.}}
 
=== Location ===
 
At game directory's root.
 
=== Naming ===
 
{| class="wikitable" style="text-align: center"
! {{arma2}} !! {{arma2oa}} !! {{tkoh}}
|-
| {{hl|ArmA2.par}} || {{hl|ArmA2OA.par}} || {{hl|TakeOnH.par}}
|}
 
=== Format ===
 
<syntaxhighlight lang="cpp">
class Arg
{
startupParameter="-startupParameter"
startupParameter2="-startupParameter2=value1;value2"
};
</syntaxhighlight>
 
=== Example ===
 
<syntaxhighlight lang="cpp">
class Arg
{
nosplash="-nosplash";
skipIntro="-skipIntro";
world="-world=none";
mod="-mod=Expansion;Expansion\beta;Expansion\beta\Expansion;@cwr2";
};
</syntaxhighlight>
 


== External links ==
== External links ==


[http://dev-heaven.net/issues/26103 Feature is discussed here by Suma]
* {{Link|https://web.archive.org/web/20151114132158/http://dev.withsix.com/issues/26103|Feature is discussed here by Suma}}
 


[[Category:Startup_Parameters]]
[[Category:Startup Parameters]]

Latest revision as of 11:51, 13 May 2024

The startup parameters config file can be used to put startup parameters in, instead of specifying them in a shortcut/commandline.

⚠
Low level parameters are NOT supported:

.par file does not (and will not) support some low level parameters, namely:

  • -cpuCount
  • -malloc
  • -exThreads
  • -maxMem
  • -profiles (confirmed on Arma 3 version 1.66.139586, options does not work from parameter file)
  • -debug
The reason is those need to be initialized before any file operations are done.


Usage

-par startup parameter allows to specify the file. Whether using Plain Text Format or .par Format, the file is preprocessed before parsing, allowing C++ style comments and #defines to be used.

ⓘ
Before Arma 2: Operation Arrowhead v1.60.86060, only the .par format was supported.

Windows

-par won't work being passed by cmd as variable to quotes; a specific format must be applied: 

setlocal enableDelayedExpansion enableExtensions

set v=!v! "-profiles=!cd!\acc"
set v=!v! "-par=D:\par\startupParameters.txt"

start "" "D:\arma3\arma3.exe" !v!	&rem need "start" for closing cmd window;
timeout /t 1						&rem need for keeping game window (starting from logo) foreground after cmd window close;


Plain Text Format

  • The file extension must be anything but .par, otherwise the .par Format syntax will be assumed.
  • The file can be located either inside or outside of the game folder for organizational purposes.
  • The file must have one command line option per line.

Location

Location can be defined with -par=parameterFileName startup parameter.

Format

Whitespace is ignored. 

-startupParameter
-startupParameter2=value1;value2
MissionFileToOpenInTheEditor

Examples

Simple Example

-nosplash
-skipIntro
-world=none
-mod=Expansion;Expansion\beta;Expansion\beta\Expansion;@cwr2
"C:\arma2\Users\USERNAME\missions\MissionName.Desert_E\mission.sqm"

Host and Client

The following example allows you to launch two instances of the game with common startup parameters. One for hosting from Eden and another one as a client to test for locality issues.

base.txt 

-mod="!Workshop\@Mod1;!Workshop\@Mod2"
-skipIntro
-noSplash
-filePatching
-noSound
-noLand

host.txt 

#include "base.txt"
"C:\Users\USERNAME\Documents\Arma 3\missions\BIKI.VR"

client.txt 

#include "base.txt"
-name=ClientTest


.par Format

⚠
The .PAR file extension is apparently no longer read correctly on a dedicated server.

Location

At game directory's root.

Naming

Arma 2 Arma 2: Operation Arrowhead Take On Helicopters
ArmA2.par ArmA2OA.par TakeOnH.par

Format

class Arg
{
	startupParameter="-startupParameter"
	startupParameter2="-startupParameter2=value1;value2"
};

Example

class Arg
{
	nosplash="-nosplash";
	skipIntro="-skipIntro";
	world="-world=none";
	mod="-mod=Expansion;Expansion\beta;Expansion\beta\Expansion;@cwr2";
};


External links

Retrieved from "https://community.bistudio.com/wiki?title=Startup_Parameters_Config_File&oldid=364391"