Introduction

Welcome to the documentation for the SkiesCrates mod! This guide will help you get started with using and configuring the mod.

---

Quick Start

1. Install the SkiesCrates mod jar onto your server. Download the mod here!
2. Set the location of your a crate using /crate set <crate_id> while in-game, looking at the block you want to be the crate.
3. Modify and create new Crates in the config/skiescrates/crates/ folder.

What is SkiesCrates?

SkiesCrates is a server-sided fabric mod that allows server admins to create custom Crates for players to interact with to earn rewards. The mod is highly configurable and uses JSON files for all configuration, allowing for organization and relative ease of use.

The mod supports a variety of features, including:

• Create practically infinite crates (idk, haven’t tested that)
  • Crates can either be physically placed or given as an inventory item
• Define keys with advanced options
  • Physical keys with customizable items
  • Virtual keys stored in a database
  • Anti-dupe systems when setting physical keys as “unique”
  • Keys support multiple crates and crates support multiple keys
• Create custom rewards for crates with tons of customization
  • 4 reward types, including: COMMAND_CONSOLE, COMMAND_PLAYER, ITEM, and POKEMON (Cobblemon required)
  • Weighted rewards for random chance crates
  • Display options when opening and previewing crates
  • Overridable display when previewing rewards
  • Apply limits on how many times a player can earn a reward
  • Automatic broadcast option
• Customizable crate preview menus for viewing potential crate rewards
  • Supports different preview menus for each crate
• Create your own crate opening animations customize them extensively
  • Inventory openings support deep customization of the animation sequence (6 includes by default!)
  • In-World openings are packet based allowing for multiple players to open the crate at once
• Per-player reward limiting
• Per-player crate cooldowns.
• Customizable broadcast messages for certain rewards
• Crate animation early cancelling supported
• Hologram support through HoloDisplays integrations
• Customizable idle particle effects/animations
• Built in /keys menu to view your virtual keys (disableable and customize commands)
• Economy integration with many Economy mods (Impactor, BEconomy, CobbleDollars, etc)
• Placeholder support with popular Placeholder APIs (TextPlaceholderAPI, MiniPlaceholders, etc)
• All customizable items support custom names, lore, enchantments, and more (anything that is a component/nbt can be applied)
• And more!

Getting Started

1. Introduction
   Initial introduction to the SkiesCrates mod, understanding the purpose and features of the mod.
2. Installation
   Guide to install the SkiesCrates mod, dependencies, and optional integrations.
3. Commands and Permissions
   List of commands and permissions available in the SkiesCrates mod.
4. Supported Economies
   List of supported economy plugins for use with SkiesCrates.
5. Placeholders
   List of supported Placeholder APIs and available placeholders for use with SkiesCrates.
6. GUI Types
   List of the supported GUI types used in SkiesCrates, including for crate previews and inventory animations.
7. FAQs
   Frequently Asked Questions about the SkiesCrates mod, including troubleshooting tips and common implementation questions.

Configuration

Base Config

1. Main Configuration
   Guide to configure the main config.json file for SkiesCrates. These settings apply globally to the mod.
   1. Keys Options
      Configuration options for the Keys menu and command
   2. Storage Options
      Configuration options for the storage system used by SkiesCrates
   3. Migration Options
      Configuration options for migrating data
   4. Webhook Options
      Configuration options for Discord webhooks
2. Lang Configuration
   Guide to customizing the messages for SkiesCrates

Crates

1. Crate Configuration
   Guide to understanding the basics of a Crate configuration file.
   1. Cost Options
      Configuration options for defining costs to open a Crate.
   2. Failure Options
      Configuration options for failure behavior when opening a Crate.
   3. Block Options
      Configuration options for the Crate block behavior and appearance.
   4. Hologram Options
      Configuration options for HoloDisplays holograms above Crate blocks.
2. Examples
   Example Crate configurations to help get started.

Rewards

1. Rewards
   Configuration of rewards within a Crate, including display properties, behaviors, and advanced options.
   1. Limit Options
      Options to configure a reward’s claim limits.
2. Reward Types
   The Available reward types and their specific configuration options.
   1. COMMAND_CONSOLE
      Guide to using the COMMAND_CONSOLE reward type.
   2. COMMAND_PLAYER
      Guide to using the COMMAND_PLAYER reward type.
   3. ITEM
      Guide to using the ITEM reward type.
   4. POKEMON
      Guide to using the POKEMON reward type (requires Cobblemon mod).

Keys

1. Key Configuration
   Guide to understanding the basics of a Key configuration file.
2. Keys Menu
   Configuration options for the /keys menu.

Previews

1. Previews
   Guide to configuring crate preview menus, which display the possible rewards in a crate.
2. Preview Settings
   Options to configure the general settings of a crate preview menu.
3. Preview Buttons
   Options to configure buttons within the crate preview menus.

Opening Animations

1. Opening Animations
   Guide to configuring crate opening animations, both inventory-based and in-world.
   1. Inventory Animations
      Guide to configuring inventory-based crate opening animations.
      1. Animation Settings
         Options to configure the general settings of an inventory opening animation.
      2. Spinning Items
         Guide to configuring spinning animated items in an inventory opening animation.
      3. Presets
         Guide to using presets in inventory opening animations.
   2. World Animations
      Guide to configuring in-world crate opening animations.
      1. World Animation Types
         List of available world animation types and their specific configuration options.
      2. SIMPLE_ROLL
         Guide to using the SIMPLE_ROLL world animation type.

Particles

1. Particle Animations
   Guide to configuring idle particle effects/animations for Crate blocks.
2. Particle Effects
   List of available particle effects and their specific configuration options.
   1. Effect Types
      List of available particle effect types and their specific configuration options.
      1. CIRCLE
         Guide to using the CIRCLE particle effect type.
      2. SPIRAL
         Guide to using the SPIRAL particle effect type.
      3. PULSE
         Guide to using the PULSE particle effect type.
      4. BEAM
         Guide to using the BEAM particle effect type.

Items

1. Item Options
   Options to configure a generic item’s appearance and data.
2. Components
   Guide to using Components and specifically how to make use of them in the SkiesCrates mod.