Skip to content

Market

Step-by-step guide for the housing marketplace (sale / rent / auction tabs).

1. Enable and open the market

  1. Set access mode:
lua
Config.RealEstate.marketAccess = "public" -- or "realtor"
Config.RealEstate.marketCommand = "housingmarket"
Config.RealEstate.marketItem = false -- or an item name
  1. Restart prp-housing-v2.
  2. Open the UI:
    • Chat: /housingmarket (or your marketCommand)
    • Optional usable item if marketItem is set
    • Client export: exports["prp-housing-v2"]:OpenMarket()

2. Understand the tabs

TabShows
For SaleDirect sale (saleType = "normal") and offer listings (offer)
For RentRent offers with isDisplaying and no tenant
AuctionsTimed auctions (saleType = "auction")

3. Player — buy a property

  1. Open the market → For Sale.
  2. Search or browse cards (banner image + price).
  3. Open a listing → check gallery, description, price.
  4. Optional: Set waypoint.
  5. Click Buy now → bank charged via prp-bridge → ownership assigned → listing cleared.

4. Player — rent a property

  1. Open the market → For Rent.
  2. Open a listing → Rent now.
  3. First period is charged to the tenant bank and paid to the owner bank.
  4. Later periods: pay from Housing Central — see Rent.

5. Player — bid or offer

  1. Open Auctions (or an offer listing under For Sale).
  2. Place bid / offer → deposit held (bidDepositPercent or listing override).
  3. Wait for auction end or owner/staff accept — see Auctions & offers.

6. Staff / owner — put a listing live

Realtor tablet

  1. Open Real estate tablet.
  2. Open the property profile.
  3. Use List for sale (type normal / offer / auction) or List for rent.
  4. Confirm it appears on the matching market tab.

Owner (public mode only)

  1. Enter the property → open Housing Central.
  2. Use the rent tab to set price / toggle listing, or list for sale via central market NUI (market/LIST_PROPERTY).
  3. Verify on the market UI.

7. Wire a custom phone app

Follow Exports — Phone app integration.