Items

Items

Items are defined in the src/items/ folder. Each file contains a table that gets merged into Config.Items.

File Structure

src/items/
├── weapons.lua
├── food.lua
├── drugs.lua
├── misc.lua
├── magazines.lua
├── ammo.lua
└── clothing.lua

Basic Item

local items = {
    ['water'] = {
        label = "Waterflask",
        description = "A water flask",
        close = false,
        weight = 0.5,
        stack = false,
        size = {
            width = 1,
            height = 2,
        },
    },
}

for k, v in pairs(items) do
    Config.Items[k] = v
end

Properties

Property	Type	Required	Description
label	string	✓	Display name
description	string		Item description
weight	number	✓	Weight in kg (0.5 = 500g)
stack	boolean	✓	Can stack multiple
size	table	✓	Grid dimensions { width, height }
close	boolean		Close inventory on use
type	string		Item type (see below)
rarity	string		"common", "uncommon", "rare", "epic", "legendary"
maxCount	number		Max per stack (if stackable)
prop	hash		GTA prop model (backtick hash)

Item Types

Type	Description
nil	Normal item
"weapon"	Weapon (equippable in hotbar)
"armor"	Armor/vest
"phone"	Phone (goes in phone slot)
"bag"	Backpack (expands storage)

Weapon Item

['weapon_pistol'] = {
    label = "Pistol",
    description = "A powerful pistol",
    close = false,
    weight = 2.5,
    stack = false,
    size = {
        width = 2,
        height = 2,
    },
    type = "weapon",
    rarity = "common",
    
    -- Ammo configuration
    ammoType = "ammo_9mm",           -- Which ammo item this weapon uses
    magazineType = "clip_pistol",    -- Default magazine type
    acceptedMagazines = { "clip_pistol", "clip_extended_pistol" },
    clipSize = 12,                   -- Max bullets per magazine
    
    prop = `w_ar_pistol`
}

Weapon Properties

Property	Type	Description
ammoType	string	Item name for ammo
magazineType	string	Default magazine item
acceptedMagazines	table	Compatible magazine item names
clipSize	number	Max ammo capacity
prop	hash	GTA weapon prop model

Phone Item

['phone'] = {
    label = "Phone",
    type = "phone",
    description = "A phone",
    close = false,
    weight = 0.2,
    stack = false,
    prop = `p_cs_cam_phone`,
    size = {
        width = 2,
        height = 2,
    },
}

Armor Item

['armour'] = {
    label = "Armour",
    description = "A vest that can hold items",
    close = false,
    weight = 2.0,
    stack = false,
    maxCount = 1,
    size = {
        width = 2,
        height = 2,
    },
    type = "armor",
}

Full Example File

-- src/items/my_items.lua
local items = {
    ['lockpick'] = {
        label = "Lockpick",
        description = "Used to pick locks",
        weight = 0.1,
        stack = true,
        maxCount = 5,
        size = { width = 1, height = 1 },
        rarity = "uncommon",
    },
    
    ['gold_bar'] = {
        label = "Gold Bar",
        description = "Pure gold",
        weight = 5.0,
        stack = true,
        maxCount = 10,
        size = { width = 2, height = 1 },
        rarity = "legendary",
    },
}

for k, v in pairs(items) do
    Config.Items[k] = v
end