VaultCrates
一个功能丰富、完全动画化的箱子插件,适用于 Paper 26.x
无需 NMS · 无需遗留库 · 无需外部全息图插件
✨ 特性
- 12 种独特动画 — 每种风格都配有粒子、音效和视觉效果
- 实体钥匙与虚拟钥匙 — 带有防复制 UUID 追踪的 NBT 标签物品;虚拟钥匙在数据库中按玩家存储
- 保底机制 — 可配置每种稀有度在开启 N 次后必定掉落
- 奖励上限 — 全局和每个玩家的奖励次数上限
- 虚拟钥匙商店 — 玩家通过
/vc shop 使用游戏内货币购买钥匙(需要 Vault 或 VaultUnlocked)
- 钱袋 — 可右键点击的奖励袋,支持配置随机数量范围
- 全息图 — 悬浮的 Text Display 实体,无需外部插件;重启后保持存在
- 放置 ID 系统 — 每个放置的箱子都会获得唯一 ID;使用
/vc remove <id> 移除它
- 家具箱子 — 使用 ItemsAdder 家具作为箱子,包括多实体家具(显示 + 碰撞箱)
- 游戏内 GUI 编辑器 — 无需触碰 YAML 文件即可编辑箱子和钥匙
- 奖励预览 — 分页 GUI,显示归一化后的掉落百分比;可按箱子切换开关
- 最佳奖品 — 从独立奖池中滚动的保证额外奖励
- 捆绑物品 — 在主奖励之外提供多个额外物品
- 可选奖励 — 玩家可以从 N 个随机选项中挑选自己的奖品
- 里程碑 — 累计开启 X 次箱子后获得额外奖励
- 奖励页脚 — 自动追加的文本行,显示奖励类型和稀有度
- NPC 支持 — Citizens、FancyNpcs、ZNPCsPlus、ZNPCs,或通过
/vc linknpc 链接任意实体
- 多语言 — 内置英语、德语、法语、西班牙语;添加任何语言只需创建一个
messages_<code>.yml 文件
- 多数据库 — JSON(默认)、SQLite 或 MySQL,支持自动建表
- 开发者 API — 自定义事件、编程方式开启箱子、钥匙管理
? 依赖
|
|
| 服务端 |
Paper(或其分支)26.1.x, 26.2 或 26.3 |
| Java |
25+ |
我需要哪个 jar 包?
| 你的服务端版本 |
下载 |
| 1.21.x |
VaultCrates-1.0.1.jar |
| 26.1 – 26.1.x |
VaultCrates-1.1.0-26.1.x.jar |
| 26.2.x |
VaultCrates-1.1.1-26.2.jar |
| 26.3.x |
VaultCrates-1.1.2-26.3.jar |
每个 jar 包都会在 Minecraft 版本低于其构建版本时拒绝加载。
对于 Minecraft 1.21.x,请使用 VaultCrates 1.0.1。
可选软依赖
所有软依赖均通过反射加载 — VaultCrates 在未安装任何这些依赖的情况下也能正常运行。
? 安装
- 选择适合你 Minecraft 版本的 jar 包(见上表),并将其放入
plugins/ 文件夹
- 启动或重启服务器 — 示例配置文件会自动生成
- 获取一个可放置的箱子:
/vc getcrate ExampleRound
- 在任何地方放置它 — 全息图会出现,且放置位置会自动保存
- 给自己一把钥匙:
/vc key give <name> ExampleRound 1
- 右键点击箱子以开启
? 命令
所有命令均使用 /vc(别名:/vaultcrates, /crate)。
箱子管理
| 命令 |
权限 |
描述 |
/vc getcrate <crate> |
vaultcrates.admin |
获取可放置的箱子物品 |
/vc create <name> |
vaultcrates.admin |
在游戏内创建新的箱子配置 |
/vc list |
vaultcrates.admin |
列出所有已加载的箱子 |
/vc errors |
vaultcrates.admin |
显示配置加载错误 |
/vc reload |
vaultcrates.admin |
重新加载所有配置和全息图 |
/vc editor <crate> |
vaultcrates.admin |
打开游戏内 GUI 编辑器 |
/vc keyeditor <crate> |
vaultcrates.admin |
打开游戏内钥匙编辑器 |
放置管理
| 命令 |
权限 |
描述 |
/vc placements |
vaultcrates.admin |
列出所有已放置实例及其 ID 和坐标 |
/vc remove <id> |
vaultcrates.admin |
根据 ID 移除已放置的箱子 |
提示: 放置宝箱时,放置 ID 会显示在聊天栏中。
方块宝箱: Shift + 左键点击可破坏并移除该方块(需要权限 vaultcrates.admin)。
家具宝箱: Shift + 左键点击仅显示 ID —— 请使用 /vc remove <id> 命令将其移除,以免有人误删宝箱。
物理钥匙(物品)
| 命令 |
权限 |
描述 |
/vc give <player> <crate> [amount] |
vaultcrates.give |
给予物理钥匙 |
/vc sgive <player> <crate> [amount] |
vaultcrates.give |
静默给予 |
/vc giveall <crate> [amount] |
vaultcrates.give |
向所有在线玩家发放 |
虚拟按键
| 指令 |
权限 |
描述 |
/vc key give <玩家> <箱子> [数量] |
vaultcrates.key |
添加虚拟钥匙 |
/vc key sgive <玩家> <箱子> [数量] |
vaultcrates.key |
静默添加 |
/vc key giveall <箱子> [数量] |
vaultcrates.key |
发送给所有在线玩家 |
/vc key set <玩家> <箱子> <数量> |
vaultcrates.key |
设置钥匙余额 |
/vc key balance <player> <crate> |
vaultcrates.key |
查看钥匙余额 |
/vc key withdraw <player> <crate> [amount] |
vaultcrates.key |
提取虚拟钥匙 |
/vc shop |
vaultcrates.shop |
打开虚拟钥匙商店 |
背包
| 命令 |
权限 |
描述 |
/vc pouch give <player> <pouch> [amount] |
vaultcrates.pouch |
给予一个皮包 |
/vc pouch sgive <player> <pouch> [amount] |
vaultcrates.pouch |
静默给予 |
/vc pouch giveall <pouch> [amount] |
vaultcrates.pouch |
给予所有在线玩家 |
/vc pouch list |
vaultcrates.pouch |
列出所有已加载的皮包 |
NPC 关联
| 命令 |
权限 |
描述 |
/vc linknpc <crate> |
vaultcrates.linknpc |
关联最近的实体或 Citizens NPC(需在 3 格范围内) |
/vc linknpc <crate> fancynpcs <name> |
vaultcrates.linknpc |
通过名称关联 FancyNpcs NPC |
/vc linknpc <crate> znpcsplus <id> |
vaultcrates.linknpc |
通过 ID 关联 ZNPCsPlus NPC |
/vc linknpc <crate> znpcs <name> |
vaultcrates.linknpc |
通过名称关联 ZNPCs NPC |
FancyNpcs 和 ZNPCsPlus 的 NPC 基于数据包且没有真实的实体,因此通过名称/ID 进行关联。
通过 NPC 开启宝箱需要钥匙,就像直接开启宝箱一样。
? 权限
| 权限 |
默认值 |
描述 |
vaultcrates.* |
op |
所有权限 |
vaultcrates.admin |
op |
放置/破坏箱子、重载、编辑器、getcrate、placements、remove |
vaultcrates.open |
true |
打开箱子 |
vaultcrates.give |
op |
发放实体钥匙 |
vaultcrates.key |
op |
管理虚拟钥匙 |
vaultcrates.shop |
true |
打开虚拟钥匙商店 |
vaultcrates.linknpc |
op |
将实体/NPC 与箱子关联 |
vaultcrates.pouch |
op |
发放钱袋 |
vaultcrates.bypass |
op |
绕过冷却时间和被阻止的命令 |
⚙️ 配置
config.yml — 关键设置
# 语言:en(默认)| de | fr | es | 或任何自定义区域代码
Language: en
Storage:
Type: JSON # JSON(默认)| SQLITE | MYSQL
KeyUuidExpiryDays: 365
Settings:
Cant_Open_Creative: false
Must_Hold_Key_In_Hand: false
Cant_Drop_Key: false
Crate_Radius: 3 # 两个箱子之间的最小距离,0 = 关闭
Keys:
Virtual_Keys_Enabled: true
Physical_Keys_Enabled: true
Shop:
Enabled: true
VirtualKeys: true # true = 虚拟钥匙;false = 实体钥匙物品
Win_Message: "&8[&6VaultCrates&8] &7你从 &e{crate_name}&7 中获得了 {reward_name} &8[{rarity}&8]"
RewardFooter: # 附加到每个奖励物品上的额外描述行
Enabled: false
Fallback: "Reward"
Lines:
- ""
- "&8奖励类型 » &7{reward_type}"
- "&8稀有度 » &7{rarity_name}"
箱子配置 (crates/MyCrate.yml)
Animation: ROUND # 参见动画列表
Material: ENDER_CHEST
IAModel: "namespace:my_crate" # 可选 — ItemsAdder 方块或家具
Size: 1 # 每次开启获得的奖励数量
PreviewEnabled: true
ShowChanceInPreview: true
ShiftInstantlyOpen: false
HologramLines:
- "&6&l我的箱子"
- "&7右键点击打开"
KeyCrate:
Require: true
KeysRequired: 1
Material: TRIPWIRE_HOOK
Name: "&6&l我的箱子钥匙"
MatchNBT: true
FinalMessage: [] # 开启时向所有玩家广播(留空以禁用)
Prizes:
diamond:
Name: "&b&l钻石"
Rarity: epic # common | rare | epic | legendary | jackpot | mega_jackpot | custom
Chance: 10.0 # 相对权重 — 无需总和为 100
Material: DIAMOND
Amount: 1
Glow: true # 仅视觉效果闪烁 — 物品仍可正常附魔
GiveItem: true
Type: "Item" # 可选 — 在 RewardFooter 中显示为 {reward_type}
Enchantments:
sharpness: 5
"myplugin:soulbound": 1 # 来自附魔插件的附魔,通过命名空间 ID
Commands: []
EnchantCommands: [] # 在给予物品后运行(用于没有注册附魔的附魔插件)
MessagesToPlayer: []
BroadcastMessages: []
GlobalLimit: 0 # 0 = 无限制
PlayerLimit: 0
BestPrizes:
legendary_item:
Name: "&6&l传说之剑"
Chance: 100.0
Material: NETHERITE_SWORD
GiveItem: true
可用稀有度
| ID |
显示名称 |
发光颜色 |
common |
Common |
灰色 |
rare |
Rare |
绿色 |
epic |
Epic |
紫色 |
legendary |
Legendary |
金色 |
jackpot |
Jackpot |
红色 |
mega_jackpot |
✦ Mega Jackpot ✦ |
深红色 |
可以在 config.yml 的 Rarities: 下添加自定义稀有度,支持设置保底阈值、发光颜色和广播消息。
钱袋配置 (pouches/MyPouch.yml)
Name: "MoneyPouch"
DisplayName: "&6&l钱袋"
Material: SUNFLOWER
Glow: true
Commands:
- "eco give {player_name} {random_number}"
MinNumber: 500
MaxNumber: 5000
? 多语言
默认捆绑了四种语言:
| 代码 |
语言 |
en |
English (默认) |
de |
German / Deutsch |
fr |
French / Français |
es |
Spanish / Español |
使用自定义或地区性语言:
- 在插件文件夹中创建
messages_pt_br.yml(或任意 messages_<code>.yml)
- 在
config.yml 中设置 Language: pt_br
- 运行
/vc reload
回退链顺序: messages_en_us.yml → messages_en.yml → messages.yml
?️ 存储后端
| 类型 |
说明 |
JSON |
默认。无需配置。所有数据存储在 data/ 目录下。 |
SQLITE |
基于文件的 SQL。内置驱动程序——无需额外的 jar 包。 |
MYSQL |
完整的 MySQL / MariaDB 支持。表会自动创建。 |
存储的数据包括:虚拟钥匙、保底计数器、奖励上限、里程碑进度、已使用的钥匙 UUID。
? 动画效果
| 名称 |
样式 |
ROUND |
老虎机式——物品循环滚动,减速并锁定中奖者 |
ROUND2 |
神秘箱子式——BARRIER 箱子环绕飞行;闪电揭示奖品 |
QUICK |
快速老虎机式——与 ROUND 相同但速度更快(约 3 秒) |
COSMIC |
轨道式——双反向旋转环,中心物品上下浮动 |
DISPLAY |
单物品循环展示奖品并落在中奖者上 |
PYRAMID |
三层金字塔式——物品分层旋转 |
CONTRABAND |
物品向上漂浮并逐个消失 |
INSTANT |
无动画——粒子爆发,立即给予奖励 |
AIR_STRIKE |
物品从高处落下并伴随闪电打击 |
BREAKOUT |
物品向外迸发然后弧形返回 |
METEOR_SHOWER |
物品如雨般落下并带有火焰轨迹 |
YIN_YANG |
两个圆环以阴阳图案汇聚 |
? 自定义物品支持
# 在奖励中:
Material: "namespace:item_id" # ItemsAdder 物品
OraxenModel: "item_id"
NexoModel: "item_id"
EIModel: "my_item_id" # ExecutableItems
MMOItem: "TYPE:item_id" # 例如 SWORD:my_sword
# 在宝箱或钥匙上:
IAModel: "namespace:item_id"
OraxenModel: "item_id"
NexoModel: "item_id"
ItemsAdder 字体图像(:icon_name:)可在所有文本字段中使用:名称、描述、全息图和消息。
? PlaceholderAPI
| 占位符 |
返回值 |
%vaultcrates_keys_<CrateName>% |
该宝箱的虚拟钥匙数量 |
%vaultcrates_opens_<CrateName>% |
玩家打开该宝箱的总次数 |
%vaultcrates_pity_<CrateName>_<rarityId>% |
当前保底计数器数值 |
%vaultcrates_milestone_<CrateName>_<milestoneId>% |
claimed / ready / needs N more opens |
%vaultcrates_is_animating% |
true / false |
%vaultcrates_active_animations% |
服务器当前活动的动画数量 |
? 开发者 API
VaultCratesAPI api = VaultCratesAPI.get();
// 虚拟钥匙
int keys = api.getVirtualKeys(player.getUniqueId(), "MyCrate");
api.addVirtualKeys(player.getUniqueId(), "MyCrate", 5);
api.removeVirtualKeys(player.getUniqueId(), "MyCrate", 1);
// 实体钥匙
api.givePhysicalKey(player, crate, 3);
// 以编程方式开启宝箱
api.openCrate(player, api.getCrate("MyCrate"), crateLocation);
// 事件监听
@EventHandler
public void onCrateOpened(CrateOpenedEvent e) {
List<Reward> rewards = e.getRewards();
Reward best = e.getBestReward();
}
? 许可证
VaultCrates 是免费软件,根据 GNU General Public License v3.0 许可。
你可以按照 GPL-3.0 的条款使用、修改和重新分发它——修改后的版本必须同样以开源形式发布。
完整文本请参阅 LICENSE。
由 itslarss 用 ❤️ 制作
VaultCrates
A feature-rich, fully animated crate plugin for Paper 26.x
No NMS · No legacy libraries · No external hologram plugin required
✨ Features
- 12 unique animations — particles, sounds and visual effects for every style
- Physical & Virtual Keys — NBT-tagged items with anti-dupe UUID tracking; virtual keys stored per player in the database
- Pity system — configurable guaranteed drop after N opens per rarity
- Reward limits — global and per-player caps per reward
- Virtual key shop — players buy keys with in-game money via
/vc shop (requires Vault or VaultUnlocked)
- Pouches — right-clickable reward bags with configurable random number ranges
- Holograms — floating Text Display entities, no external plugin needed; persist across restarts
- Placement ID system — every placed crate gets a unique ID; remove it with
/vc remove <id>
- Furniture crates — use ItemsAdder furniture as a crate, including multi-entity furniture (display + hitbox)
- In-game GUI editor — edit crates and keys without touching a YAML file
- Reward preview — paginated GUI with normalised drop percentages; toggleable per crate
- Best Prizes — guaranteed bonus reward rolled from a separate pool
- Bundled items — give multiple bonus items alongside the main reward
- Selectable rewards — players pick their prize from N random options
- Milestones — bonus rewards after X total crate opens
- Reward footer — auto-appended lore lines showing reward type and rarity
- NPC support — Citizens, FancyNpcs, ZNPCsPlus, ZNPCs, or any entity via
/vc linknpc
- Multi-language — English, German, French, Spanish built in; add any language with a
messages_<code>.yml file
- Multi-database — JSON (default), SQLite or MySQL with automatic table creation
- Developer API — custom events, programmatic crate opening, key management
📋 Requirements
|
|
| Server |
Paper (or forks) 26.1.x, 26.2 or 26.3 |
| Java |
25+ |
Which jar do I need?
| Your server |
Download |
| 1.21.x |
VaultCrates-1.0.1.jar |
| 26.1 – 26.1.x |
VaultCrates-1.1.0-26.1.x.jar |
| 26.2.x |
VaultCrates-1.1.1-26.2.jar |
| 26.3.x |
VaultCrates-1.1.2-26.3.jar |
Each jar refuses to load on a Minecraft version older than the one it was built for.
For Minecraft 1.21.x, use VaultCrates 1.0.1.
Optional soft-dependencies
| Plugin |
Tested API version |
Purpose |
| Vault / VaultUnlocked + economy plugin |
VaultUnlocked 2.20 |
Key shop, economy-priced crates |
| PlaceholderAPI |
2.12.3 |
Placeholders in messages & holograms |
| ItemsAdder |
4.0.18 |
Custom items, crate blocks & furniture, :icon: font images |
| Oraxen |
1.220 |
Custom block & item models |
| Nexo |
1.29 |
Custom block & item models |
| ExecutableItems |
SCore 5.25 |
Custom items as rewards |
| MMOItems |
6.10 |
Custom items as rewards |
| Citizens |
2.0.44 |
NPC-to-crate linking |
| FancyNpcs |
2.11 |
NPC-to-crate linking |
| ZNPCsPlus |
2.0 |
NPC-to-crate linking |
| ZNPCs |
legacy |
NPC-to-crate linking |
All soft-dependencies are loaded via reflection — VaultCrates runs without any of them installed.
🚀 Installation
- Pick the jar for your Minecraft version (see table above) and drop it into
plugins/
- Start or restart the server — example configs are generated automatically
- Get a placeable crate:
/vc getcrate ExampleRound
- Place it anywhere — the hologram appears and the placement is saved automatically
- Give yourself a key:
/vc key give <name> ExampleRound 1
- Right-click the crate to open it
💬 Commands
All commands use /vc (aliases: /vaultcrates, /crate).
Crate management
| Command |
Permission |
Description |
/vc getcrate <crate> |
vaultcrates.admin |
Get the placeable crate item |
/vc create <name> |
vaultcrates.admin |
Create a new crate config in-game |
/vc list |
vaultcrates.admin |
List all loaded crates |
/vc errors |
vaultcrates.admin |
Show config load errors |
/vc reload |
vaultcrates.admin |
Reload all configs and holograms |
/vc editor <crate> |
vaultcrates.admin |
Open the in-game GUI editor |
/vc keyeditor <crate> |
vaultcrates.admin |
Open the in-game key editor |
Placement management
| Command |
Permission |
Description |
/vc placements |
vaultcrates.admin |
List all placed instances with IDs and coordinates |
/vc remove <id> |
vaultcrates.admin |
Remove a placed crate by its ID |
Tip: The placement ID is shown in chat when you place a crate.
Block crates: Shift + left-click breaks and removes the block (requires vaultcrates.admin).
Furniture crates: Shift + left-click only shows the ID — remove them with /vc remove <id>, so nobody deletes a crate by accident.
Physical keys (items)
| Command |
Permission |
Description |
/vc give <player> <crate> [amount] |
vaultcrates.give |
Give a physical key |
/vc sgive <player> <crate> [amount] |
vaultcrates.give |
Give silently |
/vc giveall <crate> [amount] |
vaultcrates.give |
Give to all online players |
Virtual keys
| Command |
Permission |
Description |
/vc key give <player> <crate> [amount] |
vaultcrates.key |
Add virtual keys |
/vc key sgive <player> <crate> [amount] |
vaultcrates.key |
Add silently |
/vc key giveall <crate> [amount] |
vaultcrates.key |
Give to all online |
/vc key set <player> <crate> <amount> |
vaultcrates.key |
Set key balance |
/vc key balance <player> <crate> |
vaultcrates.key |
Check key balance |
/vc key withdraw <player> <crate> [amount] |
vaultcrates.key |
Remove virtual keys |
/vc shop |
vaultcrates.shop |
Open the virtual key shop |
Pouches
| Command |
Permission |
Description |
/vc pouch give <player> <pouch> [amount] |
vaultcrates.pouch |
Give a pouch |
/vc pouch sgive <player> <pouch> [amount] |
vaultcrates.pouch |
Give silently |
/vc pouch giveall <pouch> [amount] |
vaultcrates.pouch |
Give to all online |
/vc pouch list |
vaultcrates.pouch |
List all loaded pouches |
NPC linking
| Command |
Permission |
Description |
/vc linknpc <crate> |
vaultcrates.linknpc |
Link the nearest entity or Citizens NPC (stand within 3 blocks) |
/vc linknpc <crate> fancynpcs <name> |
vaultcrates.linknpc |
Link a FancyNpcs NPC by its name |
/vc linknpc <crate> znpcsplus <id> |
vaultcrates.linknpc |
Link a ZNPCsPlus NPC by its id |
/vc linknpc <crate> znpcs <name> |
vaultcrates.linknpc |
Link a ZNPCs NPC by its name |
FancyNpcs and ZNPCsPlus NPCs are packet-based and have no real entity, so they are linked by name/id.
Opening a crate through an NPC requires a key, just like the crate itself.
🔑 Permissions
| Permission |
Default |
Description |
vaultcrates.* |
op |
All permissions |
vaultcrates.admin |
op |
Place/break crates, reload, editor, getcrate, placements, remove |
vaultcrates.open |
true |
Open crates |
vaultcrates.give |
op |
Give physical keys |
vaultcrates.key |
op |
Manage virtual keys |
vaultcrates.shop |
true |
Open the virtual key shop |
vaultcrates.linknpc |
op |
Link entities/NPCs to crates |
vaultcrates.pouch |
op |
Give pouches |
vaultcrates.bypass |
op |
Bypass cooldowns and blocked commands |
⚙️ Configuration
config.yml — key settings
# Language: en (default) | de | fr | es | or any custom locale code
Language: en
Storage:
Type: JSON # JSON (default) | SQLITE | MYSQL
KeyUuidExpiryDays: 365
Settings:
Cant_Open_Creative: false
Must_Hold_Key_In_Hand: false
Cant_Drop_Key: false
Crate_Radius: 3 # Min. distance between two crates, 0 = off
Keys:
Virtual_Keys_Enabled: true
Physical_Keys_Enabled: true
Shop:
Enabled: true
VirtualKeys: true # true = virtual keys; false = physical key items
Win_Message: "&8[&6VaultCrates&8] &7You won {reward_name} &8[{rarity}&8] &7from &e{crate_name}&7!"
RewardFooter: # Extra lore lines appended to every reward item
Enabled: false
Fallback: "Reward"
Lines:
- ""
- "&8Reward Type » &7{reward_type}"
- "&8Rarity » &7{rarity_name}"
Crate config (crates/MyCrate.yml)
Animation: ROUND # See animations list
Material: ENDER_CHEST
IAModel: "namespace:my_crate" # Optional — ItemsAdder block or furniture
Size: 1 # Rewards given per open
PreviewEnabled: true
ShowChanceInPreview: true
ShiftInstantlyOpen: false
HologramLines:
- "&6&lMy Crate"
- "&7Right-click to open"
KeyCrate:
Require: true
KeysRequired: 1
Material: TRIPWIRE_HOOK
Name: "&6&lMy Crate Key"
MatchNBT: true
FinalMessage: [] # Broadcast to all players on open (leave empty to disable)
Prizes:
diamond:
Name: "&b&lDiamond"
Rarity: epic # common | rare | epic | legendary | jackpot | mega_jackpot | custom
Chance: 10.0 # Relative weight — does not need to sum to 100
Material: DIAMOND
Amount: 1
Glow: true # Visual glint only — the item can still be enchanted normally
GiveItem: true
Type: "Item" # Optional — shown in RewardFooter as {reward_type}
Enchantments:
sharpness: 5
"myplugin:soulbound": 1 # Enchantments from enchant plugins via namespaced id
Commands: []
EnchantCommands: [] # Run after the item is given (for enchant plugins without registry enchants)
MessagesToPlayer: []
BroadcastMessages: []
GlobalLimit: 0 # 0 = unlimited
PlayerLimit: 0
BestPrizes:
legendary_item:
Name: "&6&lLegendary Sword"
Chance: 100.0
Material: NETHERITE_SWORD
GiveItem: true
Available rarities
| ID |
Display |
Glow colour |
common |
Common |
Gray |
rare |
Rare |
Green |
epic |
Epic |
Purple |
legendary |
Legendary |
Gold |
jackpot |
Jackpot |
Red |
mega_jackpot |
✦ Mega Jackpot ✦ |
Dark red |
Custom rarities can be added in config.yml under Rarities: with optional pity thresholds, glow colours and broadcast messages.
Pouch config (pouches/MyPouch.yml)
Name: "MoneyPouch"
DisplayName: "&6&lMoney Pouch"
Material: SUNFLOWER
Glow: true
Commands:
- "eco give {player_name} {random_number}"
MinNumber: 500
MaxNumber: 5000
🌐 Multi-language
Four languages are bundled out of the box:
| Code |
Language |
en |
English (default) |
de |
German / Deutsch |
fr |
French / Français |
es |
Spanish / Español |
Using a custom or regional language:
- Create
messages_pt_br.yml (or any messages_<code>.yml) in the plugin folder
- Set
Language: pt_br in config.yml
- Run
/vc reload
Fallback chain: messages_en_us.yml → messages_en.yml → messages.yml
🗄️ Storage backends
| Type |
Notes |
JSON |
Default. Zero setup. All data in data/. |
SQLITE |
File-based SQL. Bundled driver — no extra jar needed. |
MYSQL |
Full MySQL / MariaDB support. Tables created automatically. |
Data stored: virtual keys, pity counters, reward limits, milestone progress, used key UUIDs.
🎬 Animations
| Name |
Style |
ROUND |
Slot machine — items cycle, slow down and lock on the winner |
ROUND2 |
Mystery boxes — BARRIER boxes orbit; lightning reveals prizes |
QUICK |
Slot machine — same as ROUND but faster (~3 s) |
COSMIC |
Orbital — double counter-rotating rings with bobbing centre item |
DISPLAY |
Single item cycles through prizes and lands on the winner |
PYRAMID |
Three-tiered pyramid of rotating items |
CONTRABAND |
Items float upward and vanish one by one |
INSTANT |
No animation — particle burst, reward given immediately |
AIR_STRIKE |
Items fall from height with lightning strikes |
BREAKOUT |
Items burst outward and arc back |
METEOR_SHOWER |
Items rain down with flame trails |
YIN_YANG |
Two rings converge in a yin-yang pattern |
🎨 Custom item support
# In a reward:
Material: "namespace:item_id" # ItemsAdder item
OraxenModel: "item_id"
NexoModel: "item_id"
EIModel: "my_item_id" # ExecutableItems
MMOItem: "TYPE:item_id" # e.g. SWORD:my_sword
# On a crate or key:
IAModel: "namespace:item_id"
OraxenModel: "item_id"
NexoModel: "item_id"
ItemsAdder font images (:icon_name:) work in every text field: names, lore, holograms and messages.
📊 PlaceholderAPI
| Placeholder |
Returns |
%vaultcrates_keys_<CrateName>% |
Virtual key count for that crate |
%vaultcrates_opens_<CrateName>% |
Total opens by the player |
%vaultcrates_pity_<CrateName>_<rarityId>% |
Current pity counter |
%vaultcrates_milestone_<CrateName>_<milestoneId>% |
claimed / ready / needs N more opens |
%vaultcrates_is_animating% |
true / false |
%vaultcrates_active_animations% |
Active animation count server-wide |
🔧 Developer API
VaultCratesAPI api = VaultCratesAPI.get();
// Virtual keys
int keys = api.getVirtualKeys(player.getUniqueId(), "MyCrate");
api.addVirtualKeys(player.getUniqueId(), "MyCrate", 5);
api.removeVirtualKeys(player.getUniqueId(), "MyCrate", 1);
// Physical keys
api.givePhysicalKey(player, crate, 3);
// Open programmatically
api.openCrate(player, api.getCrate("MyCrate"), crateLocation);
// Events
@EventHandler
public void onCrateOpened(CrateOpenedEvent e) {
List<Reward> rewards = e.getRewards();
Reward best = e.getBestReward();
}
📄 License
VaultCrates is free software licensed under the GNU General Public License v3.0.
You may use, modify and redistribute it under the terms of the GPL-3.0 — modified versions must stay open source under the same license.
See LICENSE for the full text.
Made with ❤️ by itslarss
评论 0
登录后参与评分
还没有评论,来抢沙发吧