Writing your own txAdmin recipe

resources/
├─ [cfx-default]/    from citizenfx/cfx-server-data
├─ [ox]/             oxmysql, ox_lib, ox_target
├─ [standalone]/     pma-voice, bob74_ipl
└─ [local]/          my_starter (our own)
server.cfg

$engine: 3
$onesync: on
name: My Base
version: 1.0.0
author: YourName
description: |
  A lean base with oxmysql, ox_lib, ox_target, pma-voice and a starter resource.
  No framework. Example recipe from the fivemad docs.

variables:
  dbName: null   # let txAdmin create the database with a random name

tasks:
  # 1. Database first: the most likely step to fail
  - action: connect_database

  - action: query_database
    query: |
      CREATE TABLE IF NOT EXISTS `player_stats` (
        `license` VARCHAR(60) NOT NULL PRIMARY KEY,
        `playtime` INT UNSIGNED NOT NULL DEFAULT 0,
        `last_seen` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
      ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

  # 2. Default Cfx resources, minus the old chat (the artifact has a built in one)
  - action: download_github
    src: https://github.com/citizenfx/cfx-server-data
    ref: master
    subpath: resources
    dest: ./resources/[cfx-default]

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

  # 3. Overextended libraries from their release zips
  - action: download_file
    url: https://github.com/overextended/oxmysql/releases/latest/download/oxmysql.zip
    path: ./tmp/oxmysql.zip
  - action: unzip
    src: ./tmp/oxmysql.zip
    dest: ./resources/[ox]

  - action: download_file
    url: https://github.com/overextended/ox_lib/releases/latest/download/ox_lib.zip
    path: ./tmp/ox_lib.zip
  - action: unzip
    src: ./tmp/ox_lib.zip
    dest: ./resources/[ox]

  - action: download_file
    url: https://github.com/overextended/ox_target/releases/latest/download/ox_target.zip
    path: ./tmp/ox_target.zip
  - action: unzip
    src: ./tmp/ox_target.zip
    dest: ./resources/[ox]

  # 4. Standalone resources straight from GitHub
  - action: download_github
    src: https://github.com/AvarianKnight/pma-voice
    dest: ./resources/[standalone]/pma-voice

  - action: download_github
    src: https://github.com/Bob74/bob74_ipl
    dest: ./resources/[standalone]/bob74_ipl

  # 5. Our own starter resource, written by the recipe
  - action: write_file
    file: ./resources/[local]/my_starter/fxmanifest.lua
    data: |
      fx_version 'cerulean'
      game 'gta5'

      name 'my_starter'
      description 'Starter resource created by the My Base recipe'
      version '1.0.0'

      shared_script '@ox_lib/init.lua'
      server_scripts {
          '@oxmysql/lib/MySQL.lua',
          'server.lua',
      }
      client_script 'client.lua'

      dependencies { 'oxmysql', 'ox_lib' }

  - action: write_file
    file: ./resources/[local]/my_starter/server.lua
    data: |
      AddEventHandler('playerJoining', function()
          local src = source
          local license = GetPlayerIdentifierByType(src, 'license')
          if not license then return end
          MySQL.insert('INSERT INTO player_stats (license) VALUES (?) ON DUPLICATE KEY UPDATE last_seen = NOW()', { license })
      end)

  - action: write_file
    file: ./resources/[local]/my_starter/client.lua
    data: |
      RegisterCommand('hello', function()
          lib.notify({ title = 'My Base', description = 'Hello from my_starter!', type = 'success' })
      end, false)

  # 6. server.cfg with placeholders
  - action: write_file
    file: ./server.cfg
    data: |
      ## Generated by the My Base recipe
      {{serverEndpoints}}

      sv_hostname "{{serverName}} | My Base"
      sets sv_projectName "{{serverName}}"
      sets sv_projectDesc "{{recipeDescription}}"
      sets tags "custom, base"
      sets locale "en-US"

      sv_licenseKey "{{svLicense}}"
      sv_maxclients {{maxClients}}
      sv_enforceGameBuild 3751
      set steam_webApiKey "none"
      set resources_useSystemChat true
      sv_endpointPrivacy true

      set mysql_connection_string "{{dbConnectionString}}"

      setr voice_useNativeAudio true
      setr voice_useSendingRangeOnly true

      ensure mapmanager
      ensure chat
      ensure spawnmanager
      ensure basic-gamemode
      ensure hardcap

      ensure oxmysql
      ensure ox_lib
      ensure ox_target
      ensure pma-voice
      ensure bob74_ipl

      ensure [local]

      add_ace group.admin command allow
      add_ace group.admin command.quit deny
      {{addPrincipalsMaster}}

  # 7. Fill in every {{placeholder}} in server.cfg
  - action: replace_string
    mode: all_vars
    file: ./server.cfg

  # 8. Clean up
  - action: remove_path
    path: ./tmp

- action: download_github
  src: https://github.com/AvarianKnight/pma-voice
  ref: 0123456789abcdef0123456789abcdef01234567   # a commit you tested
  dest: ./resources/[standalone]/pma-voice

- action: download_file
  url: https://github.com/overextended/ox_lib/releases/download/v3.30.0/ox_lib.zip   # a tagged release you tested
  path: ./tmp/ox_lib.zip