Configuration

⚙️ Configuration Guide

This comprehensive guide covers all configuration options for the TW Scrapyard system. The configuration is split across two main files: config.lua (gameplay settings) and coordinate.lua (location data and machine setups).

---

📋 Table of Contents

1. Core Settings

2. Framework Integration

3. UI & Interaction

4. Job Configuration

5. Mission Regions

6. Scrap Spawn System

7. Processing Machines

8. Vehicle System

9. Reconnection System

10. XP & Progression

---

Core Settings

Framework Selection

Config.Framework = 'qb'  -- Framework type

Supported Frameworks:

• 'esx' - ESX Framework (latest)

• 'oldesx' - ESX Legacy (older versions)

• 'qb' - QBCore / QBox (latest)

• 'oldqb' - QBCore (older versions)

• 'vrp' - vRP Framework

If you're using QBox, set this to 'qb' - they share the same configuration.

---

Database Configuration

Config.SQL = "oxmysql"  -- Database adapter

Supported Adapters:

• "oxmysql" - OxMySQL (recommended)

• "mysql-async" - MySQL Async

• "ghmattimysql" - GHMatti MySQL

Ensure your chosen SQL resource is started before tw-scrapyard in your server.cfg.

---

Inventory Integration

Config.Inventory = "qb_inventory"
Config.InventoryImagePath = "nui://qb-inventory/html/images/"
Config.DefaultItemImage = "nui://tw-scrapyard/html/img/gun.png"

Supported Inventory Systems:

• "qb_inventory" - QBCore Inventory

• "esx_inventory" - ESX Inventory

• "ox_inventory" - Ox Inventory

• "qs_inventory" - Quasar Inventory

Image Path Examples:

• QBCore: "nui://qb-inventory/html/images/"

• Ox Inventory: "nui://ox_inventory/web/images/"

• ESX: "nui://esx_inventoryhud/html/img/items/"

The default item image is used when an item's image cannot be found in your inventory system.

---

Currency Settings

Config.CurrencyUnit = '$'     -- Display symbol
Config.MoneyType = "$"        -- Display prefix
Config.MoneyType2 = "bank"    -- Account type for transactions

Account Types:

• "bank" - Bank account

• "cash" - Cash on hand

• "money" - Default money (framework-dependent)

Currency Symbols:

• '$' - US Dollar

• '€' - Euro

• '₺' - Turkish Lira

• '£' - British Pound

---

Framework Integration

Interaction System

Config.InteractionHandler = 'drawtext'

Supported Systems:

• 'drawtext' - Native 3D text (recommended)

• 'qb-target' - QBCore Target

• 'ox-target' - Ox Target

DrawText offers the best performance and works with all frameworks out of the box.

---

Vehicle Key Systems

Config.Vehiclekey = true  -- Enable vehicle key integration
Config.Removekeys = true  -- Enable key removal on vehicle return

Automatically Supported Key Systems:

• cd_garage

• qs-vehiclekeys

• wasabi_carlock

• qb-vehiclekeys

• qbx-vehiclekeys

• Renewed-Vehiclekeys

Custom Integration:

Config.GiveVehicleKey = function(plate, model, vehicle)
    -- Your custom key system here
    exports['your-keys']:GiveKey(plate)
end

Config.RemoveVehiclekey = function(plate, model, vehicle)
    -- Your custom key removal here
    exports['your-keys']:RemoveKey(plate)
end

---

Fuel System Integration

Config.SetVehicleFuel = function(vehicle)
    -- Automatically detects: LegacyFuel, x-fuel, ox_fuel, cdn-fuel, ps-fuel
    return SetVehicleFuelLevel(vehicle, 100.0)
end

Supported Fuel Systems:

• LegacyFuel

• x-fuel

• ox_fuel

• cdn-fuel

• ps-fuel

• Native (fallback)

---

Clothing System

Config.ChangeClothesSystem = false
Config.ClothingScript = "qb-clothing"

Supported Clothing Systems:

• "qb-clothing" - QBCore Clothing

• "fivem-appearance" - FiveM Appearance

• "illenium-appearance" - Illenium Appearance

• "esx_skin" - ESX Skin

• "rcore_clothing" - RCore Clothing

Job Outfits:

Config.JobClothes = {
    male = {
        { jacket = 97, texture = 0 },
        { shirt = 59, texture = 0 },
        { arms = 0, texture = 0 },
        { legs = 9, texture = 6 },
        { shoes = 12, texture = 3 }
    },
    female = {
        { jacket = 239, texture = 8 },
        { shirt = 15, texture = 0 },
        { arms = 0, texture = 0 },
        { legs = 35, texture = 0 },
        { shoes = 26, texture = 0 }
    }
}

---

UI & Interaction

Default UI Positions

Config.DefaultUIPositions = {
    teamList = { top = '77.22vh', left = '85.94vw' },
    scoreList = { top = '2.64vh', left = '1.61vw' },
    inviteSide = { top = '2.85vh', left = '73.07vw' },
    notificationDiv = { top = '40.48vh', left = '81.54vw' },
    keyInfoSide = { top = '50%', right = '2.0833vw' },
    dumpsterInfo = { top = '1.3542vw', left = '50%' }
}

Players can customize these positions in-game through the settings menu. These are just the defaults.

---

Language Configuration

Config.Locale = 'en'

Config.LanguageTitle = {
    { value = 'en', label = 'English' },
    { value = 'tr', label = 'Turkish' },
    { value = 'de', label = 'German' },
    { value = 'fr', label = 'French' },
    { value = 'pt', label = 'Portuguese' },
    { value = 'ru', label = 'Russian' }
}

Adding Custom Languages:

1. Create new locale file: locales/yourlang.lua

2. Copy structure from locales/en.lua

3. Translate all strings

4. Add to Config.LanguageTitle array

---

Notification System

Config.sendNotification = function(messageData)
    local message, messageType
    -- Custom notification logic
    NuiMessage('NOTIFICATION', {
        message = message,
        type = messageType
    })
end

Message Types:

• "success" - Green notification

• "error" - Red notification

• "info" - Blue notification

• "warning" - Orange notification

---

Job Configuration

Job Location

Config.Job = {
    ['coords'] = {
        ['intreactionCoords'] = vector3(1213.85, -1251.17, 36.32),
        ['ped'] = true,
        ['pedCoords'] = vector3(1213.85, -1251.17, 36.32),
        ['pedHeading'] = 87.43,
        ['pedHash'] = 0xC5FEFADE  -- Old Man model
    },
    ['job'] = 'all',  -- 'all' or specific job name
    ['blip'] = {
        show = true,
        blipName = "Scrapyard",
        blipType = 317,
        blipColor = 17,
        blipScale = 0.70
    }
}

Job Restriction:

• 'all' - Everyone can access

• 'police' - Only police

• 'mechanic' - Only mechanics

• Custom job names from your framework

---

Job Cooldown

Config.jobCoolDownHours = 0  -- Hours between job completions

Examples:

• 0 - No cooldown (unlimited jobs)

• 1 - 1 hour cooldown

• 6 - 6 hours cooldown

• 24 - Daily cooldown

---

Mission Completion Rewards

Config.Job['missioncompletedItems'] = {
    giveItemPlayer = false,  -- Give items on completion
    itemList = {
        { item = "sandwich", count = math.random(1, 4) },
        { item = "water", count = 1 }
    }
}

Set giveItemPlayer = true only if you want players to receive physical items in addition to money/XP.

---

Daily Missions

Config.Job['dailyMission'] = {
    {
        name = 'jobtask_one',
        header = "Daily Task 1",
        label = "Complete 50 scrap collections",
        count = 50,      -- Required amount
        xp = 2500,       -- XP reward
        money = 1000     -- Money reward
    },
    {
        name = 'jobtask_two',
        header = "Daily Task 2",
        label = "Complete 10 full missions",
        count = 10,
        xp = 1000,
        money = 3000
    }
}

Daily Mission System:

• Resets every 24 hours

• Tracks progress across all players

• Bonus rewards for completion

• Progress saved in database

---

Mission Regions

Region Configuration

Config.Job['regionData'] = {
    {
        regionID = 1,
        regionInfo = {
            regionName = "El Burro Heights",
            regionJobTask = "Collect and process scrap",
            regionImage = "region.png",
            regionMinimumLevel = 0  -- Required player level
        },
        regionAwards = {
            money = 5000,               -- Base money reward
            xp = 1000,                  -- Base XP reward
            onlineJobExtraAwards = 1,   -- Multiplier for online players
            bonusExtraMoney = 500,      -- Bonus money per objective
            bonusExtraXP = 200          -- Bonus XP per objective
        }
    }
}

Reward Calculation:

• Base reward increases with player count in lobby

• 2 players: +50% rewards

• 3 players: +75% rewards

• 4 players: +100% rewards

---

Job Tasks

regionJobTask = {
    {
        id = 1,
        jobName = "rent_vehicle",
        missionCount = {
            minAmount = 1,
            maxAmount = 999
        },
        madeCountFinish = true,  -- Must complete to finish mission
        jobLabel = "Rent a vehicle"
    },
    {
        id = 2,
        jobName = "scrap_createobject",
        missionCount = {
            minAmount = -1,              -- -1 = spawn all coordinates
            maxAmount = -1,
            multiplyByPlayers = false    -- Multiply by player count
        },
        madeCountFinish = true,
        jobLabel = "Collect scrap objects"
    },
    {
        id = 3,
        jobName = "scrap_press",
        madeCountFinish = true,
        jobLabel = "Press scrap items"
    },
    {
        id = 4,
        jobName = "shredding_press",
        madeCountFinish = true,
        jobLabel = "Shred pressed items"
    },
    {
        id = 5,
        jobName = "melt_scrap",
        madeCountFinish = true,
        jobLabel = "Melt metal in furnace"
    },
    {
        id = 6,
        jobName = "fill_moulds",
        madeCountFinish = true,
        jobLabel = "Fill metal moulds"
    }
}

Task Types:

• rent_vehicle - Rent a vehicle from showroom

• scrap_createobject - Collect scrap objects from world

• scrap_press - Press items in press machine

• shredding_press - Shred pressed items

• melt_scrap - Melt metal in furnace

• fill_moulds - Pour metal into moulds

---

Illegal Area Configuration

Config.Job['illegalDoor'] = {
    enabled = false,                            -- Enable door lock system
    doorHash = 1300820402,                      -- Door model hash
    coords = vector3(1163.42, -1251.99, 34.57), -- Door location
    locked = true,                              -- Initial state
    distance = 2.0,                             -- Interaction distance
    interactionKey = 47,                        -- Key code (47 = G)
    authorizedJobs = {},                        -- Empty = everyone
    checkCarryingItem = true,                   -- Block if carrying items
    openRotation = 2.0,                         -- Rotation when open
    checkRequiredItem = false,                  -- Require item to open
    requiredItem = 'keycard',                   -- Required item name
    requiredAmount = 1                          -- Required amount
}

Security Tips:

• Set authorizedJobs = {'police', 'admin'} to restrict access

• Enable checkRequiredItem for keycard-based access

• Use checkCarryingItem to prevent exploits

---

Scrap Spawn System

Scrap Areas (coordinate.lua)

Config.scrapArea = {
    [1] = {  -- Sandy Shores area
        vector3(2393.90, 3071.77, 47.16),
        vector3(2362.90, 3052.77, 48.05),
        vector3(2366.90, 3065.77, 47.16),
        -- ... more coordinates
    },
    [2] = {  -- Davis/Strawberry area
        vector3(-538.37, -1677.32, 18.19),
        vector3(-540.52, -1676.87, 18.18),
        -- ... more coordinates
    }
}

Adding New Spawn Areas:

1. Add new region ID to array

2. Add vector3 coordinates for each spawn point

3. Update Config.scrapyardCoords with region center

---

Scrapyard Zones

Config.scrapyardCoords = {
    {
        id = 1,
        coords = vector3(2388.55, 3064.8, 48.19),
        radius = 70.0,  -- Detection radius
        max = 200       -- Max concurrent objects
    },
    {
        id = 2,
        coords = vector3(-519.34, -1700.91, 19.25),
        radius = 80.0,
        max = 200
    }
}

Zone Settings:

• id - Must match Config.scrapArea index

• coords - Center point of spawn zone

• radius - How far objects can spawn from center

• max - Maximum objects allowed in zone

Objects auto-delete when no players are nearby to improve performance.

---

Scrap Item Distribution

Config.ScrapItemList = {
    regionRates = {
        [1] = {  -- Sandy Shores (rural area)
            ["tw_microwave_01"] = 80,   -- 80% chance (small)
            ["tw_coffee_01"] = 75,      -- 75% chance (small)
            ["tw_tv_01"] = 75,          -- 75% chance (small)
            ["tw_washer_01"] = 75,      -- 75% chance (medium)
            ['tw_rubwasher_01'] = 50,   -- 50% chance (medium)
            ['tw_fridge_01'] = 1,       -- 1% chance (big, rare)
            ['tw_fridge2_01'] = 15,     -- 15% chance (big)
            ['tw_coffeevend_01'] = 15   -- 15% chance (big)
        },
        [2] = {  -- Davis/Strawberry (urban area)
            ["tw_microwave_01"] = 80,
            ["tw_coffee_01"] = 75,
            ["tw_tv_01"] = 75,
            ["tw_washer_01"] = 75,
            ['tw_rubwasher_01'] = 50,
            ['tw_fridge_01'] = 1,
            ['tw_fridge2_01'] = 60,     -- Higher spawn rate
            ['tw_coffeevend_01'] = 60   -- Higher spawn rate
        }
    }
}

Spawn Weight System:

• 1-25 - Very rare (big items)

• 26-50 - Rare (medium items)

• 51-75 - Common (small-medium items)

• 76-100 - Very common (small items)

Balancing Tips:

• Urban areas should have more modern appliances

• Rural areas should have older/rarer items

• Keep big items rare to maintain value

---

Press Stage Configuration

Config.ScrapItemList.pressedModels = {
    -- Multi-stage pressing (2 stages)
    ["tw_washer_01"] = "tw_washer_02",  -- Stage 1
    ["tw_washer_02"] = "tw_washer_03",  -- Stage 2 (final)

    -- Single-stage pressing
    ["tw_microwave_01"] = "tw_microwave_02",  -- Stage 1
    ["tw_microwave_02"] = "tw_microwave_03",  -- Stage 2 (final)

    ["tw_coffee_01"] = "tw_coffee_02",
    ["tw_coffee_02"] = "tw_coffee_03",

    ["default"] = "v_res_tre_dvdplayer"  -- Fallback
}

Press Stages Explained:

1. Raw Item (_01) - Collectible scrap object

2. Partially Pressed (_02) - After first press

3. Fully Pressed (_03) - Ready for shredding

---

Shredding Output

Config.ScrapItemList.shreddableItems = {
    ["tw_microwave_03"] = { min = 1, max = 2 },  -- 1-2 metal pieces
    ["tw_tv_03"] = { min = 1, max = 3 },         -- 1-3 metal pieces
    ["tw_coffee_03"] = { min = 1, max = 2 },
    ["tw_washer_03"] = { min = 1, max = 2 },
    ['tw_rubwasher_03'] = { min = 1, max = 2 },
    ['tw_fridge_03'] = { min = 2, max = 4 },     -- Big items give more
    ['tw_fridge2_03'] = { min = 2, max = 4 },
    ['tw_coffeevend_03'] = { min = 2, max = 4 }
}

Output Scaling:

• Small items: 1-2 metal pieces

• Medium items: 1-3 metal pieces

• Large items: 2-4 metal pieces

---

Drop Zones

Config.ScrapItemList.dropZones = {
    vector4(1194.0, -1248.67, 35.36, 89.9),
    -- Add more drop zones here
}

Drop Zone Usage:

• Players can only drop pressed objects near these coordinates

• Prevents littering across the map

• Radius check: 5 meters from zone

---

Processing Machines

Press Machines (coordinate.lua)

Config.PressMachines = {
    [1] = {
        id = 1,
        name = "Press Machine #1",
        controlPanel = vec3(1225.372, -1279.440, 35.960),
        controlRadius = 1.5,
        pistonModel = "tw_press_piston",
        pistonPos = vec3(1224.66418, -1280.66541, 34.3459053),
        pistonRot = vec3(0.0, 0.0, 85.0),
        pistonMinZ = 32.0,  -- How far piston moves down
        leverModel = "tw_press_lever",
        leverPos = vec3(1225.372, -1279.440, 35.960),
        leverRot = vec3(-46.0, 0.0, 0.0),
        afterLeverRot = vec3(-140.0, 0.0, 0.0),
        pressArea = {  -- 3D polygon defining press zone
            vector3(1224.81, -1282.48, 35.14),
            vector3(1225.02, -1279.29, 35.14),
            vector3(1213.83, -1278.37, 35.14),
            vector3(1213.56, -1281.41, 35.14),
            vector3(1224.81, -1282.48, 37.44),
            vector3(1225.02, -1279.29, 37.44),
            vector3(1213.83, -1278.37, 37.44),
            vector3(1213.56, -1281.41, 37.44)
        },
        groundZ = 35.14,
        pressAreaHeight = 3.0,
        maxObjects = 20  -- Max items before starting
    }
}

Adding New Press Machines:

1. Copy existing machine config

2. Increment ID

3. Update all coordinates to new location

4. Adjust rotation values for proper alignment

5. Define press area polygon (8 points = box with height)

Important:

• Press area must be 8 points (bottom 4 + top 4)

• Piston must align with press area center

• Lever rotation affects animation direction

---

Shredding Machines (coordinate.lua)

Config.ShreddingMachines = {
    [1] = {
        id = 1,
        name = "Shredding Machine #1",
        controlPanel = vec3(1197.85, -1242.16, 36.33),
        controlRadius = 1.5,
        leftGearModel = "tw_grinder_gear_l",
        rightGearModel = "tw_grinder_gear_r",
        leftGearPos = vec3(1203.12, -1243.86, 35.4),
        rightGearPos = vec3(1203.1189, -1245.02, 35.4),
        leftGearRot = vec3(0.0, 0.0, 180.0),
        rightGearRot = vec3(0.0, 0.0, 0.0),
        gearRotationSpeed = 40.0,  -- Degrees per second
        shreddingLineStart = vec3(1198.11, -1244.44, 36.4),
        shreddingLineEnd = vec3(1202.81, -1244.44, 36.4),
        shreddingArea = {  -- 3D box where items shred
            vector3(1203.78, -1245.55, 35.55),
            vector3(1203.75, -1243.26, 35.51),
            vector3(1197.43, -1243.25, 35.51),
            vector3(1197.38, -1245.57, 35.51),
            vector3(1203.58, -1245.89, 37.10),
            vector3(1203.55, -1242.86, 37.10),
            vector3(1197.60, -1242.91, 37.10),
            vector3(1197.60, -1245.90, 37.10)
        },
        maxObjects = 5,
        objectSpawnZ = 36.55,
        processTime = 8000,  -- 8 seconds per item
        outputModel = "prop_rub_scrap_02",
        caseModel = "tw_kasa_00",  -- Case model
        caseModels = {
            empty = "tw_kasa_00",
            low = "tw_kasa_01",
            medium = "tw_kasa_02",
            full = "tw_kasa_03"
        },
        casePosition = vec3(1200.568, -1246.598, 33.573),
        outputPosition = vec3(1200.53, -1246.12, 34.33),
        caseRotation = vec3(0.0, 0.0, 90.0),
        caseCapacity = 20,  -- Items per case
        requireCase = true,
        grateModel = "tw_grid",
        gratePosition = vec3(1198.37, -1246.15869, 33.5714569),
        grateRotation = vec3(0.0, 0.0, 180.0),
        openGrateRotation = vec3(79.0, 0.0, 180.0),
        dustModel = "tw_toz",
        dustPosition = vec3(1200.26453, -1247.4845, 32.3106155),
        dustRotation = vec3(0.0, 0.0, 0.0)
    }
}

Shredding Machine Components:

1. Gears - Visual rotation during processing

2. Shredding Line - Path items travel during shredding

3. Case System - Collects shredded metal

4. Grate - Openable grate for dust collection

5. Dust System - Accumulates during operation

Case Capacity:

• 0-5 items: Empty model

• 6-10 items: Low model

• 11-15 items: Medium model

• 16-20 items: Full model

---

Vehicle System

Vehicle Rental Tiers

Vehicles are configured in coordinate.lua under Config.VehicleRental:

Config.VehicleRental = {
    tiers = {
        cheap = {
            gridSize = {w = 3, h = 3, layers = 2},  -- 3x3x2 grid
            price = 500,
            depositFee = 200,
            vehicles = {
                {model = "burrito", spawn = vec4(...), plate = "CHEAP1"}
            }
        },
        mid = {
            gridSize = {w = 4, h = 4, layers = 3},  -- 4x4x3 grid
            price = 1000,
            depositFee = 400,
            vehicles = {
                {model = "benson", spawn = vec4(...), plate = "MID1"}
            }
        },
        pro = {
            gridSize = {w = 5, h = 5, layers = 4},  -- 5x5x4 grid
            price = 2000,
            depositFee = 800,
            vehicles = {
                {model = "phantom", spawn = vec4(...), plate = "PRO1"}
            }
        }
    }
}

Grid System Explained:

• w - Width (cells left-right)

• h - Height (cells front-back)

• layers - Vertical stacking levels

Example Capacities:

• Cheap (3x3x2): 18 items max

• Mid (4x4x3): 48 items max

• Pro (5x5x4): 100 items max

---

Vehicle Blips

Config.Job['missionBlips'] = {
    ['vehicleBlips'] = {
        SetBlipSprite = 67,   -- Car icon
        SetBlipColour = 0,    -- White
        SetBlipScale = 0.8
    },
    ['deliveryBlips'] = {
        SetBlipSprite = 38,   -- Checkmark icon
        SetBlipColour = 29,   -- Green
        SetBlipScale = 0.80
    }
}

---

Reconnection System

Grace Period & Attempts

Config.Reconnection = {
    enabled = true,

    -- Grace period (0 = unlimited)
    gracePeriodSeconds = 0,

    -- Max reconnection attempts (0 = unlimited)
    maxReconnectAttempts = 3,

    -- Reset attempts after stable connection
    resetAttemptsAfterSeconds = 300,  -- 5 minutes

    -- Auto-cleanup expired players
    autoCleanupExpired = true
}

Grace Period Examples:

• 0 - Player can reconnect anytime before lobby closes

• 300 - 5 minutes to reconnect

• 600 - 10 minutes to reconnect

• 1800 - 30 minutes to reconnect

Attempt Limit Examples:

• 0 - Unlimited reconnections

• 1 - One reconnection only

• 3 - Three reconnections per session

• 5 - Five reconnections per session

---

Owner Transfer

Config.Reconnection.ownerTransfer = {
    enabled = true,
    allowRejoinAsMember = true,
    prioritizeByScore = true,
    minimumLobbyTime = 60  -- 1 minute minimum
}

Owner Transfer Logic:

1. Owner Disconnects → System searches for replacement

2. Eligibility Check:

   • Player must be in lobby ≥ minimumLobbyTime seconds

   • Player must be online (not disconnected)

3. Priority Selection:

   • If prioritizeByScore = true: Highest score wins

   • If prioritizeByScore = false: Longest lobby time wins

4. Transfer Complete:

   • New owner assigned

   • Lobby ownership transferred

   • Original owner can rejoin as member if allowRejoinAsMember = true

If no eligible replacement is found, the lobby closes and all players are kicked.

---

Notification Settings

Config.Reconnection.notifications = {
    notifyOnDisconnect = true,        -- Notify when player disconnects
    notifyOnReconnect = true,         -- Notify when player reconnects
    notifyAttemptsRemaining = true    -- Show remaining attempts
}

---

Debug Mode

Config.Reconnection.debugLogs = false  -- Enable console logs

Debug Output:

[Reconnection] Stored state for player ABC123 (lobby: XYZ789, attempts: 1/3)
[Reconnection] Player ABC123 reconnected (attempt: 1, total disconnects: 2)
[Reconnect] Synced 15 pressed objects for player 5 (lobby: XYZ789)

---

XP & Progression

Level System

Config.RequiredXP = {
    [1] = 1000,   -- Level 1 → 2
    [2] = 1500,   -- Level 2 → 3
    [3] = 2000,   -- Level 3 → 4
    [4] = 2500,
    [5] = 3000,
    -- ...continues to level 70
    [70] = 45500
}

XP Curve:

• Levels 1-10: 1000-5500 XP per level

• Levels 11-20: 6000-10500 XP per level

• Levels 21-50: 11000-25500 XP per level

• Levels 51-70: 26500-45500 XP per level

Total XP to Max Level: ~1,150,000 XP

---

XP Sources

Mission Completion:

regionAwards = {
    xp = 1000,  -- Base XP
    bonusExtraXP = 200  -- Per bonus objective
}

Daily Missions:

{
    count = 50,
    xp = 2500  -- Reward on completion
}

Calculation Example:

Base Mission XP: 1000
Lobby Size Multiplier (4 players): x2.0
Bonus Objectives (3): 200 x 3 = 600
Daily Mission Bonus: 2500
---
Total XP: (1000 x 2.0) + 600 + 2500 = 5100 XP

---

Debug & Commands

Debug Mode

Config.Debug = true          -- Enable debug prints
Config.DebugCommands = true  -- Enable admin commands

Debug Commands:

Config.Command = {
    jobReset = "jobresetscrapyard",      -- Reset current job
    jobLeave = "jobleavescrapyard",      -- Leave lobby
    openTutorial = "openTutorialscrapyard"  -- Open tutorials
}

---

Tutorial System

Config.TutorialList = {
    {
        id = 1,
        title = "Getting Started",
        description = "Learn the basics",
        name = 'https://r2.fivemanage.com/.../video1.mp4'
    }
}

Tutorial Requirements:

• Videos must be .mp4 format

• Hosted on accessible CDN

• Recommended resolution: 1920x1080

• Recommended length: 1-3 minutes

---

Sell NPCs Configuration

Legal Scrap Dealer

Config.Job['sellNPCs'] = {
    ['legal'] = {
        enabled = true,
        coords = vector3(1158.79, -1311.61, 33.75),
        heading = 172.89,
        pedModel = 'a_m_m_business_01',  -- Business man
        drawText = "Sell Scrap Items",
        blip = {
            enabled = false,
            sprite = 473,  -- Dollar icon
            color = 2,     -- Green
            scale = 0.7,
            name = "Legal Scrap Buyer"
        }
    }
}

Sellable Legal Items:

• Iron scrap

• Gold dust

• Copper fragments

• Aluminum pieces

• Steel bars

---

Illegal Black Market Dealer

Config.Job['sellNPCs'] = {
    ['illegal'] = {
        enabled = true,
        coords = vector3(1165.4, -1311.26, 33.87),
        heading = 160.67,
        pedModel = 's_m_y_dealer_01',  -- Drug dealer
        drawText = "Black Market Dealer",
        blip = {
            enabled = false,
            sprite = 486,  -- Gun icon
            color = 1,     -- Red
            scale = 0.7,
            name = "Black Market"
        }
    }
}

Sellable Illegal Items:

• Crafted weapons

• Weapon parts

• Illegal attachments

• Contraband materials

Security Warning: Enable blips with caution. Players may camp these locations.

---

Crafting System

Config.Job['craftWeaponEnabled'] = true   -- Illegal weapons
Config.Job['craftLegalEnabled'] = false   -- Legal items

Weapon Crafting:

• Requires illegal area access

• Uses processed metals

• Configurable recipes in coordinate.lua

• Integration with weapon systems

Legal Crafting:

• Tools and equipment

• Vehicle parts

• Construction materials

---

Performance Optimization

Recommended Settings

-- High-performance servers (100+ players)
Config.scrapyardCoords = {
    { id = 1, max = 150 }  -- Reduce max objects
}

-- Low-performance servers (<50 players)
Config.scrapyardCoords = {
    { id = 1, max = 300 }  -- Increase for variety
}

Entity Limits

Config.PressMachines = {
    maxObjects = 20  -- Objects before press starts
}

Config.ShreddingMachines = {
    maxObjects = 5,      -- Items per shredding cycle
    caseCapacity = 20    -- Items per collection case
}

Optimization Tips:

• Lower max values in scrapyard zones for better FPS

• Reduce maxObjects in machines for faster processing

• Limit concurrent lobbies for lower server load

---

Common Issues

Framework Not Loading

Problem: [ERROR] Failed to load framework!

Solution:

-- Check framework value
Config.Framework = 'qb'  -- Must match your server

-- Ensure framework resource is started first
-- In server.cfg:
ensure qb-core
ensure tw-scrapyard

---

Vehicle Keys Not Working

Problem: Players can't access rented vehicles

Solution:

-- Enable vehicle key system
Config.Vehiclekey = true

-- Add custom integration
Config.GiveVehicleKey = function(plate, model, vehicle)
    exports['your-keys']:GiveKey(plate)
end

---

Scrap Not Spawning

Problem: No scrap objects appear in world

Solution:

1. Check player is within radius of scrapyard zone

2. Verify job has started correctly

3. Check Config.scrapArea has coordinates

4. Ensure max limit not reached

---

Database Errors

Problem: [SQL ERROR] Table doesn't exist

Solution:

-- Verify SQL adapter
Config.SQL = "oxmysql"

-- Ensure resource started after SQL
-- In server.cfg:
ensure oxmysql
ensure tw-scrapyard

-- Script auto-creates table on first run
-- Check server console for SQL errors

---

Migration Guide

Updating from Old Versions

Config.lua Changes:

-- OLD (pre-v2.0)
Config.Locale = 'en'

-- NEW (v2.0+)
Config.Locale = 'en'
Config.Reconnection = { enabled = true }  -- New feature

Coordinate.lua Changes:

-- OLD (pre-v2.0)
Config.PressMachines = {
    [1] = { pressArea = {...} }
}

-- NEW (v2.0+)
Config.PressMachines = {
    [1] = {
        pressArea = {...},
        gridPositions = {...}  -- New optional feature
    }
}

Backup Recommendation: Always backup your config files before updating!

---

Support & Resources

Official Links

• Discord: https://discord.gg/tworst

• Documentation: https://docs.tworststore.com

• GitHub Issues: https://github.com/tworst/tw-scrapyard/issues

Configuration Generators

Use online tools to generate coordinates:

• Vector3 Converter: https://coords.tworststore.com

• Zone Creator: https://zones.tworststore.com

---

Advanced Configuration

For advanced topics including:

• Custom machine creation

• Network entity optimization

• Multi-server synchronization

• Custom crafting recipes

See: Advanced Configuration Guide →

---

Last Updated: November 2024 Version: 2.0.0 Compatibility: FiveM build 2802+