Repository navigation
7. Main Settings (BS_KeyRoom_Settings.json)
This file is the global control center of the mod. It configures debug/logging options, global display settings, and hosts the global loot pool library that can be referenced by any door on the server.
- 7.1. File Location
- 7.2. Complete File Structure
- 7.3. Global Parameters
- 7.4. Global Loot Pools (
lootPools) - 7.5. Reloading Settings —
!kcreloadand the Reload Button - 7.6. Editing Settings In-Game (Admin Menu)
$profile/BS_KeyRoom/BS_KeyRoom_Settings.json
The file is generated automatically with sensible defaults (including two example loot pools) on first server start. Individual door configs live separately in the door-configs subfolder — see 2. Door Configuration.
{
"debug_build": 0,
"admin_log": 0,
"showDoorTimerText": 1,
"enableRandomContainerRespawn": 1,
"maxRandomContainers": 50,
"lootPools": [
{
"lootPoolName": "Global_Military_Default",
"rewards": [
{
"name": "M4A1",
"chanceToSpawn": 0.3,
"quantityMin": 1,
"quantityMax": 1,
"attachments": [
{
"name": "Mag_STANAG_30Rnd",
"quantity": 30
}
]
},
{
"name": "AmmoBox_556x45_20Rnd",
"chanceToSpawn": 1.0,
"quantityMin": 1,
"quantityMax": 2,
"attachments": []
}
]
},
{
"lootPoolName": "Global_Medical_Default",
"rewards": [
{
"name": "Epinephrine",
"chanceToSpawn": 0.5,
"quantityMin": 1,
"quantityMax": 1,
"attachments": []
},
{
"name": "Morphine",
"chanceToSpawn": 0.5,
"quantityMin": 1,
"quantityMax": 1,
"attachments": []
},
{
"name": "BandageDressing",
"chanceToSpawn": 1.0,
"quantityMin": 2,
"quantityMax": 4,
"attachments": []
}
]
}
]
}ℹ️ Door definitions (
KeyCard_Locations) can technically also live in this file, but the recommended workflow is one JSON per door in the door-configs folder — the server merges both at load time and skips duplicates.
| Parameter | Type | Default | Description |
|---|---|---|---|
debug_build |
0 or 1 | 0 |
Critical. 1 = Enables the in-game DoorLocker workflow (the BS_DoorLocker tool for generating door configs by pointing at a door) and the Door Scanner overlay for inspecting doors in the world. Always set to 0 on a live public server to prevent players from abusing these tools. |
admin_log |
0 or 1 | 0 |
1 = Writes detailed player interaction logs (door opens, keycard uses) to the BS_KeyRoom/logs/ folder. Very useful for debugging and server moderation. |
showDoorTimerText |
0 or 1 | 1 |
1 = When a player looks at a door that is already open, it displays the time remaining before the door closes (e.g. "Door closing in 5m 32s"). |
enableRandomContainerRespawn |
0 or 1 | 1 |
Legacy/experimental feature. Leave at the generated default unless specifically instructed otherwise. |
maxRandomContainers |
Int | 50 |
Legacy/experimental feature. Maximum random containers allowed when enableRandomContainerRespawn is active. Leave at default. |
lootPools |
Array | 2 example pools | The global loot pool library — see 7.4. |
The lootPools array is a library of named item lists that any door on the server can reference by name. This avoids duplicating the same item list across dozens of door configs.
Doors can also define their own doorSpecificLootPools inside their door JSON. Both use the identical structure; the difference is scope and priority:
Global lootPools (this file) |
doorSpecificLootPools (door JSON) |
|
|---|---|---|
| Scope | Shared — visible to every door on the server | Private to that one door |
| Best for | Loot tiers reused by many doors (Medical, Military T1–T4…) | Unique, location-themed rewards (e.g. "GreenMountain_Unique") |
| Maintenance | Update once, all referencing doors change | Fully isolated from other doors |
| Priority | Used when no door-specific pool matches | Overrides — if a door-specific pool has the same name as a global one, the door's own pool wins for that door |
💡 Recommended pattern: keep your shared tiers here, and use door-specific pools only for one-off signature loot.
Each object in lootPools follows this structure (identical to door-specific pools):
{
"lootPoolName": "Global_Military_T3",
"rewards": [
{
"name": "AKM",
"chanceToSpawn": 0.6,
"quantityMin": 1,
"quantityMax": 1,
"attachments": [
{
"name": "AK_WoodBttstck",
"quantity": 1
},
{
"name": "Mag_AKM_30Rnd",
"quantity": 30
}
]
},
{
"name": "AmmoBox_762x39_20Rnd",
"chanceToSpawn": 1.0,
"quantityMin": 1,
"quantityMax": 3,
"attachments": []
}
]
}ℹ️ For a full explanation of pool parameters, attachment nesting, and quantity controls, see 3. Advanced Loot System.
In any door's JSON, point a container's lootPoolName at the pool's name:
{
"referenceName": "Weapons_Crate",
"className": "BS_Box4_Green",
"spawnChance": 1.0,
"lootPoolName": "Global_Military_T3",
"lootMin": 1,
"lootMax": 2
}
⚠️ If the referenced pool name doesn't exist in either the door'sdoorSpecificLootPoolsor the globallootPools, the container spawns empty and a warning is written to the log:GetLootPoolFromName: Pool '<name>' not found.
After editing BS_KeyRoom_Settings.json (or any door config) on disk, you can reload everything on a running server without a restart:
- Ensure your Steam64ID is in
admins.txt. - In-game, type
!kcreloadin chat — or click the Reload button in the Admin Menu. - The mod re-reads this file and all door configs from disk immediately.
⚠️ A reload is a FULL reset. Both!kcreloadand the menu's Reload button rebuild the entire system state — this wipes ALL door cooldowns, including doors configured with Persist Cooldown (persistCooldownOnRestart). Persisted cooldowns only survive real server restarts, not manual reloads. Expect every door to be immediately unlockable again after a reload — plan reloads accordingly on a live server.
You can edit everything in this file directly in-game via the Admin Menu, without touching the JSON manually.
How to open the Admin Menu:
Press K in-game (default keybind). The BS KeyRoom admin panel appears.
⚠️ TheKkey only opens the menu for players whose Steam64ID is listed inadmins.txt. Other players pressingKsee no response. See 8. Admin Menu Guide.
Global toggles:
Go to the General tab (first tab, selected by default). The global toggles live in the "GLOBAL MOD SETTINGS" section in the right column:
| Checkbox in menu | Corresponding JSON field |
|---|---|
DebugBuild |
debug_build |
AdminLog |
admin_log |
ShowDoorTimer |
showDoorTimerText |
Global loot pools and keycards:
The global lootPools library can also be created and edited from the menu's loot editor. When you're done, click the Save Global Loot & Keycards button — this writes your changes back into BS_KeyRoom_Settings.json on the server. Changes take effect immediately, no restart needed.
💡 In-game editing and file editing are interchangeable — the menu reads from and saves to this same file. Just remember to reload (see 7.5) after external file edits so the running server picks them up.
Master the in-game tools → 8. Admin Menu Guide
Related pages: 2. Door Configuration · 3. Advanced Loot System · 11. FAQ & Troubleshooting
Getting Started
Configuration
- 2. Door Configuration
- 3. Advanced Loot System
- 4. AI Spawning System
- 5. Vehicle Spawning System
- 6. Keys & Keycards
- 7. Main Settings
In-Game Tools
Integrations & Help