Installation
This is a guide designed to lead you through the successful installation process of the script. Please follow the steps and do not deviate from the instructions.
Download Script
To download the assets of the script which you've purchased from INNOCENT RP you must follow the steps below. Asset delivery is handled by Tabex and Cfx.re in the Cfx.re Portal aka Keymaster.
Go to Cfx.re Portal and navigate to the Granted Assets Page
Sign in if prompted
Sign in with your Cfx.re account
Sign in using the same Cfx.re account you used when purchasing the asset.
If you can't find the asset please make sure you used the correct Cfx.re account before making any support requests.
Download the script
Locate and download
- inn-laundry
Download Dependencies
It is essential that you install all of the dependencies below, in addition to the framework/inventory you already run.
github.comGitHub - overextended/oxmysql: MySQL resource for FXServer.
MySQL access
github.comGitHub - overextended/ox_lib: A FiveM resource and script library for Lua and JS.
Callbacks, zones, points, notifications
github.comGitHub - DemiAutomatic/object_gizmo: A FiveM utility for moving objects around using a 3d gizmo
In-world 3D gizmo used to precisely place a washing machine
bzzz.tebex.io
bzzz_money — washing machine + supplier NPC bag props and animations. Install and update it separately, and don't rename anything inside it.
The dependencies below are not required for the core features of the script to function and are interchangeable for other assets of your liking.
Target (ox_target or qb-target) — recommended, but every interaction (machines, the supplier NPC, the generator, shell entry/exit) can fall back to a simple [E]-prompt instead via each feature's useTarget config toggle, so a target resource isn't strictly required.
Dispatch (ps-dispatch or cd_dispatch) — if neither is installed, police raid alerts fall back to this script's own built-in notification to online police, so no third-party dispatch resource is required either.
qb-interiors — only needed if you want the default shell interior option (shell_warehouse1, the free shell from k4mb1's shell pack) to resolve in-game. Skip this if you clear Config.Shells.options or only add your own shell pack entries.
It is highly recommended that you shutdown your FiveM server before you proceed with any of the steps below.
Assets Upload
Upload the script
Drag the inn-laundry folder into your server's resources directory.
Upload bzzz_money
Drag the bzzz_money folder into resources too, and follow its own readme.txt for setup.
Copy the item icons
Copy the item icons included in install/images/ into your inventory's image folder:
- ox_inventory →
ox_inventory/web/images/ - qb-inventory →
qb-inventory/html/images/ - qs-inventory →
qs-inventory/html/images/ - qs-inventory (Advanced) →
qs-inventory/web/dist/images/
Starting Order
Dependencies must start before inn-laundry in server.cfg. Framework, inventory, and target can be whichever of the listed options you actually run:
ensure oxmysql
ensure ox_lib
ensure qb-core # or es_extended / qbx_core
ensure ox_inventory # or qb-inventory
ensure ox_target # or qb-target
ensure object_gizmo
ensure bzzz_money
ensure qb-interiors # only if using the default shell option
ensure inn-laundry
Items Setup
Add the contents of install/items/ox_inventory.lua to ox_inventory/data/items.lua.
Add the contents of install/items/qb-inventory.lua to qb-core/shared/items.lua (QBCore or Qbox running qb-inventory).
Add the contents of install/items/qs-inventory.lua wherever your qs-inventory version declares items.
Use one of the files above as a reference for the item names/weights and add them however your inventory expects.
If you rename an item in config/items.lua, rename it in your inventory's item list too, or the script will hand players an item your inventory doesn't recognize.
Database Setup
server/db.lua runs CREATE TABLE IF NOT EXISTS for all five tables the first time the resource starts — you don't need to import anything by hand in the normal case.
If your database user isn't allowed to run CREATE TABLE (some shared hosts restrict this), import install/sql/inn-laundry.sql once by hand instead, preferably using HeidiSQL or another manager compatible with MariaDB/MySQL — the resource will detect the tables already exist and skip creating them.
Avoid doing this through XAMPP or other non-optimized local server setups, as they're prone to causing connection errors.
Extra
Starting the script or the server is not recommended before you have completed Integration.
If any of the steps or instructions in this guide are incompatible with your infrastructure please request Support.