Project Wizard
The Create Project wizard sets up a new server or registers one you already run. Your First Project is the quick version; this page covers every step.
Where to start it
Section titled “Where to start it”- The dashboard (Create New Project)
- First-run setup (Create First Project)
- A migration report (Create Project from This Server, with values prefilled)
Three template types
Section titled “Three template types”- Framework — a new project on QBCore, ESX, QBox, VORP, or RSG, with an optional one-click recipe deploy.
- Import Existing — point CfxKit at a server folder you already run; it analyzes and registers it.
- Standalone — a minimal project with no framework resources.
1. Basics
Section titled “1. Basics”Server name, project path, an optional icon, and the game (FiveM or RedM). Name and path are required.
2. Template
Section titled “2. Template”Pick Framework, Import Existing, or Standalone. The framework list depends on the game:
- FiveM: ESX, QBCore, QBox
- RedM: VORP, RSG, RPX
Choosing a folder for Import Existing triggers automatic analysis. CfxKit detects server.cfg, the FXServer path, resource count, framework, and database settings.
3. Config (Framework and Standalone)
Section titled “3. Config (Framework and Standalone)”Port (1–65535), max clients (1–2048), OneSync, tags, and locale.
4. Keys (Framework and Standalone)
Section titled “4. Keys (Framework and Standalone)”Your Cfx.re license key (required) and an optional Steam Web API key.
5. Database
Section titled “5. Database”- Choose a source: auto-detect MySQL/MariaDB, connect manually, or skip for now.
- Connect with host, port, user, and password, then test it.
- Pick a mode: create a new database, use an existing one, or import SQL (Import Existing flow).
Skipping the database still lets project creation continue.
6. Review (Framework and Standalone)
Section titled “6. Review (Framework and Standalone)”A summary before CfxKit generates the configuration and creates the project.
7. Deploy (framework recipes only)
Section titled “7. Deploy (framework recipes only)”When a framework ships a recipe, CfxKit downloads and installs it with live progress. You can skip and continue. Qbox, QBCore, ESX Legacy, and VORP have recipes; RSG and RPX do not.
8. FXServer artifacts
Section titled “8. FXServer artifacts”Download a build into <project>/fxserver, browse to an existing FXServer folder, or reuse a path detected during import. The chosen path is saved to the project.
Flow by template
Section titled “Flow by template”| Template | Steps |
|---|---|
| Framework (with recipe) | Basics → Template → Config → Keys → Database → Review → Deploy → Artifacts |
| Framework (no recipe) | Basics → Template → Config → Keys → Database → Review → Artifacts |
| Import Existing | Basics → Template → Database → Artifacts |
| Standalone | Basics → Template → Config → Keys → Database → Review → Artifacts |