Config

⚙️ Configuration

The alpha-CraftingV3 script offers extensive customization options through the Shared/Config.lua file. This page provides detailed explanations for each configuration option to help you tailor the crafting system to your server's needs.

🔧 General Settings

Debug Mode

Debug = false

• Type: boolean

• Default: false

• Description: Enable debug mode to see detailed console messages and access debug commands

• Production Note: Always set to false for production servers to hide debug information

Language Configuration

Locale = "En"

• Type: string

• Options: "En" | "Tr"

• Default: "En"

• Description: Language setting for all script messages, notifications and UI texts

• Supported Languages:

  • "En" - English

  • "Tr" - Turkish

• Expandable: Add more languages by creating new files in the Locales/ folder

Interaction System

InteractType = "Target"

• Type: string

• Options: "Target" | "Default"

• Default: "Target"

• Description: How players interact with crafting stations

  • "Target" - Use target systems (ox_target/qb-target) for interactions (recommended)

  • "Default" - Use key press interactions with on-screen text

📱 Discord Logging

Basic Configuration

DiscordLog = {
    Enable = false,
    WebhookURL = "https://discord.com/api/webhooks/.../...",
    AvatarURL = "https://cdn.discordapp.com/...",
    DateFormat = "%H:%M:%S | %d/%m/%Y"
}

Setting	Description
Enable	Set to true to enable Discord logging
WebhookURL	Your Discord webhook URL from server settings
AvatarURL	Avatar image URL for Discord bot messages
DateFormat	Date/time format for timestamps (Lua format guide)

🛠️ Items Configuration

Items are the core of the crafting system. Each item represents something that can be crafted with specific requirements and properties.

Item Structure

["ItemKey"] = {
    Name = "item_name",
    Label = "Display Name",
    Description = "Item description",
    Image = "path/to/image.png",
    ImageURL = "https://example.com/image.png", -- Optional for Discord logs
    Quantity = 1,
    RequiredLevel = 0,
    Duration = 30,
    SuccessRate = 100,
    AddXPWhenCraftFails = true,
    AddXP = 5,
    Jobs = { },
    Requirements = { }
}

Item Properties

Property	Type	Description
Name	string	The actual item name in your inventory system
Label	string	Human-readable name shown in the UI
Description	string	Description shown in the UI
Image	string	Path to item image (relative to Assets/Images/)
ImageURL	string	Optional: Direct URL for Discord logs
Quantity	number	How many items are produced per craft
RequiredLevel	number	Minimum crafting level required (0 = no requirement)
Duration	number	Crafting time in seconds
SuccessRate	number	Success rate percentage (1-100)
AddXPWhenCraftFails	boolean	Whether to give XP even when crafting fails
AddXP	number	XP amount to give when crafting completes

Job Requirements

Jobs = {
    [1] = {
        Name = "mechanic",      -- Job name required
        Label = "Mechanic",     -- Job display name
        RequiredLevel = 2,      -- Minimum job grade required
    },
    -- Add multiple job requirements
}

Material Requirements

Requirements = {
    [1] = {
        Name = "steel",          -- Item name required
        Label = "Steel",         -- Display name for the requirement
        Amount = 5,              -- Quantity needed
        RemoveAfterCraft = true, -- Whether to remove the item after crafting
    },
    -- Add multiple material requirements
}

Example Items

Basic Medical Item

["Bandage"] = {
    Name = "bandage",
    Label = "Bandage",
    Description = "A bandage to stop bleeding",
    Image = "Medical/Bandage.png",
    ImageURL = "https://cdn.discordapp.com/...",
    Quantity = 3,
    RequiredLevel = 0,
    Duration = 10,
    SuccessRate = 100,
    AddXPWhenCraftFails = true,
    AddXP = 5,
    Jobs = { },
    Requirements = {
        [1] = {
            Name = "plastic",
            Label = "Plastic",
            Amount = 1,
            RemoveAfterCraft = true,
        }
    }
},

Advanced Weapon Item

["HeavyPistol"] = {
    Name = "weapon_heavypistol",
    Label = "Heavy Pistol",
    Description = "A hefty firearm designed to be held in one hand (or attempted)",
    Image = "Weapon/Pistols/HeavyPistol.png",
    ImageURL = "https://cdn.discordapp.com/...",
    Quantity = 1,
    RequiredLevel = 5,
    Duration = 60,
    SuccessRate = 80,
    AddXPWhenCraftFails = true,
    AddXP = 7,
    Jobs = { },
    Requirements = {
        [1] = {
            Name = "metalscrap",
            Label = "Metal Scrap",
            Amount = 6,
            RemoveAfterCraft = true,
        },
        [2] = {
            Name = "steel",
            Label = "Steel",
            Amount = 3,
            RemoveAfterCraft = true,
        },
        [3] = {
            Name = "rubber",
            Label = "Rubber",
            Amount = 1,
            RemoveAfterCraft = true,
        }
    }
},

📋 Crafting Menus

Menus organize items into categories and determine which items appear together in the UI.

Menu Structure

["MenuKey"] = {
    Label = "Menu Display Name",
    Items = {
        "ItemKey1",
        "ItemKey2",
        "ItemKey3",
    },
},

Default Menu Categories

Menu Key	Label	Purpose
Medical	Medical	Medical supplies and healing items
Utility	Utility	Tools and utility items
Miscellaneous	Miscellaneous	Various general items
Mechanic	Mechanic	Vehicle-related items
Digital	Digital	Electronic and tech items
Weapon	Weapons	Firearms and weapons
Ammo	Ammo	Ammunition and explosives

Example Menu

["Electronics"] = {
    Label = "Electronics",
    Items = {
        "Phone",
        "Laptop",
        "SecurityCamera",
        "GPSTracker"
    },
},

🏭 Crafting Stations

Crafting stations are physical locations where players can craft items. Each station can have multiple menus and job restrictions.

Station Structure

[StationIndex] = {
    Label = "Station Name",
    Name = "unique_name",
    Coords = vector3(x, y, z),
    Menus = { },
    Jobs = { },
    Blip = { },
    Target = { }
}

Station Properties

Property	Type	Description
Label	string	Display name for the station
Name	string	Unique identifier (no spaces)
Coords	vector3	World coordinates where the station is located
Menus	table	Which menus are available at this station
Jobs	table	Job restrictions for accessing the station
Blip	table	Map blip configuration
Target	table	Interaction zone configuration

Job Restrictions

Jobs = {
    [1] = {
        Name = "mechanic",      -- Job name required
        Label = "Mechanic",     -- Job display name
        RequiredLevel = 2,      -- Minimum job grade to access the station
    },
}

Map Blip Configuration

Blip = {
    Label = "Crafting Station", -- Blip label on map
    Color = 2,                  -- Blip color (see GTA V blip colors)
    Sprite = 446,               -- Blip sprite ID (see GTA V blip sprites)
    Scale = 0.5                 -- Blip size multiplier
}

Target Zone Configuration

Target = {
    Name = "unique_target_name", -- Unique target zone name
    Icon = "fa-solid fa-wrench", -- Font Awesome icon for interaction
    Length = 2.0,                -- Zone length
    Width = 1.5,                 -- Zone width
    Heading = 0,                 -- Zone rotation
    MinZ = 28.0,                 -- Minimum Z coordinate
    MaxZ = 32.0,                 -- Maximum Z coordinate
    Distance = 2.0               -- Interaction distance
}

Example Station Configuration

[7] = {
    Label = "Gunsmith Workshop",
    Name = "gunsmith",
    Coords = vector3(1692.41, 3759.50, 34.70),
    Menus = {
        [1] = "Weapon",
        [2] = "Ammo",
        [3] = "WeaponMods"
    },
    Jobs = {
        [1] = {
            Name = "gunsmith",
            Label = "Gunsmith",
            RequiredLevel = 1,
        }
    },
    Blip = {
        Label = "Gunsmith Workshop",
        Color = 1,
        Sprite = 110,
        Scale = 0.6
    },
    Target = {
        Name = "alpha-CraftingV3:PZ:Gunsmith",
        Icon = "fa-solid fa-gun",
        Length = 3.0,
        Width = 2.0,
        Heading = 45,
        MinZ = 31.70,
        MaxZ = 35.70,
        Distance = 2.5
    }
}

🎮 Crafting System Features

Experience System

• Leveling: Players gain XP by crafting items

• Level Requirements: Items can require minimum crafting levels

• Fail Rewards: Option to give XP even when crafting fails

• Progression: Higher level items give more XP

Success Rate System

• RNG Elements: Items can have success rates below 100%

• Skill-based: Lower success rates add challenge

• Material Loss: Failed crafts may consume materials

• Risk vs Reward: Rare items typically have lower success rates

Job Integration

• Access Control: Restrict stations by job and grade

• Specialized Crafting: Job-specific items and stations

• Role-playing: Realistic job-based crafting system

• Hierarchy: Grade requirements for advanced crafting

📝 Adding New Content

Adding a New Item

1. Create Item Entry:

["YourItemKey"] = {
    Name = "your_item_name",
    Label = "Your Item Display Name",
    Description = "Description of your item",
    Image = "Category/YourItem.png",
    ImageURL = "https://example.com/image.png",
    Quantity = 1,
    RequiredLevel = 0,
    Duration = 30,
    SuccessRate = 100,
    AddXPWhenCraftFails = true,
    AddXP = 5,
    Jobs = { },
    Requirements = {
        [1] = {
            Name = "material1",
            Label = "Material 1",
            Amount = 2,
            RemoveAfterCraft = true,
        }
    }
}

1. Add to Menu:

["YourMenuKey"] = {
    Label = "Your Menu",
    Items = {
        "YourItemKey", -- Add your item here
    },
}

1. Ensure Item Exists: Make sure the item exists in your server's inventory system

Adding a New Crafting Station

1. Get Coordinates: Use in-game tools to find desired location

2. Configure Station: Add new entry to CraftingStations

3. Set Permissions: Configure job restrictions if needed

4. Add Blip: Configure map marker if desired

5. Test Zone: Verify target zone positioning and size

🎯 Quick Setup Guide

1. Configure Items: Add your server's items to the Items section

2. Organize Menus: Group items into logical categories

3. Position Stations: Place crafting stations around your map

4. Set Permissions: Configure job restrictions for stations

5. Add Images: Place item images in Assets/Images/ folder

6. Setup Discord: Enable logging and configure webhook

7. Test Thoroughly: Verify all items craft correctly

8. Balance Economy: Adjust material costs and success rates

⚠️ Important Notes

• Unique Keys: All item keys, menu keys, and station names must be unique

• Job Matching: Job names must match your server's job system exactly

• Image Paths: Images are relative to the Assets/Images/ folder

• Item Database: Ensure all items exist in your server's inventory system or database

• Coordinates: Use precise coordinates for proper station positioning

• Performance: Consider crafting times and success rates for gameplay balance

• Testing: Always test in debug mode before production deployment

🔧 Advanced Configuration Tips

Balancing Crafting Economy

• Material Costs: Higher tier items should require more/rarer materials

• Time Investment: Longer craft times for valuable items

• Success Rates: Lower rates for high-value or rare items

• XP Rewards: Balance XP gains with item value and difficulty

Performance Optimization

• Station Count: Limit stations to prevent excessive blip clutter

• Image Sizes: Optimize images for faster loading

• Menu Organization: Group similar items together for better UX

• Craft Times: Balance realism with gameplay flow

Role-Playing Integration

• Job Restrictions: Use job requirements for realistic crafting roles

• Progression System: Gate advanced items behind level requirements

• Material Sources: Ensure materials are obtainable through gameplay

• Economic Impact: Consider effects on server economy