> For the complete documentation index, see [llms.txt](https://atiysus-organization.gitbook.io/aty-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://atiysus-organization.gitbook.io/aty-scripts/aty_housing.md). # aty\_housing ## aty\_housing Housing and property system on the `aty_lib` framework bridge: IPL, shell and MLO interiors, purchase and rent, keys and roles, loans and bills, a furniture Decor Studio, storage units, realtors and auctions, doorbell, police seals and house robbery, home security (cameras, alarm, door camera), light scenes and colours, garden decor in yards, and apartment buildings and motels, all built around one in-game tablet. > **Tested scope.** This page describes a feature-complete build that has **not** been verified on a live server as a whole. It was partly live-tested on QBCore; ESX and Qbox support comes from `aty_lib` and is untested. See Verification status before you rely on any feature in production. ### Documentation * Installation: Dependencies, Installation * Configuration: Configuration * Features and commands: Features, Commands, Languages * Living: Living: cooking, needs, hygiene and rest * Home security: Home security * Economy, upgrades and the player market: Ownership limits, Home insurance, Property upgrades, Player marketplace and contracts * Furniture, lighting and yards: Furniture store, Lighting and colours, Garden and exterior decor * Apartments, buildings and motels: Apartments, buildings and motels * Exports and events: Exports, Events * Webhooks and migration: Discord webhooks, Migrating from qb-houses / ps-housing * Troubleshooting: Troubleshooting ### Info | | | | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Resource name | `aty_housing` | | Version | `1.0.0` | | Status | Released. Partly live-tested on QBCore (see Verification status) | | Frameworks | ESX / QBCore / Qbox (through its qb-core compatibility) — detected via `aty_lib`. Live-tested partially on QBCore only; ESX and Qbox are untested | | Database | MySQL through `aty_lib` (`modules.ExecuteSql`). Tables are created and migrated automatically on start, no SQL file to import | | Lua version | Lua 5.4 (`lua54 'yes'`), `fx_version 'cerulean'`, `game 'gta5'` | | Sides | Client + server (shared config and locales) | | NUI | Yes — Vue 3 + Pinia, pre-built into `ui/` (housing tablet, property creator, Decor Studio, in-world prompts, lock-pick mini game) | | Languages | English (`en`), Turkish (`tr`), German (`de`), French (`fr`), Spanish (`es`) and Brazilian Portuguese (`pt-br`), selected with `Config.Language`; a missing key falls back to English | | Interiors | IPL (17 `bob74_ipl` interiors in the catalog), shell (your own shell resource), MLO (defined per property in the creator) | | Config files | `shared/config.lua`, `shared/config_colours.lua` (light colours), `shared/config_exterior.lua` (yards) and `server/config_webhooks.lua` (Discord, server only). Apartment buildings are set in `Config.Buildings` inside `shared/config.lua` | | Third-party notices | `docs/LICENSES.md` | #### Verification status | Area | Status | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | QBCore with `aty_inventory` (live, partial) | Resource start without errors and automatic database migration; framework admin permission; property creator with camera capture, interior point visit and draft resume after a restart; entrance marker and label; buying and renting (with deposit and the Finance tab); IPL enter and exit; re-login while inside a property; `aty_garage_v2` house garage; stash at the default point, several named stashes and the stash access rules; housing tablet by command and by the `housing_tablet` item; notification center (toast, bell badge, delete); Decor Studio placement, purchase and gizmo move / rotate; seats, beds and toilets; electricity meter with lights and TVs; cooking, sleeping, sink and shower; hygiene HUD with its effects and progress bars; properties built with `aty_shellcreator` (*Built shells* tab, preview, creating a property on a built shell); `housingbulkcreate` (dry run and a 24-property batch); first-start seeding of the 24 Vinewood houses (on a server that already had them: 24 adopted, 0 created, and nothing on the next start) | | Implemented and checked with offline test harnesses, **not yet live-verified** | Rent cycle and eviction, keys between two players, MLO doors, catalog shell interiors, selling, loans, bills and transfers, storage units, doorbell, police seals and raids, house robbery, realtors and auctions, Admin tab, ready-furnished interiors, `aty_multicharv2` spawn cards, water bills and supply cut-offs, home security (cameras, alarm, keypad, door camera; the camera lens offsets and the far-camera view are estimates that need tuning in game) | | Light scenes and colours, yards (garden decor), apartment buildings and motels | Implemented, **not yet verified on a live server**. They depend on the game world (the light draw, the interior detail sets, yard streaming and the road check of the yard editor, elevator teleports, the motel and starter flows), so try them on your server before you rely on them | | ESX, Qbox | Untested. Expected to work through `aty_lib`, but nothing is claimed | | Inventories | Supported through `aty_lib`: `aty_inventory`, `ox_inventory`, `qb-inventory`, `qs-inventory`, `ps-inventory`, `codem-inventory`, `tgiann-inventory`, `origen_inventory`, `gfx-inventory`, `esx_inventoryhud`, `ak47_inventory` and `ak47_qb_inventory`. Live testing was done on `aty_inventory` only; the `qb-inventory`, `ox_inventory` and `qs-inventory` stash paths are implemented from each inventory's documentation | | Dispatch adapters | Implemented from each resource's documentation; none was tested |