> For the complete documentation index, see [llms.txt](https://lng.gitbook.io/lng-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lng.gitbook.io/lng-docs/keycrates/readme.md).
# Welcome to KeyCrates
Welcome to the official documentation for KeyCrates.
***
KeyCrates is a highly visual, RNG-based reward system designed to give your players a thrilling way to spend their hard-earned loot. By combining physical map placements with a dynamic spinning UI, this mod brings a premium "mystery box" experience directly to your DayZ server.
Whether you want to set up a Black Market gambling den or reward players for completing high-tier server events, KeyCrates gives you total control over the economy and the dopamine.
***
### β¨ Core Features
* π 5-Tier Ecosystem: Fully structured progression spanning from Common to Legendary. Each tier requires its own specific key classname to unlock.
* π¨ Visual Indicators: Custom 3D floating text and hex-color tags hover above the crates, letting players instantly recognize the tier of the vault they are approaching.
* π° Dynamic Spinning UI: When a key is inserted, the player is locked into a slick, customizable spinning UI that cycles through the potential rewards before landing on their prize.
* π² Weighted RNG Pools: You dictate exactly what drops and how often. Set specific probability weights for every single item to protect your server's high-tier economy.
* π Kit Support: Don't just drop a single gun. KeyCrates allows you to bundle items into "Kits" (e.g., a "Sniper Set" containing a Ghillie Suit, Rifle, and Ammo) that drop all at once upon a successful roll.
* πΊοΈ Static Map Placements: Place the physical crates permanently anywhere on your map using exact XYZ coordinates and orientations.
***
### π Documentation Navigation
Select a section below to start configuring your crates:
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://lng.gitbook.io/lng-docs/keycrates/readme.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.