Skip to main content

Configuration

All configuration is done in the config/shared.lua file. This guide covers every option.

Basic Settings​

Config = {}

-- Debug mode - shows extra console output
Config.Debug = false

-- Framework detection (auto, 'qbcore', 'qbox', 'esx')
Config.Framework = 'auto'

-- Inventory detection (auto, 'ox_inventory', 'qb-inventory', etc.)
Config.Inventory = 'auto'

-- Notification system (auto, 'ox_lib', 'framework')
Config.Notifications = 'auto'

-- Locale for translations
Config.Locale = 'en'
info

Setting any detection to 'auto' lets the resource find what you're using. Only change if you have issues.

Queue Settings​

Config.Queue = {
    -- Refund percentage when canceling (0.0 = none, 1.0 = full)
    refundPercentage = 0.5,
    
    -- Time limit to cancel (seconds, 0 = anytime)
    cancelTimeLimit = 60,
    
    -- Max crafts per player across all stations
    MaxPerPlayer = 5,
    
    -- Max crafts per station
    MaxPerStation = 10,
    
    -- Allow multiple crafts at same station simultaneously
    parallelCrafting = true,
    
    -- Days to keep completed crafts in database
    CleanupRetentionDays = 7,
    
    -- How often to check for completed crafts (ms)
    TickRate = 1000,
    
    -- Allow players to cancel crafts
    allowCancel = true,
}

Default Station Settings​

These apply to all stations unless overridden:

Config.DefaultStation = {
    -- Default prop model
    model = 'prop_toolchest_05',
    
    -- Interaction distance
    distance = 2.0,
    
    -- Use ox_target for interaction
    useTarget = true,
    
    -- Show spinning prop during crafting
    showCraftingProp = true,
    
    -- 3D offset for crafting prop (relative to station)
    -- x = right/left, y = forward/back, z = up/down
    propOffset = { x = 0.0, y = 0.0, z = 1.5 },
    
    -- Default crafting prop model
    craftingProp = 'prop_toolchest_05',
    
    -- Particle effect during crafting
    craftingParticle = {
        asset = 'core',
        name = 'ent_dst_gen_spark_spawn',
        scale = 1.0,
        offset = { x = 0.0, y = 0.0, z = 0.2 },
    },
}

Notification Settings​

Control when players receive notifications:

Config.NotificationSettings = {
    onCraftStart = true,   -- When crafting begins
    onCraftReady = true,   -- When craft is ready to collect
    onCraftCollect = true, -- When items are collected
    onCraftFail = true,    -- When craft fails (bad luck)
}

Sound Settings​

Config.Sounds = {
    enabled = true,
    
    -- Ambient sound near active stations
    ambient = {
        enabled = true,
        sound = 'Drill_Pin_Break',
        soundSet = 'DLC_HEIST_FLEECA_SOUNDSET',
        range = 10.0,
        interval = 3000,
    },
    
    -- Sound when craft completes
    complete = {
        enabled = true,
        sound = 'PICK_UP',
        soundSet = 'HUD_FRONTEND_DEFAULT_SOUNDSET',
    },
}

Prop Offset Configuration​

Prop offset determines where the crafting indicator appears relative to the station. Use the admin tool to configure this visually:

  1. Run /craftadmin
  2. Select a station type
  3. Click "Offset" button
  4. Move the sphere to desired position
  5. Press Enter to save
  6. Copy the output from F8 console to your config
-- Example: Prop appears inside a 3D printer
['3d_printer'] = {
    label = '3D Printer',
    model = 'prop_printer_01',
    propOffset = { x = 0.0, y = 0.35, z = 0.5 },
    recipes = { 'plastic_part' },
},

Next Steps​