RAGE Multiplayer Wiki - User contributions [en]

Server settings

2022-02-22T20:05:13Z

Nameless: Update sync rate description to be accurate

* '''conf.json -''' is a configuration file which allows you manage your server easily.

== Settings ==
The following table will explain the use of the following settings:

{| class="wikitable"
|-
! Setting !! Default value !! Description
|-
| announce || false || Announce to the master server so people can see you in their server browser.
|-
| bind|| 127.0.0.1 || The IP to listen to.
|-
| gamemode|| Freeroam || The server's gamemode. [[gamemodes|List of valid gamemodes]]
|-
| encryption|| false|| Whether the connection to the server will be encrypted or not.
|-
| maxplayers || 100 || Maximum number of players your server will hold.
|-
| name || RAGE:MP Unofficial server || Server name that will be displayed to the master server. Use [] for tags. Eg. "Beast [Serious Roleplay]"
|-
| stream-distance || 500.0 || The distance on the X,Y plane which server entities will stream in for connected players.
|-
| port || 22005 || The port that the server will use. The server uses both UDP and TCP protocols.<br/>The port after that one (''port + 1'', so 22006 by default) will be used for the HTTP server that hosts the client packages for the clients to download from.
|-
| disallow-multiple-connections-per-ip|| false|| Allows (false) or disallows (true) multiple players to connect from the same IP address
|-
| limit-time-of-connections-per-ip|| 0|| Maximum time a player can try to reconnect before getting timeout
|-
| url|| || Website URL. Must be a valid URL. Truncated to 20 characters in [https://rage.mp/masterlist RAGE:MP Master List Web] (shows fine in RAGE:MP client).
|-
| language|| us || Server's language (needs to be a string, example: "language": "us" will display the United States flag on your server's name)
|-
| sync-rate|| 40|| This number indicates the interval, in milliseconds, that the server has to synchronize its entities. 40 = 40ms
|-
| resource-scan-thread-limit|| || Indicates the maximum number of threads used for resource scanning
|-
| max-ping|| || Maximum Ping accepted for the server
|-
| min-fps|| || Minimum FPS required for the server
|-
| max-packet-loss|| || Maximum Packet loss accepted in the server
|-
| allow-cef-debugging || || Whether the client can (true) or not (false) debug the server's CEF pages
|-
| nodejs || true || Enables NodeJS serverside
|-
| csharp || disabled|| If your server will be using the C# bridge plugin set it to true, else don't add this line
|-
| enable-http-security|| false|| When set to true, enables an extra security layer to avoid the server being flooded by fake HTTP requests
|
|-
| voice-chat || || boolean true / false
|
|-
| allow-voice-chat-input || || (only available via registry at the moment); default value: 1
|
|-
| voice-chat-sample-rate || || allowed values are 8000, 16000, 24000, 48000
|-
| fastdl-host || || String URL, this parameter specifies the external URL from which clients will be able to download needed clientside packages.<br />Otherwise they will download them directly from the server.
|-
| server-side-weapons-only-mode || true || boolean true / false, if it's set to true, clientside created wont be synced only if they got created serverside (available with RAGE 1.1+)
|-
| api-threading-debugging || false || If set to true, it'll report every single usage of the API out of proper thread. Use it only for debugging since it adds some CPU overhead. (available with RAGE 1.1+)
|-
| fqdn || || string, e.g. "fqdn": "game-srv.rage.mp". Thanks to this option your players won't notice any server IP change, including the re-utilisation of downloaded packages.
|-
| resources-compression-level || 1 || Use 0 for local server, or a higher value for bandwidth optimisation. -9 for fast compression (available with RAGE 1.1+)
|-
| node-commandline-flags || || e.g. "node-commandline-flags": "--inspect" (available with RAGE 1.1+)
|-
| synchronization-extrapolation-multiplier || 0.0 || enables vehicle synchronization prediction disabling possible latency offset (available with RAGE 1.1+, enabled by default with 1.0 value in 0.3.7)
|-
| http-threads || 50 || Specifies how many concurrent connections will be handled at the same time, the rest will be queued (Increasing this number will increase bandwidth usage)
|-
| trigger-compression-logging || false || Log compression rates of all outgoing client event triggers with the dictionary the server has been initialized with (available with RAGE 1.1+)
|-
| trigger-compression-training || false || Dictionary training, takes data from all of your triggers and flushes it to the file specified at "trigger-compression-dictionary" at every 20th trigger. TIP: You can train it without joining using "mp.players.call" (available with RAGE 1.1+)
|-
| trigger-compression-dictionary || || File to load/save compression dictionary (available with RAGE 1.1+)
|
|-
| create-fastdl-snapshot || false || Generates client packages files to a folder to be downloadable and used with FastDL
|-
| disable-client-packages-ram-cache || false || Doesn't cache resources in memory (for only un-encrypted files with DISABLE_ENCRYPTION_LIST file) and instead streams it from storage
|-
| client-packages-shared-folder || || Enables you to use the same client resources across different servers (i guess) (FQDN must be a subdomain of shared folder name, e.g. foo.domain.com, bar.domain.com => domain.com)
|}

== Sample file ==

This is an example of '''conf.json''':

<syntaxhighlight lang="javascript">
{
"announce": false,
"bind": "127.0.0.1",
"gamemode": "freeroam",
"name": "RAGE:MP Unofficial server [Tag]",
"maxplayers": 100,
"port": 22005,
"stream-distance": 500.0
}
</syntaxhighlight>
[[Category:Reference]]

Vehicle::setHandling

2020-08-29T16:14:52Z

Nameless:

You can find all list of the types here: https://forums.gta5-mods.com/topic/3842/tutorial-handling-meta

==Notes==
'''setHandling''' does not use the exact values from '''handling.meta''' for certain fields, these are as follows:

*'''fInitialDriveMaxFlatVel''' - handling.meta value / 3.6

*'''fBrakeBiasFront''' - handling.meta value * 2

*'''fSteeringLock''' - handling.meta value * 0.017453292

*'''fTractionCurveLateral''' - handling.meta value * 0.017453292

*'''fTractionBiasFront''' - handling.meta value * 2

*'''fSuspensionCompDamp''' - handling.meta value / 10

*'''fSuspensionReboundDamp''' - handling.meta value / 10

*'''fSuspensionBiasFront''' - handling.meta value * 2

*'''fAntiRollBarBiasFront''' - handling.meta value * 2

==Syntax==
<syntaxhighlight lang="javascript">vehicle.setHandling(type, value);</syntaxhighlight>
=== Required Arguments ===
*'''type:''' string
*'''value:''' number/string
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
if (mp.players.local.vehicle) {
mp.players.local.vehicle.setHandling("fMass", 3500);
mp.players.local.vehicle.setHandling("fInitialDragCoeff", 4.77);
}
</syntaxhighlight>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::setHandling

2020-08-29T16:14:39Z

Nameless: Add missing property

You can find all list of the types here: https://forums.gta5-mods.com/topic/3842/tutorial-handling-meta

==Notes==
'''setHandling''' does not use the exact values from '''handling.meta''' for certain fields, these are as follows:

*'''fInitialDriveMaxFlatVel''' - handling.meta value / 3.6

*'''fBrakeBiasFront''' - handling.meta value * 2

*'''fSteeringLock''' - handling.meta value * 0.017453292

*'''fTractionCurveLateral''' - handling.meta value * fTractionCurveLateral

*'''fTractionBiasFront''' - handling.meta value * 2

*'''fSuspensionCompDamp''' - handling.meta value / 10

*'''fSuspensionReboundDamp''' - handling.meta value / 10

*'''fSuspensionBiasFront''' - handling.meta value * 2

*'''fAntiRollBarBiasFront''' - handling.meta value * 2

==Syntax==
<syntaxhighlight lang="javascript">vehicle.setHandling(type, value);</syntaxhighlight>
=== Required Arguments ===
*'''type:''' string
*'''value:''' number/string
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
if (mp.players.local.vehicle) {
mp.players.local.vehicle.setHandling("fMass", 3500);
mp.players.local.vehicle.setHandling("fInitialDragCoeff", 4.77);
}
</syntaxhighlight>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::setHandling

2020-08-29T16:13:13Z

Nameless: Add information on certain handling.meta properties requiring some modification to work correctly as they do not directly map

You can find all list of the types here: https://forums.gta5-mods.com/topic/3842/tutorial-handling-meta

==Notes==
'''setHandling''' does not use the exact values from '''handling.meta''' for certain fields, these are as follows:

*'''fInitialDriveMaxFlatVel''' - handling.meta value / 3.6

*'''fBrakeBiasFront''' - handling.meta value * 2

*'''fSteeringLock''' - handling.meta value * 0.017453292

*'''fTractionBiasFront''' - handling.meta value * 2

*'''fSuspensionCompDamp''' - handling.meta value / 10

*'''fSuspensionReboundDamp''' - handling.meta value / 10

*'''fSuspensionBiasFront''' - handling.meta value * 2

*'''fAntiRollBarBiasFront''' - handling.meta value * 2

==Syntax==
<syntaxhighlight lang="javascript">vehicle.setHandling(type, value);</syntaxhighlight>
=== Required Arguments ===
*'''type:''' string
*'''value:''' number/string
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
if (mp.players.local.vehicle) {
mp.players.local.vehicle.setHandling("fMass", 3500);
mp.players.local.vehicle.setHandling("fInitialDragCoeff", 4.77);
}
</syntaxhighlight>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Object::notifyStreaming

2020-06-21T15:59:48Z

Nameless: server side property

This property, if true, will call [[EntityStreamIn|EntityStreamIn]] for the Object.

'''Default:''' false

==Setter==
* {{RageType|Boolean}}

== Example ==

{{ServersideCode|
<pre>
const object = mp.objects.new('prop_cs_box_clothes', new mp.Vector3(500, 500, 500)); // Untested inside Options
object.notifyStreaming = true;
</pre>
}}

==See Also==
{{Object_definition_c}}

[[Category:Object API]]
[[Category:Server-side Property]]

Object::notifyStreaming

2020-06-21T15:58:30Z

Nameless: /* Example */ server side

Object::notifyStreaming

2020-06-21T15:56:20Z

Nameless: Update link

This property, if true, will call [[EntityStreamIn|EntityStreamIn]] for the Object.

'''Default:''' false

==Setter==
* {{RageType|Boolean}}

== Example ==

{{ClientsideCode|
<pre>
const object = mp.objects.new('prop_cs_box_clothes', new mp.Vector3(500, 500, 500)); // Untested inside Options
object.notifyStreaming = true;
</pre>
}}

==See Also==
{{Object_definition_c}}

[[Category:Object API]]
[[Category:Client-side Property]]

Object::notifyStreaming

2020-06-21T15:55:12Z

Nameless: Added property default

This property, if true, will call https://wiki.rage.mp/index.php?title=EntityStreamIn for the Object.

'''Default:''' false

==Setter==
* {{RageType|Boolean}}

== Example ==

{{ClientsideCode|
<pre>
const object = mp.objects.new('prop_cs_box_clothes', new mp.Vector3(500, 500, 500)); // Untested inside Options
object.notifyStreaming = true;
</pre>
}}

==See Also==
{{Object_definition_c}}

[[Category:Object API]]
[[Category:Client-side Property]]

Object::notifyStreaming

2020-06-21T15:52:38Z

Nameless: Added this properties page after notification of it existing and what it does in the Discord

This property, if true, will call https://wiki.rage.mp/index.php?title=EntityStreamIn for the Object.

==Setter==
* {{RageType|Boolean}}

== Example ==

{{ClientsideCode|
<pre>
const object = mp.objects.new('prop_cs_box_clothes', new mp.Vector3(500, 500, 500)); // Untested inside Options
object.notifyStreaming = true;
</pre>
}}

==See Also==
{{Object_definition_c}}

[[Category:Object API]]
[[Category:Client-side Property]]