Skip to content

Your First Project

Use this page for a quick start. For the full implementation-backed flow, see Create Project Wizard.

Import an Existing Server

If you already have a FiveM or RedM server, choose Create New Project, then pick Import Existing in the wizard template step.

Typical flow:

  1. Basics: name the project and choose game
  2. Template: choose Import Existing and select your existing server folder
  3. Database: connect, choose/create/import SQL as needed
  4. Artifacts: reuse detected FXServer path or set/download one
  5. Open project

CfxKit detects:

  • Framework: QBCore, ESX, QBox, VORP, or custom
  • Resources: All enabled resources from server.cfg
  • Database: MySQL connection from your config

Create a New Project

Starting fresh in the wizard:

  1. Click Create New Project
  2. Basics: set name, location, icon (optional), and game
  3. Template: choose Framework or Standalone
  4. Configure server settings, keys, and database
  5. Review and create project
  6. Deploy template recipe (if available for the selected framework)
  7. Set up FXServer artifacts (download or browse existing)
  8. Open project

Project Structure

For new projects (Framework/Standalone), CfxKit generates files like:

server-data/
├── .cfxkit/           # CfxKit project config
│   └── rules.md       # AI rules for your project
├── resources/          # Resource folders (when generated by this path)
├── server.cfg          # Server configuration
└── ...

Import Existing registers and configures your current folder instead of always generating a fresh structure.

Next Steps

Built by Boltise