For the complete documentation index, see llms.txt. This page is also available as Markdown.

Keys

Edit rcore_housing/configs/config.keys.lua to control the physical-key system and the optional keychain.

๐Ÿ”‘ Keys

Config.Keys = {
    UseKeysOnItem         = false,
    Limit                 = 8,
    Price                 = 300,
    LockReplacementPrice  = 1000,
    RemoveOnRentEnd       = true,
    AutoGiveOnPurchase    = true,
    RequireInsideInterior = false,
}
Option
Description

UseKeysOnItem

When true, keys are physical inventory items. When false, access is purely virtual.

Limit

Max number of keys that can be generated per property.

Price

Cost to generate a new physical key.

LockReplacementPrice

Cost to replace all locks (invalidates all existing keys).

RemoveOnRentEnd

Strip keys from a tenant's inventory when their rent ends.

AutoGiveOnPurchase

Auto-give the master key to the owner on purchase.

RequireInsideInterior

When true, players inside still need keys to use interior doors.

๐Ÿ—๏ธ Keychain

The keychain is an optional single inventory item that holds multiple keys. Enable it if you want to keep slot usage low when players collect many keys.

Last updated