Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt

Use this file to discover all available pages before exploring further.

The Crate Extension allows you to implement highly engaging rewards via mystery boxes or loot crates. It supports both physical world-crates (interactable blocks) and virtual menus, featuring weighted probabilities and visual opening sequences.

Features

Weighted loot tables, visual animations, virtual & physical keys, and milestone rewards.

📚 Entry Library

📖 Definitions

Core configuration for crates.

Crate Definition

The main definition of a loot box.

Global Menu

Browse all available crates.

🎬 Actions

Triggering crate logic.

Open Crate

Trigger an opening sequence.

Open Menu

Open the crate browsing menu.

📦 Artifacts

Data storage.

Crate Artifact

Persistent storage for keys and history.

Commands

All commands are under the /crate prefix.
CommandDescriptionPermission
/crate menuOpen the global crate browsing menutypewriter.crate.menu
/crate give <crate_id> [amount]Grant virtual keys to a playertypewriter.crate.give
/crate remove <crate_id> [amount]Revoke virtual keys from a playertypewriter.crate.remove

Placeholders

All placeholders use the prefix %typewriter_crate_<crate_id>_%.
PlaceholderDescription
%typewriter_crate_<id>_openings%Total times opened by the player
%typewriter_crate_<id>_keys%Virtual keys held
%typewriter_crate_<id>_milestone%Highest reward milestone reached