Skip to content

Usage ​

Player-facing overview. Deep detail lives on linked pages.

How it works ​

  1. On character connect, a player can be auto-assigned a tower apartment when Apartment Towers (prp-apartments) is started — Apartments.
  2. Staff create MLO / shell locations; ownership is assigned via real estate panel or admin commands.
  3. Owners and keyholders use door targets to enter, lock, ring, or check mail.
  4. Inside a property, the Housing Central radial opens upgrades, furnish, garage placement, and keyholders.
  5. Privileges control who can furnish, open storage, use inner doors, garages, and settings.

Apartments ​

Full guide: Apartments.

Requires Apartment Towers (prp-apartments started — recommended before prp-property, not a hard dependency). Four towers; units auto-assign on connect.

  • Follow the tower blip to your building lobby.
  • Talk to the receptionist → What's my room? for room and floor (no floor/room blip).
  • Elevator menu marks your room on the matching floor.
  • Lock/unlock the apartment door; enter your unit to furnish via Housing Central.

Properties ​

Creating properties ​

Full step-by-step (MLO creator keys, dialog fields, shell path, assign owner): Creating properties.

Short version:

  • MLO — Admin /register_housing inside the interior → mark doors → G to save → /housing_give [stateId] [locationId].
  • Shell — Real estate panel → Shells tab (grade createShellProperty).

Use /edit_housing [locationId] to change name, price, type, and limits.

Assigning ownership ​

/housing_give [stateId] [locationId]

Legacy: /assign_location. Agents can also sell/assign from the real estate panel.

Entering & interiors ​

Players with access enter through configured doors. Shell properties use a shared routing bucket so keyholders see each other — see Shells.

Doors & targeting ​

Exterior doors use ox_doorlock by default. Full option list (doorbell, lock, lockpick, mail, furniture storage, etc.): Doors & targeting.

Housing Central ​

When inside a loaded property, the ox_lib radial (house icon) or /housing_menu opens Housing Central.

AreaPage
Furnish, storages, settings, keyholdersHousing Central
Buy upgradesUpgrades
Place / use garageGarages
Electricity, overload, humidity / temperatureElectricity & House Usage

Maintenance and rent

Maintenance fees are active via prp-bridge (payer + auto-charge + seizure). Full rent (list / pay / auto-evict) is available — see Rent and Housing Central.

Electricity & climate ​

Powered furniture (lamps, fridges, heaters) draws kWh. Overloading breaks powered pieces until players remove load and repair them. Humidity defaults to 50% in stock builds (escrowed logic). Full guide: Electricity.

Furnishing ​

Players with the FURNISH privilege open the catalog from Housing Central. Catalog data: furnishing/furniture_items.json (plain JSON). Category/interaction hooks: furniture.lua.

Furniture can also be placed from inventory items with model and category metadata (placeable_furniture_item / collectable_furniture_item). Catalog placement charges the bank via HousingBridge.chargeBank.

Gizmo controls ​

InputAction
Left clickSelect furniture
WMove mode
RRotate mode
LToggle local/world space
OToggle outline

Storage stashes ​

Stash typeDescription
PROPERTY_FURNITUREStorage inside furniture pieces
PROPERTY_STORAGEBuilt-in property storage
MAILBOXProperty mailbox (receive items)
MAIL_DEPOSITDeposit slot for mail delivery
TEMP_PROPERTY_TRASHTemporary trash during furnishing

Garages ​

Buy the GARAGE upgrade, then place access + vehicle spawn points near the house. Re-placing updates the same garage (housing zone moves; one garage per property). Supported scripts and parking behaviour: Garages.

Open world furnishing ​

Configured poly zones allow persistent props outside properties (Config.Features.openWorldFurnish).

CommandDescription
refresh_zonesReload open world zones (client)
/show_accessOpen access management for the current zone (admin)

Access privileges ​

PrivilegeDescription
FURNISHPlace and remove furniture
ACCESSManage other keyholders
UPGRADESPurchase upgrades
MAINTENANCEPay / manage maintenance fee and payer
STORAGEOpen property storage
INNER_DOORLock/unlock inner doors
GARAGEUse / place property garage
SETTINGSWall colour, timecycle, projects

Property projects ​

Owners and keyholders with SETTINGS can save named presets (wall, timecycle, floor). With Config.Projects.includeFurniture = true, a preset can also snapshot placed furniture.

  • Apply on enter — active project settings apply when you enter (Config.Projects.applyOnEnter).

Admins: /housing_project list|save|apply|delete [housingId|locationId] ...

Configuration & APIs ​

Locales ​

UI strings: locales/en.json, locales/br.json, locales/sv.json.