RAGE Multiplayer Wiki - User contributions [en]

Getting Started with Client-side

2018-12-22T07:44:26Z

Threshold: Minor grammatical fixes.

__TOC__

== Introduction ==

Client-side is the side where you have better control over a single player and provides you access to more information about the game world, but less information about the other players. You can use client-side to create '''GUI''' (Graphical User Interface), visual effects, and much more.

== Using Client-side ==

Client-side has a different pattern than server-side. Requiring the files are a bit different, and you can't use '''NPM Packages''' like server-side. Client-side's requiring files system needs to start from the root folder until the file you want to require. Let us give you a little example of the structure of client-side.

*Go to the client_packages '''folder''' inside your server-files and create a new file called '''index.js'''.
*Create a folder and name it whatever you want, let's say '''gamemode'''.
* Now your structure should be like this:
<gallery widths=600px heights=77px>
File:Client_struct_1.png
</gallery>
*Edit your '''index.js''' and add <code>require('./gamemode/index');</code> or <code>require('./gamemode');</code>
*Open your gamemode folder and create a new file called '''index.js'''.
*In the file, add any test script you want and it should work once you enter the game. For example, add <code>mp.gui.chat.push('Hello World')</code>. You should get the message once you join the server.

== Create your first client-side resource ==

As we learned how the structure works in the previous section, now we'll create our first resource to show how client-side actually works. '''Remember''' the index we added inside the '''gamemode''' folder, it's the first file that triggered when you completely download your files, so now we'll create a simple resource which sets your discord rich presence into a custom made message.

*Create a folder called modules (optional) inside your '''gamemode''' folder.
*Create a file called '''discord.js'''
*Add the following code:
<pre>
//We registered an event to the client side's events tree which sets discord status.
mp.events.add('setDiscordStatus', (serverName, status) => {
mp.discord.update(serverName, status)
});
</pre>
*Go back to your '''index.js''' inside the '''gamemode''' folder and add <code>require('./gamemode/modules/discord');</code>. Like that you required the discord module once you join/download the server. It's always necessary to add the '''rootFolder''' in your required file-path to get the file, it's not like server-side where you can just do <code>require('./modules/discord');</code>.
*Now in your '''index.js''', add <code>mp.events.call('setDiscordStatus', 'Playing on Freeroam', 'Playing as Ronald McDonald')</code>. If you're new to the events system, check '''[[Getting Started with Events|Getting Started with Events tutorial]]'''.
*If you want autocomplete, check '''[[Getting Started with Development|Getting Started with Development tutorial]]'''.
*Your code structure should be like this:

<gallery widths=776px heights=133px>
File:Client_struct_2.png
</gallery>
*Now join the server and check your discord status. It should look like this:
<gallery widths=250px heights=100px>
File:UpdatedRichPresence.jpg
</gallery>

You have accomplished your first resource. Now go create your own resources/servers and share your work with the community.

Getting Started with Development

2018-12-22T07:38:28Z

Threshold: Minor grammatical fixes.

__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.

== Setting up API autocomplete ==

Autocompletion is one of the most important features a developer can use while developing. It's annoying to keep searching in the wiki for the right syntax or find the right function you want. Thanks to '''CocaColaBear''' for his great contribution in creating an autocompletion package for RAGE JS API.

*[https://github.com/CocaColaBear/types-ragemp-s autocomplete SERVER]
*[https://github.com/CocaColaBear/types-ragemp-c autocomplete CLIENT]

=== Installation ===
*Open your terminal and navigate to your server's folder.
*Install the following Node packages:
**<code>npm install --save-dev github:CocaColaBear/types-ragemp-s#master</code>
**<code>npm install --save-dev github:CocaColaBear/types-ragemp-c#master</code> or <code>npm install --save-dev https://github.com/CocaColaBear/types-ragemp-c/tarball/master</code>
*You should now get autocomplete.
*Follow our next title to find out how the environment works and you'll notice that autocomplete is working.

== Creating your first resource ==

<b>Rage Multiplayer</b> consists of 2 sides of scripting, '''Client-side''' and '''Server-side'''. So as mentioned above, '''Client-side''' allows you to create and develop UI and show people your creativity, while '''Server-side''' allows you to manage the server itself with 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. (Call it anything you want) Then in your server folder, create an <code>index.js</code> file. After that, open the file and write the following:

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

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

Add these 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 these, 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 noticed anything wrong with the code we just wrote? If not, let me give you a hint. If you trigger the kill command, 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 an event for when the player dies. When this event is triggered, they re-spawn in a random location from the spawn points you defined. Also don't forget to make the player's health 100 again or they can teleport while dead to the spawn point.

'''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 everything and launch your server and go test what you just wrote!

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!

[[Category:Tutorials]]

Getting Started with Server

2018-12-22T07:27:57Z

Threshold: Minor grammatical fixes.

== Introduction ==

This brief tutorial will show you how to run your server on both Windows and Linux distributions.

By default, the server makes use of port 22005 UDP for server access and the port after (here 22006) for the HTTP server hosting the client packages for the clients to download from.<br>
So make sure to have done the ports forwarding on your router process and have also unblocked the ports on your firewall before running the server.

=Bridge=
The following tutorial is found on [https://wiki.gtanet.work/index.php?title=Setting_up_the_Bridge_on_Linux/Windows Setting up the Bridge on Linux/Windows].

=Windows=
==Prerequisite==
For a hassle-free installation and operation, it is recommended to have the latest VC Redist.

[https://aka.ms/vs/15/release/VC_redist.x64.exe Microsoft Visual C++ Redistributable 2017]

==Setting up the server==
1. Download the latest [https://cdn.rage.mp/client/updater.exe updater.exe].

2. Run the downloaded '''updater.exe'''.

3. Launch '''server.exe''' and you should be able to connect to it.

=Linux=
==Prerequisite==
===Ubuntu===
<syntaxhighlight lang="bash">
sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt-get update
sudo apt-get install libstdc++6
</syntaxhighlight>

===Debian===
<syntaxhighlight lang="bash">
echo 'deb http://httpredir.debian.org/debian testing main contrib non-free' > /etc/apt/sources.list
apt-get update
apt-get install -y -t testing gcc
</syntaxhighlight>

==Setting up server==
This bash snippet should automate the server installation.
<syntaxhighlight lang="bash">
# Downloading server
wget https://cdn.rage.mp/lin/ragemp-srv-036.tar.gz

# Extract the server files
tar -xzf ragemp-srv-036.tar.gz

# Accessing the directory
cd ragemp-srv

# Set executable permission
chmod +x server

# Run the server
./server

</syntaxhighlight>

==Installing screen (Optional)==
For running the server in the background, we recommend using screen, mainly for its ease of use.

===Debian based (Ubuntu & derivatives)===
<syntaxhighlight lang="bash">
sudo apt-get install screen
</syntaxhighlight>

===CentOS 6.x/7.x===
<syntaxhighlight lang="bash">
yum install screen
</syntaxhighlight>

===Starting the server===
<syntaxhighlight lang="bash">
screen -dmS GTASERVER -L bash -c 'cd ~/srv && ./server' &

# Parameter explanation
# screen -dmS = starts a separate shell without directly opening an interface towards it (detached mode). The S param defines a session name for the newly created session, so that it is easier to manage in the future.
# screen -L = basically logs whatever error that is shown by the server through the separate shell into a file for easier reference in the future.
# !IMPORTANT!
# Log output will be saved as screenlog._number_ in the server directory.
# &: IS IMPORTANT IF YOU WANT TO TERMINATE THE PROCESS GRACEFULLY
</syntaxhighlight>

===Stopping the server===
There's usually two ways to stop the server; One that we call a '''graceful''' shutdown that sends the server a signal for termination and the other, well, a '''crash''' since it does not allow the code to run through the termination process correctly.

'''RECOMMENDED:'''
<syntaxhighlight lang="bash">
kill $(ps h --ppid $(screen -ls | grep GTASERVER | cut -d. -f1) -o pid)
</syntaxhighlight>

'''NOT RECOMMENDED:''' It does not shut down the server gracefully
<syntaxhighlight lang="bash">
screen -S GTASERVER -X quit
</syntaxhighlight>

=Troubleshooting=
==Linux==
<syntaxhighlight lang="bash">
./server: /usr/lib/x86_64-linux-gnu/libstdc++.so.6: version `GLIBCXX_3.4.22' not found (required by ./server)
</syntaxhighlight>

Make sure GCC/G++ 6 or newer is installed, follow the [[Getting_Started_with_Server#Prerequisite|Prerequisite]].

[[Category:Tutorials]]