This no-fluff guide how to maintain FiveM scripts is for server owners, developers, and QA leads. You\u2019ll get a production-like \u201cTest City\u201d in Docker, an acceptance checklist you can run end-to-end, a quantitative risk scoring model, and a vendor-vetting rubric that keeps you away from headaches.<\/p>\n\n\n\n
What you get<\/strong><\/p>\n\n\n\n Download test-city.zip<\/strong><\/a> (Github)<\/p>\n\n\n\n How to use:<\/strong><\/p>\n\n\n\n Prereqs:<\/strong> Docker + Docker Compose, a cfx license key, and an If your artifact uses a different launcher path, adjust the last line accordingly (e.g., Enable your script:<\/strong> copy it into Use this every time. Copy into your tracker and check off items.<\/p>\n\n\n\n Good event pattern (example):<\/strong><\/p>\n\n\n\n Use this to decide \u201cship\/hold\/reject.\u201d Lower is better.<\/p>\n\n\n\n\n
oxmysql<\/code> and base resources<\/li>\n\n\n\nresources\/custom<\/code> where you drop the script under test<\/li>\n\n\n\n\n
cd test-city<\/code><\/li>\n\n\n\n.env.example<\/code> to .env<\/code> and set your LICENSE_KEY<\/code> (and DB creds if you like).<\/li>\n\n\n\noxmysql<\/code> into server-data\/resources\/[standalone]\/oxmysql\/<\/code>.<\/li>\n\n\n\nserver-data\/resources\/custom\/<scriptname>\/<\/code> and add ensure <scriptname><\/code> to server.cfg<\/code>.<\/li>\n\n\n\ndocker compose build && docker compose up -d<\/code> \u2192 connect via Direct Connect to localhost:30120<\/code>.<\/li>\n<\/ol>\n\n\n\n\n
oxmysql<\/code> resource copy (drop into server-data\/resources\/[standalone]\/oxmysql<\/code>).<\/p>\n<\/blockquote>\n\n\n\nFolder layout<\/h3>\n\n\n\n
test-city\/\n\u251c\u2500 docker-compose.yml\n\u251c\u2500 fxserver\/\n\u2502 \u251c\u2500 Dockerfile\n\u2502 \u2514\u2500 entrypoint.sh\n\u251c\u2500 server-data\/\n\u2502 \u251c\u2500 server.cfg\n\u2502 \u2514\u2500 resources\/\n\u2502 \u251c\u2500 [standalone]\/oxmysql\/ # place oxmysql here\n\u2502 \u2514\u2500 custom\/ # put the script under test here (e.g., myscript\/)\n\u2514\u2500 .env\n<\/pre>\n\n\n\n
.env<\/code> (example)<\/h3>\n\n\n\nLICENSE_KEY=changeme_cfx_license_key\nMYSQL_DATABASE=fivem\nMYSQL_USER=fivem\nMYSQL_PASSWORD=fivempw\nMYSQL_ROOT_PASSWORD=rootpw\nFX_ARTIFACT_URL=https:\/\/runtime.fivem.net\/artifacts\/fivem\/build_proot_linux\/master\/LATEST.tar.xz\n# Tip: replace with a specific artifact URL you trust for reproducibility.\n<\/pre>\n\n\n\n
docker-compose.yml<\/code><\/h3>\n\n\n\nversion: \"3.9\"\n\nnetworks:\n testcity:\n\nvolumes:\n db_data:\n\nservices:\n db:\n image: mariadb:10.11\n restart: unless-stopped\n environment:\n MYSQL_DATABASE: ${MYSQL_DATABASE}\n MYSQL_USER: ${MYSQL_USER}\n MYSQL_PASSWORD: ${MYSQL_PASSWORD}\n MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}\n command: >\n --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci\n --innodb_buffer_pool_size=256M\n volumes:\n - db_data:\/var\/lib\/mysql\n networks: [testcity]\n\n adminer:\n image: adminer:4\n restart: unless-stopped\n ports:\n - \"8080:8080\"\n networks: [testcity]\n depends_on: [db]\n\n fxserver:\n build:\n context: .\/fxserver\n args:\n FX_ARTIFACT_URL: ${FX_ARTIFACT_URL}\n restart: unless-stopped\n environment:\n LICENSE_KEY: ${LICENSE_KEY}\n MYSQL_DATABASE: ${MYSQL_DATABASE}\n MYSQL_USER: ${MYSQL_USER}\n MYSQL_PASSWORD: ${MYSQL_PASSWORD}\n depends_on: [db]\n networks: [testcity]\n ports:\n - \"30120:30120\/udp\"\n - \"30120:30120\/tcp\"\n - \"40120:40120\/tcp\" # txAdmin (optional)\n volumes:\n - .\/server-data:\/opt\/fivem\/server-data\n<\/pre>\n\n\n\nfxserver\/Dockerfile<\/code><\/h3>\n\n\n\nFROM debian:bookworm-slim\n\nARG FX_ARTIFACT_URL\nENV DEBIAN_FRONTEND=noninteractive\n\nRUN apt-get update && apt-get install -y --no-install-recommends \n xz-utils curl ca-certificates tini bash && \n rm -rf \/var\/lib\/apt\/lists\/*\n\n# Fetch & extract FXServer artifact (URL provided via build-arg)\nRUN mkdir -p \/opt\/fivem && \n curl -fsSL \"$FX_ARTIFACT_URL\" -o \/opt\/fivem\/fx.tar.xz && \n tar -xJf \/opt\/fivem\/fx.tar.xz -C \/opt\/fivem && \n rm -f \/opt\/fivem\/fx.tar.xz\n\n# Non-root\nRUN useradd -ms \/bin\/bash fivem\nUSER fivem\n\nWORKDIR \/opt\/fivem\nCOPY --chown=fivem:fivem ..\/server-data \/opt\/fivem\/server-data\nCOPY --chown=fivem:fivem entrypoint.sh \/entrypoint.sh\n\nENTRYPOINT [\"\/usr\/bin\/tini\",\"--\"]\nCMD [\"\/bin\/bash\",\"\/entrypoint.sh\"]\n<\/pre>\n\n\n\n
fxserver\/entrypoint.sh<\/code><\/h3>\n\n\n\n#!\/usr\/bin\/env bash\nset -euo pipefail\n\n# Provide DB string for oxmysql via server.cfg (already set there),\n# just ensure the DB is reachable before boot to avoid spam errors.\necho \"Waiting for database...\"\nuntil nc -z db 3306; do sleep 1; done\necho \"DB ready.\"\n\n# Run FXServer with our server.cfg\n# Most Linux artifacts ship a run.sh in the artifact root.\nexec bash \/opt\/fivem\/run.sh +exec \/opt\/fivem\/server-data\/server.cfg\n<\/pre>\n\n\n\n
\n
\/opt\/fivem\/alpine\/opt\/cfx-server\/run.sh<\/code>).<\/p>\n<\/blockquote>\n\n\n\nserver-data\/server.cfg<\/code> (lean, test-ready)<\/h3>\n\n\n\n# ---------- Identity ----------\nsv_licenseKey \"%LICENSE_KEY%\" # injected by env in entrypoint command or replace manually\nsv_hostname \"Test City \u2014 Script QA\"\nsets tags \"qa,testing,fivemx\"\nsv_maxclients 2\nonesync on\nsv_scriptHookAllowed 0\nsv_enforceGameBuild 3095\n\n# ---------- Networking ----------\nendpoint_add_tcp \"0.0.0.0:30120\"\nendpoint_add_udp \"0.0.0.0:30120\"\n\n# ---------- Database (oxmysql) ----------\nset mysql_connection_string \"mysql:\/\/%MYSQL_USER%:%MYSQL_PASSWORD%@db:3306\/%MYSQL_DATABASE%?charset=utf8mb4\"\n\n# ---------- Core \/ Base resources ----------\nensure mapmanager\nensure chat\nensure spawnmanager\nensure sessionmanager\nensure hardcap\nensure baseevents\n\n# ---------- Datastore ----------\nensure oxmysql\n\n# ---------- Under test ----------\n# Drop your script folder into resources\/custom\/<scriptname> and enable here:\n# ensure myscript\n\n# ---------- QA helpers ----------\n# Verbose logging in dev\nsetr con_minSeverity info\n\n# Enable txAdmin panel (optional)\nsetr txAdminPort 40120\n<\/pre>\n\n\n\n
\n
server-data\/resources\/custom\/myscript\/<\/code> and add ensure myscript<\/code> to the bottom block.<\/p>\n<\/blockquote>\n\n\n\nRun it<\/h3>\n\n\n\n
cd test-city\ndocker compose build\ndocker compose up -d\n# Adminer at http:\/\/localhost:8080 (server: db, user: fivem, pass: fivempw)\n# Connect FiveM client \u2192 Direct Connect: your-docker-host:30120\n<\/pre>\n\n\n\n
\n\n\n\nPart 2 \u2014 Script Acceptance Checklist (Do Not Skip)<\/h2>\n\n\n\n
A. Pre-flight (before install)<\/h3>\n\n\n\n
\n
ox_lib<\/code>, oxmysql<\/code>, PolyZone<\/code>, etc.<\/li>\n\n\n\nlua54 'yes'<\/code>, correct game 'gta5'<\/code>, fx_version<\/code> not ancient.<\/li>\n\n\n\nB. Installability<\/h3>\n\n\n\n
\n
ensure<\/code>:<\/strong> zero stack traces or asset missing spam.<\/li>\n\n\n\ndeprecated natives<\/code> spam.<\/strong><\/li>\n\n\n\nC. Functional<\/h3>\n\n\n\n
\n
D. Performance (client & server)<\/h3>\n\n\n\n
\n
resmon<\/code>:<\/strong> idle \u2264 0.10ms<\/strong>, active \u2264 0.50ms<\/strong> (client).<\/li>\n\n\n\nE. Security<\/h3>\n\n\n\n
\n
source<\/code>, perms, and input types.<\/li>\n\n\n\nloadstring<\/code>\/remote code<\/strong> patterns.<\/li>\n\n\n\nRegisterNetEvent('myscript:buy', function(item, amount)\n local src = source\n if type(item) ~= 'string' or type(amount) ~= 'number' or amount < 1 then return end\n if not HasPermission(src, 'shop.buy') then return end\n local xPlayer = GetPlayer(src) -- framework adapter\n if not xPlayer then return end\n -- validate price server-side, check inventory limits, do DB in a transaction\nend)\n<\/pre>\n\n\n\nF. Compatibility & Cleanliness<\/h3>\n\n\n\n
\n
\n\n\n\nPart 3 \u2014 Quantitative Risk Scoring Model (0\u2013100)<\/h2>\n\n\n\n