A txAdmin recipe is a YAML file (recipe.yaml) that the Recipe Deployer runs to set up a FiveM server: it downloads resources and then writes server.cfg. This tool builds the recipe from a form.
How to use the tool
Fill in name, version, author and description (name and author: 24 characters max, description: 256 max).
Choose OneSync and, if needed, the minimum FXServer version ($minFxVersion).
Add your GitHub repositories (one per line, "owner/repo" or "owner/repo@ref"): each one is downloaded into resources/[local].
List the resources to start (ensure) and, if needed, extra lines for server.cfg.
Save recipe.yaml, host it (for example in a GitHub repository), then paste its URL in the Recipe Deployer's custom template step, or paste its content.
Deployer variables
The generated server.cfg uses variables that txAdmin replaces at the end of deployment: {{serverEndpoints}} (default 0.0.0.0:30120), {{maxClients}} (default 48), {{svLicense}} (the key entered in step 2), {{serverName}}, {{recipeName}}, {{recipeAuthor}} and, with a database, {{dbConnectionString}}.
Good practice
- Pin "ref" to a commit or tag for reproducible deployments.
- Execution stops at the first failing task: test the recipe on an empty server.
- Never put passwords or keys in the recipe: use the deployer variables.
Frequently asked questions
- Which txAdmin actions are generated?
- download_github, connect_database (if enabled) and write_file for server.cfg. For other actions (download_file, unzip, move_path, replace_string, query_database...), add them by hand following the txAdmin documentation.
- Why is the license key not in the recipe?
- The deployer asks for the key in step 2 and replaces {{svLicense}} in server.cfg at the end: it must never appear in a shared file.
- Is my data uploaded?
- No, everything stays in your browser (localStorage).
