txAdmin Recipes

Recipes are pre-configured templates that install frameworks and essential resources with one click. They are the easiest way to set up a new server.

Available Recipes

QBCore

Modern, feature-rich framework with active development.

• Includes: QBCore framework, qb-phone, qb-inventory, and essential jobs.
• Best for: Most roleplay servers.

ESX Legacy

The classic framework, widely supported.

• Includes: ESX framework, basic jobs, and essentials.
• Best for: Servers wanting compatibility with older scripts.

Qbox

A modern, performance-oriented fork/rewrite of QBCore.

• Includes: Qbox framework, updated ox_lib integration.
• Best for: Developers wanting modern Lua features and performance.

Installing a Recipe

1. Fresh Install: Open txAdmin web interface on a new server.
2. Deployment Page: Navigate to the “Deployment” tab.
3. Select Recipe: Choose your desired framework.
4. Configure: Fill in database details and license key.
5. Run: Click “Run Recipe” and wait.

Updating Recipes & Handling Diffs

txAdmin recipes are primarily for initial setup. They do not have a “magic update” button that safely patches your modified files.

The Update Problem

If you re-run a recipe on an existing server:

1. It tries to download the latest version of files.
2. It might overwrite your configurations (config.lua) or custom code.
3. It might conflict with new resources you added.

Recommended Update Workflow

Do not rely on the recipe deployer for updates. Instead, use Git.

1. Version Control: Keep your resources folder in a Git repository.
2. Upstream Remote: Add the framework’s repository as a “remote”.

   git remote add upstream https://github.com/qbcore-framework/qb-core.git

3. Pull Updates:

   git fetch upstream
   git merge upstream/main

4. Resolve Conflicts: Git will show you exactly what lines changed, allowing you to keep your config values while getting the new logic.

Using Recipe Deployer (If you must)

If you decide to re-run a recipe to “reset” or update a specific part:

1. Backup: Full backup of DB and files.
2. Select “Skip”: When prompted about existing files, select “Skip” for files you know you’ve modified (like server.cfg or shared/config.lua).
3. Select “Overwrite”: Only for core resources you haven’t touched.
4. Review: Check server.cfg for duplicate ensure lines.

Custom Recipes

You can create custom recipes to automate your own server deployments (e.g., for spinning up dev instances).

Structure of a recipe.yaml:

name: My Custom Server
author: Me
tasks:
  - action: download_github
    src: my-org/my-repo
    dest: ./resources
  - action: connect_database
  - action: import_database
    file: ./system/db.sql

Refer to the txAdmin Recipe Documentation  for full syntax.