Server mtaserver.conf: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(added missing settings)
Line 7: Line 7:


====serverip====
====serverip====
:''<serverip></serverip>
:''<serverip>auto</serverip>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING'''
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING''' - it is generally only needed for professional servers and should be left at the default value otherwise.
:It is generally only needed for professional servers and should be left blank otherwise. This parameter specifies the IP to use for servers that have multiple IP addresses. If left blank, it will default to server's standard local IP address.
: This parameter specifies the IP to use for servers that have multiple IP addresses. If set to auto, it will automatically detect and use the server's standard local IP address.
:SERVERIP SHOULD BE LEFT BLANK UNLESS YOU ARE SURE OF WHAT YOU ARE DOING
:Values: auto or x.x.x.x ; default value: auto -->
:People who set this and then ask for support will be the first ones against the wall when the revolution comes
:SERVERIP SHOULD BE LEFT SET TO auto UNLESS YOU ARE SURE OF WHAT YOU ARE DOING
:WARNING: SETTING serverip AND THEN ASKING FOR SUPPORT CAN CAUSE DEATH OR INJURY


====serverport====
====serverport====
Line 235: Line 236:
{{New feature/item|3.0136|1.3.4|5809|
{{New feature/item|3.0136|1.3.4|5809|
====loadstringfile====
====loadstringfile====
:''<!-- <loadstringfile>logs/loadstring.log</loadstringfile> -->
:''<nowiki><!-- <loadstringfile>logs/loadstring.log</loadstringfile> --></nowiki>
:Specifies the location and name of the file used to log loadstring function calls. If left blank or not set, no logging is done.
:Specifies the location and name of the file used to log loadstring function calls. If left blank or not set, no logging is done.
}}
}}
Line 295: Line 296:
====compact_internal_databases====
====compact_internal_databases====
:''<compact_internal_databases>1</compact_internal_databases>
:''<compact_internal_databases>1</compact_internal_databases>
:This parameter specifies when the internal sqlite databases should be defragmented. Details: http://www.sqlite.org/lang_vacuum.html
:This parameter specifies when the internal sqlite databases should be defragmented.
:For more info see: http://www.sqlite.org/lang_vacuum.html
:Values: 0 - Never, 1 - On server start only after basic backup, 2 - On server start always.  Default - 1
:Values: 0 - Never, 1 - On server start only after basic backup, 2 - On server start always.  Default - 1
}}
}}
====crash_dump_upload====
:''<crash_dump_upload></crash_dump_upload>
:This parameter specifies whether server crash dump files should be sent to MTA HQ.
:Values: 0 - Off, 1 - On. Default - 1
====auth_serial_groups====
:''<auth_serial_groups>Admin</auth_serial_groups>
:This parameter lists the ACL groups that are protected by serial authorization.
:Login attempts to a protected account from a second serial are blocked until the serial is manually authorized via the authserial command.
:For more info see: https://mtasa.com/authserial
:Values: Comma separated list of ACL groups.  Default - Admin
====auth_serial_http====
:''<auth_serial_http>1</auth_serial_http>
:This parameter specifies if the authorized serial login checks should also apply to the http interface.
:Protected account login attempts to the http interface will only succeed if the IP address matches one recently used by the account holder in-game.
:For more info see: https://mtasa.com/authserialhttp
:Values: 0 - Off, 1 - Enabled.  Default - 1
====database_credentials_protection====
:''<database_credentials_protection>1</database_credentials_protection>
:This parameter specifies if extra security measures are applied to resources which use dbConnect with mysql.
:The extra measures are:
: - script files cannot be accessed with [[fileOpen|fileOpen( )]]
: - [[meta.xml]] is read-only
:'''NOTE:''' This only protects resources which use [[dbConnect]] with MySQL
:Values: 0 - Off, 1 - Enabled.  Default - 1


====module====
====module====
:''<nowiki><!-- <module src="sample_win32.dll"/> --></nowiki>
:''<nowiki><!-- <module src="sample_win32.dll" /> --></nowiki>
:''<nowiki><!-- <module src="sample_linux.so"/> --></nowiki>
:''<nowiki><!-- <module src="sample_linux.so" /> --></nowiki>
:Specifies the module(s) which are loaded with the server. To load several modules, add more <module> parameter(s). Optional parameter.
:Specifies the module(s) which are loaded with the server. To load several modules, add more <module> parameter(s). Optional parameter.


====resource====
====resource====
:''<resource src="admin" startup="1" protected="0"/>
:''<resource src="admin" startup="1" protected="0" />
:''<resource src="defaultstats" startup="1" protected="0"/>
:''<resource src="defaultstats" startup="1" protected="0" />
:''<resource src="helpmanager" startup="1" protected="0"/>
:''<resource src="helpmanager" startup="1" protected="0" />
:''<resource src="joinquit" startup="1" protected="0"/>
:''<resource src="joinquit" startup="1" protected="0" />
:''<resource src="mapcycler" startup="1" protected="0"/>
:''<resource src="mapcycler" startup="1" protected="0" />
:''<resource src="mapmanager" startup="1" protected="0"/>
:''<resource src="mapmanager" startup="1" protected="0" />
:''<resource src="parachute" startup="1" protected="0"/>
:''<resource src="parachute" startup="1" protected="0" />
:''<resource src="resourcebrowser" startup="1" protected="1" default="true"/>
:''<resource src="resourcebrowser" startup="1" protected="1" default="true" />
:''<resource src="resourcemanager" startup="1" protected="1"/>
:''<resource src="resourcemanager" startup="1" protected="1" />
:''<resource src="scoreboard" startup="1" protected="0"/>
:''<resource src="scoreboard" startup="1" protected="0" />
:''<resource src="spawnmanager" startup="1" protected="0"/>
:''<resource src="spawnmanager" startup="1" protected="0" />
:''<resource src="voice" startup="1" protected="0" />
:''<resource src="voice" startup="1" protected="0" />
:''<resource src="votemanager" startup="1" protected="0"/>
:''<resource src="votemanager" startup="1" protected="0" />
:''<resource src="webadmin" startup="1" protected="0"/>
:''<resource src="webadmin" startup="1" protected="0" />
 
:''<resource src="play" startup="1" protected="0" />
 


<auth_serial_groups>Admin</auth_serial_groups>
:Specifies persistent resources which are loaded when the server starts. Persistent resources are not stopped even if all the other resources that depend on them stop; that is, the only way to stop them is by explicitly using the ''stop'' server command or [[stopResource]] scripting function. To load several resources, add more <resource> parameters.
:Specifies persistent resources which are loaded when the server starts. Persistent resources are not stopped even if all the other resources that depend on them stop; that is, the only way to stop them is by explicitly using the ''stop'' server command or [[stopResource]] scripting function. To load several resources, add more <resource> parameters.



Revision as of 17:07, 7 January 2017

This page lists the settings that can be set in the settings file. Setting from the default mtaserver.conf settings file is in italics.


servername

<servername>Default MTA Server</servername>
This parameter specifies the name the server will be visible as in the ingame server browser and on Game-Monitor. It is a required parameter.

serverip

<serverip>auto</serverip>
ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING - it is generally only needed for professional servers and should be left at the default value otherwise.
This parameter specifies the IP to use for servers that have multiple IP addresses. If set to auto, it will automatically detect and use the server's standard local IP address.
Values: auto or x.x.x.x ; default value: auto -->
SERVERIP SHOULD BE LEFT SET TO auto UNLESS YOU ARE SURE OF WHAT YOU ARE DOING
WARNING: SETTING serverip AND THEN ASKING FOR SUPPORT CAN CAUSE DEATH OR INJURY

serverport

<serverport>22003</serverport>
This parameter specifies the UDP port on which the server will be accepting incoming player connections;
default value: 22003. It is a required parameter.

maxplayers

<maxplayers>32</maxplayers>
This parameter specifies the number of maximum player slots available on the server;
default value: 32. It is a required parameter.

httpserver

<httpserver>1</httpserver>
This parameter specifies whether the builtin http server will be used.
Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
More information: Using the web interface

httpport

<httpport>22005</httpport>
This parameter specifies the TCP port on which the server will be accepting incoming http connections. It can be set to the same value as <serverport>. It is a required parameter if <httpserver> is set to 1.
More information: Using the web interface

httpdownloadurl

<httpdownloadurl></httpdownloadurl>
If set, this parameter specifies the external URL from which clients will be able to download needed resources ingame. Otherwise they will download them directly from the server.
More information: Configuring an external web server

httpmaxconnectionsperclient

<httpmaxconnectionsperclient>5</httpmaxconnectionsperclient>
This parameter limits the number of http connections each client can make. Depending on the type of http server that is used, a lower figure may reduce download timeouts. Only relevant when using an external http server.
Available range: 1 to 8.

httpdosthreshold

<httpdosthreshold>20</httpdosthreshold>
This parameter limits the number http connections that an IP can initiate over a short period of time.
Available range: 1 to 100. default value: 20

http_dos_exclude

<http_dos_exclude></http_dos_exclude>
This parameter lists the IP addresses that are to be excluded from http dos threshold limits.
e.g. 88.11.22.33,101.2.3.4

allow_gta3_img_mods

<allow_gta3_img_mods>none</allow_gta3_img_mods>
By default, the server will block the use of locally customized gta3.img player skins.
This setting can be used to allow such mods. Not recommended for competitive servers.
Values: none or peds ; default value: none
From server version 1.4.1-9.07268

client_file

<!-- <client_file name="data/carmods.dat" verify="0" /> -->
By default, the server will block the use of customized GTA:SA data files.
To allow specific client files, add one or more of the above lines.
More information: Anti-cheat guide

disableac

<disableac></disableac>
Comma seperated list of disabled anti-cheats.
e.g. To disable anti-cheat #2 and #3, use: 2,3
More information: Anti-cheat guide

enablesd

<enablesd></enablesd>
Comma seperated list of enabled special detections. A special detection is a type of anti-cheat for (usually) harmless game modifications. Competitive servers may wish to enable special detections, but most servers should leave this setting blank.
e.g. To enable special detection #12 (disallow custom D3D9.DLL) use: 12
More information: Anti-cheat guide

networkencryption

<networkencryption>1</networkencryption>
This parameter specifies whether communications between the server and client is encrypted. Encryption can help prevent network data being viewed and modified.
Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
This parameter can changed and saved while the server is running with setServerConfigSetting

minclientversion

<minclientversion></minclientversion>
Minimum client version. Clients with a lower version will not be allowed to connect. After disconnection, clients will be given an opportunity to download an update. If left blank, this setting is disabled and there are no restrictions on who can connect. Version numbers are described in getPlayerVersion and look like this: 1.1.0-9.03100.0
This parameter can changed and saved while the server is running with setServerConfigSetting
Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [highest available].

minclientversion_auto_update

<minclientversion_auto_update></minclientversion_auto_update>
This parameter specifies if/when the <minclientversion> setting is automatically updated.
Keeping <minclientversion> updated can help reduce cheating.
Note: The instant setting (2) is only recommened for competitive servers.
Values: 0 - disabled, 1 - enabled (delayed by a few days), 2 - enabled (instant) ; default value: 1.

recommendedclientversion

<recommendedclientversion></recommendedclientversion>
Recommended client version. When connecting, if clients have a lower version, they will be given the option to download an update. If left blank, this setting is disabled.
This parameter can changed and saved while the server is running with setServerConfigSetting
Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [highest available].

ase

<ase>1</ase>
This parameter can be used to make the server report to Game-Monitor master servers, allowing it to be visible in the ingame server browser. An additional UDP port needs to be available for this to work (value from <serverport> + 123 , so on a default <serverport> value 22003 the right port will be 22126 ).
Available values: 0 - disabled , 1 - enabled. Optional parameter, defaults to 0.

donotbroadcastlan

<donotbroadcastlan>0</donotbroadcastlan>
This parameter allows you to disable LAN broadcasting.

password

<password></password>
If set, players will have to provide a password specified below, before they can connect to the server. If left blank, server doesn't require a password from them.
This parameter can changed and saved while the server is running with setServerPassword or setServerConfigSetting

bandwidth_reduction

<bandwidth_reduction>medium</bandwidth_reduction>
This parameter reduces the server's bandwidth usage by using various optimizations.
Values: none, medium or maximum ; default value: medium
This parameter can be changed and saved while the server is running with setServerConfigSetting

player_sync_interval

<player_sync_interval>100</player_sync_interval>
This parameter determines the time in milliseconds between player sync packets.
Available range: 50 - 500; default value: 100
This parameter can be changed and saved while the server is running with setServerConfigSetting
Suggested values for this and the other sync_interval settings can be found here: Sync interval settings

lightweight_sync_interval

<lightweight_sync_interval>1500</lightweight_sync_interval>
This parameter determines the time in milliseconds between lightweight (player) sync packets.
Available range: 200 - 40000; default value: 1500
This parameter can be changed and saved while the server is running with setServerConfigSetting
Suggested values for this and the other sync_interval settings can be found here: Sync interval settings

camera_sync_interval

<camera_sync_interval>500</camera_sync_interval>
This parameter determines the time in milliseconds between camera sync packets.
Available range: 200 - 400; default value: 500
This parameter can be changed and saved while the server is running with setServerConfigSetting
Suggested values for this and the other sync_interval settings can be found here: Sync interval settings

ped_sync_interval

<ped_sync_interval>400</ped_sync_interval>
This parameter determines the time in milliseconds between ped sync packets.
Available range: 200 - 4000; default value: 400
This parameter can be changed and saved while the server is running with setServerConfigSetting
Suggested values for this and the other sync_interval settings can be found here: Sync interval settings

unoccupied_vehicle_sync_interval

<unoccupied_vehicle_sync_interval>1000</unoccupied_vehicle_sync_interval>
This parameter determines the time in milliseconds between unoccupied vehicle sync packets.
Available range: 200 - 4000; default value: 1000
This parameter can be changed and saved while the server is running with setServerConfigSetting
Suggested values for this and the other sync_interval settings can be found here: Sync interval settings

keysync_mouse_sync_interval

<keysync_mouse_sync_interval>100</keysync_mouse_sync_interval>
This parameter determines the minimum time in milliseconds between key sync packets due to mouse movement.
Available range: 50 - 500; default value: 100
This parameter can be changed and saved while the server is running with setServerConfigSetting
Suggested values for this and the other sync_interval settings can be found here: Sync interval settings

keysync_analog_sync_interval

<keysync_analog_sync_interval>100</keysync_analog_sync_interval>
This parameter determines the minimum time in milliseconds between key sync packets due to joystick movement.
Available range: 50 - 500; default value: 100
This parameter can be changed and saved while the server is running with setServerConfigSetting
Suggested values for this and the other sync_interval settings can be found here: Sync interval settings

bullet_sync

<bullet_sync>0</bullet_sync>
This parameter can improve the reliability of shots when using certain weapons. However, it uses more bandwidth.
It only works on server build 4247 or later, and when enabled, connecting clients will be auto-updated if required.
Note that bullet sync will be active regardless of this setting when certain glitches are enabled.
Values: 0 - disabled , 1 - enabled ; default value: 0.
This parameter can be changed and saved while the server is running with setServerConfigSetting

vehext_percent

<vehext_percent>0</vehext_percent>
This parameter sets the amount of extrapolation that clients will apply to remote vehicles.
This can reduce some of the latency induced location disparency by predicting where the remote vehicles will probably be.
Depending on the gamemode, an incorrect prediction may have a negative effect.
Therefore this setting should be considered expermental.
It only works on server build 4456 or later.
Available range: 0 to 100. Default - 0 -->

vehext_ping_limit

<vehext_ping_limit>150</vehext_ping_limit>
This parameter places a limit on how much time (in milliseconds) the vehicle extrapolation will attempt to compensate for.
Only relevant if <vehext_percent> is greater than zero.
It only works on server build 4456 or later.
Available range: 50 to 500. Default - 150

latency_reduction

<latency_reduction>0</latency_reduction>
This parameter can reduce the delay of player actions appearing on remote clients by 2 frames (approx 50ms).
Due to the impact this may have on shot lag compensation, it should be considered experimental.
Values: 0 - disabled , 1 - enabled ; default value: 0.
Bugs caused by enabling latency_reduction: http://bugs.mtasa.com/view.php?id=8191 + http://bugs.mtasa.com/view.php?id=8226

threadnet

<threadnet>1</threadnet>
This parameter specifies whether or not to run the network synchronization on another thread.
Enabling will make the sync smoother, but may increase cpu usage slightly.
Values: 0 - disabled , 1 - enabled ; default value: 1.
This parameter can be changed and saved while the server is running with setServerConfigSetting

idfile

<idfile>server-id.keys</idfile>
Specifies the location and file name of this servers unique private key. This is used to prevent private files saved on the client from being read by other servers.
Keep a backup of this file in a safe place. Default value: server-id.keys
More information about client private files: Filepath

logfile

<logfile>logs/server.log</logfile>
Specifies the location and name of the main server log file. If left blank, server won't be saving this file.

authfile

<authfile>logs/server_auth.log</authfile>
As well as the main log file, login successes and failures are logged here for easy reviewing of security issues. If left blank, this file is not used

dbfile

<dbfile>logs/db.log</dbfile>
Specifies the location and name of the file used to log database queries. The server command debugdb sets the amount of logging.

loadstringfile

<!-- <loadstringfile>logs/loadstring.log</loadstringfile> -->
Specifies the location and name of the file used to log loadstring function calls. If left blank or not set, no logging is done.

acl

<acl>acl.xml</acl>
This parameter specifies the location and name of the Access Control List settings file. If left
blank, server will use acl.xml file, located in the same folder as this configuration file.

scriptdebuglogfile

<scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile>
Specifies the location and name of the debugscript log file. If left blank, server won't be saving this file.

scriptdebugloglevel

<scriptdebugloglevel>0</scriptdebugloglevel>
Specifies the level of the debugscript log file. Available values: 0, 1, 2, 3. When not set, defaults to 0.

fpslimit

<fpslimit>36</fpslimit>
Specifies the frame rate limit that will be applied to connecting clients.
Available range: 25 to 100. Default: 36.
When running the map editor locally (i.e. from the client), the default FPS limit is 50.
This parameter can be changed and saved while the server is running with setServerConfigSetting

voice

<voice>0</voice>
This parameter specifies whether or not to enable player voice chat in-game
Values: 0 - disabled , 1 - enabled

voice_samplerate

<voice_samplerate>1</voice_samplerate>
This parameter specifies the sample rate for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the sampling quality of voice chat
Values: 0 - Narrowband (8kHz), 1 - Wideband (16kHz), 2 - Ultrawideband (32kHz). Default - 1

voice_quality

<voice_quality>4</voice_quality>
This parameter specifies the voice quality for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the the overall quality of voice chat
Available range: 0 to 10. Default - 4

voice_bitrate

<!-- <voice_bitrate>24600</voice_bitrate> -->
Specifies the voice bitrate, in bps. This optional parameter overrides the previous two settings. If not set, MTA handles this automatically. Use with care.

backup_path

<backup_path>backups</backup_path>
This parameter specifies the path to use for a basic backup of some server files. Note that basic backups are only made during server startup. Default value: backups

backup_interval

<backup_interval>3</backup_interval>
This parameter specifies the number of days between each basic backup. Backups are only made during server startup, so the actual interval maybe much longer. Setting backup_interval to 0 will disable backups
Available range: 0 to 30. Default - 3

backup_copies

<backup_copies>5</backup_copies>
This parameter specifies the maximum number of backup copies to keep. Setting backup_copies to 0 will disable backups
Available range: 0 to 100. Default - 5

compact_internal_databases

<compact_internal_databases>1</compact_internal_databases>
This parameter specifies when the internal sqlite databases should be defragmented.
For more info see: http://www.sqlite.org/lang_vacuum.html
Values: 0 - Never, 1 - On server start only after basic backup, 2 - On server start always. Default - 1

crash_dump_upload

<crash_dump_upload></crash_dump_upload>
This parameter specifies whether server crash dump files should be sent to MTA HQ.
Values: 0 - Off, 1 - On. Default - 1

auth_serial_groups

<auth_serial_groups>Admin</auth_serial_groups>
This parameter lists the ACL groups that are protected by serial authorization.
Login attempts to a protected account from a second serial are blocked until the serial is manually authorized via the authserial command.
For more info see: https://mtasa.com/authserial
Values: Comma separated list of ACL groups. Default - Admin

auth_serial_http

<auth_serial_http>1</auth_serial_http>
This parameter specifies if the authorized serial login checks should also apply to the http interface.
Protected account login attempts to the http interface will only succeed if the IP address matches one recently used by the account holder in-game.
For more info see: https://mtasa.com/authserialhttp
Values: 0 - Off, 1 - Enabled. Default - 1

database_credentials_protection

<database_credentials_protection>1</database_credentials_protection>
This parameter specifies if extra security measures are applied to resources which use dbConnect with mysql.
The extra measures are:
- script files cannot be accessed with fileOpen( )
- meta.xml is read-only
NOTE: This only protects resources which use dbConnect with MySQL
Values: 0 - Off, 1 - Enabled. Default - 1

module

<!-- <module src="sample_win32.dll" /> -->
<!-- <module src="sample_linux.so" /> -->
Specifies the module(s) which are loaded with the server. To load several modules, add more <module> parameter(s). Optional parameter.

resource

<resource src="admin" startup="1" protected="0" />
<resource src="defaultstats" startup="1" protected="0" />
<resource src="helpmanager" startup="1" protected="0" />
<resource src="joinquit" startup="1" protected="0" />
<resource src="mapcycler" startup="1" protected="0" />
<resource src="mapmanager" startup="1" protected="0" />
<resource src="parachute" startup="1" protected="0" />
<resource src="resourcebrowser" startup="1" protected="1" default="true" />
<resource src="resourcemanager" startup="1" protected="1" />
<resource src="scoreboard" startup="1" protected="0" />
<resource src="spawnmanager" startup="1" protected="0" />
<resource src="voice" startup="1" protected="0" />
<resource src="votemanager" startup="1" protected="0" />
<resource src="webadmin" startup="1" protected="0" />
<resource src="play" startup="1" protected="0" />
Specifies persistent resources which are loaded when the server starts. Persistent resources are not stopped even if all the other resources that depend on them stop; that is, the only way to stop them is by explicitly using the stop server command or stopResource scripting function. To load several resources, add more <resource> parameters.
In addition, there are several flags which control how the server deals with each resource:
  • src: the resource name. This is the only mandatory flag.
  • startup: controls whether the resource will be started with the server or not. If "1", "true" or "yes", the resource will be started. If not specified, defaults to not starting the resource.
  • protected: if "1", "true" or "yes", the resource will not be able to be stopped when started. Otherwise, even if not specified, it will default to the normal behaviour.
  • default: if given a "1", "true" or "yes" value, this resource will be the one who populates the built-in HTTP server main page, which is seen when no resource is given in the web address. It is not possible to have more than one default resource.