GTA Connected

ServerConfiguration: Difference between revisions

Page Discussion

ServerConfiguration (view source)

Revision as of 14:30, 20 July 2025

2,372 bytes removed ,  20 July 2025
no edit summary
No edit summary
No edit summary
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Server Configuration}}
{{DISPLAYTITLE:Server Configuration}}
== Summary ==
== Summary ==
The server configuration file is named <code>server.xml</code> by default, and is located in the same folder as the file named <code>Server.exe</code> on Windows or <code>Server</code> on Linux.<br>
The server.xml file is used to configure your server with things like server name, game, networking, sync, which resources to load, and many other options.
You can use a custom filename for the server configuration file with the <code>-config</code> option. Example: <code>Server.exe -config my-config.xml</code>. See the [[ServerCommandLine|server command line]] page for more info on accepted command arguments.<br>
The file uses the XML syntax, with a root node named <code>server</code>. [https://www.w3.org/TR/xml/ Official XML Specification]


== Settings ==
== Custom Config File ==
It's best practice to specify all or most of these properties in your server config XML. The corresponding default value will be used if the property is not specified.<br>
You can start the server with a [[ServerCommandLine|command switch]] for a different configuration file name. Example: <code>Server.exe -config my-config.xml</code>.


== CVars ==
See the [[CVars|CVars]] page for info.
== Options ==
{| class="wikitable"
{| class="wikitable"
!Server Property Name
!Server Property Name
Line 18: Line 20:
|-
|-
|bindip
|bindip
|"" (empty string)
|(empty string)
|Forces the server to use a specific IP. Only for hosts that have multiple IP addresses.
|Forces the server to use a specific IP. Only for hosts that have multiple IP addresses.
|-
|-
|cvar
|cvar
|null
|(individual default values)
|Sets a server's cvar value. See [[CVars|CVars]] for more information.
|Sets a server's cvar value. See [[CVars|CVars]] for more information.
|-
|-
Line 46: Line 48:
|-
|-
|httpurl
|httpurl
|"" (empty string)
|(empty string)
|A URL (like a CDN) containing the server's client resource files and scripts. Clients will download them from that URL instead of the server.
|A URL (like a CDN) containing the server's client resource files and scripts. Clients will download them from that URL instead of the server.
|-
|-
Line 59: Line 61:
|iv_nativemultiplayer
|iv_nativemultiplayer
|true
|true
|If enabled, server uses native sync (from Rockstar/GFWL), otherwise server uses GTAC's custom sync.
|If enabled, server uses Rockstar's sync, otherwise server uses GTAC's custom sync. See [[NativeMultiplayer|this page for more information]]
|-
|-
|logpath
|logpath
|"" (empty string)
|(empty string)
|The path to store the server logs. Leave blank to not use server logs.
|The path to store the server logs. Leave blank to not use server logs.
|-
|-
Line 77: Line 79:
|minclientversion
|minclientversion
|1.0.0.0
|1.0.0.0
|The minimum version that clients can connect with. [https://gtaconnected.com/downloads/client/version See latest client version here].
|The minimum version that clients can connect with. Between 1 and 4 dot-delimited tokens. [https://gtaconnected.com/downloads/client/version See latest client version here].
|-
|-
|minuteduration
|minuteduration
Line 92: Line 94:
|-
|-
|password
|password
|"" (empty string)
|(empty string)
|The password to connect to the server.
|The password to connect to the server.
|-
|-
Line 112: Line 114:
|-
|-
|rconpassword
|rconpassword
|"" (empty string)
|(empty string)
|The password to connect to the remote console service.
|The password to connect to the remote console service.
|-
|-
Line 124: Line 126:
|-
|-
|rule
|rule
|"" (empty string)
|(empty string)
|Adds a server rule. See [[ServerRules|server rules]] for more info.
|Adds a server rule. See [[ServerRules|server rules]] for more info.
|-
|-
Line 130: Line 132:
|false
|false
|The status of whether to show the server in the server browser, use true or false.
|The status of whether to show the server in the server browser, use true or false.
|-
|serverlistingurl
|serverlisting.gtaconnected.com
|The URL of the server listing.
|-
|-
|servername
|servername
Line 188: Line 186:
|-
|-
|}
|}
== CVars ==
See the [[CVars|CVars]] page for info.
== Sync Methods ==
There are a few different config options for server sync. Here is the list of them and a brief description of each.
{{ServerSyncMethods}}
== Optional Settings ==
Most of the XML server config settings are optional, and have a default value used if not specified.<br>
The "Default Value" column in the settings list shows "required" if the setting is required.<br>
To explicitly not specify a server config XML setting, either remove that setting's XML element, or comment it out with an XML comment.<br>
Do not leave a setting's XML element present with a blank value.
== IV Settings ==
Server config settings <code>iv_episode</code>, <code>iv_gamemode</code>, and <code>iv_nativemultiplayer</code>, are all optional to be specified in the server config XML file. Check the list above for default values.<br>
'''When <code>iv_nativemultiplayer</code> is <code>false</code>:'''
<code>iv_episode</code> and <code>iv_gamemode</code>  are ignored, whether they are specified or not.
'''When <code>iv_nativemultiplayer</code> is <code>true</code>:'''
<code>iv_episode</code> and <code>iv_gamemode</code> are acknowledged and used if specified, or their default values are used if not specified.<br><br>
<code>iv_gamemode -1</code><br>
This means that an internal IV gamemode is not used, and that a sandboxed scripting environment is preferred.<br>
A script will need to be present to fade the camera in and spawn the player, via scripting functions [[fadeCamera|fadeCamera]] and [[spawnPlayer|spawnPlayer]].<br><br>
<code>iv_gamemode 30</code><br>
This is an outdated value for <code>iv_gamemode</code>, and should not be used. Please use <code>-1</code> instead.<br>
Using <code>iv_gamemode</code> with a value of <code>30</code>, is different than using <code>iv_gamemode</code> with a value of <code>-1</code>.<br>
This setting value is currently left in for backward compatibility, however may become obsolete in the future.


== Example ==
== Example ==
Vortrex
Interface administrators, moderator
2,818

edits

Retrieved from "https://wiki.gtaconnected.com/Special:MobileDiff/10971...11107"