Configuration

All settings live in stg-crafting/shared/config.lua, recipes live in stg-crafting/shared/recipes.lua (see Recipes). Both files stay editable in the escrow version. Restart the resource after a change.

Language

Config.Language = 'en'

Available: en, de, fr, es, pt, it, nl, pl, sv, no, fi, ar, he, jp, zh. To change a text, edit the matching file in stg-crafting/locales/. Texts of the crafting screen are in the web table at the bottom of each file.

Theme

Config.Theme = 'blue'

Colour of the crafting screen and the admin bench list. Available: blue, red, green, purple, orange, pink, yellow, cyan, white and custom.

To use your own colours, set Config.Theme = 'custom' and edit the colour values in stg-crafting/shared/themes/custom.css. Every value is explained at the top of that file.

Interaction

Config.Target = 'auto'

How players open a bench:

With a target resource, players can open a bench from 2.5 metres. The target sits on the bench prop, or on a small box at the bench position when the bench has no prop.

Queue

Config.MaxQueueSize = 5
Config.RefundOnCancel = true

Ingredients are taken when a craft is added to the queue. Crafts run one after another and the finished item goes straight into the player's inventory. The queue is saved to the database, so it keeps running while the screen is closed, after a server restart and while the player is offline. Crafts that finished while the player was offline are handed out when they join again.

Benches

The script ships with two weapon benches. Each entry in Config.Benches is one bench, and its key must be unique:

Config.Benches = {
    ['bench_weapon_1'] = {
        label = Locales[Config.Language]['bench_weapon'],
        coords = vector3(717.5297, -973.0, 30.3953),
        heading = -90.0,
        radius = 1.5,
        restriction = { type = false, name = 'police' },
        minLevel = 0,
        recipes = {
            'm4a9_nike',
            'ak47_custom',
            'pistol_mk2',
            -- ...
        },
        blip = { sprite = 110, color = 1, scale = 0.7, visible = false },
        prop = 'prop_tool_bench02',
    },
}

Players outside the job or gang see a notification and the bench does not open. Recipes above the player's level show a padlock and their Craft button stays disabled. The bench minLevel is checked when the player presses Craft.

Adding a bench

You can add a bench here in the config, or in game with the bench creator. To add one in the config:

Level system

Config.LevelSystem = {
    enabled = true,
    xpPerCraft = 10,
    maxLevel = 50,
    Ranks = {
        { level = 1,  label = 'Novice' },
        { level = 5,  label = 'Apprentice' },
        { level = 15, label = 'Journeyman' },
        { level = 30, label = 'Expert' },
        { level = 45, label = 'Master Crafter' },
    },
}

Every player starts at level 1. The XP needed to reach the next level grows with each level: 263 XP for level 2, 465 for level 3, 951 for level 5 and 2511 for level 10. With the default 10 XP per craft, that is 27 crafts for level 2 and 238 crafts in total to reach level 5. Raise xpPerCraft to make levelling faster.

Bench creator

Config.Creator = {
    command = 'benches',
    allowedGroups = { 'god', 'admin', 'superadmin' },
}

/benches lists every bench with its coordinates and recipe count. Benches from the config are marked BUILT-IN and can only be teleported to. Benches made in game are marked CUSTOM and can also be edited and deleted.

To create a bench, click + New, then set:

• Minimum Level
• Restriction Type and Job / Gang Name: leave the name empty for everyone. One name only, use the config for a list.
• Prop Model: prop_tool_bench02 by default. Tick No prop (box zone) to place the bench where you stand without a prop.
• Show map blip
• Recipes: at least one.

After Save, a see-through prop follows your camera. Rotate it with the Left and Right arrow keys, press Enter to place it or Esc to cancel. The bench appears for every player at once and is saved in the stg_crafting_benches table, so it stays after a restart.

Give yourself access in server.cfg if your framework does not do it already:

add_principal identifier.license:YOUR_LICENSE group.admin

Notifications

Config.CustomNotify = false

Config.Functions.Notify = function(type, message, title)
    if Config.CustomNotify then
        lib.notify({ type = type, description = message, title = title })
    else
        TriggerEvent('stg-crafting:internal:notify', type, message, title)
    end
end

Config.Functions.ShowHelpNotify = function(message)
    lib.showTextUI(message, { position = 'left-center', icon = 'hammer' })
end

Config.Functions.HideHelpNotify = function()
    lib.hideTextUI()
end

• CustomNotify: set to true to run the code in Config.Functions.Notify, then replace the lib.notify line with your own notification system. With false, the built-in ox_lib notification is used.
• Notify: used for messages from the game client, such as a cancelled placement or a missing permission. Craft results, level ups and errors sent by the server always use the built-in ox_lib notification.
• ShowHelpNotify and HideHelpNotify: the "Press [E] to open crafting" prompt shown near a bench when no target resource is active.