Getting started
Your first project
The server key, a new project from a framework recipe and the first time in the game.
A project is a plain FiveM server folder with server.cfg and resources. It also works without the studio: you can copy it to a server and run it like any other.
Server key
A FiveM server does not start without a licence key. The key is free.
- Sign in at portal.cfx.re and create a server key.
- In the studio open Server key and paste it. The key starts with
cfxk_.
The studio remembers the key for later projects and never shows it in logs or reports.
New project
- On the start screen pick the New project tile (or New project on the Projects tab).
- Answer What should the server run on?: no framework, ESX Legacy, ox_core, QBCore or Qbox.
- Type the project name and pick a folder in Save in.
- Click Create project.
The studio installs the framework’s official txAdmin recipe and creates the project’s database. The window shows the recipe’s steps as they run. The first project with a framework downloads about 1 GB; later ones use the cache. The framework stays with the project for good.
Already have a server? Do not create a new project, import it: drag the server folder onto the studio window or pick Import server.
First time in the game
Click Play. The studio starts the server and, once it is up, Player 1. The game window opens inside the studio, on the Player 1 tab.
You create a character in the game the same way as on any server with that framework. On the next Play the studio signs Player 1 in on the last character.
Player 2 is a second FiveM client on the same computer, for things that need two players. It is in the Server plan and higher.