txAdmin recipes empower server developers and hosting providers to automate the installation of complete FiveM server environments in seconds. In this tutorial, we dissect how to author a custom YAML recipe that clones your studio repository, imports SQL tables, and sets up your server.cfg automatically.
1. The Anatomy of a txAdmin Recipe (YAML)
A txAdmin recipe consists of metadata, user input variables, and a sequential list of installation tasks such as download_github, waste, and database_query.
name: RolePlay.ly Studio Base 2026
author: RolePlay.ly Development Team
version: 3.2.0
description: Complete production turnkey QBCore server base.
variables:
svLicense:
title: "Cfx.re Server Key"
description: "Enter your server key from keymaster.fivem.net"
type: string
tasks:
- action: clone_repo
url: https://github.com/roleplayly/base-core.git
path: ./resources/[core]
- action: db_import
file: ./resources/[core]/sql/init.sql
2. Best Practices for Production Recipes
When engineering recipes for public distribution or internal studio deployments, always enforce explicit version tags on cloned repositories to prevent upstream breaking changes from disrupting new server initializations.
