Starter Apartments

Starter apartments give first-time players a free place to live. The system is disabled by default - enable it in main config.

🔌 Enable

Config.StarterApartment = {
    Enabled               = false,
    AutoAssignOnFirstJoin = true,
    TeleportOnAssign      = true,
    NotifyPlayer          = true,
}

Option	Description
Enabled	Master switch.
AutoAssignOnFirstJoin	Clone a starter template and assign it on first join.
TeleportOnAssign	Teleport the player to the apartment immediately after assignment.
NotifyPlayer	Send a toast notification when the apartment is assigned.

🧬 How It Works

1. A player joins for the first time (no row in rcore_housing_players yet).

2. The resource picks a starter template - any property tagged as a starter in the property manager.

3. The template is cloned into a fresh property.

4. The player is set as the owner of the clone.

5. If TeleportOnAssign = true, the player is teleported to the apartment's entry.

The starter assignment is recorded with has_starter_apartment = true so the same player never gets a second starter.

🧩 Compatibility With Existing Apartment Systems

rcore_housing exposes provides 'qb-apartments' and provides 'qbx-apartments' in its fxmanifest. Resources expecting those names see rcore_housing as their apartment provider, so the starter flow plays nicely with multicharacter and similar resources.

See providers integration for the compatibility layer.