RAGE Multiplayer Wiki - User contributions [en]

Getting Started with Server

2018-01-27T18:25:29Z

Austin: /* Windows */

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

=Windows=
'''Basic Instructions:'''

1. Download the latest [https://cdn.rage.mp/client/updater.exe CLIENT]

2. After you run the updater, it will have created a '''server-files''' folder.

3. Launch '''server.exe''' and you're good to go.

Your NodeJS packages and modes go in <code>packages/yourgamemodename</code>. Your client code goes in <code>client_packages</code>.

You can edit your '''conf.json''' to setup which package you're going to use and the basic server settings.

== Troubleshooting ==

Verify the following requirements are installed:

'''.NET Core 2.0''': [https://www.microsoft.com/net/download/windows Download page for .NET]. '''Select Runtime'''.

'''VC2017''': [https://aka.ms/vs/15/release/VC_redist.x64.exe Visual C++ 2017 Redist]

=Linux=

==Installing GCC 6==
===Debian, Ubuntu, and derivatives===

====Ubuntu 16.04.x and older====

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

==Installing the server==

<syntaxhighlight lang="bash">
# Downloading server
cd /tmp
wget https://cdn.rage.mp/lin/ragemp-srv.tar.gz
# Extract the server files
tar -xzf ragemp-srv.tar.gz
mv ragemp-srv ~/ragemp-srv
# Run the server
cd ~/ragemp-srv
chmod +x server
./server

# Firewall commands (iptables only) (dont forget to save the rule after adding it)
iptables -A INPUT -p udp --dport 22005 -j ACCEPT
iptables -A INPUT -p tcp --dport 22006 -j ACCEPT

</syntaxhighlight>

==Setting up==
===Installing screen===
For running the server in 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===
To stop the server, there's usually two ways to do that, 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 ==

Vehicle::setColorRGB

2017-09-23T17:36:36Z

Austin:

This function used for set vehicle RGB body color.

==Syntax==
<syntaxhighlight lang="javascript">
void vehicle.setColourRGB(int r1, int g1, int b1, int r2, int g2, int b2);
</syntaxhighlight>

===Required Arguments===
*'''r1:''' Primary red color in diapason 0 - 255.
*'''g1:''' Primary green color in diapason 0 - 255.
*'''b1:''' Primary blue color in diapason 0 - 255.
*'''r2:''' Secondary red color in diapason 0 - 255.
*'''g2:''' Secondary green color in diapason 0 - 255.
*'''b2:''' Secondary blue color in diapason 0 - 255.

==Example==
no example, ez

<syntaxhighlight lang="javascript">
//todo
</syntaxhighlight>

==See Also==
{{Vehicle_block}}

Vehicle::getColorRGB

2017-09-23T17:36:08Z

Austin: Created page with "This function used to get the vehicle RGB body color. '''Returns null if never set explicitly'''. ==Syntax== <syntaxhighlight lang="javascript"> Array vehicle.getColourRGB(in..."

This function used to get the vehicle RGB body color. '''Returns null if never set explicitly'''.

==Syntax==
<syntaxhighlight lang="javascript">
Array vehicle.getColourRGB(int slot);
</syntaxhighlight>

===Required Arguments===
*'''slot:''' The color you want to get. (valid is 0 or 1)

==Example==
<syntaxhighlight lang="javascript">
let primaryColor = vehicle.getColourRGB(0);
let secondaryColor = vehicle.getColourRGB(1);
// primaryColor output: [ 255, 0, 0 ]
</syntaxhighlight>

==See Also==
{{Vehicle_block}}

Vehicle::setColorRGB

2017-09-23T17:34:52Z

Austin:

Vehicle::setColorRGB

2017-09-23T17:31:13Z

Austin:

This function used to get the vehicle RGB body color.

==Syntax==
<syntaxhighlight lang="javascript">
Object vehicle.getColourRGB(int slot);
</syntaxhighlight>

===Required Arguments===
*'''slot:''' The color you want to get. (valid is 0 or 1)

==Example==
<syntaxhighlight lang="javascript">
let primaryColor = vehicle.getColourRGB(0);
let secondaryColor = vehicle.getColourRGB(1);
</syntaxhighlight>

==See Also==
{{Vehicle_block}}