# 🌟 **SqizleCrates** - Premium Reward System for Minecraft Servers **Transform your server experience with the most elegant crate solution available!** ## 🚀 Elevate Your Server's Economy SqizleCrates redefines how rewards work on your Minecraft server. With a perfect balance of simplicity and power, this plugin delivers an unmatched crate experience that will keep your players coming back for more. ## ✨ Why SqizleCrates Stands Above the Rest - **Streamlined Design** - Intuitive interfaces make setup and management a breeze - **Dual Key System** - Flexible virtual or physical key options to suit your server's needs - **Item Fidelity** - Preserves all item metadata including names, lore, and trims - **Resource Efficient** - Optimized code ensures minimal server impact - **Integration Ready** - Seamless PlaceholderAPI support for extended functionality ## 💎 Core Features - **Customizable Crates**: Create multiple crates with different rewards, settings, and appearances - **Virtual & Physical Keys**: Choose between virtual keys (stored in database) or physical key items - **Remote Crate Access**: Open crates from anywhere using the crate GUI without visiting the physical location - **GUI Editor**: Easy-to-use in-game editor for creating and managing crates - **Reward System**: Add items or commands as rewards with customizable appearance and enchantments - **Metadata Preservation**: Item names, lore, and trims are preserved when players receive rewards - **Roll Animation**: Exciting slot machine-like animation when opening crates - **Reroll System**: Allow players to reroll rewards with configurable number of chances - **Permission System**: Control access to crates with permission nodes - **Database Storage**: Persistent storage of virtual keys using SQLite - **PlaceholderAPI Support**: Display key counts in hologram plugins with `%sqizlecrates_key_%` - **Customizable Chat Prefix**: Configure the plugin's chat prefix with custom colors - **Hex Color Support**: Use modern hex color codes (#RRGGBB) in addition to traditional color codes ## 🛠️ Commands & Permissions | Command | Description | Permission | |---------|-------------|------------| | `/sqca give key ` | Give keys to a player | sqizlecrates.give | | `/sqca giveall key ` | Give keys to all online players | sqizlecrates.giveall | | `/sqca reload` | Reload configuration | sqizlecrates.reload | | `/sqca crate create ` | Create a new crate | sqizlecrates.create | | `/sqca editor` | Open the crate editor GUI | sqizlecrates.editor | | `/sqc crates` | Open the crate list GUI (player command) | sqizlecrates.command | | `/sqc keys` | View a list of all your keys and their amounts | sqizlecrates.command | **Permission Groups:** - `sqizlecrates.admin` - Access to all admin commands and features (default: operators) ## Installation 1. Download the latest version of SqizleCrates from [Modrinth](https://modrinth.com/plugin/sqizlecrates) 2. Place the SqizleCrates.jar file in your server's `plugins` folder 3. Restart your server or use a plugin manager to load the plugin 4. The plugin will generate default configuration files in the `plugins/SqizleCrates` folder

Initial Configuration

### Creating Your First Crate 1. Use `/sqca crate create ` to create a new crate 2. Open the crate editor with `/sqca editor` and select your crate 3. Configure the crate settings: - Set display name, key name, and permissions - Choose between roll mode or direct selection - Configure reroll chances 4. Place the crate in the world: - In the editor, click "Place Crate" - Click on a block in the world to set it as the crate location 5. Add rewards to the crate: - In the editor, click "Edit Rewards" - Put items you want to add as rewards in your inventory - Click on these items to add them as rewards - Configure reward settings (display, commands, etc.) ### Giving Keys to Players - For virtual keys: `/sqca give key ` - For physical keys: Enable `physical-items: true` in config.yml and use the same command

## 🔧 Effortless Configuration Implementation couldn't be simpler:

Config Spoiler

```yaml # ╔════════════════════════════════════════════════════════╗ # ║ ░░ GENERAL PLUGIN SETTINGS ░░ ║ # ╚════════════════════════════════════════════════════════╝ plugin: # Language setting for messages (currently only 'en' is supported) language: "en" # Enable to check for plugin updates on startup check-updates: true # Debug mode configuration # - Set to true to enable detailed logging for troubleshooting # - Set to false for normal operation (recommended) debug: false # ╔════════════════════════════════════════════════════════╗ # ║ ░░ DATABASE SETTINGS ░░ ║ # ╚════════════════════════════════════════════════════════╝ database: # Enable database storage for virtual keys enabled: true # Database type (currently only 'sqlite' is supported) type: "sqlite" # Database file name file: "crates.db" # ╔════════════════════════════════════════════════════════╗ # ║ ░░ KEY SETTINGS ░░ ║ # ╚════════════════════════════════════════════════════════╝ keys: # Set to true for physical key items, false for virtual keys physical-items: false # Material to use for physical key items key-material: "TRIPWIRE_HOOK" # Name format for keys (%key_name% will be replaced with the crate's key name) # Supports both traditional color codes (&6) and hex colors (#aaa8a8) key-name: "&6%key_name% Key" # Example with hex color: key-name: "#aaa8a8%key_name% Key" # Lore for key items (supports both traditional color codes and hex colors) key-lore: - "&7Use this to open a %crate_name% crate!" - "&eRight-click on the crate to begin." # Example with hex colors: # - "#aaa8a8Use this to open a %crate_name% crate!" # - "#ffd700Right-click on the crate to begin." # ╔════════════════════════════════════════════════════════╗ # ║ ░░ SOUND SETTINGS ░░ ║ # ╚════════════════════════════════════════════════════════╝ sounds: # Sound played when opening a crate open: "BLOCK_CHEST_OPEN" # Sound played when claiming a reward claim: "ENTITY_PLAYER_LEVELUP" # Sound played when an error occurs error: "BLOCK_NOTE_BLOCK_BASS" # ╔════════════════════════════════════════════════════════╗ # ║ ░░ GUI SETTINGS ░░ ║ # ╚════════════════════════════════════════════════════════╝ gui: # Number of rows in the crate GUI (1-6) # Waring: If you change this with active crates you will need to redo them. rows: 3 # Default number of reroll chances for crates default-reroll-chances: 1 # Filler item settings for empty slots filler: # Enable or disable filler items enabled: true # Material for filler items material: "GRAY_STAINED_GLASS_PANE" # Display name for filler items name: " " # ╔════════════════════════════════════════════════════════╗ # ║ ░░ CHAT SETTINGS ░░ ║ # ╚════════════════════════════════════════════════════════╝ chat: # Chat prefix configuration prefix: # Enable or disable the chat prefix enabled: true # Text to use as prefix (supports color codes and hex colors like #aaa8a8) text: "&6[SqizleCrates]:" # Example with hex color: text: "#aaa8a8[SqizleCrates]:" ``` ```yaml crate: name: "Example" display-name: "&eExample Crate" key: "Example Key" permission: "" key-required: true # Set to true to use the roll animation, false for direct selection roll-mode: true # Number of reroll chances for this crate (overrides default) reroll-chances: 2 gui: title: "&eExample Crate Rewards" rows: 3 filler: enabled: true material: "BLACK_STAINED_GLASS_PANE" name: " " sound: on-open: "BLOCK_ENDER_CHEST_OPEN" on-claim: "ENTITY_ENDER_DRAGON_GROWL" location: world: "world" x: 0 y: 70 z: 0 rewards: reward1: slot: 10 display: material: "DIAMOND" name: "&bDiamond Reward" lore: - "&7Win a diamond!" give: type: "item" item: material: "DIAMOND" amount: 1 reward2: slot: 11 display: material: "EXPERIENCE_BOTTLE" name: "&aXP Reward" lore: - "&7Get some XP!" give: type: "command" command: "xp add %player% 100" ```

## 🔌 Server Compatibility - Full support for Minecraft 1.20.1+ - Works flawlessly with Paper/Spigot, Folia and Purpur server! - Enhanced functionality with PlaceholderAPI Join the community of forward-thinking server owners who have already discovered the future of Minecraft rewards! --- *SqizleCrates - Redefining Reward Experiences*

BusyBee Development

Members

SqizleCrates

InfiniteBuckets