Skip to content

0. Installation

cjcarw edited this page Jul 15, 2026 · 4 revisions

📥 0. Installation

Follow these steps to install BS KeyRoom on your DayZ server. Installation takes only a few minutes — the mod generates all of its configuration files automatically on first boot.


Prerequisites

  • A working DayZ server (PC).
  • FTP or File Manager access to your server files.
  • Access to your server's startup script (.bat on Windows, .sh on Linux).

Required Dependency: Community Framework (CF)

BS KeyRoom requires Community Framework (CF) to be installed and loaded before BS KeyRoom in the mod load order:

-mod=@CF;@BS_KeyRoom;

⚠️ Warning: If @CF is missing or loaded after @BS_KeyRoom, the server will fail to load the mod correctly. Always keep @CF first.

ℹ️ Note: Both the server and every connecting client need the mod. Clients subscribe to BS KeyRoom (and CF) on the Steam Workshop and load them through the DayZ Launcher; the server loads the same mods via its -mod= parameter. A client without the mod cannot join a server running it.


Steps

1. Subscribe to the Mod

Subscribe to BS KeyRoom on the Steam Workshop. Steam will download the mod files to your local machine automatically. Subscribe to Community Framework (CF) as well if you don't already have it.

2. Copy Mod Files to Your Server

Locate the downloaded mod folder on your PC — typically found at:

C:\Program Files (x86)\Steam\steamapps\common\DayZ\!Workshop\@BS_KeyRoom

Upload the entire @BS_KeyRoom folder (and @CF if not already present) to the root directory of your DayZ server using your preferred FTP client or file manager.

💡 Tip: If the mod ships with a keys/ folder, copy its .bikey files into your server's keys/ directory so clients with verified signatures can connect.

3. Enable the Mod in Startup Parameters

Add the mod to your server's startup script. Look for the -mod= argument and append @BS_KeyRoom; to the list, after @CF.

Example startup line (Windows):

DayZServer_x64.exe -config=serverdz.cfg -port=2302 "-mod=@CF;@BS_KeyRoom;"

Example startup line (Linux):

./DayZServer -config=serverdz.cfg -port=2302 "-mod=@CF;@BS_KeyRoom;"

⚠️ Warning: Make sure each mod is separated by a semicolon (;). Order matters — dependency mods (like @CF) must come before @BS_KeyRoom.

4. Generate Default Config Files

Start your server once. The mod will automatically create its default configuration folders and files inside your server's profile directory (commonly called sc or referenced as $profile:).

After the server has fully loaded, stop it. You are now ready to configure the mod.


✅ Verifying the Installation

After the first boot, confirm the mod loaded correctly:

1. Check the profile directory. A new BS_KeyRoom folder should exist inside $profile: containing:

$profile/
└── BS_KeyRoom/
    ├── DoorConfigs/                     ← Auto-generated example door config inside
    ├── logs/
    ├── BS_KeyRoom_Settings.json
    ├── BS_KeyRoom_ItemNames.json
    ├── BS_KeyRoom_Cooldowns.json
    └── admins.txt

See 1. Initial Setup for a full explanation of each file.

2. Check the server RPT log. Look for a line like:

[KeycardSystem] Logging to: ...

This line confirms BS KeyRoom initialized successfully and shows the exact path where the mod writes its log files. If you see it, the mod is up and running.

💡 Tip: If the folder or the RPT line is missing, the mod did not load — re-check your -mod= line and load order before going any further.


❌ Common Install Mistakes

Mistake Symptom Fix
@CF missing or loaded after @BS_KeyRoom Mod fails to initialize; script errors on boot Use -mod=@CF;@BS_KeyRoom; — CF always first
Mod only installed on server, not clients Players can't connect / mod features invisible Clients must subscribe to and load the same mods
Missing semicolon between mods Mods after the typo silently fail to load Separate every mod with ; in the -mod= line
Uploaded mod to wrong directory No BS_KeyRoom folder in $profile:, no RPT line Place @BS_KeyRoom in the server root directory
Missing .bikey in server keys/ folder Clients kicked with signature verification errors Copy the mod's .bikey files to the server's keys/ folder
Edited configs before first boot Custom configs overwritten or missing Boot once, let defaults generate, then edit

Optional Dependencies

BS KeyRoom can integrate with these mods if they are loaded:

Mod Benefit
DayZ-Expansion Richer notification system for global announcements, AI bots, and Quests — see 10. Expansion Integration
CFTools / GameLabs Player interaction logging to external services
LBmaster Rework Use LBmaster loot presets inside containers
Bastardos Hacked Crates Spawn hackable crates on door open

These are optional — the mod works fully without any of them.


Troubleshooting

Problem Solution
Config files not generated Ensure the mod loaded correctly and check adm.log for errors
Door not responding to keycard Verify debug_build is 1 and the door config was generated correctly
Server crashes on startup Check for JSON syntax errors in your config files using a validator like jsonlint.com

ℹ️ Note: For a much longer list of common issues and fixes, see 11. FAQ & Troubleshooting.


Next Steps

With the mod installed and default files generated, proceed to 1. Initial Setup to configure admins and learn the file structure.

Clone this wiki locally