RAGE Multiplayer Wiki - User contributions [en]

Server settings

2019-02-05T14:12:48Z

Brophy: /* Settings */

* '''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. 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
|-
| language|| gb|| Server's language
|-
| sync-rate|| 40|| This number indicates how many times per second the server has to synchronize its entities
|-
| 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
|-
| enable-nodejs || true || Enables NodeJS serverside
|-
| csharp || false|| 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. Otherwise they will download them directly from the server.
|}

== 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,
"streamdistance": 500.0
}
}
</syntaxhighlight>
[[Category:Reference]]

Server settings

2019-02-05T14:10:38Z

Brophy: /* Settings */

* '''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. 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
|-
| language|| gb|| Server's language
|-
| sync-rate|| 40|| This number indicates how many times per second the server has to synchronize its entities
|-
| 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
|-
| enable-nodejs || true || Enables NodeJS serverside
|-
| csharp || false|| 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 || || String URL, this parameter specifies the external URL from which clients will be able to download needed clientside packages. Otherwise they will download them directly from the server.
|}

== 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,
"streamdistance": 500.0
}
}
</syntaxhighlight>
[[Category:Reference]]

Ui::addTextComponentSubstringPlayerName

2018-02-12T16:30:24Z

Brophy:

� Description : Processes a string and removes the player name(max len 99) You can use this function to create notifications/subtitles -------------------------------------------------------------------- � Usage(Colors) : ~r~ = red ~y~ = yellow ~g~ = green ~b~ = light blue ~w~ = white ~p~ = purple ~n~ = new line -------------------------------------------------------------------- � Example (C++): void ShowNotification(char *text) { UI::_SET_NOTIFICATION_TEXT_ENTRY('STRING'); UI::ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text); UI::_DRAW_NOTIFICATION(FALSE, FALSE); // if first param = 1, the message flashes 1 or 2 times } � Colors example : string red = '~r~Red test'; string white_and_yellow = '~w~White and ~y~yellow'; string text_with_double_line = 'First line.~n~Second line'; You can also call fonts which are defined in: common/data/ui/'''[[Fontmap.xml|fontmap.xml]]''', along with 'html' style colours and font sizes, see example below This native (along with 0x5F68520888E69014 and 0x94CF4AC034C9C986) do not actually filter anything. They simply add the provided text (as of 944)
==Syntax==
<syntaxhighlight lang="javascript">mp.game.ui.addTextComponentSubstringPlayerName(text);</syntaxhighlight>
=== Required Arguments ===
*'''text:''' String
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
mp.game.ui.addTextComponentSubstringPlayerName(`font renders fine`);
</syntaxhighlight>
==See also==
{{Ui_s_function_c}}
[[Category:Clientside API]]
[[Category:UI API]]
[[Category:TODO: Example]]

Ui::addTextComponentSubstringPlayerName

2018-02-12T16:21:57Z

Brophy:

� Description : Processes a string and removes the player name(max len 99) You can use this function to create notifications/subtitles -------------------------------------------------------------------- � Usage(Colors) : ~r~ = red ~y~ = yellow ~g~ = green ~b~ = light blue ~w~ = white ~p~ = purple ~n~ = new line -------------------------------------------------------------------- � Example (C++): void ShowNotification(char *text) { UI::_SET_NOTIFICATION_TEXT_ENTRY('STRING'); UI::ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text); UI::_DRAW_NOTIFICATION(FALSE, FALSE); // if first param = 1, the message flashes 1 or 2 times } � Colors example : string red = '~r~Red test'; string white_and_yellow = '~w~White and ~y~yellow'; string text_with_double_line = 'First line.~n~Second line'; You can also call fonts which are defined in: common/data/ui/[[Fontmap.xml|fontmap.xml]], see example below This native (along with 0x5F68520888E69014 and 0x94CF4AC034C9C986) do not actually filter anything. They simply add the provided text (as of 944)
==Syntax==
<syntaxhighlight lang="javascript">mp.game.ui.addTextComponentSubstringPlayerName(text);</syntaxhighlight>
=== Required Arguments ===
*'''text:''' String
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
mp.game.ui.addTextComponentSubstringPlayerName(`font renders fine`);
</syntaxhighlight>
==See also==
{{Ui_s_function_c}}
[[Category:Clientside API]]
[[Category:UI API]]
[[Category:TODO: Example]]

Fontmap.xml

2018-02-12T16:20:09Z

Brophy: Default fontmap

Ui::addTextComponentSubstringPlayerName

2018-02-12T16:18:18Z

Brophy: Added example of usage with different fonts

� Description : Processes a string and removes the player name(max len 99) You can use this function to create notifications/subtitles -------------------------------------------------------------------- � Usage(Colors) : ~r~ = red ~y~ = yellow ~g~ = green ~b~ = light blue ~w~ = white ~p~ = purple ~n~ = new line -------------------------------------------------------------------- � Example (C++): void ShowNotification(char *text) { UI::_SET_NOTIFICATION_TEXT_ENTRY('STRING'); UI::ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text); UI::_DRAW_NOTIFICATION(FALSE, FALSE); // if first param = 1, the message flashes 1 or 2 times } � Colors example : string red = '~r~Red test'; string white_and_yellow = '~w~White and ~y~yellow'; string text_with_double_line = 'First line.~n~Second line'; You can also call fonts which are defined in: common/data/ui/fontmap.xml, see example below This native (along with 0x5F68520888E69014 and 0x94CF4AC034C9C986) do not actually filter anything. They simply add the provided text (as of 944)
==Syntax==
<syntaxhighlight lang="javascript">mp.game.ui.addTextComponentSubstringPlayerName(text);</syntaxhighlight>
=== Required Arguments ===
*'''text:''' String
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
mp.game.ui.addTextComponentSubstringPlayerName(`font renders fine`);
</syntaxhighlight>
==See also==
{{Ui_s_function_c}}
[[Category:Clientside API]]
[[Category:UI API]]
[[Category:TODO: Example]]