Money Wash

Overview

Money Wash turns dirty money into clean money. Players take their blood money clips to a washer, choose cash or gold and how many clips, then ride to a handoff spot where a contact takes the money. After a short hand-over they're paid, minus the washer's cut, and earn XP. Higher levels wash more clips at once and unlock handoff spots further afield.

• A washer NPC with a menu: level, XP to the next level, the washer's cut, the clip limit, and the pay per clip in cash or gold.
• A number box for how many clips, filled in with the most the player can wash.
• A random handoff spot for the player's level, marked on the map with a GPS route, and a contact NPC waiting there.
• A timed hand-over that the server checks, so it can't be skipped.
• 8 levels, XP saved per character, a cooldown between washes, and the option to call off a handoff.

Money Wash is free. You can use it and change it on your own servers; please don't sell it or re-upload it (see LICENSE.md).

Requirements

• poggy_core (free), version 0.14.0 or newer.
• oxmysql.
• One of VORP, RSG Core or QBCore RedM (poggy_core connects the script to it).
• A way for players to get blood_money_clip: robberies, heists, loot or drops. Many robbery scripts already give it.

Install

1. Download Britannia_Money_Wash free from playbritannia.co.
2. Put the Britannia_Money_Wash folder in your server's resources folder.
3. Add the item (see Items):
   • VORP: run SQL.sql in your database (HeidiSQL, phpMyAdmin and so on). It's safe to run more than once, and leaves the item alone if your server already has it.
   • RSG Core / QBCore RedM: copy the entry from installation/items_rsg_qbcore.txt into your shared items list.
4. Copy installation/images/blood_money_clip.png into your inventory's item image folder (VORP: vorp_inventory/html/img/items/).
5. Add ensure Britannia_Money_Wash to server.cfg, after ensure oxmysql and ensure poggy_core.
6. Restart the server.

The XP table vorp_moneywash is created automatically on every framework.

Items

Item	Picture	Label	What it's for
blood_money_clip		Blood Money Clip	The dirty money that gets washed. Not usable on its own.

To wash a different item, set Config.DirtyItem to its name.

Configuration

Everything is in config.lua, and every option is commented.

Positions copied from where your character stands work fine: the washer and the contact are placed on the ground automatically.

Commands and permissions

There are no commands. Players use the washer's prompt (E) and the contact's prompt at the handoff.

How it works

1. At the washer, the player presses E. The menu's heading shows their level (for example Level 1/8), their XP to the next level, the washer's cut and their clip limit.
2. They pick Wash for cash or Wash for gold. Each shows what they get per clip after the cut. The options are greyed out, with the reason, when they have no clips or are on cooldown.
3. A box asks how many clips, filled in with the most they can wash.
4. A handoff spot for their level is marked on the map with a route. A contact appears there as they get close.
5. At the contact they press E and hold still for the hand-over. The server then takes the clips, pays them after the cut, and adds XP. A cooldown starts.

Opening the washer's menu during a handoff lets the player call it off; their clips stay with them.

Fair play. The server checks every step: that the player is at the washer, their level and clip limit, that they have the clips, the cooldown, that they are at their own handoff spot, and that the hand-over time has really passed. The pay is worked out on the server. If a payout fails, the clips are given back.

Troubleshooting

The washer isn't there

He appears when a player comes within 120 metres. Check Config.StartPed.coords and the server console for a line about the ped model. If you changed Config.StartPed.model, make sure it's a valid ped model.

"You have no blood money clips."

The player has no Config.DirtyItem in their inventory. Check the item exists (see Install) and that something on your server hands it out.

The menu doesn't open

Make sure poggy_core 0.14.0 or newer is started before Britannia_Money_Wash, and check the F8 and server consoles for errors.

There's no contact at the handoff spot

The contact appears when the player is within Config.HandoffPed.spawnDistance metres. If a handoff spot is somewhere unreachable, change it in Config.WashLocations.

"Go to your marked handoff."

The player is more than Config.LocationCompleteDistance metres from the spot. Stand next to the contact and try again.

"The handoff isn't finished yet."

The hand-over was ended early. Hold still for the full Config.WashSeconds.

The route goes in a straight line

Set Config.RouteFollowRoads = true. Spots far from any road are always reached in a straight line for the last part.

Item pictures are missing

Copy installation/images/blood_money_clip.png into your inventory's item image folder. The file name must match the item name.

Version history

• 1.1.0: first public release.