Before You Begin#
Before installing Crafting Creator, make sure your server meets the requirements. A handful of resources are mandatory; the rest are detected on their own and simply switch a feature on.
Requirement | Status | Notes |
|---|---|---|
| Required | Database access for benches, queues and player levels. |
| Required | Callbacks, zones and the progress circle. |
| Required | The player's portrait next to their level in the crafting window. |
OneSync | Required | Enabled by default on txAdmin servers. |
Framework | Required |
|
Inventory | Required |
|
Target | Optional |
|
| Optional | Gang benches on ESX. QBCore and Qbox use their own gangs. |
| Optional | Quasar notifications and HUD hiding, and the Quasar 3D prompt. |
Everything framework- or inventory-specific sits behind a small, open bridge file, and the resource picks the right one by looking at what is already running:
Layer | Detected from |
|---|---|
Framework |
|
Inventory |
|
Target |
|
Extras |
|
Run one inventory only. Integrations has the details for each layer and how to adapt a renamed resource.
github.comReleases · overextended/oxmysqlMySQL resource for FXServer.github.comReleases · overextended/ox_libA FiveM resource and script library for Lua and JS.github.comBaziForYou/MugShotBase64Converts a ped's mugshot to Base64 — used for the player portrait in the crafting window.Downloading Crafting Creator#
After purchasing Crafting Creator, the resource is automatically linked to your CFX Portal account.
Sign in to the CFX Portal using the same account used during checkout, open Granted Assets, and download Crafting Creator.
After extracting the download, you should have the following:
[sql]/
├── esx.sql -- the database for ESX
└── qb.sql -- the database for QBCore and Qbox
qs-crafting/
├── config/main.lua -- what you may edit
├── custom/ -- framework bridges, notifications, HUD, progress (editable)
├── client/custom/ -- inventory and target bridges (editable)
├── server/custom/ -- inventory bridges and crafting hooks (editable)
├── server/webhooks.lua -- Discord logging
├── locales/ -- 41 languages
└── web/ -- the interface, ready to useKeep the folder named
qs-crafting. The update checker and the console messages identify the resource by that name.
Installing the Resource#
Move the qs-crafting folder into your server's resources directory. It can live anywhere inside it, including a category folder:
resources/
└── [qs]/
└── qs-crafting/Then open your server.cfg and make sure every dependency — and everything it should detect — starts before Crafting Creator:
ensure oxmysql
ensure ox_lib
ensure MugShotBase64
# Framework
ensure es_extended
# ensure qb-core
# ensure qbx_core
# Inventory (one), target and optional extras
ensure qs-inventory
ensure ox_target
ensure qs-interface
ensure qs-textui
ensure qs-gangs
ensure qs-craftingThe loading order matters. Detection only sees resources that are already started, so an inventory or target that starts after Crafting Creator is not found.
The Database#
Import the SQL file for your framework with HeidiSQL, phpMyAdmin or any MySQL/MariaDB client, into the same database your framework uses. Do it once, before the first start.
Import [sql]/esx.sql. It creates the two crafting tables and adds the crafting_skill column to users.
Import [sql]/qb.sql. It creates the two crafting tables and adds the crafting_skill column to players.
Table | Holds |
|---|---|
| Every bench made in the creator: name, prop, position, recipes, blip, jobs, gangs and options. |
| Crafts in progress or waiting to be picked up, with their start time. |
| Each character's crafting level and XP. |
-- ESX
ALTER TABLE `users` ADD IF NOT EXISTS `crafting_skill` LONGTEXT NULL DEFAULT NULL;
ALTER TABLE `crafting_tables` ADD IF NOT EXISTS `jobs` LONGTEXT NULL DEFAULT NULL;
ALTER TABLE `crafting_tables` ADD IF NOT EXISTS `gangs` LONGTEXT NULL DEFAULT NULL;
ALTER TABLE `crafting_tables` ADD IF NOT EXISTS `showWeaponsTab` TINYINT(1) NOT NULL DEFAULT '1';
-- QBCore / Qbox: the same, with `players` instead of `users` on the first line
ALTER TABLE `players` ADD IF NOT EXISTS `crafting_skill` LONGTEXT NULL DEFAULT NULL;Who May Open the Creator#
The creator is where benches are made, moved and deleted, so it is behind a permission check. Press F10 or type /crafting_creator in game; a player without access gets “You don’t have permission to do that.” Any of these routes lets someone in:
Players whose group is admin or superadmin. Set it with your usual ESX admin tools, for example:
setgroup <server id> adminPlayers with the god or admin permission, or the command ace that txAdmin gives its admins:
add_principal identifier.license:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx group.admin
add_ace group.admin command allowEvery job listed in Config.CreatorJobs can open the creator too, whatever the player's group:
Config.CreatorJobs = {
'realestate',
'police',
}Configuring the Resource#
Benches and recipes are best made in the creator, live. The files are for the rules around them:
File | Contents |
|---|---|
| Language, target, money type, crafting mode, creator key and jobs, item props, bench props, benches defined in code, XP curve, debug. |
| The Discord webhook, and whether IP addresses appear in logs. |
| Hooks for skill and perk scripts: change a craft, react to it starting, finishing or being cancelled. |
| Notifications, the 3D prompt, the progress circle and HUD hiding. |
| Every text players and staff read, per language. |
The values worth reviewing first:
Config.Locale = 'en' -- 41 languages, see locales/
Config.UseTarget = false -- true = ox_target / qb-target, false = 3D prompt + E
Config.MoneyType = 'money' -- what recipe prices are paid with: 'money' | 'bank' | 'black_money'
Config.OpenCreatorKey = 'F10' -- opens the creator
Config.CreatorJobs = {} -- jobs that may open the creator without being admin
Config.CraftingProgression.Mode = 'queue' -- 'queue' | 'proximity'
Config.Debug = false -- extra console output and test commands
Config.Debugships astrueso the first start explains itself in the console. Set it tofalsebefore opening to players: debug mode prints every action and registers developer test commands.
Verifying the Installation#
Restart your server and read the console. You should see the framework that was loaded and the result of the update check:
[INFO] Successfully loaded the framework. esx
You are using the latest version of qs-crafting!A line reading CRAFTING ERROR names what is wrong — usually an item in a recipe that your inventory does not have. Common Errors lists them. Then join your server and work through the first loop:
Visit a starter bench
Two benches ship in
config/main.lua, in the city centre just north of Legion Square. Walk up to the Attachment Crafting Bench and pressE: the camera moves over the bench and the crafting window opens.Craft something
Give yourself the ingredients of a recipe, choose it, set the amount and press craft. In queue mode the item appears in the queue; press Pick Up when the timer ends and you earn its XP.
Open the creator
Press
F10to open the list of benches made in game. From there, Usage covers building a bench of your own.
Benches made in the creator need no restart: they appear, change and disappear for every player the moment you save.