Laundromat Heist Installation

This guide gets vs-laundromat-heist running from a clean download. Follow the steps in order: the most common failure is starting the resource before its dependencies.

Requirements

• A licensed FiveM server on a recent artifact.
• The Go & Wash Laundromat MLO: the heist's locations live in its ymaps (Config.Heist.mapResource, default wxmaps_laundromat). Scouting and the heist only run where that map is present.
• The dependencies on the Dependencies & Compatibility page.
• A MySQL database reachable through oxmysql.

Step 1: Install the dependencies first

Install and confirm these are working before the heist. See Dependencies for links and details.

• ox_lib, oxmysql
• a target: ox_target or qb-target/qtarget
• an inventory: ox_inventory or qb-inventory
• vs-npc-dialogue and vs-minigames (free companion resources)

Step 2: Install the map

Upload the Go & Wash Laundromat map resource and ensure it in server.cfg. The heist reads its locations from the map named in Config.Heist.mapResource. If you renamed the map resource, update that config value to match.

Step 3: Upload the heist

Extract the download and upload the whole vs-laundromat-heist folder into your resources/ directory (a sub-folder such as resources/[vanguardscripts] is fine). Do not rename it.

Step 4: Order server.cfg correctly

This is the step people get wrong. Every dependency must start before the heist. The script prints a clear warning at boot if any are missing.

# ── libraries ─────────────────────────────
ensure ox_lib
ensure oxmysql

# ── target + inventory (start the ones you use) ──
ensure ox_target
ensure ox_inventory

# ── free companion resources ──────────────
ensure vs-npc-dialogue
ensure vs-minigames

# ── the map, then the heist ───────────────
ensure wxmaps_laundromat
ensure vs-laundromat-heist

Step 5: Database

The four tables auto-create on first start (idempotent CREATE TABLE IF NOT EXISTS). Importing install.sql up front is recommended so the economy is ready before the first heist and a boot-time DB hiccup can't delay it:

mysql -u <user> -p <database> < install.sql

This creates vs_laundro_debt, vs_heist_reputation, vs_laundro_prep, and vs_laundro_audit. Full schema on the Economy & persistence page.

Step 6: Register the items

Register the heist items in your inventory and wire the three usable items to their exports. Copy-paste blocks for ox_inventory and qb-inventory are on the Items page. All item names are configurable in config/config.lua.

Step 7: Configure the essentials

Open config/config.lua (left editable via escrow_ignore) and set, at minimum:

• Config.Heist.crewSize: 1 for solo testing, 4 for production. This is both the requirement to start and the hard cap on who joins at prep.
• Config.PoliceAlert.jobs: your server's police job name (or a list, e.g. { 'police', 'sheriff', 'bcso' }).
• Config.Contract.payout: how cash is paid ('cash' to the wallet, or 'dirty' as a launderable item).
• Config.Boss.clan: the shared clan id reputation is tracked under (see Bosses & reputation).

The full annotated reference is on the Configuration page.

Step 8: Go live

Before opening to players, set both of these false in config/config.lua:

Config.Debug   = false  -- console prints + debug notifications
Config.DevMode = false  -- registers the ACE authoring/test commands

Anti-cheat & model whitelist

The heist spawns peds, vehicles, and props, and edits entity state (freezing props, opening a safe door, guard behaviour). If your anti-cheat blocks ped/vehicle spawns or entity edits, whitelist the models below so the actors and props appear.

Verify it's running

1. Start the server and watch the console: a missing dependency prints a named warning at boot.
2. Join and travel to the laundromat. With Config.DevMode = true, run /laundro_startheist to jump straight into a heist and confirm the objective board, targets, and minigames work.
3. Set crewSize = 1 while testing solo.

Still stuck? See Troubleshooting & FAQ or open a ticket on Discord.