Popular txAdmin recipes

The “Popular Recipes” list on txAdmin’s setup page is not built into txAdmin. It is downloaded from the official citizenfx/txAdmin-recipes repository, which holds the index of listed recipes and the files for the “Basic Server” recipes. The framework recipes themselves live in each framework’s own repository.

This page goes through every recipe in that index. For each one: what it installs, what it needs, the recipe URL, the notable tasks it runs and what to do after deploying. Everything below was read from the recipe files on GitHub in September 2026. Recipes change as projects update, so always read the YAML on the deployer screen before you click Next.

Comparison

All of these set $onesync: on in their YAML (except where noted), and all framework recipes connect to the database before downloading anything else, as the repository’s guidelines recommend.

Which list you see

The repository keeps several index files, one per txAdmin generation: indexv1.json to indexv5.json. Your txAdmin version decides which one it reads.

• indexv4.json lists: FiveM Basic Server (CFX Default), ESX Legacy, Qbox, QBCore, vMenu, StreetKings, WarfareTacticsV, RedM Basic Server (CFX Default) and VORP Core.
• indexv5.json, the newest, starts with FiveM Basic Server (Enhanced) and lists ESX Legacy, Qbox, QBCore, StreetKings and WarfareTacticsV.

The repository README also lists the Legacy basic server, vMenu (with a recipe patch), VORP, and two deprecated entries (ZAP-Hosting ESX Pack and PlumeESX Legacy) that you should not use for new servers.

How to deploy any of them

1. Start FXServer without +exec so txAdmin runs, link your Cfx.re account (see First setup).
2. On the setup page choose Popular Recipes and click the recipe. For a recipe that isn’t listed (or to pin a specific file), choose Remote URL Template and paste the raw YAML URL from the sections below.
3. Pick the data folder (txAdmin suggests txData/<Recipe>_<id>.base).
4. Read the YAML, click Next, paste your license key, and for framework recipes fill in the MariaDB host, port, user and password. Leave the database name empty so txAdmin creates one.
5. Run Recipe, review server.cfg, Save & Run Server.

The task types used below (download_github, query_database and so on) are explained in Recipes explained.

FiveM Basic Server (CFX Default)

• Recipe URL: https://raw.githubusercontent.com/citizenfx/txAdmin-recipes/refs/heads/main/default-fivem/recipe.yaml
• Source: txAdmin-recipes/default-fivem
• Needs: a license key. No database.

What it does. Three tasks: copy the resources folder of cfx-server-data, delete the old chat resource from it (the artifact’s built in chat is used instead, via set resources_useSystemChat true), and download a minimal server.cfg.

  - action: download_github
    src: https://github.com/citizenfx/cfx-server-data
    ref: master
    subpath: resources
    dest: ./resources

  - action: remove_path
    path: ./resources/[gameplay]/chat

The server.cfg starts mapmanager, chat, spawnmanager, basic-gamemode and hardcap, sets sv_enforceGameBuild 3751 (A Safehouse in the Hills), steam_webApiKey "none", and gives group.admin every command except quit. The file itself says it is “NOT supposed to be enough for most servers”.

After installing. Change sets locale "root-AQ" to your language (for example en-US), set a real sv_hostname, and start adding resources: Installing resources, vMenu, or your own code from Your first resource.

Good for: learning, development servers, freeroam, anything that isn’t roleplay.

FiveM Basic Server (Enhanced)

• Recipe URL: https://raw.githubusercontent.com/citizenfx/txAdmin-recipes/refs/heads/main/default-fivem-enhanced/recipe.yaml
• Source: txAdmin-recipes/default-fivem-enhanced
• Needs: the Cfx Server (Enhanced) artifact and a license key.

What it does. Downloads cfx-server-data into ./tmp, then moves only what it needs into resources: basic-gamemode, mapmanager, spawnmanager and two example maps (fivem-map-hipster, fivem-map-skater), and deletes ./tmp. There is no $onesync line (OneSync is always on in Enhanced) and no game build line (Enhanced only supports the latest build). Its server.cfg starts mapmanager, spawnmanager and basic-gamemode and uses the tags enhanced, default, deployer.

Good for: trying FiveM for GTA V Enhanced. Read Legacy and Enhanced first.

ESX Legacy

• Recipe URL: https://raw.githubusercontent.com/esx-framework/ESX-recipes/legacy/recipe.yaml
• Source: esx-framework/ESX-recipes (branch legacy)
• Needs: MariaDB (the ESX docs say MariaDB only, not XAMPP), a license key.

What it installs.

• Default Cfx resources into [cfx-default] (minus the old chat).
• ESX core: the [core] folder of esx-framework/esx_core, including es_extended.
• ESX addons: the [esx_addons] folder of ESX-Legacy-Addons (jobs, shops, society and more).
• [standalone]: bob74_ipl, pma-voice, oxmysql, ox_lib, and sd-phone with sd-phone-props.

Notable tasks. It downloads the core repo, then imports its SQL from inside it. The addons download gets a long timeout because the repository is big:

  - action: connect_database

  - action: download_github
    src: https://github.com/esx-framework/esx-core
    ref: main
    dest: ./tmp/core

  - action: query_database
    file: ./tmp/core/[SQL]/legacy.sql

  - action: download_github
    src: https://github.com/esx-framework/ESX-Legacy-Addons/
    ref: main
    dest: ./tmp/addons
    timeoutSeconds: 900

The server.cfg sets sv_enforceGameBuild 3258, the connection string from {{dbConnectionString}}, pma-voice settings (voice_useNativeAudio true, voice_useSendingRangeOnly true), and some security convars (sv_filterRequestControl 2, networked sounds, script entity states and phone explosions disabled). It lets es_extended run add_ace, add_principal, remove_principal and stop, which ESX uses to sync its admin groups. Start order: chat, oxmysql, esx_lib, es_extended, [core], [standalone], [esx_addons].

After installing. Set setr esx:locale if you want a language other than the one picked in txAdmin (the line is commented out by default). See the ESX quick start for jobs, items and admin.

Qbox

• Recipe URL: https://raw.githubusercontent.com/Qbox-project/txAdminRecipe/refs/heads/main/qbox.yaml
• Source: Qbox-project/txAdminRecipe
• Needs: MariaDB 10.9 or newer (Qbox’s docs say MySQL and XAMPP are not supported), a license key.

What it installs.

• Config files: server.cfg, permissions.cfg, ox.cfg, voice.cfg, misc.cfg and a logo.
• [ox]: ox_lib, ox_target, oxmysql, ox_doorlock, ox_inventory (with Qbox’s items.lua and the item images from qbx_invimages) and ox_fuel.
• [standalone]: bob74_ipl, safecracker, screencapture, mhacking, scully_emotemenu, ultra-voltlab, Renewed-Banking, illenium-appearance, MugShotBase64, Renewed-Weathersync, xt-prison, vehiclehandler, a loading screen and mana_audio.
• [voice]: pma-voice and mm_radio.
• [qbx]: qbx_core and around 50 qbx_* resources (garages, vehicle shop and sales, police, ambulance and medical, mechanic, properties, vehicle keys, spawn, HUD, radial menu, management, city hall, customs, density, jobs and robberies).
• [npwd] and [npwd-apps]: the npwd phone (pinned to release 3.16.0) with Qbox garage and mail apps.
• [assets]: a Pillbox hospital map.

Notable tasks. It imports a base qbox.sql, then each resource’s own SQL right after downloading it, and pauses between batches of GitHub downloads so users don’t get rate limited:

  - action: query_database
    file: ./resources/[qbx]/qbx_drugs/qbx_drugs.sql

  - action: waste_time # prevent github throttling
    seconds: 10

It also moves the item images into ox_inventory/web/images with overwrite: true and copies the Qbox npwd config over npwd’s default one.

The server.cfg uses set sv_enforceGameBuild 3258 and has many qbx: convars, including qbx:enableBridge "true" (the qb-core compatibility bridge), qbx:enableQueue, qbx:max_jobs_per_player, qbx:enableVehiclePersistence and a chat MOTD. Start order: ox_lib, qbx_core, ox_target, [ox], [qbx], [standalone], [voice], [assets], then npwd. Permissions come from {{addPrincipalsMaster}} and exec permissions.cfg.

After installing. Change the locale lines (sets locale, setr qb_locale, setr illenium-appearance:locale), set qbx:discordLink, and fill in SCREENSHOT_BASIC_TOKEN / NPWD_AUDIO_TOKEN only if you want npwd’s camera and audio features. See the Qbox quick start.

QBCore

• Recipe URL: https://raw.githubusercontent.com/qbcore-framework/txAdminRecipe/main/qbcore.yaml
• Source: qbcore-framework/txAdminRecipe (version 2.2.4 at the time of writing)
• Needs: MariaDB (the QBCore install guide pairs it with HeidiSQL), a license key.

What it installs.

• Default Cfx resources into [cfx-default] (minus the old chat).
• [standalone]: oxmysql (pinned to v2.14.1), menuv (v1.4.1), bob74_ipl, safecracker, screencapture, progressbar, interact-sound, connectqueue, PolyZone.
• [voice]: pma-voice and qb-radio.
• [defaultmaps]: hospital, dealer and prison maps.
• [qb]: qb-core and around 60 qb-* resources: multicharacter, target, inventory, phone, garages, vehicle shop and sales, police, ambulance, mechanic, houses, apartments, banking, clothing, doorlock, fuel, HUD, menu, input, loading screen, admin menu, management, weather sync, many jobs and robberies.

Notable tasks. The database goes first with one SQL file from the recipe repository, and the recipe pauses 10 seconds between batches of downloads (waste_time, eight times in total) to avoid GitHub throttling.

  - action: connect_database
  - action: query_database
    file: ./tmp/qbcore/qbcore.sql

  - action: download_file
    path: ./tmp/files/oxmysql.zip
    url: https://github.com/overextended/oxmysql/releases/download/v2.14.1/oxmysql.zip

The server.cfg sets sv_enforceGameBuild 3095 (The Chop Shop), pma-voice settings (voice_useNativeAudio true, default cycle key GRAVE), setr qb_locale "en" and setr UseTarget false. It defines a permission chain: qbcore.god inherits group.admin and qbcore.admin, and qbcore.admin inherits qbcore.mod. It also lets resource.qb-core run commands.

After installing. Let the first start finish: QBCore’s docs warn to let yarn install run all the way through on the initial startup. Then give yourself QBCore admin by adding your identifier to the god group, for example add_principal identifier.fivem:123456 qbcore.god. Switch UseTarget to true if you want qb-target interactions instead of key prompts. See the QBCore quick start.

vMenu

• Recipe URL (as listed in indexv4.json): https://raw.githubusercontent.com/tabarra/vMenu-recipe/refs/heads/main/recipe.yaml. The README links the recipe patch at feelfreetofee/vMenu-recipe.
• Needs: a license key. No database.

What it does. Copies cfx-server-data, removes the old chat and the [builders] folder, downloads its server.cfg, then downloads a pinned vMenu release (v3.8.61 in the patch at the time of writing) and unzips it into resources/[local]/vMenu.

The server.cfg runs exec @vMenu/config/permissions.cfg before ensure vMenu, which is exactly the order the vMenu docs require.

After installing. Edit resources/[local]/vMenu/config/permissions.cfg to decide who can use which menu options. Newer vMenu releases may exist: see vMenu for updating it by hand.

StreetKings

• Recipe URL: https://raw.githubusercontent.com/streetkings-fivem/txAdminRecipe/refs/heads/main/streetkings.yaml
• Needs: MariaDB, a license key.

A freeroam street racing game mode by 919DESIGN and Envi-Scripts: solo or up to 20 player races, XP for character and vehicle across five classes, daily races and a short story campaign. The recipe imports streetkings.sql, downloads bob74_ipl, pma-voice, the streetkings resource with its audio and blips assets, and ox_lib and oxmysql. Note that at the time of writing it downloads ox_lib and oxmysql from the CommunityOx GitHub organisation, whose copies of those repositories are now archived; the maintained versions are under overextended.

WarfareTacticsV (Real-Time Strategy)

• Recipe URL: https://raw.githubusercontent.com/FiveM-RTS-WarfareTactics/txAdminRecipe/refs/heads/main/recipe.yaml
• Needs: MariaDB, a license key.

A standalone RTS game mode by EnyoScripts (version 2.1.1 at the time of writing): platoon combat, 5 maps, 24 unit types, CPU opponents and matchmaking. The recipe pins cfx-server-data to a specific commit and only moves the pieces it needs (sessionmanager, baseevents, hardcap, the yarn and webpack builders, spawnmanager), then downloads its [rts] resources with 900 second timeouts because they are large.

RedM Basic Server and VORP Core

For Red Dead Redemption 2 servers on RedM:

• RedM Basic Server (CFX Default): https://raw.githubusercontent.com/citizenfx/txAdmin-recipes/refs/heads/main/default-redm/recipe.yaml, the same three tasks as the FiveM basic recipe with a RedM server.cfg.
• VORP Core: https://raw.githubusercontent.com/VORPCORE/VORP_txAdmin/main/vorp_recipe.yaml, the most used RedM roleplay framework. Needs MariaDB.

These docs focus on FiveM, but txAdmin works the same way for RedM.

Common issues with recipe deploys

Writing or listing your own

Anyone can deploy a recipe from a URL. To have one included in the Popular list, it must follow the txAdmin-recipes guidelines: start from the CFX Default structure, “just work” without manual edits, use only open source or sharable resources, support OneSync, use the {{maxClients}}, {{addPrincipalsMaster}}, {{serverEndpoints}} and {{svLicense}} placeholders, and accept txAdmin’s random database name. See Writing your own recipe for a full example.