CrateBundles

CrateBundles - Customizable Reward Crates!

Supercharge your server's reward system with CrateBundles! This powerful server-side Fabric mod allows you to create highly customizable, tiered reward crates (called "Bundles") packed with items, commands, or even complex kits. Featuring intuitive in-game GUIs for configuration, dynamic opening animations, and robust permission controls, CrateBundles offers a versatile solution for player rewards.

Key Features:

Deeply Customizable Reward Crates:

• Define unlimited "Bundle Types" (e.g., Vote Crate, Legendary Key) stored in the configuration.
• Configure rewards as Items (with custom names, lore, NBT, enchantments, and counts), Commands (executed by the server, with player placeholders), or Kits (MULTI rewards) containing multiple sub-rewards.
• Assign weights to each reward to control drop chances.
• Set custom display names, lore, the base Minecraft bundle item (e.g., minecraft:red_bundle, minecraft:black_bundle), and even add a cosmetic enchantment glint for each Bundle Type.

Animated Crate Opening:

• Engage players with a visually appealing GUI animation when they open a Bundle.
• Choose from 8 different item presentation styles (controlled by itemCycleVariant) that dictate how items appear and move during the rolling animation (e.g., Standard Single, Dual Horizontal Line Scroll, Diagonal Sweep, Random Flash & Hold).
• Select from over a dozen pane animation styles per Bundle Type (e.g., Rainbow Wave, Border Chase, Spiral In, Ambient Sparkle, Row Pulse, Center Pulse, and more!) to make each crate's background feel unique.
• Customize the opening GUI layout itself with 9 different structural variants, affecting row count and reward placement.

Comprehensive In-Game & File Configuration:

• GUI-Based Management: Admins can use commands like /bundle modify <Bundle_name> to open intuitive GUIs for:     Adding/removing rewards from bundles.     Editing item/command properties (count, rarity/weight, display names, NBT aspects).     Managing kit contents, icons, and properties (display name, icon, weight, description).     Changing bundle animation styles (pane animation, item cycle variant, GUI layout).
• Chat-Driven Editing: Configure specific properties like command preview names, command strings, command preview lore (descriptions), and kit metadata through guided chat prompts initiated from the GUIs.
• JSON Configuration: All settings are stored in human-readable JSON files (cratebundles.json, cratebundles_messages.json) for easy backup, sharing, or advanced manual editing. A detailed default configuration is generated to get you started.

Advanced Kit System (MULTI Rewards):

• Create "Kits" that grant multiple items and/or execute multiple commands as a single reward.
• Kits can have custom display icons (any item, with NBT), names, descriptions, and weights within their parent bundle.
• Easily convert existing Item or Command rewards into new Kits via the Item Property Editor GUI.
• If a kit contains only one Item or Command reward after editing, it can automatically "unwrap" back into that single reward type, simplifying your configuration.

Player-Friendly Features:

• Bundle Previews: Players can shift-right-click a Bundle to see its potential rewards. Admins can use /bundle list (hovering over bundle names shows the item) or toggle /bundle adminlore for an enhanced preview mode with more details.
• Kit Redeem Chest: If a player's inventory is full when winning a Kit, they receive a special "Kit Redeem Chest" (a custom player head item) to claim their items later, ensuring no rewards are lost.
• Server Broadcasts: Configure optional, customizable messages to announce when players open specific high-value bundles.
• Protected Bundles: CrateBundle items are sealed; players cannot manually add or remove items from them using vanilla bundle mechanics.
• No Auto-Pickup for CrateBundles: Crafted/given CrateBundle items have a special tag to prevent them from being auto-filled by vanilla bundle mechanics if a player picks up items.
• Customizable Messages: Almost all messages sent to players by the mod can be customized via cratebundles_messages.json.

Commands & Permissions:

All commands require an initial permission level of 2 (typically op) and then check for specific permission nodes. The primary command is /bundle (aliases: /cb, /cratebundle).

/bundle give <player> <Bundle_name> [amount]

• Description: Gives the specified player a CrateBundle item or a Kit Redeem Chest (e.g., bundle_key:kit_name).
• Permission: cratebundles.command.give

/bundle reload

• Description: Reloads all CrateBundles configuration files.
• Permission: cratebundles.command.reload

/bundle list

• Description: Lists all configured CrateBundle types. Hovering over a bundle name shows the item, and clicking its ID runs /bundle modify <id>.
• Permission: cratebundles.command.list (Defaults to allow all if no permission manager, but generally level 0 access is intended).

/bundle create <Bundle_name>

• Description: Creates a new, empty CrateBundle type with the given internal name (which will be converted to lowercase) and opens its configuration GUI.
• Permission: cratebundles.command.create

/bundle modify <Bundle_name>

• Description: Opens the main configuration GUI for the specified bundle type (player-only command).
• Permission: cratebundles.command.modify

/bundle commanditem \"<Display Name>\" /<command_to_run>

• Description: Gives the admin a special "Command Item" (a Light block) pre-configured with the specified custom display name and the command to be executed. This item can then be placed into a bundle's reward configuration GUI.
• Permission: cratebundles.command.addcmditem

/bundle adminlore

• Description: Toggles a more detailed informational lore view for admins in preview GUIs.
• Permission: cratebundles.preview.admin

/bundle rename <old_Bundle_name> <new_Bundle_name>

• Description: Renames the internal key of an existing bundle type (keys are treated as lowercase).
• Permission: cratebundles.command.modify

/bundle name <Bundle_name> <display_name>

• Description: Sets or changes the display name for the specified bundle type. Supports color codes.
• Permission: cratebundles.command.modify

/bundle lore <Bundle_name> set <line_number> <lore_text>

• Description: Sets a specific line of lore for the physical bundle item. Supports color codes.
• Permission: cratebundles.command.modify

/bundle lore <Bundle_name> add <lore_text>

• Description: Adds a new line of lore to the physical bundle item. Supports color codes.
• Permission: cratebundles.command.modify

/bundle lore <Bundle_name> remove <line_number>

• Description: Removes a specific line of lore from the physical bundle item.
• Permission: cratebundles.command.modify

/bundle lore <Bundle_name> clear

• Description: Clears all custom lore from the physical bundle item.
• Permission: cratebundles.command.modify

/bundle color <Bundle_name> <color_name_or_code>

• Description: Sets the base vanilla bundle item used for the physical CrateBundle item (e.g., minecraft:blue_bundle via "blue" or "&1"). Use "none" or "&" for the default brown bundle.
• Permission: cratebundles.command.modify

/bundle glint <Bundle_name>

• Description: Toggles the cosmetic enchantment glint on the physical bundle item.
• Permission: cratebundles.command.modify

Other Important Permissions:

• cratebundles.preview: Allows players to use shift-right-click to open the preview GUI for a bundle they are holding.
• cratebundles.command.configure_rewards: General permission checked internally for various GUI actions related to changing rewards, kit properties, or item properties. Typically granted alongside cratebundles.command.modify.

Permissions Information: This mod utilizes the Fabric Permissions API. For permissions to function correctly, a compatible permissions manager (such as LuckPerms) must be installed on your server. If no permissions manager is detected, some features might default to enabled or require operator status (level 2+).

Modpack Policy:

• You ARE PERMITTED to include CrateBundles in any modpack.
• Please do not modify the mod's JAR file directly.
• The modpack itself, or access to this mod within the modpack, must not be sold.