Installation

Install the Multiplayer Scrapyard Job, or update an older version to 3.0.

Updating from 1.x? Skip to Updating from 1.x. Do not delete your old folder.

---

Prerequisites

Requirement	Description
tw-lib	Free Tworst library, version 1.0.0 or newer
oxmysql	Database
FiveM Server	A recent server build (OneSync on, as txAdmin sets by default)

---

Step 1: Download

From Cfx.re Portal

1. Go to portal.cfx.re → Granted Assets

2. Download tw-scrapyard and tw-lib

tw-lib is free and comes with every Tworst job. You can also download it from GitHub Releases. Download the tw-lib-x.x.x.zip file there, not "Code → Download ZIP" (that folder is named tw-lib-main and the jobs will not find it).

---

Step 2: Extract Files

Put these three folders into your resources directory:

resources/
├── tw-lib/                     ← Tworst library (REQUIRED)
├── tw-scrapyard/               ← The job
│   ├── defaults/
│   │   ├── config.lua          # Settings
│   │   ├── coordinate.lua      # Locations, machines, rental, sell & craft
│   │   └── locales/            # Texts (7 languages)
│   ├── hooks/                  # Your own functions (survive updates)
│   ├── client/  server/  shared/  html/
│   ├── ITEM/                   # Item definitions & images
│   └── fxmanifest.lua
└── tw_scrapyard_stream/        ← Map, props, vehicles (REQUIRED)

The folder names must stay exactly tw-lib, tw-scrapyard and tw_scrapyard_stream. Without the stream folder the scrapyard is invisible and the trucks do not spawn.

---

Step 3: Database

Nothing to import. On first start the job creates tw_scrapyard (player levels, daily missions, history) and tw-lib creates its own tables (tw_lib_settings, tw_lib_players, tw_lib_ledger, tw_lib_ledger_daily, tw_lib_job_history).

---

Step 4: Add Items

QBCore / QBox

Add to qb-core/shared/items.lua (also in ITEM/qb.txt):

gold_dust    = { name = 'gold_dust', label = 'Golden Dust', weight = 100, type = 'item', image = 'gold_dust.png', unique = false, useable = false, shouldClose = true, description = 'A golden dust seems like the jackpot to me!' },
iron         = { name = 'iron', label = 'Iron', weight = 100, type = 'item', image = 'iron.png', unique = false, useable = false, shouldClose = false, description = 'Handy piece of metal that you can probably use for something' },
pistol_part1 = { name = 'pistol_part1', label = 'Pistol Part 1', weight = 100, type = 'item', image = 'pistol_part1.png', unique = false, useable = false, shouldClose = true, description = '' },
pistol_part2 = { name = 'pistol_part2', label = 'Pistol Part 2', weight = 100, type = 'item', image = 'pistol_part2.png', unique = false, useable = false, shouldClose = true, description = '' },
pistol_part3 = { name = 'pistol_part3', label = 'Pistol Part 3', weight = 100, type = 'item', image = 'pistol_part3.png', unique = false, useable = false, shouldClose = true, description = '' },
pistol_part4 = { name = 'pistol_part4', label = 'Pistol Part 4', weight = 100, type = 'item', image = 'pistol_part4.png', unique = false, useable = false, shouldClose = true, description = '' },

ox_inventory

Add to ox_inventory/data/items.lua (also in ITEM/ox.txt):

["gold_dust"] = { label = "Gold Dust", weight = 1, stack = true, close = true },
["iron"] = { label = "Iron", weight = 1, stack = true, close = true },
["pistol_part1"] = { label = "Pistol Part 1", weight = 1, stack = true, close = true },
["pistol_part2"] = { label = "Pistol Part 2", weight = 100, stack = true, description = 'A component used in assembling a pistol.', client = { image = 'pistol_part2.png' } },
["pistol_part3"] = { label = "Pistol Part 3", weight = 100, stack = true, description = 'A component used in assembling a pistol.', client = { image = 'pistol_part3.png' } },
["pistol_part4"] = { label = "Pistol Part 4", weight = 100, stack = true, description = 'A component used in assembling a pistol.', client = { image = 'pistol_part4.png' } },

Other inventories

Add the same six items the way your inventory expects. The weapon crafting reward is weapon_pistol, which your framework already has.

Item Images

Copy the images from tw-scrapyard/ITEM/ into your inventory's image folder (for example qb-inventory/html/images/ or ox_inventory/web/images/).

---

Step 5: server.cfg

ensure oxmysql
ensure qb-core              # your framework, if any
# ... your inventory, keys, fuel, clothing, target scripts

ensure tw-lib               # before every Tworst job
ensure tw_scrapyard_stream
ensure tw-scrapyard

Start order matters: tw-lib must start before tw-scrapyard. If the job starts first, tw-lib restarts it once by itself and prints a warning. Fix the order anyway.

---

Step 6: Start & Check

Start the server and look at the console:

[tw-lib] server loaded
[tw-lib] 1.0.0 | framework=qb | inventory=qb-inventory | keys=qs-vehiclekeys | fuel=LegacyFuel | clothing=qb-clothing
[tw-lib] up to date: tw-lib 1.0.0, tw-scrapyard 3.0.0

• The second line shows what tw-lib detected. If something is wrong there, see Troubleshooting.

• The last line appears a few seconds later. If a new version exists it says update available instead.

Then in game: go to the scrapyard (default: El Burro Heights), talk to the NPC, open a lobby and start.

---

Admin Menu Permission

/twlib opens the Tworst admin menu for players with the tw-lib.admin ace. QBCore / QBox admins (god, admin) and ESX admins (admin, superadmin) are allowed automatically. For anyone else, add to server.cfg:

add_ace group.admin tw-lib.admin allow

You can also list players by identifier in tw-lib/config.lua, and set the menu language there. See tw-lib → Admin Menu for what each page of the menu does.

---

Updating from 1.x

1. Stop the server (or the resource).

2. Download the new tw-scrapyard and tw-lib.

3. Copy the new tw-scrapyard over your old folder. Do not delete the old folder first: tw-lib reads your old config/config.lua, config/coordinate.lua and locales/ once and keeps every value you had changed (money, XP, language, texts, coordinates).

4. Keep your tw_scrapyard_stream folder as it is.

5. Add ensure tw-lib before ensure tw-scrapyard in server.cfg.

6. Start the server. The console lists what was imported. Your players' levels and history in tw_scrapyard are kept.

From 3.0 on, updates are simple: copy the new folder over the old one. Your settings are stored in the database (tw_lib_settings), so nothing you changed is lost.

Options that are functions (Config.startJobFunction, Config.endJobFunction, Config.sendNotification) are not imported. Move your code into hooks/my-hooks.lua (see Configuration → Hooks).

---

Troubleshooting

Could not find dependency tw-lib for resource tw-scrapyard

tw-lib is not installed or not started. Install it (Step 1) and ensure tw-lib before the job.

tw-scrapyard needs tw-lib X or newer

Your tw-lib is older than the job needs. Download the latest from GitHub or the Cfx.re portal and replace the tw-lib folder.

Wrong framework / inventory / keys / fuel / clothing detected

Look at the [tw-lib] 1.0.0 | framework=... line. If a script you use is not there, check that it is started, and that its folder name is the original one. To force a choice: twlib set tw-lib bridge.inventory ox_inventory in the server console (same for framework, keys, fuel, clothing), then restart tw-lib.

Invisible scrapyard / trucks do not spawn

tw_scrapyard_stream is missing or not started.

Items are not given

The six items are missing from your inventory. See Step 4. Item names are case-sensitive.

---

Need Help?

Open a ticket on our Discord with the [tw-lib] ... status line from your console and any red error lines.