RedM: Customise server details
This guide was created with the following products:
(Details may vary with products from different providers but the main concepts remain the same)
Introduction
Are you looking to customise your server to display custom information in the server list? This can be done easily! In this guide you will learn how to set a range of different customisations that are available to make your server stand out in the server list!
Accessing your server's configuration
There are multiple ways available to access your server.cfg configuration file for your RedM game server. Editing this file is needed in order to allow you to set customisations.
- Via Webinterface
- Via WI Config file
- Via FTP
The most user-friendly method is by heading over to the Settings section on your game server's webinterface and searching for the appropriate settings there, as seen below:
Alternatively, for users who wish to directly edit the raw file, you can access this by heading over to the Configs section on your game server's webinterface and pressing the blue edit file button, as seen below:
This will open up a text editor directly on the site to enable you to edit it.
The final method of accessing the raw file, is through FTP. If you are not familiar with using FTP, we recommend you to have a look at the Access via FTP guide. However, this method takes longer and if you wish to directly edit the file contents, we recommend simply using the Configs section on your game server's webinterface as mentioned.
Custom Server Name
Color Codes
There are a range of colors that you can add to your server name. These can be specified through the use of a prefix when wanting to change color. The list of colours that are available can be viewed in the table below.
In order to use colours in your server name, you must have a valid FiveM Patreon tier which has the benefit. If you do but it still doesn't work, ensure that you have set a Own License Key.
Now you can change your server's name, through one of the three methods described in the accessing configuration section. Here is an example of using colors and the outcome they produce:
sv_hostname "^2ZAP-Hosting ^0| ^4Official Community Server ^0- ^1Events coming ^8soon^1!"
Colour Codes Table
| Code | Color | Hex Code |
|---|---|---|
| ^0 | White | #F0F0F0 |
| ^1 | Red | #F44336 |
| ^2 | Green | #4CAF50 |
| ^3 | Yellow | #FFEB3B |
| ^4 | Blue | #42A5F5 |
| ^5 | Light Blue | #03A9F4 |
| ^6 | Purple | #9C27B0 |
| ^7 | White | #F0F0F0 |
| ^8 | Orange | #FF5722 |
| ^9 | Grey | #9E9E9E |
Emojis
RedM also allows you to place emojis directly into your server name.
Simply place any emojis you wish into the sv_hostname parameter within your server configuration and it will work. You do not need a RedM Patreon tier for this.
Here is an example of adding emojis via your game server's webinterface:
Likewise, you can add this directly to your server.cfg file via FTP or the Configs section on your game server's webinterface.
Setting Project Details
Server Description
Setting a server description is useful for providing a short and to the point overview of your server.You can easily set a small project server description for your RedM game server, which will display besides your server name on the server list.
Here is an example of setting a project name and the outcome it produces:
sets sv_projectDesc "Join our Discord to stay updated on latest events! discord.gg/zaphosting"
Server Tags
Setting server tags can be beneficial to narrowing down what your server is about, and allow potential players to view your server when filtering out servers based on their likings. Once you set tags, these will be visible on your server's server list page and will also be used to filter your server.
Here is an example of setting project tags and the outcome it produces:
sets tags "zap, zap-hosting, official, community, zap-community, zap-community-server"
Other Misc. Details
You can also change a few miscellaneous server details to your liking.
Gametype
Setting the gametype parameter changes what is displayed on your server's server list page. This does not change the gamemode on the server itself.
You can change the gametype through your game server's webinterface, or by setting a tag:
sets gametype "Freeroam"
Language
Finally, you can change the language of your server which is displayed on your server's server list page. We have a dedicated guide for setting localisation which you can view here: Language / location (flag).
This can be done through your game server's webinterface, or by setting a tag:
sets locale "en-GB"
You can get a list of all locale tags by viewing this resource or anything similar.
You have successfully customised your RedM game server!