RedM documentation

Murphy's Housing

Getting Started

Installation

Install Housing with its database, framework, interactions and complete interface files.


Prepare the downloaded package

Use the murphy_realestate resource from your purchase. Read the version in fxmanifest.lua, back up any existing property data and configuration, and extract the complete resource without an extra folder around it.

The inspected source imports @oxmysql/lib/MySQL.lua, declares oxmysql and murphy_interact, and loads its interface from ui/build/index.html. The complete compiled ui/build/ directory must be present. A production installation should not need an interface rebuild just to start the supplied package.

Dependencies and start order

Start the database connector, supported framework and inventory before Housing. Install the RedM-compatible dependency version required by murphy_interact, and ensure the interaction resource starts successfully.

server.cfg
# Add these after your framework and its inventory.
ensure oxmysql
ensure ox_lib
ensure murphy_interact
ensure murphy_realestate

The example assumes an Interact distribution using ox_lib. Check that resource's own manifest. Install mapping resources used by the interior templates before testing the corresponding property.

Framework and configuration

Housing detects the supported framework at runtime. Do not paste a Config.framework selector from another Murphy plugin as an installation requirement. Check startup output and that the intended core and inventory have actually started.

Edit the existing shared/settings.lua. Keep Config.DevMode disabled for player use. Review admin groups, interior definitions, economic settings and enabled optional integrations using Configuration.

Database and upgrades

Inspect the SQL and migration instructions in the downloaded release. Apply missing schema changes to the correct database, keeping existing property, ownership and decoration data. Never use a fresh-install reset on an established server.

If upgrading from before 1.36.0, read Taxes and Updates before starting the new resource: the corrected eviction system can act on old unpaid properties. VORP storage changes in 1.38.1 also affect how configured capacity is interpreted.

First verification

Use a test character and an inexpensive test property. Confirm startup, admin access, creation, purchase/rental, entry, exit, storage and reconnect. Then test a second character with and without guest access. Check the first client F8 and server error if any step fails.

Run this verification on your installed version before applying the same configuration to an established server.


Last updated: September 10, 2026