Starter Apartments
A starter apartment is a free or cheap first home for new players. Any unit can be flagged as a starter; a new character can be dropped straight into one, or pick from a starter selection screen.
Starters work in both modes, scoped to state/job stock in Classic mode and company stock in Block mode.
Player experience
- On spawn (or when eligible), a new character is offered a starter apartment and previews the interior before choosing.
- Selecting a starter assigns that unit to the player and spawns them inside.
- The unit behaves like any other property afterwards (lock, decorate, stash…), usually with a small weekly rent.
Flagging starters & allotments (management)
Starters and their allotment caps are managed from the management hub:
- Classic mode: Job Hub → Starters & Allotments
(needs
MANAGE_STARTER). One table across the job's stock: toggle a building as a starter, set its weekly rent, and set the per-interior allotment cap. - Block mode: Company → Starters & Allotments. One table across every block the company manages: Built/Cap, Allotment cap, Vacant (eligible), Starters count, a per-block weekly-rent input, and Assign All / Remove All.
Eligible for bulk assign = company/state-owned, no active lease, listing = none, not frozen.
Allotment model
- Block mode: allotments are edited in the block editor (per interior); this screen shows the caps read-only.
- Classic mode: a single stored config
{ default, overrides = { [interior] = cap } }, editable from the Starters & Allotments screen. Reads override → default →Config.Classic.Allotment, clamped toConfig.MaxAllotment.
Starter sources
Starter housing comes from two sources. Each can be switched on or off separately in Admin → Settings → Starter Apartments System, under the master switch:
| Source | Setting | What it is |
|---|---|---|
| Player stock | Company Starters (Block mode) / Realtor Job Starters (Classic mode) | Units a company or the realtor job already owns and flags as starters (see above). |
| Admin pools | Admin Starter Pools | Server-run pools that create their own apartments as players arrive. |
Both are on by default. Turning a source off returns its vacant starters to normal stock. Occupied units are never evicted; the tenant keeps the home.
The same screen sets the Assignment Mode (auto hands a unit over
automatically, select shows the picker) and the Max Price Cap (the highest
weekly rent auto-assignment will use).
Admin starter pools
Open Admin → Starter Pools (needs state/admin access). A pool is a template the server fills on demand:
| Field | Meaning |
|---|---|
| Label | Pool name, e.g. Mirror Park Starters. |
| Interior | Any shell or IPL interior. Walk-ins can't back a pool. |
| Entrance | Placed in-world; every unit shares this door. |
| Rent | Weekly rent (0 = free). Must be within the Max Price Cap. |
| Keep ready | How many vacant units to keep waiting (1–20). |
| Max units | Hard cap on units (0 = no cap). |
| Unit prefix | Optional prefix for unit numbers, e.g. A. |
| Stash / Wardrobe slots | Fit-out given to every unit. |
How pools behave:
- A pool keeps Keep ready units vacant. When one is claimed, a new one is created straight away, until Max units is reached.
- Pool units are server-owned and never billed: no construction cost, maintenance or tax. They don't appear in any company or job view and can't be sold or deeded.
- When a tenant leaves, the unit is reset (furniture, stashes and keys cleared) and goes back into the pool. Extra units above the buffer are removed.
- Vacant pool units are hidden from the shared-door unit list. A unit appears there once someone lives in it.
- Changing a pool's rent updates its vacant units. Occupied units keep the rent their tenant agreed to.
- Disabling a pool removes its vacant units and stops new ones; tenants stay. Deleting a pool does the same and detaches the occupied units from it.
- If a pool isn't creating units (for example, its rent is above the price cap), the panel shows the reason.
Custom multicharacter / spawn scripts can move a player into a starter with the
AssignStarterApartment
export and the spawnInStarter event.
How it relates to buildings
Starter units usually live in an apartment building (many units on one
entrance). The starter table groups by building,
and you can add units to a building to expand available starters (a paid
expand, gated by BUILD_PROPERTY and society/treasury funds).
The starter spawner accepts both company stock (Block mode) and state stock (Classic mode), so a classic realtor's flagged starters actually spawn players, not just display a flag.