Configuration
Three Ways to Change a Setting
In game: /twlib → Settings
Pay, XP, bonus, cooldown, crew size, level rules, reward split, interaction style. Saved values apply when the job restarts: use the Restart button in the menu.
Edit defaults/config.lua / defaults/coordinate.lua
Everything else. Save the file and restart tw-scrapyard: tw-lib notices your edit and stores it.
Server console: twlib set
Quick changes without opening a file: twlib set tw-scrapyard Config.MaxPlayersInLobby 3, then restart tw-scrapyard. Undo with twlib unset tw-scrapyard Config.MaxPlayersInLobby.
Configuration Files
defaults/config.lua
General settings, lobby, commands, UI colours, regions & rewards, daily missions, sell NPCs, door lock, levels
defaults/coordinate.lua
Scrap areas, machines (press, shredder, furnace, rail), vehicle rental, items, sell prices, craft recipes, controls
defaults/locales/*.lua
Texts in 7 languages
hooks/*.lua
Your own functions (start/end hooks, notifications, prompts)
General
Inventory
Config.InventoryImagePath
qb-inventory
nui://qb-inventory/html/images/
ox_inventory
nui://ox_inventory/web/images/
Language
Default is English. To change it, run twlib set tw-scrapyard Config.Locale tr in the server console and restart the job, or change 'en' in the Config.Locale line and restart the job. Both are kept across updates.
Interaction
'default'
Use the choice made once for all Tworst jobs in /twlib → Settings → All jobs (or twlib set tw-lib interaction ox-target)
'drawtext'
Tworst prompt with E
'ox-target' / 'qb-target'
Target eye
'auto'
ox_target if running, else qb-target, else the Tworst prompt
Lobby & Job
Who Can Take the Job
The job rule is checked on the server when a lobby is opened and when an invite is accepted. On frameworks without jobs (standalone, vRP, TMC) everyone can join.
Commands
Tutorial
Job Menu Look
The job menu is the shared Tworst job UI inside tw-lib. Scrapyard's colours and pictures:
Config.DefaultUIPositions sets where the crew list, score, invite and notification boxes sit on screen. Players can also move them in game.
Job Location & Blips
['missionBlips'] holds the blips of each task step, the truck and the delivery point.
Regions & Rewards
Reward Split
With Config.LetOwnerSplitRewards = true the lobby owner sets each member's share in the lobby menu: the crew's total (the reward per player × the members online at the payout) is shared by those percentages. With false every member gets the same reward.
Mission Completion Items
missioncompletedItems gives extra items at the end of a region. dropMode = "perItem" rolls each item on its own; "weightedPool" gives one item from the pool.
Daily Missions
Vehicle Rental
In defaults/coordinate.lua:
Config.VehicleSettings lists the spawn-point trucks, Config.VehicleTiers their capacity.
Selling
In defaults/coordinate.lua. Items sell only next to the matching NPC.
The NPCs themselves (position, model, blip, on/off) are in defaults/config.lua under Config.Job['sellNPCs'].
Crafting
Recipes are in defaults/coordinate.lua:
If the reward does not fit the player's inventory, it waits and can be collected later.
Illegal Area Door
Levels
Config.RequiredXP holds the XP needed for each of the 70 levels. XP above the requirement carries over to the next level.
Machines, Scrap & Controls
defaults/coordinate.lua also holds the scrap areas (Config.scrapArea, Config.ScrapItemList), the machines (Config.PressMachines, Config.ShreddingMachines, Config.Furnaces, Config.Rail, Config.CrucibleSystem), timings (Config.Timing), the mould rewards (Config.MoldRewards) and the keys (Config.Controls). Change these only if you move the scrapyard.
Texts
All texts are in defaults/locales/<language>.lua. Edit the file and restart the job: tw-lib keeps your edited texts across updates like any other setting. A text missing in a language falls back to English.
Hooks
Functions cannot be stored in the database, so they live in hooks/. Copy hooks/hooks.example.lua to hooks/my-hooks.lua and edit it there. An update replaces only the example; your file is never touched, and it is loaded after the settings, so it wins.
Need Help?
Last updated

