RAGE Multiplayer Wiki - User contributions [en]

Getting Started with Development

2018-03-31T15:18:50Z

Myonlake: /* Requirements */

__TOC__
== Requirements ==

* [https://cdn.rage.mp/client/updater.exe Rage MP updater]
* Basic JS/NodeJS programming knowledge

== Introduction ==

Today we are going to show you how you can start developing your own server with a simple Tutorial. We will show you how you can create your own resource and run it in your server.

== Starting the server ==

When downloading the [https://cdn.rage.mp/client/updater.exe Rage MP updater] and running it, you'll get the server files. The folder name will be called <code>server-files</code>. When you open the folder you'll find this:

<gallery widths=800px heights=426px>
File:server-files.png
</gallery>

*'''client_packages''': Folder in which client-side scripts reside. (Client-side allows you to draw GUI or do [https://bitbucket.org/chromiumembedded/cef CEF] work)
*'''packages''': Folder in which server-side scripts reside. (Server-side allows you to manage the player and create your own world)
*'''maps''': Allows you to load maps into the game world in JSON format.
*'''plugins''': Allows you to load custom '''dll''' plugins into the game.
*'''conf.json''': Contains the server configuration in JSON format. Read more about server settings [[Server_settings|here]].
*'''server.exe''': Server executable, which if you run starts the game server.

Currently you'll find your folders empty, so if you want to load a gamemode, there is a [https://github.com/n-n1ks/rage.mp-freeroam freeroam gamemode] available to study/use on your server.

== Creating your first resource ==

Rage Multiplayer Consists of 2 sides of scripting, '''Client-side''' and '''Server-side''', so as mentioned up '''Client-side''' allows you create and develop UI and show people your creativity, and '''Server-side''' allows you to manage the server itself with its things like managing players, vehicles, and markers etc.

Today we will create our first server-side resource, and will see how it works ingame.

First of all go to <code>packages</code> and create a folder if you haven't already, then in your server folder then create <code>index.js</code> file if you don't have one. After that you open the file and do

<syntaxhighlight lang="javascript">
//init Commands file
require('./commands.js')
</syntaxhighlight>

After that save and close. Now create another file called <code>commands.js</code> and open it.

Add those simple commands to your file.

<syntaxhighlight lang="javascript">
mp.events.addCommand('kill', (player) => {
player.health = 0;
});

mp.events.addCommand('hp', (player) => {
player.health = 100;
});

mp.events.addCommand('armor', (player) => {
player.armour = 100;
});
</syntaxhighlight>

if you don't understand those please proceed to [[Getting Started with Commands|Getting started with commands]]. Now we have created a simple source with 3 basic commands. One that gives Health, one that gives armor, and one that kills you.

Now save the file and close it. Have you wondered anything wrong with the code up there? If no let me give you a hint. If you trigger the command kill this means it will kill the player, but will you re-spawn back? I have the solution for you!.

create a '''JSON''' file and name it <code>spawn_points.json</code> and then add the following code:

<syntaxhighlight lang="json">
{
"SpawnPoints": [
{ "x": -425.517, "y": 1123.620, "z": 325.8544 },
{ "x": -415.777, "y": 1168.791, "z": 325.854 },
{ "x": -432.534, "y": 1157.461, "z": 325.854 },
{ "x": -401.850, "y": 1149.482, "z": 325.854 }
]
}
</syntaxhighlight>

done? now save it and close.

Create a new file called <code>events.js</code> and add the following code:

<syntaxhighlight lang="javascript">

let spawnPoints = require('./spawn_points.json').SpawnPoints;

mp.events.add('playerDeath', (player) => {
player.spawn(spawnPoints[Math.floor(Math.random() * spawnPoints.length)]);
player.health = 100;
});
</syntaxhighlight>

We have defined our spawn points that we want the player to spawn in, and then we added a event which when the player dies it spawns the player in random location from the spawn points you defined, and also don't forget to make his health 100 again or the player can teleport while dead to the spawn point and crashes might happen.

'''IMPORTANT''': Don't forget to require the <code>events.js</code> in the <code>index.js</code>

Your <code>index.js</code> file should be like this:

<syntaxhighlight lang="javascript">
//init Commands file
require('./commands.js')

//init Events file
require('./events.js')
</syntaxhighlight>

Now save and everything and launch your server from <code>server.exe</code> and go test what you just did!.

I hope you enjoyed creating your first script in RAGE:MP and we will be sure to create further tutorials for you to learn more.
Happy Gaming!

Getting Started with Development

2018-03-31T15:18:30Z

Myonlake: /* Starting the server */

__TOC__
== Requirements ==

* [https://cdn.rage.mp/client/updater.exe Ragemp Updater]
* Basic JS/NodeJS programming knowledge

== Introduction ==

Today we are going to show you how you can start developing your own server with a simple Tutorial. We will show you how you can create your own resource and run it in your server.

== Starting the server ==

When downloading the [https://cdn.rage.mp/client/updater.exe Rage MP updater] and running it, you'll get the server files. The folder name will be called <code>server-files</code>. When you open the folder you'll find this:

<gallery widths=800px heights=426px>
File:server-files.png
</gallery>

*'''client_packages''': Folder in which client-side scripts reside. (Client-side allows you to draw GUI or do [https://bitbucket.org/chromiumembedded/cef CEF] work)
*'''packages''': Folder in which server-side scripts reside. (Server-side allows you to manage the player and create your own world)
*'''maps''': Allows you to load maps into the game world in JSON format.
*'''plugins''': Allows you to load custom '''dll''' plugins into the game.
*'''conf.json''': Contains the server configuration in JSON format. Read more about server settings [[Server_settings|here]].
*'''server.exe''': Server executable, which if you run starts the game server.

Currently you'll find your folders empty, so if you want to load a gamemode, there is a [https://github.com/n-n1ks/rage.mp-freeroam freeroam gamemode] available to study/use on your server.

== Creating your first resource ==

Rage Multiplayer Consists of 2 sides of scripting, '''Client-side''' and '''Server-side''', so as mentioned up '''Client-side''' allows you create and develop UI and show people your creativity, and '''Server-side''' allows you to manage the server itself with its things like managing players, vehicles, and markers etc.

Today we will create our first server-side resource, and will see how it works ingame.

First of all go to <code>packages</code> and create a folder if you haven't already, then in your server folder then create <code>index.js</code> file if you don't have one. After that you open the file and do

<syntaxhighlight lang="javascript">
//init Commands file
require('./commands.js')
</syntaxhighlight>

After that save and close. Now create another file called <code>commands.js</code> and open it.

Add those simple commands to your file.

<syntaxhighlight lang="javascript">
mp.events.addCommand('kill', (player) => {
player.health = 0;
});

mp.events.addCommand('hp', (player) => {
player.health = 100;
});

mp.events.addCommand('armor', (player) => {
player.armour = 100;
});
</syntaxhighlight>

if you don't understand those please proceed to [[Getting Started with Commands|Getting started with commands]]. Now we have created a simple source with 3 basic commands. One that gives Health, one that gives armor, and one that kills you.

Now save the file and close it. Have you wondered anything wrong with the code up there? If no let me give you a hint. If you trigger the command kill this means it will kill the player, but will you re-spawn back? I have the solution for you!.

create a '''JSON''' file and name it <code>spawn_points.json</code> and then add the following code:

<syntaxhighlight lang="json">
{
"SpawnPoints": [
{ "x": -425.517, "y": 1123.620, "z": 325.8544 },
{ "x": -415.777, "y": 1168.791, "z": 325.854 },
{ "x": -432.534, "y": 1157.461, "z": 325.854 },
{ "x": -401.850, "y": 1149.482, "z": 325.854 }
]
}
</syntaxhighlight>

done? now save it and close.

Create a new file called <code>events.js</code> and add the following code:

<syntaxhighlight lang="javascript">

let spawnPoints = require('./spawn_points.json').SpawnPoints;

mp.events.add('playerDeath', (player) => {
player.spawn(spawnPoints[Math.floor(Math.random() * spawnPoints.length)]);
player.health = 100;
});
</syntaxhighlight>

We have defined our spawn points that we want the player to spawn in, and then we added a event which when the player dies it spawns the player in random location from the spawn points you defined, and also don't forget to make his health 100 again or the player can teleport while dead to the spawn point and crashes might happen.

'''IMPORTANT''': Don't forget to require the <code>events.js</code> in the <code>index.js</code>

Your <code>index.js</code> file should be like this:

<syntaxhighlight lang="javascript">
//init Commands file
require('./commands.js')

//init Events file
require('./events.js')
</syntaxhighlight>

Now save and everything and launch your server from <code>server.exe</code> and go test what you just did!.

I hope you enjoyed creating your first script in RAGE:MP and we will be sure to create further tutorials for you to learn more.
Happy Gaming!

Server settings

2018-03-31T15:10:35Z

Myonlake: /* Sample file */

* '''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.
|-
| encryption|| false|| ...
|-
| 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.
|-
| 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|| ...
|-
| limit-time-of-connections-per-ip|| 0|| ...
|-
| url|| || Website URL.
|-
| language|| en|| Server's language
|-
| sync-rate|| 40|| ...
|-
| resource-scan-thread-limit|| || ...
|-
| 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
|-
| min-game-version|| || Accepted Game version for the server (Example: 1.41)
|-
| allow-cef-debugging || || ...
|-
| csharp || false|| C# state
|}

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