Create Project Wizard

This guide covers CfxKit's Create Project wizard in detail.

Entry Points

You can open the wizard from:

• Dashboard (Create New Project)
• Setup flow (Create First Project)
• Migration report (Create Project from This Server, with prefilled values)

Wizard Paths At A Glance

There are three template types:

• Framework: new project + config/keys/review, optional recipe deploy, then FXServer setup
• Import Existing: analyze existing folder, database step, register project, then FXServer setup
• Standalone: new minimal project with no framework resources, then FXServer setup

flowchart TD
  subgraph s1 [Step1Basics]
    basics[NamePathIconGame]
  end
  subgraph s2 [Step2Template]
    framework[Framework]
    existing[ImportExisting]
    standalone[Standalone]
  end

  basics --> framework
  basics --> existing
  basics --> standalone

  framework --> config[Step3Config]
  standalone --> config
  config --> keys[Step4Keys]
  keys --> database[Step5Database]
  database --> review[Step6Review]
  review --> createNew[CreateProject]
  createNew --> hasRecipe{HasRecipeUrl}
  hasRecipe -->|yes| deploy[Step7Deploy]
  hasRecipe -->|no| artifacts[Step8Artifacts]
  deploy --> artifacts

  existing --> analyze[AnalyzeExistingFolder]
  analyze --> databaseExisting[Step5Database]
  databaseExisting --> createExisting[CreateExistingProject]
  createExisting --> artifacts
  artifacts --> finish[OpenProject]

Steps And Validation

Step 1: Basics

• Inputs: server name, project path, optional icon, game (FiveM/RedM)
• Must have non-empty server name and project path to continue

Step 2: Template

• Choose one:
  • Framework
  • Import Existing
  • Standalone
• Framework list depends on game.
• Framework options shown in UI:
  • FiveM: ESX, QBCore, QBox
  • RedM: VORP, RSG, RPX
• For Import Existing, selecting a folder triggers automatic analysis.
  • CfxKit detects: server.cfg, FXServer path, resource count, framework, and database settings.

Step 3: Config (Framework/Standalone only)

• Inputs: port, max clients, onesync, tags, locale
• Validation:
  • Port: 1-65535
  • Max clients: 1-2048

Step 4: Keys (Framework/Standalone only)

• Required: Cfx license key
• Optional: Steam Web API key

Step 5: Database

This step has internal phases:

• Choice: auto-detect MySQL/MariaDB, manual connect, or skip for now
• Credentials: host/port/user/password + test connection
• Database mode:
  • Create New
  • Use Existing
  • Import SQL (only for Import Existing flow)
• Extra actions:
  • Retry Auto-detect from choice phase
  • Back from credentials to choice phase
  • Change credentials from connected state

Notes:

• If DB is skipped, project creation still continues.
• For recipe-backed framework flows using an existing DB, users can wipe tables first.

Step 6: Review (Framework/Standalone only)

• Summarizes settings before create.
• Create action generates your server configuration and sets up the project.

Step 7: Deploy (conditional)

This step appears only when a framework has a recipeUrl in FRAMEWORK_TEMPLATES.

• Downloads and installs the framework recipe
• Shows real-time progress as tasks execute
• You can cancel or skip and continue

Recipe-backed frameworks in the current template registry:

Framework	Recipe deploy in Step 7
Qbox	Yes
QBCore	Yes
ESX Legacy	Yes
VORP	Yes
RSG	No (recipeUrl: null)
RPX	No (not present in FRAMEWORK_TEMPLATES)

Step 8: FXServer Artifacts

Users can:

• Download selected artifact into <projectRoot>/fxserver
• Browse and choose an existing FXServer folder
• Use detected FXServer path from existing analysis (if present)
• If a detected path is present, UI also shows Download New Instead

When an FXServer path is confirmed, it is saved in project config.

Visible Step Differences By Template Type

Template Type	Visible Flow
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

Current Limitations

• Artifact fetch currently targets FiveM Windows master artifacts.
• Not every framework shown in template selection has a recipe URL for deploy.
• Import Existing path intentionally skips Config/Keys/Review and does not generate a new server.cfg in that step.
• In Artifacts, Download New Instead is currently a placeholder button (no dedicated handler; users can still manually pick an artifact and click Download & Install).