HousingDeprecated

Installation

Install the housing system and configure its database, framework, objects, translations and TypeScript build.

Required dependencies

✓

Node.js

Required for dependency installation and TypeScript compilation.

✓

FiveM artifact 4752+

Required for Lua 5.4 and escrow support.

✓

Aquiver module

Framework and database compatibility layer.

Open resource ↗

✓

Recent game build

Build 2612 or newer is recommended for the widest object selection.

Installation steps

1. 01

   Extract the resource

   Copy the extracted folder into your server resources directory.

2. 02

   Install dependencies

   Run the included npm dependency installer.

   dev/install_dep.bat
3. 03

   Import the database

   Import the included SQL file into your server database.

4. 04

   Configure translations

   Edit the shared locale strings.

   source-files/shared/shared-translations.ts
5. 05

   Configure the server

   Select your framework and database resource.

   server.ts
6. 06

   Configure the client

   Select your framework in the client configuration.

   client.ts
7. 07

   Configure object prices

   Review and adjust the buildable object prices.

   source-files/shared/objects.json
8. 08

   Compile the resource

   Build the TypeScript files after completing the configuration.

   dev/compile.bat
9. 09

   Start the resource

   Add the housing resource to your server configuration.

   ensure housebuilder

Aquiver module config

Configuration

Module configuration

Configure the server and client settings used by the Housing resource.

Server

Module server config

import * as Aquiver from "@aquiversdk/server";

Aquiver.Config.Framework = "ESX_LEGACY";
Aquiver.Config.SqlDebug = false;
Aquiver.Config.sqlResource = "oxmysql";
Aquiver.Config.ResourceExtra.selectedAccount = "bank";
/** Players cannot enter a house until at least this many objects (walls, floors, etc.) have been placed. */
Aquiver.Config.ResourceExtra.MinimumObjectToEnterHouse = 30;
// How many houses can a player own.
Aquiver.Config.ResourceExtra.MaximumOwnableHouse = 3;
/** Set the group required to use the /ahouse command and other protected functions. */
Aquiver.Config.ResourceExtra.NeededPermission = "admin";
/** Selectable:
 * "only-owned": Show only player-owned houses.
 * "every": Show every house blip on the map.
 * "sold": Show sold houses on the map.
 * "buyable": Show only buyable houses on the map.
 */
Aquiver.Config.ResourceExtra.ShowBlips = "buyable";
/** Allow house key owners to build the house. */
Aquiver.Config.ResourceExtra.keyOwnersAbleBuild = false;

Client

Module client config

import * as Aquiver from "@aquiversdk/client";
Aquiver.Config.Framework = "ESX_LEGACY";

/** Enable or disable the native GTA map in the editor. */
Aquiver.Config.ResourceExtra.DisplayRadarInEditor = false;

/** These Node.js intervals are measured in milliseconds. Adjust them to balance update frequency and performance.
 * Review the associated functions before changing these values, as incorrect settings can cause major issues.
 */
Aquiver.Config.ResourceExtra.Performance = {
    CursorTickerMS: 15, // Updating Cursor position.
    DoorCheckerMS: 1000, // Updating streamed doors.
    ObjectSelectingMS: 85, // Object selecting render speed.
    PlacingPropRenderMS: 85, // Placing props render. (This is raycast, so its expensive.)
    PlacingPropBindsMS: 1, // This is also placing props render with the camera movements and keybinds.

    DoorDistance: 10 // Vector3<->Vector3 distance to render the doors & markers.
}