InstallationCopy Anchor Link

Thank you for choosing Kartik Properties, a complete property, block & real-estate economy system for FiveM.

This guide walks you through installing, starting, and preparing the resource. Configuration of individual features lives in the Configuration section, and mode selection in Operating Modes.

RequirementsCopy Anchor Link

Kartik Properties depends on two resources that must be started before it:

• ox_lib
• oxmysql

It also needs one supported framework and one supported inventory (auto-detected at runtime, see Supported Frameworks).

Download the assetCopy Anchor Link

1. Log in to Keymaster.
2. Locate Kartik Properties in your acquired assets.
3. Download it into your server's resources folder (keep the folder name kartik-properties).

Start orderCopy Anchor Link

Add these to your server.cfg in this order:

ensure oxmysql
ensure ox_lib
ensure qbx_core      # or qb-core / es_extended - your framework
ensure ox_inventory  # or qb-inventory / codem-inventory - your inventory
ensure kartik-properties

DatabaseCopy Anchor Link

The database schema is created and migrated automatically on server start. There is no SQL file to import manually, the resource builds every kp_* table and applies schema migrations for you on first run (and on every update).

You'll see migration lines in the server console the first time it starts. If you're importing from another housing script, see Migrations.

Add the itemsCopy Anchor Link

Some optional features (physical keys, contracts) use inventory items. Add them to your inventory following Configuration → Items. Lockpicks use whatever item you already have (lockpick by default).

First runCopy Anchor Link

1. Start the server and confirm the schema migrations run without errors.
2. Decide your mode in shared/mode.lua Block mode (default) or Classic mode.
3. Press F7 in-game (or open the Property radial entry) to launch the tablet.
4. If you're staff/admin, use /propadmin to open the Admin Registry and begin drawing blocks (Block mode) or letting your realtor job create property (Classic mode).

Continue with the How-To Guide for step-by-step walkthroughs.

Rebuilding the NUI (optional)Copy Anchor Link

The compiled UI ships in build/. Only rebuild if you modify the React source in source/:

cd source
npx vite build