Getting started with FiveM servers and development

These docs take you from “I want a FiveM server” to running one, managing it with txAdmin, installing resources and frameworks, and writing your own scripts. Everything here is checked against the official Cfx.re documentation and the source repositories on GitHub. When something depends on a version, the page says so.

If you only want to get a server online today, jump to Setting up a server on Windows or on Linux. If you want to write code, start with Your first resource. Come back to this page when a word stops making sense.

The pieces and who makes them

FiveM is a modification framework for Grand Theft Auto V that lets people run their own multiplayer servers with custom code, maps, vehicles and game modes. A few names show up everywhere:

How it fits together

When you start a server, this is what happens:

1. You run FXServer. With no arguments it starts txAdmin, which opens a web panel on port 40120.
2. txAdmin (or you, by hand) starts FXServer with a server.cfg. That file sets the server name, the license key, player slots, endpoints and which resources to start.
3. FXServer reads the resources folder, loads every resource you ensure, and runs their server scripts.
4. A player connects on port 30120. Their client downloads the client scripts, NUI pages and streamed assets (models, textures, maps) of your resources, then joins.
5. Client scripts and server scripts talk to each other with events, and to the game through natives.

FXServer/
├─ server/            the artifact: FXServer.exe (Windows) or run.sh + alpine/ (Linux)
└─ txData/
   ├─ admins.json     txAdmin accounts
   └─ MyServer.base/  your server data folder (any name you pick in the deployer)
      ├─ server.cfg
      └─ resources/
         ├─ [cfx-default]/   mapmanager, spawnmanager, chat...
         └─ [local]/         your own resources

A learning path through these docs

Follow the sections in this order. Each page links to the next one.

1. Understand what you need

• Glossary: every term you will meet, in one place.
• Requirements: hardware, Windows or Linux, and the legal basics (license, Rockstar content, monetisation).

2. Get a server online

• Server setup overview, then Windows or Linux.
• server.cfg explained line by line. You can also build one with the server.cfg Generator.
• Ports and networking and Database setup if you plan to run a framework.
• Common errors and fixes and Security basics.

3. Run it day to day with txAdmin

• txAdmin overview, first setup and the deployer, recipes, everyday admin and the Discord bot.

4. Add content

• Installing resources, recommended open source resources, maps, MLOs and clothing and vehicle packs.
• Pick a framework, or none: Frameworks compared.

5. Write your own scripts

• Development overview (tools and setup), then Your first resource.
• Client, server and events, natives, state bags and OneSync, NUI.
• Threads and performance, exports and dependencies, debugging.
• Streaming custom assets and publishing a resource.

6. Watch instead of read

The video tutorial archive groups hand-picked YouTube tutorials into courses: running your first server, txAdmin, frameworks, Lua scripting, NUI, streaming assets, CodeWalker and Blender with Sollumz.

Where to get help

• Official docs: docs.fivem.net for server setup, the scripting manual and the natives reference.
• Forum: forum.cfx.re has Server Discussion, Development and Releases categories. Search before you post, most errors have been seen before.
• Framework communities: QBCore, Qbox, ESX and Overextended each run their own Discord and docs, linked from the frameworks pages.
• txAdmin: the txAdmin Discord and the docs folder in the txAdmin repository.