Installer
Recipe generator
Already run txAdmin? Choose your resources and download a recipe.yaml, or paste the URL into txAdmin's Remote URL deployer. No account needed.
Loading catalog…
Installer
Already run txAdmin? Choose your resources and download a recipe.yaml, or paste the URL into txAdmin's Remote URL deployer. No account needed.
Loading catalog…
Wrappers that let scripts written for other frameworks and libraries (such as ox_lib) run on Kora.
Kora does not provide support for these libraries. They are here for added convenience, and some of them need their own setup.
0 selected
53 resources
In txAdmin: Deploy server, Remote URL, paste this link. The link carries your selection, so it keeps working without an account.
$engine: 3
$onesync: 'on'
name: Kora Framework
version: 0.2.0-alpha
author: KoraFiveM
description: Official txAdmin recipe for Kora Framework Alpha.
tasks:
- action: write_file
file: ./server.cfg
data: |
# _ __ ___ ____ _
# | |/ / / _ \| _ \ / \
# | ' / | | | | |_) | / _ \
# | . \ | |_| | _ < / ___ \
# |_|\_\ \___/|_| \_\/_/ \_\
#
# KORA FRAMEWORK
# OFFICIAL txAdmin RECIPE
#
# Kora Docs: https://docs.koraframe.work/
# Kora GitHub: https://github.com/KoraFiveM
# FiveM Docs: https://docs.fivem.net/
# ================================================================
# =============================================================================
# KORA FRAMEWORK | OFFICIAL TXADMIN SERVER CONFIGURATION
# =============================================================================
# https://docs.fivem.net/docs/server-manual/server-commands/
# Generated by txAdmin. Review Cfx Portal listing settings and local server permissions.
# Do not commit a deployed server.cfg containing actual credentials.
# -----------------------------------------------------------------------------
# 1. NETWORKING & SERVER CAPACITY
# -----------------------------------------------------------------------------
# txAdmin supplies the TCP/UDP listener addresses and ports.
# Docs: https://github.com/citizenfx/txAdmin/blob/master/docs/recipe.md
{{serverEndpoints}}
# Maximum simultaneous players; txAdmin supplies the chosen limit.
# Docs: https://docs.fivem.net/docs/server-manual/server-commands/#sv_maxclients-newvalue
sv_maxclients {{maxClients}}
# Cfx.re server license; txAdmin supplies it securely.
# Docs: https://docs.fivem.net/docs/server-manual/server-commands/#sv_licensekey-key
sv_licenseKey "{{svLicense}}"
# OneSync is configured by the txAdmin recipe ($onesync: on).
# Configure your server's ports/firewall at the hosting provider.
# -----------------------------------------------------------------------------
# 2. SERVER LISTING | CONFIGURE IN CFX PORTAL
# -----------------------------------------------------------------------------
# [!] Server listing configuration has moved to Cfx Portal.
# Configure the server name, project name/description, locale, tags,
# connecting/detail banners and server icon in your server's portal settings.
# Portal: https://portal.cfx.re/servers
# Do NOT configure these listing ConVars here:
# sv_projectName, sv_projectDesc, sv_hostname, locale, tags,
# banner_connecting, banner_detail, load_server_icon
#
# -----------------------------------------------------------------------------
# 3. GAME & PLATFORM
# -----------------------------------------------------------------------------
# Pins the GTA V game build used by joining clients.
# Docs: https://docs.fivem.net/docs/server-manual/server-commands/#sv_enforcegamebuild-build
sv_enforceGameBuild 3751
# Only enable Steam API integration if required by a resource.
# set steam_webApiKey "YOUR_STEAM_WEB_API_KEY"
# System chat is available to resources that use it.
# Enables the system chat mode requested by this server setup.
# Docs: https://docs.fivem.net/docs/server-manual/server-commands/
set resources_useSystemChat true
# Controls join messages in compatible chat resources; verify support in your chat resource.
# Docs: https://docs.fivem.net/docs/scripting-reference/resource-manifest/resource-manifest/
set chat_showJoins false
# Controls leave messages in compatible chat resources; verify support in your chat resource.
# Docs: https://docs.fivem.net/docs/scripting-reference/resource-manifest/resource-manifest/
set chat_showQuits false
# -----------------------------------------------------------------------------
# 4. DATABASE
# -----------------------------------------------------------------------------
# txAdmin supplies this value from its database setup.
# Never paste a real database password into a public GitHub repository.
# Database connection string populated from txAdmin setup.
set mysql_connection_string "{{dbConnectionString}}"
# Database creation: kora.sql (executed during txAdmin deployment).
# Table creation/migrations: kora_sql (when the server starts).
# -----------------------------------------------------------------------------
# 5. LOCALES & KORA COMPATIBILITY
# -----------------------------------------------------------------------------
# QBCore-compatible resource locale; resource-specific setting.
# Docs: https://github.com/qbcore-framework/qb-core
setr qb_locale "en"
# Add Kora-specific convars here only when documented by their resources.
# Keep the framework's default configuration in the relevant resource files.
# -----------------------------------------------------------------------------
# 6. DEFAULT FIVE M RESOURCES
# -----------------------------------------------------------------------------
# The resource startup order is written by the recipe as `ensure [folder]` lines after this file.
# Base FiveM resources (mapmanager etc.) live in [cfx-default], which is ensured first.
# Uncomment only if supplied and required by your chosen resource pack.
# ensure spawnmanager
# ensure sessionmanager
# ensure hardcap
# -----------------------------------------------------------------------------
# 7. KORA STARTUP ORDER
# -----------------------------------------------------------------------------
# Do not add `ensure` lines for single resources here: the recipe appends one `ensure [folder]` per folder.
# Kora core libraries (kora_lib, kora_sql, kora_inventory, kora_core) live in [pre]/[kora] and start in that order.
# Put your own scripts in [addons] and your assets in [streamedassets]; both are ensured last.
# -----------------------------------------------------------------------------
# 8. ACCESS CONTROL
# -----------------------------------------------------------------------------
# Admin roles, QBCore compatibility permissions, and Kora permissions.
# Loads Kora/QBCore ACE access rules from a separate config.
# Docs: https://docs.fivem.net/docs/server-manual/server-commands/
exec permissions.cfg
# The txAdmin master administrator's principals are written into permissions.cfg by the recipe.
# -----------------------------------------------------------------------------
# =============================================================================
# 9. OPTIONAL SECURITY CONTROLS
# =============================================================================
# Disallow ScriptHook-based plugins. Does not block all client-side cheats.
# Docs: https://docs.fivem.net/docs/server-manual/setting-up-a-server-vanilla/
sv_scriptHookAllowed 0
# Optional request-control filtering; review Kora gameplay compatibility first.
# Docs: https://docs.fivem.net/docs/developers/server-security/
#sv_filterRequestControl 2
# Optional entity lockdown; may affect resources that create client-side entities.
# Docs: https://docs.fivem.net/docs/server-manual/server-commands/#sv_entitylockdown-mode
#sv_entityLockdown relaxed
# =============================================================================
# 10. OPTIONAL VOICE SETTINGS (FIVEM LEGACY)
# =============================================================================
# Native audio permits filters/submixes in compatible legacy voice resources.
# Not supported as a legacy convar on FiveM for GTAV Enhanced.
# Docs: https://docs.fivem.net/docs/scripting-manual/voice/
#setr voice_useNativeAudio true
# Restricts legacy voice reception to a player's sending range.
# Not supported as a legacy convar on FiveM for GTAV Enhanced.
# Docs: https://docs.fivem.net/docs/scripting-manual/voice/
#setr voice_useSendingRangeOnly true
# 11. OPTIONAL OPERATIONS & SECURITY
# -----------------------------------------------------------------------------
# Use txAdmin for scheduled restarts, monitoring, backups and admin management.
# Keep artifacts/resources updated and restrict access to the txAdmin panel.
# Avoid adding blanket "add_ace builtin.everyone command allow" permissions.
# Do not expose database credentials, Discord tokens, or API keys in GitHub.
# Add resource-specific keys only when those resources are installed.
# FiveManage token (uncomment and configure privately if needed):
# Optional Kora-specific FiveManage token. Keep your actual token private.
# Docs: https://docs.fivemanage.com/
#set kora_fivemanage_token "YOUR_FIVEMANAGE_TOKEN"
# =============================================================================
- action: write_file
file: ./permissions.cfg
data: |
## Permissions
add_ace group.admin command allow
add_ace group.admin command.zoneeditor allow
add_ace group.admin kora_core.admin allow
add_ace group.admin kora_lib.config.edit allow
## Resource permissions
add_ace resource.kora_core command allow
## Gods
add_ace kora_core.god command allow
## Inheritance
add_principal kora_core.god group.admin
add_principal kora_core.god kora_core.admin
add_principal kora_core.admin kora_core.mod
## QBCore backwards compatibility: principals granted the stock qbcore.* levels keep working
add_principal qbcore.god kora_core.god
add_principal qbcore.admin kora_core.admin
add_principal qbcore.mod kora_core.mod
## txAdmin master admin (filled in by the recipe from the Cfx.re account used to log in)
{{addPrincipalsMaster}}
- action: connect_database
- action: write_file
file: ./kora.sql
data: |
-- Kora Framework: create the txAdmin-selected database only.
-- txAdmin replaces KORA_DATABASE_NAME with {{dbName}} before execution.
-- No tables, inserts, deletes, or destructive statements.
CREATE DATABASE IF NOT EXISTS `KORA_DATABASE_NAME`
DEFAULT CHARACTER SET utf8mb4
COLLATE utf8mb4_unicode_ci;
USE `KORA_DATABASE_NAME`;
- action: replace_string
file: ./kora.sql
search: KORA_DATABASE_NAME
replace: '{{dbName}}'
- action: replace_string
mode: all_vars
file:
- ./kora.sql
- action: query_database
file: ./kora.sql
- action: download_github
src: https://github.com/KoraFiveM/-cfx-default-
ref: dev
dest: ./resources/[cfx-default]
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/-default-maps-
ref: dev
dest: ./resources/[default-maps]
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_phoneshop
ref: main
dest: ./resources/[default-maps]/kora_phoneshop
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_lib
ref: 6e5dd02ce6dab6cf7380336d7e6a91b1ed2fd126
dest: ./resources/[pre]/kora_lib
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_sql
ref: 0ab7487c5e76fb25b494f3d26250872e30e6e76f
dest: ./resources/[pre]/kora_sql
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_inventory
ref: 65788defbde80b3cfae48c6ed60c5189c3196050
dest: ./resources/[pre]/kora_inventory
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_core
ref: 0089df7fe7609223c795829fe0e658271a6988f9
dest: ./resources/[pre]/kora_core
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_drugs
ref: 34c638e7d33187409deac105e409e4718379081a
dest: ./resources/[kora]/kora_drugs
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_utils
ref: 3cef820b5f7bee32a3400a9ca2073efb43b5f4df
dest: ./resources/[kora]/kora_utils
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_doorlock
ref: dbbb0faf336cc88be3307141236d7d8d3944dd34
dest: ./resources/[kora]/kora_doorlock
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_businesses
ref: f843d48fc5bdcfdaaefed3a95ed7b33a9afc7bfe
dest: ./resources/[kora]/kora_businesses
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_admin
ref: d8d174e0979fdb5317e6d9c2947cff676d181777
dest: ./resources/[kora]/kora_admin
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_multijob
ref: 44d48f61c06cc4554ae84fcffed9b75270721153
dest: ./resources/[kora]/kora_multijob
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_bossmenu
ref: c074286404f2fafec7676a7b9447cb771ab0c234
dest: ./resources/[kora]/kora_bossmenu
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_multichar
ref: 0b30144610dc261dc4586613872014c8e2cf5ef8
dest: ./resources/[kora]/kora_multichar
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_loading
ref: 5e7511f3c6b34d632ecaefd788b6a0867aa041b9
dest: ./resources/[kora]/kora_loading
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_hud
ref: 2b03de8d1302475c640283e1e1ac30184c880a8f
dest: ./resources/[kora]/kora_hud
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_clothing
ref: a4b450f31faf8e8316c92cd07a05dc10bb1fb652
dest: ./resources/[kora]/kora_clothing
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_banking
ref: c8e38d7284ea35ff7d2395b9cf26b87aabf94085
dest: ./resources/[kora]/kora_banking
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_dispatch
ref: e1c8fb0fbc93b3db0da66ee1eb6e2c2930df875b
dest: ./resources/[kora]/kora_dispatch
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_fuel
ref: 3e5213dce07baaff39629d2abbc2411df0ca0ded
dest: ./resources/[kora]/kora_fuel
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_target
ref: 84eedcd0c5a5f9b7ba5a9f7c98f4a86b39c47aa8
dest: ./resources/[kora]/kora_target
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_interior
ref: 791cb6b82b1e6f91471ecb1a42a7cdcc5623a1c4
dest: ./resources/[kora]/kora_interior
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_weathersync
ref: 4fdaa5fa0ba59e46897edab7c9ee59cf220a9ea6
dest: ./resources/[kora]/kora_weathersync
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_phone
ref: dev
dest: ./resources/[kora]/kora_phone
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_police
ref: 78fc211e316e7739d8a3a3544abb8bf9955bf649
dest: ./resources/[kora]/kora_police
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_garages
ref: dd20a197f9acdbe88ba52c3e9aa33a1f2e62da62
dest: ./resources/[kora]/kora_garages
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_skills
ref: ab2d8c84b7cce9dda0a21163f9f7d6ce5d205698
dest: ./resources/[kora]/kora_skills
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_dealership
ref: 0e471169a67c236a490340779dc544ec9f3a808a
dest: ./resources/[kora]/kora_dealership
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_jobcreator
ref: 83ff745ad296360262d8273d327c1a70dc802ccc
dest: ./resources/[kora]/kora_jobcreator
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_crafting
ref: d1d6b135c1a3b7a9a997bdbb4b33ff1eb89bdf53
dest: ./resources/[kora]/kora_crafting
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_ambulance
ref: 2572bf66607e052f68be8e2efff931e5d103d3d3
dest: ./resources/[kora]/kora_ambulance
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_truckerjob
ref: acfc49aa97967ca5f20c177ce387020e29f214a0
dest: ./resources/[kora]/kora_truckerjob
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_newsjob
ref: 004958a58ccb2e55a4de141ec7b61a957535db42
dest: ./resources/[kora]/kora_newsjob
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_cityhall
ref: 3074dfe27c3545d92d95f1e0b5ece048df036fe9
dest: ./resources/[kora]/kora_cityhall
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_customs
ref: a9c61f7a1978d936bd5d0205629bbd2d3ccff124
dest: ./resources/[kora]/kora_customs
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_consumables
ref: eb61f6a60a558a2336f505d484d8d0092069933a
dest: ./resources/[kora]/kora_consumables
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_scoreboard
ref: 77aa9f4e73e721105ec232acd16f9adb930a7dd2
dest: ./resources/[kora]/kora_scoreboard
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_pawnshop
ref: 07eda932f961c49d0a37d1aa56166d68cf703b0b
dest: ./resources/[kora]/kora_pawnshop
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_fishing
ref: e5f0f41ea42aff4119fced955af73f4b7acbb504
dest: ./resources/[kora]/kora_fishing
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_vehiclekeys
ref: dd1a65c69bf20933bb948534e3b742faffb3c15d
dest: ./resources/[kora]/kora_vehiclekeys
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_metaldetecting
ref: 34deee3c69bcd7e628b991223cec0c4985533b8c
dest: ./resources/[kora]/kora_metaldetecting
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_mdt
ref: 2fba74c317502234f6343bf62904e9c1f94f4a8f
dest: ./resources/[kora]/kora_mdt
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_mining
ref: 388750017296c009fc3a426bf381262794947eee
dest: ./resources/[kora]/kora_mining
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_robberies
ref: bd75ee224c860bac13622ec3ae5dd719f7c86e18
dest: ./resources/[kora]/kora_robberies
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_queue
ref: 6d7c6be4d4a4481142bb2a667f0dd53d56ea9182
dest: ./resources/[standalone]/kora_queue
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_chat
ref: 0e568be534ddb73d1b4b17bbdc5ef8899898e80f
dest: ./resources/[standalone]/kora_chat
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_voice
ref: b59c9e841e46d05ed4f8808b7691a869c3d3a849
dest: ./resources/[standalone]/kora_voice
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_theme
ref: db3616615a3cb5261fd4ee101a4db85542bbbd7e
dest: ./resources/[standalone]/kora_theme
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_emotemenu
ref: 15da53d1db6df27d54797310a42d5f5d638e73ee
dest: ./resources/[standalone]/kora_emotemenu
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/props
ref: main
dest: ./resources/[standalone]/props
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/KoraFiveM/kora_sound
ref: bb59059e3f0cd9a323e2dbce8c1230872d4a8194
dest: ./resources/[standalone]/kora_sound
- action: waste_time
seconds: 5
- action: download_github
src: https://github.com/Bob74/bob74_ipl
ref: master
dest: ./resources/[standalone]/bob74_ipl
- action: waste_time
seconds: 5
- action: ensure_dir
path: ./resources/[addons]
- action: ensure_dir
path: ./resources/[streamedassets]/[cars]
- action: ensure_dir
path: ./resources/[streamedassets]/[maps]
- action: ensure_dir
path: ./resources/[streamedassets]/[props]
- action: ensure_dir
path: ./resources/[streamedassets]/[peds]
- action: write_file
file: ./server.cfg
append: true
data: |
ensure [cfx-default]
ensure [default-maps]
ensure [pre]
ensure [standalone]
ensure [kora]
ensure [addons]
ensure [streamedassets]
- action: replace_string
mode: all_vars
file:
- ./server.cfg
- ./permissions.cfg
- action: remove_path
path: ./tmp
Only resources listed in the Kora catalog are accepted; the YAML is never run, only read.