Your First Project

A project in CfxKit points at a server-data folder and tracks its framework, resources, database connection, and FXServer artifacts. You either create a fresh one or import a server you already run.

This page is the quick path. For a reference of every wizard option, see the Project Wizard.

Import an existing server

The fastest start. In the wizard, choose Create New Project, then pick Import Existing at the template step.

1. Basics: name the project and choose the game (FiveM or RedM).
2. Template: select Import Existing and point CfxKit at your current server folder.
3. Database: connect to MySQL, then create or import SQL as needed.
4. Artifacts: reuse the detected FXServer path, or set or download one.
5. Open project.

On import, CfxKit detects:

• Framework: QBCore, ESX, QBox, VORP, or custom.
• Resources: every enabled resource in server.cfg.
• Database: the MySQL connection from your config.

Import registers and configures your existing folder in place. It does not overwrite your structure.

Create a new server

Starting fresh:

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

Project structure

For new Framework or Standalone projects, CfxKit generates a layout like this:

server-data/
├── .cfxkit/           # CfxKit project config
│   └── rules.md       # AI rules for this project
├── resources/         # Resource folders
├── server.cfg         # Server configuration
└── ...

The .cfxkit/rules.md file is where you teach the AI about this specific server: conventions, frameworks in use, and anything it should always keep in mind.

Tip

Editing .cfxkit/rules.md is the highest-leverage thing you can do for AI quality. The assistant reads it on every request, so a few lines about your framework and folder conventions pay off across the whole project.

Next steps

• AI Script Installer to add resources without manual setup.
• CfxKit AI to ask questions and generate code with real FiveM context.