Getting started with FiveM

Before you start#

FiveM needs a free server key from the Cfx.re portal. The setup guide asks for it when you create your server. It also lets you choose between txAdmin, which we recommend, and a plain server.

With txAdmin you can pick a starting template such as QBCore, Qbox, ESX, a basic server or vMenu. You also choose your txAdmin username and password.

Connect#

Copy the address from the Connect card on the Overview page. In FiveM, press F8 and run:

connect your-address:port

Your server can also be found in the in-game server list, but this can take time.

Use txAdmin#

The txAdmin link is under your server address on the Overview page. Log in with the details you chose during setup. If txAdmin asks for a PIN, it is printed in the Console when the server starts.

Add resources#

Resources are FiveM's mods.

1. Upload the resource folder to resources on the Files page. On a txAdmin template this is inside txData/<Name>_<ID>.base/. On a plain server it is in the top folder.
2. Add ensure resource_name to the server.cfg in the same place.
3. Restart the server. The Console will name any missing dependency.

Your template's database is already set up. See it on the Databases page.

Make yourself an admin#

On txAdmin servers, manage admins inside txAdmin. Your txAdmin login is already the main admin. On a plain server, add this to server.cfg using your own Cfx.re ID:

add_principal identifier.fivem:YOUR_ID group.admin

Where the settings are#

• Settings > Startup: server name, licence key and auto-updates. On a txAdmin template, the licence key the game uses is the sv_licenseKey line in the template's server.cfg.
• Players: play time and bans from txAdmin. This page is view only, so make changes in txAdmin.
• Live Map: see players in your browser.