FiveM server icon, banner, tags and colours: improve your listing

Your server is online, but in the server list it is a plain name with a grey default icon. This guide covers the lines in server.cfg that control how your server looks in the listing and on the connecting screen: the icon, the banners, the coloured name, tags, locale and a Discord link.

#The server icon

load_server_icon myLogo.png

Put myLogo.png in your server data folder, the one that holds server.cfg, and give it exactly this shape:

• 96x96 pixels.
• PNG format.
• A simple, readable design. It is shown very small.

If the icon does not appear, check the file name and case (on Linux, Logo.png and logo.png are different files), the size and that the line is not commented out. The console prints a message if the file cannot be loaded.

#The name and description

sets sv_projectName "My Server"
sets sv_projectDesc "A friendly roleplay server, active staff, custom jobs"

sv_projectName is the name people see in the list, and sv_projectDesc is the short description under it. Keep the name short so it is not cut off on small screens. The sets form publishes the value in the listing, as opposed to set, which keeps it private.

#Colour codes

Colour codes start with ^ and a digit. The text after the code takes that colour until the next code:

sets sv_projectName "^1My ^5Server"

Common codes: ^1 red, ^2 green, ^3 yellow, ^4 blue, ^5 light blue, ^6 purple, ^7 white, ^8 dark red, ^9 pink, ^0 default white. Reset with ^0 or ^7. Two colours are enough; a rainbow name looks cheap and is hard to read.

Tip: if the colour looks wrong in the list but right in game, the listing may be showing a cached value. See "Why changes take time" below.

#Banners

sets banner_detail "https://example.com/banner-detail.png"
sets banner_connecting "https://example.com/banner-connecting.png"

• banner_detail is the image on your server's detail page in the list.
• banner_connecting is the image shown while a player is connecting.

Both take a URL to an image. The image must be hosted somewhere that stays online and serves it directly, without a login or a page around it. A Discord CDN link can expire or change, so a host you control is safer. Use a wide image, and keep the file reasonably small so it loads quickly.

If you also want your own loading screen once the player has joined, see custom loading screen.

#Tags and locale

sets tags "roleplay, esx, english, economy"
sets locale "en-US"

Tags are keywords, separated by commas, that players use to find a server in the list. Pick tags that describe the server truthfully: the framework, the type (roleplay, racing), the language. Do not stuff them with unrelated words, which only makes players leave.

locale is the language and region of the server, in the form en-US, fr-FR and so on.

#The Discord link

sets Discord "https://discord.gg/yourinvite"

sets lets you publish extra key and value pairs, and many servers use one for their Discord. Players see it in the server details. Use a permanent invite that never expires, because an expired link is worse than none.

#Why changes take time to show

You edited server.cfg, restarted, and the list still shows the old icon or name. That is normal, for three reasons:

1. The server reads its config at start. A change does nothing until you restart. Restart the server from txAdmin.
2. The listing is cached. The server sends its info to the Cfx.re listing regularly, and the listing keeps copies. It can take several minutes to update.
3. Your client caches it too. The FiveM client may keep an old copy of the server's details. If a few minutes pass and your own client still shows the old version, restart FiveM. If it is only your client that shows it, nothing is wrong with the server.

So after a change: restart the server, wait, and check from a different account or machine if you can. Do not keep editing in the meantime, since every restart restarts the waiting.

#A complete example

load_server_icon myLogo.png
sets sv_projectName "^5My ^7Server"
sets sv_projectDesc "A friendly roleplay server"
sets tags "roleplay, english"
sets locale "en-US"
sets Discord "https://discord.gg/yourinvite"
sets banner_detail "https://example.com/banner-detail.png"
sets banner_connecting "https://example.com/banner-connecting.png"

For the rest of the file, see server.cfg explained. If your server does not show up in the list at all, that is a different problem: server not showing: port forwarding.

#Checklist