search_products
Search FiveM resources
Search the RPScripts catalogue of FiveM scripts, MLOs, server packs, vehicles and assets. Filter by framework, category and USD price; results are ranked by relevance when a query is given, otherwise by popularity. Only published, listed products. 24 results per page.
输入参数pagesortlimitquerylocalecategoryframeworksbuyable_onlymax_price_usdmin_price_usd
get_product
Get a FiveM resource
Details of one RPScripts product by slug (from search_products): description, frameworks, version, categories, price, whether it can be bought, and install requirements from RPScripts Lab's static check of the download (dependencies, start order).
输入参数slug必填locale
list_categories
List shop categories
All RPScripts shop categories (scripts by framework and job, MLOs, vehicles, clothing, server packs …) with their paths and URLs.
输入参数locale
check_compatibility
Check FiveM compatibility
Checks whether an RPScripts product (by slug) or your own resource files fit a server: framework (QBCore, Qbox, ESX, vRP, standalone), required resources such as ox_lib, ox_inventory, ox_target or oxmysql, FXServer artifact and game build minimums, OneSync, and conflicts in your resource list. Each check is supported, unsupported or unknown with its evidence; nothing is assumed without a source.
输入参数checkfilesonesyncproductframeworkgame_buildserver_buildserver_resources
validate_resource
Validate a FiveM resource
Statically checks a FiveM resource: Lua syntax, fxmanifest.lua directives and referenced files, resource structure, undeclared dependencies, framework API calls against pinned QBCore/Qbox/ESX versions, unknown natives, net-event security and backdoor patterns. Returns diagnostics with severity, rule code, file and line and a fix. Code is parsed, never run.
输入参数files必填frameworkresource_name
search_docs
Search FiveM documentation
Searches RPScripts documentation (installation, downloads, server packs, updates, QBCore/Qbox/ESX guides, compatibility, troubleshooting, AI workflow) and the framework API reference RPScripts reads from pinned QBCore, Qbox, ESX, ox_lib, ox_inventory, ox_target and oxmysql sources. Returns matching sections with source URLs. Pass page to read one docs page in full.
输入参数pagelimitqueryscopeframework
validate_server_cfg
Validate server.cfg
Parses and checks an FXServer server.cfg: syntax, argument counts and values, duplicate or conflicting settings, repeated resource starts, framework and ox resource start order, missing dependencies, OneSync/slot conflicts, secrets exposed with set/sets, weak RCON passwords, plain-text database passwords and placeholder values. Returns issues with line numbers and a suggested fix. The config is processed in memory and never stored; secret values are never echoed.
输入参数config必填
generate_fxmanifest
Generate fxmanifest.lua
Generates a valid fxmanifest.lua (fx_version 'cerulean', game 'gta5') for client/server/shared Lua or JS scripts, NUI pages, maps, vehicle data files and dependencies, then validates it with the RPScripts manifest rules. Lua 5.4 is the default runtime, so no lua54 line is written.
输入参数filesauthorpresetui_pageversiondata_filesdescriptiondependenciesnode_versionclient_scriptsserver_scriptsshared_scripts
create_job
Create a FiveM job (Jobs Creator)
Generates a complete job resource with the RPScripts Jobs Creator for QBCore, Qbox or ESX: job definition and grades with salaries and boss flags, duty, stash, garage, armory, shop, crafting, harvest/process/sell, boss office, wardrobe, teleports, billing, dispatch, player and vehicle actions, plus the framework install entries (shared jobs entry or ESX SQL) and a README. Start from a template (preset) and/or pass a full spec. The output is checked statically with RPScripts Lab before it is returned. Templates: police, sheriff, ambulance, fire, security, mechanic, cardealer, taxi, delivery, trucking, business, restaurant, fishing, mining, gang.
输入参数namespeclabelpresetframework必填
lookup_server
Look up a public FiveM server
Looks up a public FiveM server by cfx.re join code/link (e.g. cfx.re/join/abc123) or public host:port. Returns what the server or the Cfx server list publishes: hostname, player count, slots, artifact/build, OneSync, tags, public variables and resources. Private and local addresses are refused; offline servers are reported as unreachable. Player names and identifiers are not returned. shop_products lists up to six RPScripts products whose resource name the server runs (exact name; frameworks, libraries and packs excluded).
输入参数server必填
list_purchases
List my purchases
Lists the RPScripts products the signed-in customer owns (active purchases, including bundle items): product id, name, product page, files with their index for get_download_url, download availability and install requirements. Requires signing in to RPScripts.
输入参数pagelimitlocale
get_download_url
Get a download link
Creates a signed download link for one file of a product the signed-in customer owns (from list_purchases). The link is personal, works for 5 minutes and counts toward the limit of 20 downloads per product per day. Requires signing in.
输入参数file_indexproduct_id必填
generate_script
Generate a FiveM script (RPScripts AI)
Builds or changes a FiveM resource with the RPScripts AI generator (QBCore, Qbox, ESX or standalone): the agent writes Lua/NUI files, checks them (syntax, manifest, framework API) and repairs problems. Uses the signed-in customer's AI credits (typically about 0.2 per script). Spending requires confirm_credit_use: true, which you may only set after the user explicitly agreed to spend credits. Without a prompt, returns the status and files of an existing project. Long runs continue in the background: call again with the project_id and no prompt to collect the result.
输入参数namelocalepromptframeworkproject_idmax_creditsconfirm_credit_use