Documentation
Learn how the script works, explore its main features, and discover how to configure and use everything with ease.
Everything revolves around the motel zone. Each motel has a blip, a reception, a room management point and its own rooms, all drawn live in the world and stored in the database.
Interaction uses markers by default. Set Config.target = true to use ox_target / qb-target instead.
Command | Side | Who | Purpose |
|---|
| Client | Admins + | Open or close the motel creator. Also bindable through FiveM keybindings |
| Server |
| Break into the nearest room |
| Client | Anyone at an MLO door | Teleport through an MLO room door |
| Console only | Server owner | Force a full save of every motel |
The /raid and motel-save names come from Config.raid.command and Config.saveCommand. Setting either to false removes the command entirely.
Access to the creator is granted when either of these is true:
The player is an admin — the groups listed in Config.adminSettings.permissions (admin, superadmin, god by default).
The player's job and grade match an entry in Config.CreatorJobs (realestate by default).
Pick the type before drawing anything — it decides how the interiors work.
Type | Interior | Requires | Notes |
|---|---|---|---|
| Real map interior | The MLO resource | Each room has its own physical door; |
| Spawned shell prop |
| Rooms are instanced; models listed in |
| bob74_ipl interior |
| Coordinates and exports listed in |
For shell and IPL motels, the stash and wardrobe points are defined once on the motel and reused by every room instance. For MLO motels they are defined per room.
A ready-made example of a Gabz Pinkcage MLO motel ships in database/mlo motels/gabz pinkcage.sql.
Run /motelcreator.
Pick a type — mlo, shell or ipl.
Draw the zone: left click adds a point, right click undoes, Enter confirms. A minimum of 4 points is required, and scroll adjusts the polygon height.
Place the blip, the reception (with an optional reception ped) and the room management point.
Add the rooms — doors, stashes and wardrobes. On shell and IPL motels the shared stash and wardrobe points are placed once.
Set the pricing: cost_per_minute, pricing_unit (minute / hour / day / week), key_cost, sale_price, sale_multiplier, purchasable and auto_system.
Save. The motel is written to the database and broadcast to every client immediately — no restart needed.
Editor controls are fully remappable in ActionControls and Config.FreeModeKeys, and camera feel in CameraOptions.
Config.IplData[#Config.IplData + 1] = {
export = function() return exports['bob74_ipl']:GetExecApartment1Object() end,
exitCoords = vec3(-787.44, 315.81, 217.64),
iplCoords = vec3(-787.78, 334.92, 215.83)
}How a player rents depends on whether the motel has an owner:
Auto-system motel (no owner, or auto_system = 1) — the player interacts with the reception and rents directly.
Owned motel — an employee with the rent permission rents a room to a nearby player from the reception UI, within Config.nearbyPlayersRadius.
If Config.bill.active is enabled the price is issued as a bill, payable at Config.bill.pos. Otherwise the money is taken immediately and deposited into the motel balance.
On success the tenant receives a motelkey metadata item (when Config.MetaKeys is on) bound to motelId-roomId plus a random unique_key. Rotating the key invalidates every old copy.
Config.maxRoomsPerPlayer (5) limits simultaneous rentals across all motels, and with Config.existBillThenBlock a player with unpaid bills cannot rent anything new.
Tenants can share their key with up to 5 guests, each with individual permissions:
door · stash · wardrobe · extend · pay · request · create key
Config.warningSystem fires at 50 %, 70 % and 90 % of the rental period. Each warning adds debtMultiplier to the outstanding debt and notifies the tenant.
On expiry the debt is multiplied by finalMultiplier (2.0) and, with suspendOnDebt, the room is suspended — the key stops working until the debt is paid.
Room stashes hold 80 slots / 1,000,000 weight by default (Config.stashSettings).
With Config.wipeStashOnLeave enabled, the stash is wiped when a tenant leaves, is kicked, or the rental expires. Config.personalStashes switches to one stash per tenant instead of per room — this is not available on standalone and requires an inventory whose stash API accepts an owner.
Owners hire from the reception UI. Each employee gets individual permissions:
kick · change · timerefresh · createnewkey · sendmessage · takeplayer · showrequests · takeMoney · depositMoney · updateStatus · openRoom · rent
Salaries are paid every Config.employee.autoSalary (20 min by default) using Config.employee.salaryMethod (bank or money).
With Config.storage.takeSalary the money is drawn from the motel balance. Setting obligatorySalary = false skips the payment when funds are insufficient instead of letting the balance go negative.
Upgrades only apply to motels that have an owner. Auto-system motels have every feature unlocked.
Config.Upgrades = {
enabled = true,
roomCapacity = { levels = { 25, 50, 75, 100 }, prices = { 10000, 25000, 50000, 100000 } },
security = { raidTimeMultiplier = { 1.5, 2.0, 3.0 }, prices = { 15000, 30000, 60000 } },
keySharing = { price = 20000 },
autoSystem = { price = 50000 },
}roomCapacity is a percentage of the motel's total rooms that are rentable at that level — so a 100-room motel at level 1 rents only its first 25 rooms.
/raid breaks into the nearest room. It requires a job listed in Config.raid.jobs (police by default) and the item in Config.raid.item (police_stormram).
The security upgrade multiplies the raid time by 1.5×, 2× or 3× depending on its level. If Config.raid.minigame is enabled, ps-ui is required.
Motels are saved automatically every Config.autoSaveTime (10 min) while Config.autoSave is enabled.
To force a save at any time, run motel-save in the server console — this command is not available in game.
Discord webhooks are configured in server/custom/main.lua. Empty strings disable that specific webhook.
Webhooks = {
['Create Bill'] = 'https://discord.com/api/webhooks/...',
['Pay Bill'] = '', ['Accept Request'] = '', ['Reject Request'] = '',
['Left Motel'] = '', ['Pay Rent'] = '', ['Set Employee Salary'] = '',
-- ...
}Events cover bills, rent, requests, employees, keys, permissions, motel balance, ownership and stashes.
Config.Debug ships enabled — turn it off in production, as it produces verbose console logging.
Config.Debug = false
Config.ZoneDebug = falseConfig.ZoneDebug draws the interaction polyzones in the world, which is useful while placing a motel but should also stay off on a live server.