CrazyCrates

Changes 🔨

• Improved performance when checking placeholders via PlaceholderAPI
  • This has also lessened maintenace burden internally!
• Improved updating the examples folder.
• Removed LegacyItemBuilder as maintaining 2 ItemBuilders was not fun.
  • There should be no need to change configurations unless you use HideItemFlags: true
  • If you do use HideItemFlags, Click Me
• Improved migration types by looping through the folders instead of the FileManager cache which led to unnecessary checks.
• Improved verbose logging across the plugin.
• Improved placeholder migrations in config migrator.
• Improved /crazycrates teleport <crate_id>.
• Improved placeholder parsing throughout the plugin.
• Replaced {key_amount} from the not_enough_keys message with {amount}.
  • {key_amount} is no longer usable.
• Placeholders that normally could've only been used in the DisplayName of items can now be used in DisplayLore as well.
• Cleaned up code related to sending messages to the player, or broadcasting messages to the server.
• Removed an unnecessary prize loop for Cosmic Crate, if we do the math right initially... we shouldn't need this.
• Switched to using StringUtils#tryParseInt which uses an optional for better verbosity instead of Integer#parseInt.
• Updated default configuration files.

Crate Changes

• Improved tracking code for crates.
• Improved performance & readability when building crate objects.
• Improved performance when loading/adding crate locations.
• Improved cleaning up crate tasks, and other caches when a crate opening ends.
  • This should fix a few other weird issues.

Key Changes

• Fixed a logical issue with taking keys using /crazycrates mass-open or sneaking on QuickCrate after giving the prizes, it should be the other way around to minimize the free loot gain if something happens.
  • In addition to this, if they are keys not taken for any reason like your inventory being full, they should be refunded to you.

Crate Types

• CrateOnTheGo now passes through the openCrate method, so things like Required Keys, and other features the other crates have are now respected.

Item Layout

• By default, use-different-items-layout is set to true now.
  • Existing servers with an up-to-date config will not have to change anything.

Item Changes

• Removed the option to configure the spawner preview.
  • This is pointless, because they all look the same in crate menus.
• Updated glow configuration, Glowing now accepts values like "add_glow", "remove_glow", or "none"
  • Existing true/false should work, but you should update it as soon ass possible.

Removals

Permissions

• Removed the use-new-permission-system toggle, and keep the original behaviour everyone liked.

Additions

Key Placeholders

• Added shorthand formatting to key placeholders, so 1,000 would become 1k and so on.

Plugin Support

Note: replace <item_id> with the correct identifier from the custom item plugins. Second Note: Any place you can input diamond_axe allows you to use this format. Third Note: You can still use emerald_helmet as in direct ids as well

• Added support for HMCWraps.
  • DisplayItem: hmcwraps@<item_id>
• This introduces new formats for other plugins like Oraxen, Nexo, CraftEngine, and ItemsAdder
  • DisplayItem: nexo@<item_id>
  • DisplayItem: oraxen@<item_id>
  • DisplayItem: itemsadder@<item_id>
  • DisplayItem: craftengine@<item_id>

New Commands

• Added /crates version which includes the git commit, previous git commit, and current version.
  • If any value is not found, it will return "N/A"

Other

• Added custom item support in areas that didn't have it.
• Added text shadow support for FancyHolograms.
  • #890

Configuration Changes

Glowing

• Glowing no longer is true/false, however existing configurations using true/false will still work as we look for that internally as well.

  # Should the item glow?
  # Available Types: add_glow, remove_glow, none
  Glowing: "none"

Hidden Components

If you are using Hidden-Components or Components in places, It has been replaced by flags.components, Existing configurations will still work.

Bugs Fixed 🐛

• Fixed a bugs with incorrect messages being used for things, or variables in places.
• Fixed a bug with the log method when the uuid is null causing a console error to appear.
• getPrize not filtering out invalid weights properly leading to weird prize winnings.
  • We did the correct check for the totalWeight variable, but when looping through prizes. Prizes with -1 weight were still present.
  • If you add -1 to a value, it increases the value which can cause issues with prize chances.
  • Any value with 0.0, 0, or numbers less than 0 will be considered filler items.
• Paginated guis creating a second page despite there not being enough items for it.
• Log messages potentially not being saved.
• Updated the ExcellentCrates migrator which fixed a few migration bugs
• Fixed an important issue with /crazycrates transfer.
  • If you cannot update, I recommend denying the permission to use this command.
• Fixed issues with /crazycrates take/give & /crazycrates mass-open by clamping the amount to be a required amount.
• CMI in recent updates, whether it's CMI Lib or CMI API, in short. the API broke, and I forked it, compiled it, published it to my repo... and it seems to work for now
  • It seems I shall be maintaining it until the heat death of the universe.
    • #876
    • #9919 CMI's issue on Zrips repository that is closed by a stupid bot.
• /crazycrates debug was not working properly.
• Use correct variables when logging messages.
• Fix multiple issues with custom heads/skulls not being built.
• Use correct message when a player has no keys when doing /keys.
• Fixed an issue with mass-open where if any of the rows were null, or the tiers were empty. the keys you would've spent would've been lost. They get refunded now.
• Message responses when running commands not being sent to console.

As always, Report 🐛 to https://github.com/Crazy-Crew/CrazyCrates/issues

Changes 🔨

New API

CrazyCrates API has been bumped to 0.9.0

A new class has been added.

Key Manager class, which allows you to check Items that players are holding.

You can fetch this by doing CratesProvider#get()#getKeyManager()

/**
 * A class for the KeyManager, It handles checking physical keys, and anything else we might need soon.
 *
 * @author Ryder Belserion
 * @version 0.9.0
 * @since 0.9.0
 */
public abstract class KeyManager<I> {

    /**
     * The default constructor for {@link KeyManager<I>}.
     *
     * @author Ryder Belserion
     * @since 0.9.0
     */
    public KeyManager() {}

    /**
     * Checks if the item is a valid key.
     *
     * @param item the ItemStack
     * @return true or false
     * @since 0.9.0
     */
    public abstract boolean isKey(@NotNull final I item);

    /**
     * Checks if an item matches another item.
     *
     * @param item the initial ItemStack
     * @param comparing the ItemStack to compare
     * @return true or false
     * @since 0.9.0
     */
    public abstract boolean isMatchingKey(@NotNull final I item, @NotNull final I comparing);

    /**
     * Gets the name of the crate the key belongs to.
     *
     * @param item the ItemStack
     * @return the name of the crate
     * @since 0.9.0
     */
    public abstract String getKey(@NotNull final I item);

}

Configuration changes

• ChestLines has been renamed to Rows in the crate config files, 5eec53b
  • All existing configurations should continue to work, You can run /crazyrates migrate -mt CratesDeprecated to change this, or simply use Find and Replace.

Other Changes

• Added the ability to customize the row/column of the back/next and menu button.
• Added the ability to customize the CSGO animation to either have the top/bottom be static or dynamic. 95de51e
  • If you run /crazycrates migrate -mt CratesDeprecated, The existing options you need will generate.
  • Please refer to the examples/crates/CrateExample.yml folder for a full example of how to do it.
  • It supports the same structure as the new way to do items in the Items section which can be found on the documentation.
• Run the command on click in the Crate Menu, instead of on open.
  • 6c580b1
• Added %chance% / %weight% to the prize/default message.
• Added command syntax suggestions to all existing commands.
• Return "N/A" if the file is empty, because files#getFirst() throws an error because no element found.
• Utilize built in methods from CMI/DecentHolograms to handle coloring the messages for better compatibility with their plugins.
  • This will maybe also allow other plugin specific features like CMI's countless other features for holograms.
• Remove the brackets from custom name for the item displayed above QuickCrate.
• Fill the bottom border with air to prevent item overfill with the buttons.
• Added toggle to disable opening tracking crate.
  • 76625ba

Bugs Fixed 🐛

• Fixed an error with WonderCrate.yml on first install, because a prize was lacking an Items section.
• Fixed a potential memory leak caused by using double brace initializers.
• Fixed multiple bugs with PlaceholderAPI support.
• Fixed a typo in CosmicCrateManager. #873
• Fixed a typo with %crate_opened_raw%.
  • 1ef6553
• Fixed an issue with items dropping on Folia. #856
• Fixed an issue by using #runNow instead of #run which calls the internal void method.
• Fixed multiple issues with migration types.
• Fixed multiple issues on Folia due to not using schedulers when needed.
  • 0e139f6
• Fixed an issue with potion color not applying with the new items section.
• Fixed an issue with the shield banners using the new item format.
• Fixed an issue with the tier chance per prize not properly showing.
• Fixed crates debug command.

As always, Report 🐛 to https://github.com/Crazy-Crew/CrazyCrates/issues

fde1b0e Update {prefix} replacement for messages

2e73bce Replace all double brace initializers with immutable maps, or new HashMap/List when needed

b92b47f Fix placeholders requiring a player name

5cfc069 Add missing item reward to prize #2 on first startup

1ef6553 Fix placeholder typo

496e4d0 Allow server owners to manually pick CMI

You must downgrade to at least 9.8.2.0, as it seems to still work there.

Automatic enabling of CMI is disabled.

e3d85d5 Update placeholder api support

6c580b1 Run the command on click with gui customizer, instead of on open.

f99bb83 Add %chance% / %weight% placeholder to the prize/default message

f2c5fbd Disable CMI Support temporarily as the API available seems not to match with the newer version of CMI

c0b8105 Fix an issue where players couldn't open crates by default due to non-stripped name being used.

876f3a7 Fix typo in CosmicCrateManager (#873)

1efdceb Always break if the value is less than or equal to 0.0

68ecd37 Fixed issue with new crate files not being added on plugin reload

Fixed an underlying issue where if the crate was deleted, the keys would be deleted as well.

Fixed another issue where the logs folder wasn't being created.

bc92cef Send message when a player uses too many or too few arguments

3af2d36 Add command syntax annotation to all commands

This allows a better way to handle telling players invalid command usage.

ecef83e Added the ability to customize the row/column of the back/next and menu button.

91507b3 Condense the if else check by moving the isEmpty check into the loop.

95de41e Added ability to customize the csgo animation to either have the top/bottom be static or dynamic

If you run /crazycrates migrate -mt CratesDeprecated, The existing options you need will generate.

Please refer to the examples/crates/CrateExample.yml folder for a full example of how to do it.

It supports the same structure as the new way to do items in the Items section which can be found on the documentation.

5eec53b Renamed ChestLines to Rows in the Crate config files.

Existing configurations should continue to work, You can run /crazycrates migrate -mt CratesDeprecated to change this!

a81d617 Fix an issue by using #runNow instead of #run which calls the internal void method.

e1530d1 Fix issue with the migrators due to FileType not being overridden properly

ea710bf Return "N/A" if the file is empty, because files#getFirst() throws an error because no element found.

13968e3 Utilize built in methods from CMI/DecentHolograms to handle coloring the messages for better compatibility with their plugins.

This will maybe also allow other plugin specific features like CMI's countless other features for holograms.

4241727 Remove the brackets from custom name

55af5e1 Added folia scheduler to 2 locations related to command execution

• Fixed glass not showing up in WarCrate, the border toggle is stupid for that as it's required for the crate.
• Removed the remaining ItemMeta usage in favor of Data Components, specifically with the additem command, and the ExcellentCratesMigrator

0e139f6 Added Folia support to every section I know of that was lacking Folia support.

• The display rewards that appear above QuadCrates now have Folia support.
• Multiple methods giving physical keys now have Folia support.
• Checking if a crate type was CrateOnTheGo which requires giving a physical item have been moved to the UserManager#addKey method.
• Updated previous Folia support for sections that did not use FoliaScheduler.
• The /crates admin menu has Folia support now.
• Deprecated QuadCrateManager#endCrateForce for removal, which uses QuadCrateManager#endCrate internally.

7c3b2f2 Update session manager cache for QuadCrates

The cache used to be static, and was accessed very weirdly, I did not like it.

8894d22 Strip the crate name correctly when making the itemstack for the keys

6e8e663 Fill the bottom border with air to prevent item overfill with the buttons

31b2b5f Fix issue with additem command

5654508 Fix issue with potion color not applying with the new items section

3fd6d3e Update fusion api

76625ba Add toggle to disable tracking crate openings

304d53e Remove dead imports / whitespace

ad9b522 Clean up file logger impl

7ef9d6f Simplify logger checks

d6f2ca0 Crate type is labeled as NotNull, because we fall back on CSGO crate type in-case they messed up configurations.

fa4ba52 Fix an issue with the shield banners using the new item format.

d567691 Fix re-location issue causing the plugin not to boot

5e4acb6 Fix crates debug command

Fix issue with dropping items on Folia #856

• Added the prize display when opening FireCracker crate type.
• Added the ability to hide components on items in the new Items section. (turn it on in config.yml)

    '1':
      DisplayName: <red>Diamond Helmet
      DisplayEnchantments:
      - protection:5
      - unbreaking:3
      # The item to display in the gui.
      DisplayItem: diamond_helmet
      # The amount to display in the gui.
      DisplayAmount: 1
      # The lore of the item.
      DisplayLore:
      - <gradient:#8fcfa0:#32a852>A gradient lore!
      # The chance to win i.e. 15%
      Weight: 15.0
      Items:
        1ca8f0ac:
          material: diamond_helmet
          # The name of the item.
          name: <red>Diamond Helmet
          # The configuration section for enchantments, minecraft: is not needed in front of the enchantment.
          # A list of enchantments https://jd.papermc.io/paper/1.21.4/io/papermc/paper/registry/keys/EnchantmentKeys.html
          # enchantment: amount
          enchantments:
            unbreaking: 3
            protection: 3
          # A list of components to hide.
          # https://jd.papermc.io/paper/1.21.5/io/papermc/paper/registry/keys/DataComponentTypeKeys.html, Grab the value from the description without minecraft:
          hidden-components:
            - "enchantments"

• Fixed an issue with a try catch firing when it shouldn't.
• Fixed a deprecation warning in the ExcellentCrates migrator.

• Fixed a null pointer with the new Items layout.

• Fixed issue with player skulls not displaying correctly.

• Fix issue with the inventory titles not being colored. This issue only exists on 4.10.0 and 4.10.1.

• Fixed #850 which was an issue with the examples folder loading.
  • If you still have issues, turn off update-examples-folder in the config.yml

• Updated to 1.21.5
• Added authors to paper-plugin.yml

• Fixed an issue with ExcellentCratesMigrator

• Fixed an issue on default installations where the rows were set to 3 instead of 6 in the config.yml

• Fixed an issue with the FireCracker crate type

• Fixed an issue on Folia #844

• Fixed an issue with filtering tiered prizes by using the correct symbol!
  • This prevented properly getting prizes, #842

• Fixed an issue with the damage data component being applied to the ItemStack
• Fixed an issue with migrating to the new Items section where the integer is a string
• Added back /cc set because why not?

• Fixed another issue with files being overwritten which caused files like locations.yml or data.yml to be replaced.

This build has a data loss bug in it, Please do not use it.

• Fixed an issue with example crate files generating on startup in the crates folder

This build has a data loss bug in it, Please do not use it.

• Added the ability to use Item Models which was introduced in 1.21.4
  • This acts as replacement to Custom-Model-Data wherever you see it, It's up to the plugin/resource pack you use to find the new id.
    • oraxen:emerald_helmet
    • nexo:emerald_helmet
    • itemsadder:emerald_helmet
  • Above are examples of namespace:id.

  PhysicalKey:
    # Name of the Key.
    Name: "<bold><gradient:#084CFB:#ADF3FD>Wonder Crate Key</gradient></bold>"
    # Lore of the Key.
    Lore:
      - "<gradient:#084CFB:#ADF3FD>A fancy key to open a wonderful crate!</gradient>"
    # The item the key is.
    Item: "blue_dye"
    # The item model, Mojang introduced this in 1.21.4... this replaces custom model data!
    # Set this to blank for it to do nothing.
    # The format is namespace:id
    Model:
      # The namespace i.e. nexo
      Namespace: ""
      # The id i.e. emerald_helmet
      Id: ""
    # Makes the key look enchanted.
    Glowing: true 

• Added the ability to display potion effects in item previews

# This is an example of the new crate format.
Crate:
  # A list of prizes.
  Prizes:
    "1":
      # The name of the item to display in the gui.
      DisplayName: "<gradient:light_purple:dark_purple>Witch's Potion"
      # The item to display in the gui.
      DisplayItem: "potion"
      # The configuration section for potions, minecraft: is not needed in front of the potion.
      # A list of potion effects https://jd.papermc.io/paper/1.21.4/io/papermc/paper/registry/keys/MobEffectKeys.html
      DisplayPotions:
        # This must be the potion name typed exactly as it is, A list of potions linked above.
        poison:
          # The length of the potion in seconds.
          # https://minecraft.wiki/w/Calculators/Tick
          duration: 20
          # The strength of the potion.
          level: 5
        absorption:
          duration: 30
          level: 5
      # The amount to display in the gui.
      DisplayAmount: 1
      # The lower the number, the less likely to win it.
      Weight: 1.0 

• Custom-Model-Data, or custom-model-data can accept numbers or strings due to recent changes in 1.21.4.
• Fixed the /crates additem command

• /crazycrates debug will tell you no prizes can be won if the item sections are empty, or if there are no prizes.

New Item Format

This is only for the new item format behind a toggle in config.yml

Fixes

• Fixed an issue with items having blank names with the new item format (not the old format)
  • This happens only when name is not present in the Items section

Additions

• Added the ability to have multiple potion effects for a potion, or tipped arrows
  • Potion effects are measured in seconds, https://minecraft.wiki/w/Calculators/Tick

New Item Format

I've been working on a new format for the Items section as the current one is very restrictive, You can experiment with this by enabling it in your config.yml

• The command /crazycrates migrate -mt NewItemFormat will update all Items section to the best it can.
  • The migration is one way, Please be wary of this and take backups.
  • Editor-Items should be migrated as soon as possible when you feel like it as this is much more readable, I plan to do much more to expand on the in-game editor since the structure makes such a thing easier.

You can find an example of the Items format linked below https://docs.crazycrew.us/docs/category/items-3

Fixes

• ItemsAdder blocks were not working with left/right click
• A double message sent to admins when using /crazycrates giveall
• Holograms were not refreshing when using DecentHolograms
• Set the default item plugin option to "None" because it was causing issues
• Fixed a few other issues like ItemStacks not stacking properly

Changes

• Removed an unused config option from the config.yml
  • The option this was replaced with has already been moved to fusion.yml previously
• Marked use-new-permission-system for removal
  • This option is being removed as crazycrates.open. will be the permission going forward.

• Fixed an issue with internal placeholders in the lore of /crates not working.

• Fixed an issue with an error when broadcasting a message
• Added new placeholders without number formatting, https://docs.crazycrew.us/docs/plugins/crazycrates/guides/placeholders
  • Simply add _raw to the end of all placeholders including our internal ones like %keys% i.e. %keys_raw%
• Fixed an issue with /crates placeholder not being replaced properly

• Added back the old way of breaking crates via shift left click
  • Creative Mode is still not required
• Added similar max pull checks, filler checks, and alternative prize checks for tiered prizes
• Fixed an issue with ItemsAdder and CrateInteractEvent
• Fixed an issue with Folia servers

• Fixed an issue with vanilla blocks not working as crates.

• Fixed issue with furniture plugins due to a pesky boolean.
• Added a new feature for a "rolling name" during animations

Crate:
  # Settings related to animations...
  Animation:
    # This is only when an animation starts.
    Name: "Rolling your prize..."

• Cleaned up a bit of the internals for if else checks
  • You must run /crazycrates migrate -mt CratesDeprecated
• Add missing commands or arguments to locale files
• Fixed an issue where some border toggles werent being used

• Added -s as an option for /crazycrates give|give-random|giveall
• Slight performance increase when checking physical keys
• fusion.yml rather than config.yml defines what custom items plugin to use now.

• Added a new way to define color/rgb for things like potions, leather_armor etc which should fix the potion#10040:229,164,229 issue trying to stack model data and color/rgb

    "8":
      # The name of the item to display in the gui.
      DisplayName: "<red>Red Potion"
      # The item to display in the gui.
      DisplayItem: "potion"
      # Prize display preview settings
      Settings:
        # The custom model data of the item, -1 is disabled.
        Custom-Model-Data: -1
        # The rgb used for the potion.
        RGB: '229,164,229'
        # Color: RED
      # The amount to display in the gui.
      DisplayAmount: 1
      # The lower the number, the less likely to win it.
      Weight: 15.0
      # The list of items to win.
      Items:
        - "Item:potion, RGB:229,164,229" # Color:RED

• Flags has been removed from being a configuration option for Prizes
  • If you used Flags, as long as it's not empty. It will simply hide everything, but lore/displayname.
• HideItemFlags: true/false will now function, it will hide all, but lore/displayname.
• hide-tool-tip:true/false is now an option for the Items section in Prizes.
• Updated to 1.21.4

• Added direct support for Nexo/ItemsAdder/Oraxen furniture.
  • A new config option was added in the config.yml letting you choose which plugin to use.
  • If you leave it blank, or as "None"... The plugin will pick whichever it finds first.
  • If you find an issue with one of the other plugins, Set the option in the config.yml to None then restart your server.
• Updated misleading comment on Prize Commands.
• Added /cc as an alias.
• Replaced /crates set with /crates editor
• Updated /crates editor.
  • The new format is /crates editor -c/--crate <crate_name> or -e/--exit (if you want to leave the mode), This will put you an editor mode for this specific crate.
  • While in this mode, If you right-click a block, You will add a crate location. If you left-click a block, You will remove a crate location.
  • You no longer need to shift click, or be in creative mode.

• Fixed an error with War Crate which was thrown when clicking.

Update

• Ignore offhand when right-clicking a physical crate.

Update

• Fixed an issue an entity task error on Folia.

Update

• Fixed an issue on startup with extracting files.

Update

• Added Nexo support.

Update

• Added {key} placeholder in places it was missing
• Use Server#getPlayerExact() instead of Server#getPlayer()

Update

• Added 2 new toggles in the config.yml which allow you to switch what right/left do when interacting with physical or virtual crates.
• Added the ability to migrate user data with ExcellentCrates by adding -data to the command which ignores migrating crates.
  • crazycrates migrate ExcellentCrates -d
• Updated the migration command format
  • crazycrates migrate -mt <migration_type> -c <crate_name> -d
    • -d/--data is used for migrating from user data from other crate plugins.
      • If you wish to migrate from a crates plugin like ExcellentCrates, Do not use -d
    • -mt/--migration_type is used to specify what migration type you want to use.
    • -c/--crate is used for supplying a crate name.
• Fixed multiple issues with the ExcellentCrates Migrator.
• Fixed an issue where sometimes fireworks would spawn double stacked or triple stacked.
  • This is because in the sections handling giving the prizes, we forgot how many times we actually spawned fireworks.
• Fixed a similar issue where the PlayerPrizeEvent was called multiple times, sometimes even 3 times.
  • This is a similar reason to above, we forgot where we used it, or method stacking.
• No longer spawns a firework when a prize is picked before opening the re-spin menu as the idea of the fireworks is only when the prize is actually given to the player.

Changes:

• Allow mass-open to be used on the following crate types:
  • QuadCrates
  • CasinoCrate
  • CosmicCrate
  • FireCracker
  • QuickCrate
• Updated logging messages for tiers in CasinoCrate
  • Only checking if a tier is null, rather than if the config option is empty, then checking if a tier is null.
• Moved calling the player prize event, and spawning fireworks to the method which gives the prize.

Fixed:

• The migrator for ExcellentCrates was setting to Chance not Weight in our crate configs during migration.

Fixed:

• Fixed an issue with the broadcast toggle.

Changes:

• Bumped to 1.21.3

Additions:

• Added a feature to turn off the glass border in CSGO, RouletteCrate, WheelCrate, and WonderCrate #800

Crate:
  # Global Settings
  Settings:
    # Handles settings related to the border
    Border:
      # Settings related to the glass border
      Glass-Border:
        Toggle: true # Should the glass border be enabled?

Fixed:

• No longer ignore items with a -1 weight when building the preview, this prevented prizes being able to be used as filler items.

Fixed:

• An issue with the max pull lore being appended, despite the config option being set to -1 for max pulls.

Changes:

• Updated global crate broadcast, and per prize broadcast which overrides crate broadcasts

Fixed:

• No longer ignore items with a -1 weight when building the preview, this prevented prizes being able to be used as filler items.

Changes:

• Added after the key name or crate name when logging crate/key events to console.
• Strip colors when logging to the crates.log/keys.log file.

Changes:

• Updated use-different-random comment in config.yml.
• Add more verbose logging, and an extra safety net to Casino Crate.
  • This requires is_verbose set to true in vital.yml

Fixed:

• Properly including calculate the total weight of the tiers for casino crate.
• Properly calculate the per tier prize pools total weight, for things like Casino or Cosmic Crate.

Fixed:

• Fixed an issue with infinite re-spins on join due to using temporary cache.
• Fixed case-sensitive issue with /crazycrates claim

Breaking Changes:

• The weight system has been merged in, which effectively replaces the Chance/Max Range system.
  • You must run the command /crazycrates migrate WeightMigration, which will convert your configurations.
  • https://docs.crazycrew.us/docs/plugins/crazycrates/guides/crates/weight-system

Additions:

• Added the ability to log the plugin actions to file i.e. crates.log and keys.log... A list of events currently tracked
  • event_key_given
  • event_key_sent
  • event_key_received
  • event_key_transferred
  • event_key_removed
  • event_key_taken
  • event_key_taken_multiple
  • event_crate_opened
  • event_crate_force_opened
  • event_crate_mass_opened
• If you notice anything not tracking right, or lacking tracking. Create an issue.
• The files will zip on /crazycrates reload, plugin shutdown, plugin startup.
  • This avoids the files getting large, and leading to issues with crashing the server.
  • It mimics how Paper handles their .log files...
• Added /crazycrates claim which claims prizes they didn't get from respins

Changes:

• Added config options, which allow you to configure slots 4 and 22 above the prize in csgo crate
• Added the ability to run commands with the gui customizer.
• Added the ability to respin prizes to each crate file, if the option is enabled.

Crate:
  # Global Settings
  Settings:
    # Settings related to rewards.
    Rewards:
      # Should a yes/no popup be made, to ask if they want to keep the prize?
      Re-Roll-Spin: false
      # Should there be a limit to how many times they can re-roll?
      Permission:
        # Should this be enabled?
        Toggle: false
        # Should this persist restarts? i.e. writes to disk the amount of respins, and reads the amount of respins.
        Persist: false
        # This will define how many permissions will be registered to the server per crate.
        # i.e. crazycrates.respin.<crate_name>.1-20
        # It will simply register multiple permissions, so it shows up in things like LuckPerms.
        Max-Cap: 20

• You can view an example of this in examples/crates/CrateExample.yml
• If Permission.Persist is set to true, we will write to disk, and the re-spins will be considered global
  • If the option is set to false, it will be cached... and allow re-spins for X amount every time they open a crate.
• You must have Re-Roll-Spin set to true to allow re-rolls.
• You must have Permission.Toggle set to true, for it to be permission based.
  • The higher the permission, the more spins they have.
  • Internally, we loop through a player's permissions.... and find the highest matching one with crazycrates.respin.<crate_name>.<amount>
  • The permissions will be registered on startup, and on /crates reload if not found.
    • We also unregister on /crates reload, if you set Permissions.Toggle to false.
  • <amount> is the Max-Cap, It will not go any higher... The higher that number is, the heavier the permission checks.
• Crate Types such as Cosmic Crate, Casino Crate, QuadCrate, and WarCrate do not have support for re-spins
  • Casino Crate has 3 prizes, the gui currently only supports 1 prize.
  • Cosmic Crate has 4 prizes that you pick, the gui currently only supports 1 prize.
  • QuadCrate has 4 prizes, the gui currently only supports 1 prize.
  • WarCrate is in a similar situation, where it's picked prizes.
• The complexity for these crate types above will take some time to add it in while it not being a train wreck.

Fixed:

• Fixed an issue, where if the border was toggled off. and you didn't have a second page, a glass pane would be there.
  • It will simply be air now until the border is on.

Fixed:

• Fixed an issue with pagination on prizes.
• Fixed an issue with the next/main/back buttons being static not dynamic.
  • They would not re-size with the gui if you changed the row size.

Changes:

• No longer do hefty checks on PlayerMoveEvent if the player is not in the session for QuadCrate

Big Changes: ( only for existing configurations )

If you DO not change this, all your previews will look weird.

• config.yml has had a change that cannot be automatically done.
  • the customizer specifically the slot option, due to recent inventory changes.
  • you must subtract 1 from each option, and start from slot:0 instead of slot:1
• Similar tweaks have to be made with subtracting 1 from each option in the crate files
  • Specifically, related to the position of the crates in /crates and the position of the tiers in the tier previews
• Why did this change? Inventories naturally start from 0, and the gui framework I switched to does start from 0
  • This change allows for much easier inventory management and future features.

Added:

• Added a new feature to prizes, The ability to set a limit on prizes.
  • If a prize has Max-Pulls set to any number i.e. 1 or higher.
  • That is limit globally for any player to claim it.
  • Once that limit is reached, It will no longer be winnable.
    • %pulls%, %maxpulls% are 2 new placeholders which can be used in DisplayLore, DisplayName, Messages, Commands and the global/per prize broadcast.
  • A lore will be added to any prize that meets the criteria.
    • This message can be edited in messages.yml, and set to empty if you don't want it appended.

An example of what a prize would look like with the Max-Pulls option

    '6':
      # The name of the item to display in the gui.
      DisplayName: "<green>Fancy Shield <gray>| <red>%pulls%<gray>/<red>%maxpulls%"
      # The enchants to display in the gui.
      DisplayItem: "shield"
      # A list of patterns: https://jd.papermc.io/paper/1.21/org/bukkit/block/banner/PatternType.html
      # The patterns don't need to be uppercased. you can type them lowercased along with the colors.
      # Patterns have to be laid out in a specific order, otherwise it won't look right.
      # This also applies to the Items section.
      DisplayPatterns:
        - "base:white"
        - "gradient_up:light_gray"
        - "straight_cross:light_blue"
        - "flower:light_blue"
      # Prize settings
      Settings:
        # The custom model data of the item, -1 is disabled.
        Custom-Model-Data: -1
        # The amount of times this item can be pulled.
        Max-Pulls: 10

• Added the ability to have per prize broadcasts and global broadcast for prizes.
  • The permissions used to filter out who can see the broadcast are registered as proper permissions, so they show up in LuckPerms
  • They do get removed when you turn off the per prize broadcast or the global broadcast.

Removed:

• All legacy color codes are removed, I do not want to maintain it anymore as I've figured out ways around needing it.
  • You can run /crazycrates migrate LegacyColorAll which should migrate all values in config.yml, messages.yml and all crate files.

Fixed:

• CSGO Crate animation was delayed by 1 tick, for some reason.
• Fixed https://github.com/Crazy-Crew/CrazyCrates/issues/788
• Fixed spacing in migrate command usage.

Changes:

• Improved /crazycrates migrate internally.
  • ExcellentCrates Migrator has changed significantly, report any bugs you might find. It will convert legacy color codes to MiniMessage.
  • Properly warn the player/sender if the inputted migration type is not valid.
• Removed sections of code related to giving a prize if Editor-Items, Commands or Items were all not found.
  • This would use the DisplayItem, DisplayName, DisplayLore, DisplayEnchantments and DisplayAmount as the prize.
• Updated the /crazycrates additem command
  • CrazyCrates additem command now supports MiniMessage, regardless of the item format used.
  • This is only happening, as legacy colors have been removed and I did some research to improve things.
• Updated the config option use-old-editor, It is now migrated to use-new-editor
  • true uses the new editor, false uses the old one which is more readable. The option should be migrated on startup.
• Updated Vital API.

Fixed:

• Fixed an issue with some commands not properly validating virtual keys

Deprecation

• Deprecated PlayerPrizeEvent(player, crate, crateName, prize)
  • Please use PlayerPrizeEvent(player, crate, prize) as the crateName is already passed through via the crate object.

Fixed:

• Fixed a class cast exception with the ItemBuilder when using Data: or DisplayData:

Fixed:

• Fixed an issue with /crazycrates migrate ExcellentCrates
  • Added a missing configuration option, that is required in our crate configs.

Changes:

• Removed all getItemMeta/hasItemMeta calls for checking PersistentDataContainer
  • We now check ItemStack#PersistentDataContainerView which no longer relies on ItemStack#getItemMeta
  • TLDR: stonks

Added:

• Added a toggle, which allows you to revert the chance made previously.
  • crazycrates.open.<crate_name> -> crazycrates.deny.open.<crate_name>
• The configuration option can be found in the config.yml i.e. root.use-new-permission-system which defaults to false
  • This option is subject for removal however toggled like this for now, false means the old system i.e. crazycrates.open.<crate_name> is back.
  • The new way i.e. crazycrates.deny.open.<crate_name> will be removed in the next version of Minecraft!
  • All further experiments will be behind toggles like this one going forward.

Added:

• Ability to migrate crate configurations from ExcellentCrates.
  • active locations from ExcellentCrates are also migrated!
• Added a new feature where the RequiredKeys can also take that amount of keys #755
  • use-required-keys in config.yml has to be true for that to take effect.
• Added %chance% placeholders to prizes and tiers

Crate Config Changes:

• Crate.CrateName is deprecated, and has been replaced by Crate.Name
  • The options were duplicate, and one wasn't used which annoyed me.
  • Crate.CrateName will be removed in the next version of Minecraft!
  • You can run /crazycrates migrate CratesDeprecated to migrate deprecated options.

Crate:
  # https://docs.crazycrew.us/docs/plugins/crazycrates/misc/crate-types

  # Make sure to check out the wiki for anything not explained here.
  # https://docs.crazycrew.us/docs/category/crazycrates

  # See CosmicCrate.yml to see how the Cosmic CrateType works.
  CrateType: Casino
  # Name of the Inventory if a GUI crate.
  CrateName: "<dark_blue>Casino Crate" # Deprecated, but will still work
  # Name of the item in the GUI.
  Name: "<bold><dark_blue>Casino Crate</bold>" # This is what is used now if CrateName isn't found
  # The lore of the item in the GUI.
  Lore:
  - "<gray>This crate contains strange objects."
  - "<gray>You have <gold>%keys% keys <gray>to open this crate with."
  - "<gray>You have opened this crate: <gold>%crate_opened% times"
  - "<gray>(<yellow>!<gray>) Right click to view rewards."

• Crate.Preview-Name is deprecated, and has been replaced by Crate.Preview.Name
  • The option was meant to always be under Crate.Preview
  • Crate.Preview-Name will be removed in the next version of Minecraft!
  • You can run /crazycrates migrate CratesDeprecated to migrate deprecated options.

  Preview:
    # The name of the inventory for the preview menu.
    Name: "<green>Basic Crate Preview" # moved it under Preview
    # Turn on and off the preview for this crate.
    Toggle: true
    # How many lines the Crate Preview should have. Including Header and Bottom (Between 3 and 6)
    ChestLines: 6
    Glass:
      # Turn the glass border in the preview on and off.
      Toggle: true
      # The name of the border item.
      Name: " "
      # The item that shows in the border. Can be glass or any other item.
      Item: "gray_stained_glass_pane"
      # The custom model data of the item, -1 is disabled.
      Custom-Model-Data: -1 

Fixes:

• Fixed a rare issue where you weren't able to open QuickCrate
• Fixed a duplication issue with CosmicCrate
• Fixed an issue where CMI likely wouldn't be detected

Changes:

• Right click now opens the crate menu as well.
• Checked location strings instead of object ids
• Simplified multiple location getters, don't need to get the same location 3 times if we aren't changing it.
• {crate} in messages will now return Crate.Name instead of the file name
  • Cleaned up internals related to sometimes, the file name being used along with bad naming schemes.
  • Crate#getName() is now Crate#getFileName() while Crate#getCrateInventoryName() is Crate#getCrateName()
• Check if the prizes section is empty before opening a crate, prevents unneeded chance calculation.
• Overhauled the /crazycrates migrate command, sends a more detailed message of what was migrated.
  • files that show up red failed to migrate while files that are green succeeded,
  • it also tells you the migration type you picked when running the command, while also reloading the plugin!
  • Only saving to file, if we find anything that needs to be migrated with CratesDeprecated option
  • Only migrate Editor-Items, if use-old-editor in the config.yml is set to false
• A lot of other changes were internal clean up, I was merely being a Janitor. functionality should not change.
• Deprecated use-minimessage in config.yml, it will be removed in the next major version of minecraft
  • The library (made by me), now has its own directory much like bStats. Each plugin using it will get a config generated inside it.
  • You simply after use-minimessage is removed will have to edit that file instead which is Vital/crazycrates-config.yml
  • Once the option use-minimessage is removed, setting is-legacy to false will allow MiniMessage

Added:

• Bumped minecraft version to 1.21.1
  • You should update to 1.21.1 as soon as possible, there is no changes to prevent any plugins from being used on 1.21.1
  • This version of Minecraft is a minor version fixing bugs, it's plug and play unless the plugin developer is insane and has some hardcoded restrictions.

Changes:

• Properly relocate the command framework
• CsgoCrate now when the task is finished, sets an item below and above the prize you won.
  • In the future, this will be configurable. I just don't know what to call it.
• Updated permission description
• Updated exclude.give-all to default to FALSE, #774
• Bumped CMI dependencies

Fixed:

• Typo in config options
• Adventure api issue #770
• CsgoCrate was missing 2 glass panes #772
• CsgoCrate was not animating the glass panes

Added:

• Added missing configurable messages to places around the plugin, all messages should now be configurable.
• Added a new config option where you can decide to send messages in chat or in the actionbar.
  • Messages that send a list to chat will by default never be sent to actionbar as it would not look pretty.
• Added a new placeholder, {required_amount} to crates.requirements.not-enough-keys
• Added another new placeholder, {key} to crates.requirements.not-enough-keys, #756
  • This placeholder returns the name of the key.
• Added a new migration type which converts deprecated fields in the crate files.
• Added 2 new toggles to the config.yml which you can find at the top of the file.
  • The use-old-editor requires use-minimessage to be false as it's uses legacy color codes.
• Added per prize broadcast, this will send a message to every player on the server.

    '5':
      # The display name of the item.
      DisplayName: "<yellow>$1,000"
      # The item to display in the gui.
      # The enchanted book will function with the enchants properly in an anvil.
      DisplayItem: "sunflower"
      # Prize settings
      Settings:
        # The custom model data of the item, -1 is disabled.
        Custom-Model-Data: -1
        # Broadcast a message to the server
        Broadcast:
          # If the messages should be sent.
          Toggle: false
          # The messages to broadcast.
          Messages:
            - '<red>%player% won the prize <yellow>%reward%.'
          # If the player has this permission, they don't get the broadcast.
          Permission: 'your_permission' 

• Added optional arg for Player with crazycrates debug, so you can use it in console.
• Added missing message notifying an item was added using /crates additem

Changes:

• The permission check for whether a player can open a crate has been changed.
  • crazycrates.open.<crate_name> is now crazycrates.deny.open.<crate_name>
  • The crate name is case-sensitive, so it must match exactly the crate name in the crates folder
  • If the file name is CrateBeans.yml, it must be crazycrates.deny.open.CrateBeans
• If a message in the messages.yml is blank, it will not send the message.
• Update default message for crates.crate-no-permission
• Update some comments because of grammar.
• Update logger message when the CrateOpenEvent is cancelled to be more verbose.

Fixed:

• Wheel Crate animation now spins properly. #764
• Roulette Crate inventory size is now normal. #765
• Don't give 2 prizes if the editor items isn't empty.
• Casino/Cosmic crate tier previews would share total items causing pagination to appear despite the inventory not being full.

Deprecations:

• Deprecated {key_amount} and replaced it with {required_amount} in crates.requirements.not-enough-keys
  • {key_amount} will stop working in the next major version of Minecraft.

Added:

• Ability the ability to make items glow in Items

Items:
  - 'Item:spawner, Glowing:true'

Fixed:

• The config option for verbose-logging was not applied to some parts of the plugin.

Changes:

• No longer add the contents of DisplayData to the Items section on /crazycrates reload
• Lowercase shield pattern types and colors which also fixed a display issue, so previous shield pattern/color configs work. They no longer need to be typed like GRADIENT_UP:LIGHT_GRAY, you can simply type gradient_up:light_gray
• Deprecated Patterns in favor of DisplayPatterns, it will be removed in the next major version of Minecraft.

    '6':
      # The name of the item to display in the gui.
      DisplayName: "<green>Fancy Shield"
      # The enchants to display in the gui.
      DisplayItem: "shield"
      # A list of patterns: https://jd.papermc.io/paper/1.21/org/bukkit/block/banner/PatternType.html
      # The patterns don't need to be uppercased. you can type them lowercased along with the colors.
      # Patterns have to be laid out in a specific order, otherwise it won't look right.
      # This also applies to the Items section.
      DisplayPatterns:
        - "base:white"
        - "gradient_up:light_gray"
        - "straight_cross:light_blue"
        - "flower:light_blue" 

Added:

• Ability to define spawner type in prizes

    '1':
      # The name of the item to display in the gui.
      DisplayName: "<green>Creeper Spawner"
      # The enchants to display in the gui.
      DisplayItem: "spawner"
      # Prize settings
      Settings:
        # The custom model data of the item, -1 is disabled.
        Custom-Model-Data: -1
        # The type of mob for the spawner.
        Mob-Type: creeper
      # The amount to display in the gui.
      DisplayAmount: 1
      # The max range i.e. 15/100 = 15% chance to win.
      MaxRange: 100
      # The chance to win i.e. 15%
      Chance: 23
      Items:
        - 'Item:spawner, Mob:creeper'

Changes:

• Play knockback/sounds if they don't have the required keys.
• Removed runtime dependency loader.

Cosmic Crate:

• Cosmic Crate was changed back in March for the calculation of tiers to be handled when you open the inventory, so that when picking a mystery crate. The choice would actually matter!
• It has been brought to my attention of being able to skimp it using client side mods. this has been addressed, the mods will no longer be able to skimp it by seeing item differences.
• The calculation still happens but, the picks are stored internally to the player's uuid in a cache which clears when the player quits, the inventory closes or the crate task ends for X reason.

Fixed:

• Issue with file not found on first install.
• Issue where examples folder wasn't being created properly.
• Issue with shields not getting color or patterns.
• Wonder crate type never playing the cycle sound.
• Wheel crate type playing the stop sound twice.
• Wheel crate type not playing the cycle sound as most people have the client music muted.
• War crate type played the cycle sound a bit early.

Fixed:

• Issue with /crazycrates migrate.
• Multiple null checks in commands.
• Issue with invalid argument output not outputting the proper syntax.

Changes:

• Updated migrator command format.
• Updated invalid argument output to just describe it better.

Fixed:

• Re-worked how display names are handled for items/previews, This format now works properly and stacks with vanilla items.

    '1':
      # The item to display/give in the gui.
      DisplayItem: "diamond"
      # The amount to display/give
      DisplayAmount: 3
      # The max range i.e. 25/100 = 15% chance to win.
      MaxRange: 100
      # The chance to win i.e. 25%
      Chance: 25

• Applied a bandaid to quadcrates
• Use correct crate name for {crate} when a crate location already exists in /crazycrates set <crate>
• Fixed npe with /keys view, player name wasn't supplied, so it freaked out.
• Fixed npe with placeholder parsing in messages.

Changes:

• Optimize display reward above quad/quick crate

Fixed:

• Issue with ItemBuilder not allowing further modification of the Oraxen items.

Changes:

• When interacting with a crate previously, it would check both virtual and physical keys, but it was a coin flip on what it would use, the interaction functions the same now as /crates in terms of hierarchy... physical keys are checked first then virtual keys.
• If you hold a key that can't open the crate you are looking at, it will instead default to checking your virtual keys if the config option is enabled, if a key is found... it will open the crate using virtual keys. as always, please report any bugs.

Fixed:

• Cancel the key check event if the checks find a player does not have enough keys.
• Simplify key checks so virtual keys can work, this removes an unneeded physical key check as we were checking it twice? why...
• Config comments for physical-crate-accepts-physical-keys and virtual-crate-accepts-physical-keys in config.yml were incorrect.

Changes:

• When interacting with a crate previously, it would check both virtual and physical keys, but it was a coin flip on what it would use, the interaction functions the same now as /crates in terms of hierarchy... physical keys are checked first then virtual keys.
• If you hold a key that can't open the crate you are looking at, it will instead default to checking your virtual keys if the config option is enabled, if a key is found... it will open the crate using virtual keys. as always, please report any bugs.

Fixed:

• Cancel the key check event if the checks find a player does not have enough keys.
• Simplify key checks so virtual keys can work, this removes an unneeded physical key check as we were checking it twice? why...
• Config comments for physical-crate-accepts-physical-keys and virtual-crate-accepts-physical-keys in config.yml were incorrect.

Changes:

• The fix below required preview to be only opened through left click so right click can function as for only opening the crate.

Fixed:

• The key check on right-clicking a crate was working, however we didn't inform the player they had no key.

Changes:

• The fix below required preview to be only opened through left click so right click can function as for only opening the crate.

Fixed:

• The key check on right-clicking a crate was working, however we didn't inform the player they had no key.

Fixed:

• Issue with file manager not properly loading/reloading files.

Fixed:

• Apply MaxStackSize to the player's inventory when using Player#addItem, so now instead of 99 items popping up in the inventory if giving 99 keys or any items, it'll split 64/35
  • Spigot for some odd reason made Player#addItem use the max stack size for the inventories. #hardforkwhen

Changes:

• Simplified parsing messages internally with placeholders

Changes:

• All file read/writes operations are actually moved off the main thread.

Removed:

• console_prefix config option no longer needed.

Changes:

• Use component logger for startup dependencies.

Fixed:

• Issue with PlaceholderAPI.

Changed:

• Updated how interaction with crates has been handled.

Fixed:

• Prevents placeable blocks from being placed on blocks if a key like tripwire hook or candle.

Added:

• A different way to apply CustomModelData to an item, this addition avoids an error that isn't an error from appearing. -1 means no custom model data will be applied!
  • Our documentation will be updated with the new format sometime this weekend however you can keep using the old format.
  • The old format tripwire_hook#custom_model_data will continue to work however consider this the deprecation notice.
  • Try and make an effort to use the new format please, you can look in the examples folder to see some applications of the format.

Changes:

• Deprecation warning for Lore -> DisplayLore is now more verbose, it'll tell you the prize name and crate file now.

Changes:

• verbose_logging in config.yml now applies to everything including errors, turn it on if something isn't working.

Fixed:

• Player Heads were not stacking previously, they should now.

Fixed:

• /crazycrates giveall did not have a permission requirement.
• Items not stacking with vanilla items if obtained through Items

Added:

• 1.20.6 support

Removed:

• 1.20.4 support

Fixed:

• War Crate no longer bugs out if you close the inventory.
• Files were not loading properly on Linux.
• Uppercase player name in default files to avoid some stupid error.
• Virtual Keys were not being taken from offline players.
• add {key} placeholder to /crazycrates open-others
• Missing placeholder {key} in /crates mass-open
• Temporarily commented out code for direct ItemsAdder support until LoneDev is finished making any changes they would like to.
• New players if the config option Crate.StartingKeys is not 0 weren't getting keys.
• Removing a file from the crates folder and then running /crazycrates reload, It would yell about file not found.
• Lore was not properly handled when using /crates additem.
• Updated the message in commands, instead of misc.no-virtual-keys, It will be using misc.no-keys message.
• Send the message to the command sender instead of the player when using /crates forceopen.
• b25b867 Issue with the preview not working for casino/cosmic tiers (#726)
• 46e6dba Add /crazycrates forceopen back (#715)
• 5940d29 Compile issue with workflows (#724)
• d9a9f49 Cosmic crate (#716)
• 854efe6 Error on player quit (#719)
• Issue with QuickCrate where holograms were stacking.
• Issue where the display name of the item above QuickCrate had [] around it i.e. [Diamond Helmet]
• open-others shouldn't be usable by everyone.
• Default casino crate.
• Update fallback sound.

Added:

• Support for heads from HeadDatabase by Arcaniax! Check the CrateExample.yml in the examples/crates folder for how to use HeadDatabase heads.

API:

• Bumped crazycrates api to 0.7

Breaking Changes:

• All items ids used for potions, materials, blocks, trim materials/patterns and sounds etc. have all been changed.
  • A list of sounds: https://minecraft.wiki/w/Sounds.json#Java_Edition_values, Custom Sounds from resource packs are also supported!
• Enchantments instead of PROTECTION_ENVIRONMENTAL and DAMAGE_ALL, It would be protection and sharpness

Changes:

• Updated to 2.2.0 FancyHolograms, they made a breaking change in the api so all previous versions of FancyHolograms will no longer work.
• Command / General Permissions have been updated!
  • You can find a list of permissions @ https://docs.crazycrew.us/docs/plugins/crazycrates/commands/permissions
• Update the order some if checks go in to prevent potentially unnecessarily heavy calls when not needed.
• Removed unsupported-settings from the example config.yml
• War/Cosmic Crate listeners for PlayerCloseEvent have been combined and had unnecessary method calls reduced.
• Ability to set update intervals for holograms, -1 disables it.
• /crazycrates migrate which should update materials/enchants/trim materials to mojang mapped ids.
• /crazycrates set on a location already taken will tell you that you that a location already exists.
• Allow left/right-clicking for locations created by /crazycrates set Menu.
• Updated the /crazycrates additem command to support any item you can make in-game, it will still allow you to apply other configuration to the item added like your own custom lore.
• This change required a few other tweaks in some areas so please report any oddities to our Github Issues tab.

    '7':
      DisplayName: '<red>This is a name.'
      DisplayLore:
        - '<yellow>This is a lore.'
      DisplayEnchantments:
        - 'sharpness:5'
      DisplayData: H4sIAAAAAAAA/53PQQrCMBAF0N8mQo0giEtv4sqFZ3Bb0iRiaDNTkhS8vTaI1KV0OfDfzB8FCOyuOuubi8kzAftXg9pbnIInZ6K+53M3aNO36TENvYttx0+BjeGJMoBKQRkOI5OjnLY4LswwZT1PUc05KSDTwIVAQfrswufOYQHW68Bkf7ZfSr+vq1a6eqUT/7umvPUGDbb6oU0BAAA=
      MaxRange: 100
      Chance: 10

• Note: Items used still have different restrictions like Shulker Boxes do not glow for example. If you can't do it in Vanilla Minecraft through /minecraft:give, our plugin can't either.
• Deprecated usage of Lore in prizes in favor of DisplayLore, you will be given a warning in console if using. Lore will be removed in the next major version of Minecraft (1.22)

Fixed:

• /crazycrates giveall did not have a permission requirement.

Added:

• 1.21 support

Removed:

• 1.20.6 support

Changes:

• Issue with items given through Items not stacking with items obtained through vanilla means.
• Issue with /crates additem not adding Data: to the Items section which caused the plugin to think it was an enchantment.
• Updated the output of /crazycrates additem again to create an Items section with the Item you held in your hand
• All pre-existing options in your prizes if they have DisplayData will create an Items section.
• The purpose of DisplayData should only be for what is outputted in the Crate previews however you can still remove Items if you want the existing options to function as the prize as well.

    '7':
      DisplayName: '<red>This is a name.'
      DisplayLore:
        - '<yellow>This is a lore.'
      DisplayEnchantments:
        - 'sharpness:5'
      # This only acts as the base display item which can be modified even after as you can see directly above.
      DisplayData: H4sIAAAAAAAA/53PQQrCMBAF0N8mQo0giEtv4sqFZ3Bb0iRiaDNTkhS8vTaI1KV0OfDfzB8FCOyuOuubi8kzAftXg9pbnIInZ6K+53M3aNO36TENvYttx0+BjeGJMoBKQRkOI5OjnLY4LswwZT1PUc05KSDTwIVAQfrswufOYQHW68Bkf7ZfSr+vq1a6eqUT/7umvPUGDbb6oU0BAAA=
      MaxRange: 100
      Chance: 10
      # This is what the plugin will try to give when winning this prize.
      Items:
        - 'Data:H4sIAAAAAAAA/53PQQrCMBAF0N8mQo0giEtv4sqFZ3Bb0iRiaDNTkhS8vTaI1KV0OfDfzB8FCOyuOuubi8kzAftXg9pbnIInZ6K+53M3aNO36TENvYttx0+BjeGJMoBKQRkOI5OjnLY4LswwZT1PUc05KSDTwIVAQfrswufOYQHW68Bkf7ZfSr+vq1a6eqUT/7umvPUGDbb6oU0BAAA='

Quick Note:

Migrate your configurations to MiniMessage!, this was changed in Version 2.1, please take a gander at our previous changelogs and as always, contact support if you need assistance.

Fixed:

• The migrator for Editor-Items would cause an error on fresh install.​

Fixed:

• Editor-Items are now migrated on start-up to a new format to prevent an error.

Fixed:

• Files were not loading properly on Linux.
• Holograms duplicated with QuickCrate.
• Prize Names that hovered above QuickCrate had [] around them.

Added

• Translation keys on materials, so it respects client language settings.

Fixed

• Startup errors preventing the use of the plugin.

Fixed:

• Immutable error when doing /crates additem on a prize already existing.

Fixed:

• /crazycrates debug/additem allowed you to use Menu as an argument.

Migrate your configurations to MiniMessage!

Previous Breaking Changes:

• Added minimessage support which replaces legacy color codes like &7 or &c

  • CMI/DecentHolograms do not support MiniMessage so you still have to use legacy color codes for that.

• b290d54 Updated /cc additem to be much more precise and friendly -> This will likely change again in the next version of CrazyCrates for 1.20.6, The item internals have changed.

Previously added rewards will still work for now. The new /cc additem currently only supports 1 item at a time but it's an improvement from before. DisplayAmount is what tells the plugin how much of the item to give so that is required. It will default to 1!

If you add an Items: section, It will use that instead for rewards and treat the nbt tag as if it was just purely for display.

Previous Additions:

• Added folia support.
• Added the ability to color the background using hex colors of holograms. It only works with CMI and FancyHolograms.
  • You can check the examples/crates folder under Hologram section for an example of how to add colors.
  • transparent is an option that can be used as well for see through holograms which is the default.
• Add the option to HideItemFlags in filler glass and crate preview items.
• Add config option to turn off the auto updating of examples folder.

Extra Item Options:

    1:
      DisplayName: '<red>Porkchop'
      DisplayItem: 'PORKCHOP'
      DisplayAmount: 4
      Chance: 60

If you simply want to give basic items without the need for using Items: or Commands:, You can configure a prize like this and it will give 4 porkchop.

DisplayAmount defines how many items to give, DisplayItem defines the material to give to the player.

You cannot have commands or items while using these type of format for giving items.

Removal:

• Removed the config option crate.unsupported-settings.old-key-checks as a bug I fixed broke what this setting was used for.

Previous Changes:

• Updated how holograms are handled. FancyHolograms should be less finnicky and CMI should perform better.
• Ability to set Chance in crate fields to -1 to use filler items.

Plugin Support:

• Add placeholder api support to broadcast message in each crate file.
• Added support for FancyHolograms by Oliver.
• Add support for PlaceholderAPI in key displayname/lores.

Previous Fixes:

• Fixed double lines with decentholograms.
• Fixed an issue where list messages would have an extra line at the end.
• Fixed an issue with materials not being recognized.
• Fixed a bug where keys did not have lores.
• Fixed an issue where if display names matched, it would not give the right prize.
• Fixed an issue with casino crate where you could open a casino crate without the key.
• Temp fix for double message when trying to open a crate with key in off hand. This means for the time being, Keys cannot be used in off hand for physical crates.

Fixed:

• Prizes were being picked incorrectly as we were checking if the display name of prizes matched when picking a prize.​

Fixed:

• Casino Crate was allowed to be opened without a key.

Fixed:

• Leather Armor not being colored.

Fixed:

• Placeholder issue in commands like /key by using the right config path.
• Key Name if not found in the config would throw an NPE.

Fixed:

• Setting crate type menu tried to create a hologram.

Big Changes:

• Replaced all instances of NBT-API with PersistentDataContainer. Old Keys will no longer work.
• We do not check if a key has lore/names when checking if you have a valid key because that makes the point of PersistentDataContainer redundant.
• The ItemBuilder has been updated to a slightly more modern version in preparation for MiniMessage support.

Removed:

• Temporarily disabled logging keys to console/file due to a weird issue with keys not being taken, the section handling logging is pending re-write

Added:

• A warning on startup if the spawn protection in server.properties isn't 0.
• Extra placeholders to all messages. The messages.yml will update with new comments showing what each message can use.
• A toggle to allow legacy key checks for niche use cases.
• Default commands to run per crate if no prize commands are found similar to Prize-Messages.
• %reward_stripped% which returns a stripped version of the reward for plugins like DiscordSRV.
• Ability to select custom particles and colors for QuadCrates.
• Ability to add enchants to ENCHANTED_BOOK, so they function in anvil.

Changes:

• Updated example files in the examples folder
• All internal placeholders used in config.yml and messages.yml have changed.
  • %player% is now {player}
  • %crate% is now {crate}
  • %amount% is now {amount}
  • %key% is now {key}
  • %keys% is now {keys}
  • %page% is now {page}
  • %prefix% is now {prefix}
  • %world% is now {world}
  • %cratetype% is now {cratetype}
  • %prize% is now {prize}
  • %number% is now {number}
  • %keytype% is now {keytype}
  • %usage% is now {usage}
  • %key-amount% is now {key_amount}
  • %crates_opened% is now {crates_opened}
  • %id% is now {id}
• Used correct message when a player has no keys using /cc open.

Enhancements:

• Prevent pistons from moving blocks if they are a crate.
• Play sounds in /crazycrates admin when a player gets virtual/physical keys.
• Change from sending messages in chat for /crazycrates admin to using action bars.
• Optimize item meta checks.
• If the crate main menu is turned off, trying to do /crates set menu will send you a message saying you can't.
• If the crate main menu is disabled, /crates will simply open the help message instead.
• Only check if a player has physical keys if the config option is enabled.

API:

• Deprecated and marked for removal CrazyCratesService and ICrazyCrates.

Fixed:

• Remove player from crate/page/preview arrays on inventory close event as it wasn't before.
• Player kept getting a preview message if they weren't in the preview when you did /crates reload.
• CrateOnTheGo where the event would fire twice using 2 of your crates.
• Failing to take keys would fire multiple times.
• Issue with mass-open related to being added to opening list and not being removed if no keys found.
• Multiple issues with how the inventory are checked for keys.
• Issue with QuadCrates where if you set the structure.random to false, it would still be random.

Added:

• Ability to override the menu button functionality to use your own menu through DeluxeMenus and any other gui plugin.

Changes:

• Re-did how /crate admin handles giving keys, It expands the size of the inventory to 54 slots and adds a button at the bottom explaining how to get keys.

Added:

• New crate type called Casino. (Idea by slimemcstew)
• Ability to have files categorized by folder.
• War Crate as a default generated crate.
• Ability to have holograms created using CMI or DecentHolograms have a configurable "block" range.
• Ability to configure sounds per crate.
• Configure the cycling sounds when crates are doing animations, the sounds played when a crate ends.
• Adjust the volume of sounds and the speed of the sounds.

Changes:

• Cosmic Crate configurations have new options, click me!
• Color has been replaced by Item as you could have always used any item, so it was misleading to name it Color.
• If Item is not found, it will fall back to LIME_STAINED_GLASS_PANE.
• You can choose between a pre-defined tier for each row or have it pick randomly between available tiers.
• Cosmic Crate when initially picking crates, all the ??? crates will have a tier bound to them, so it actually matters when you pick them.
• Updated slot checks for menu items to rely on PersistentDataContainer.
• Re-organized the default /crates gui.
• Check uuids for quad crate sessions over player objects.
• Update /crates additem to take input for tiers which only work for cosmic/casino, /crates additem <crate_name> <prize_number> [tier]
• Update /crates additem again to take input for custom chance, Note: The max range by default is still 100 so keep it under 100. /crates additem <crate_name> <prize_number> [tier].
• No longer create a snapshot of the holder when checking for InventoryHolders.
• Add a config option to switch to a faster implementation of picking numbers. It defaults to false which is the old way of doing random.
• All messages in chat, lore of preview items, gui names even filler items have PlaceholderAPI support.

Fixed:

• Crates being broken in worlds created by world plugins.
• Refund event needed to be fired sync.
• Display damage where if you put a value that can't be parsed as an integer like 50f, it wouldn't be empty durability.
• In-game editor wouldn't add tiers to casino/cosmic crate.
• Stored the wrong value for PDC causing it to error when using QuadCrates.

Changes:

• Removed the wildcard crazycrates.open.*
• Registered crazycrates.open.<crate_name> to server permissions on startup.
  • Each crate will have one registered, if you remove a crate. The permission will not be removed from the server until server restart.
• Updated cluster api version.

Fixed:

• Permission checks were not accurate.

Fixed:

• Error when a player left the server.

Changes:

• We no longer download Adventure API on runtime using the libraries feature in the plugin.yml.

Fixed:

• Remove all data related to the crate they opened if they leave.

Added:

• Toggle for the cosmic crate timeout feature. Settings.Cosmic-Crate-Timeout will be automatically added to your config.

Fixed:

• Cosmic Crate time out feature was not working as expected.

Fixed:

• Players not being removed from opening crates on quit thus crates getting stuck in a limbo of "Player is already opening crate."

Fixed:

• ItemBuilder was throwing an error in console.

Removed:

• plugin-config.yml as it was just weird, Options in there will migrate to config.yml automatically.

Changed:

• Bumped to 1.20.4
• Bumped nbt api
• Nested placeholders now work
  • %crazycrates_<player>_<crate>_opened% must be done like %crazycrates_{player_name}_your_crate_opened%
  • {player_name} can be replaced with almost any player variable from https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders
• /crazycrates admin-help has been removed.
  • /crazycrates help now has a permission check if the player has crazycrates.admin-access
• The permission crazycrates.command.player.help has been changed to crazycrates.help which defaults to TRUE
• Console can now use /crazycrates help.

Full Changelog: https://github.com/Crazy-Crew/CrazyCrates/compare/v1.18.5...v1.19

Fixed:

• Glow did not work.

Fixed:

• CSGO Crate animation was out of order.

Changes:

• Close CosmicCrate menu after 10 seconds when all 4 prizes are given.
• Clean up after ourselves when we need to.

Fixed:

• Custom Heads and Custom Items were not working.

Fixed:

• QuadCrate/CrateOnTheGo were not being opened when the command was run.​

Changes:

• Better support for custom items.

Fixed:

• Prevent obtaining keys when in /crates admin if clicking already existing keys in your inventory.

Added:

• Simple warning about plans to migrate from Spigot to Paper only.
• Config option to hide the QuickCrate item.

Changes:

• Respect a client's sound settings.
• CosmicCrate has been re-coded and optimized.
• Re-coded how crates are handled to allow for new crate types.
• Developer API has been updated.

Fixed:

• CosmicCrate had a bug
• CrateOpenEvent was fired twice.
• Spigot Compatibility.

Changes:

• %Player% no longer works, you must use %player%. This applies to all our internal placeholders.

Fixed:

• QuadCrate, QuickCrate or CrateOnTheGo were labeled as a virtual crate despite being in the Physical World.

Added:

• Track opened crates for /crates mass-open.
• Added a new message for when taking keys from poor people as an admin i.e. if they are offline or online.
  • A directory called examples will be re-generated on every startup and /crates reload to always ensure that you get fresh example files if needed.

Changes:

• If no display name option in the crate config prize section is present, the material name will be used for %reward%.
• Inventories are no longer checked by if the view matches, this led to you being able to name your inventory Enchant and now you can't use the Enchant table.
• Use customizable message for when getting keys out of the admin menu.
• If you try to use the /crates give/take command with any number equal or less then 0, It will tell you that it isn't a valid number.
• /crates mass-open now allows you to pick between physical and virtual keys.

Fixed:

• /crates set was not functioning properly.
• Menu Crate was not in tab completion.
• QuadCrate told you it can't be used as a virtual crate.
• Don't clean player data for users who have no keys if tracking is present under the user.

Fixed:

• Items had extra data added to items preventing them from stacking.

Changes:

• Reload all preview inventories for all viewers after /crates additem.
• Take all players out of any preview inventories during /crates reload.

Fixed:

• You could take items out when viewing previews.

Fixed:

• Placeholders were not being replaced in specific messages.

Fixed:

• The last physical key was not being taken from inventory.

Added:

• Ability to require a permission to open a crat
• New Message: No-Crate-Permission: '&cYou do not have permission to use that crate.'
• New Permissions: crazycrates.open.<crate_name or *>
• A new set of internal placeholders: %crate(s)_opened%
• PlaceholderAPI allows us to add new placeholders!
• Ability to run commands when a crate is opened, it defaults too false.

Changes:

• Added plugin-config.yml
• Metrics actually shuts down when you reload the plugin after turning off metrics.
• The plugin prefix is no longer automatically appended, you must add %prefix% to every message.
• Added new config options related to gui-customizer and sounds in config.yml

Fixed:

• Cosmic Crates should no longer error. #599
• Total-Crates in data.yml would be overwritten if adding a new crate.
• Check if the crate type is cosmic before marking it as "open", We want the key to be taken before being marked as open so people can't abuse it.

Added:

• Ability to have items appear damaged in the crate preview, add DisplayDamage: 50 to your prize as an example.

Added:

• You can now require a player have a custom amount of keys to open a crate.
• It will default to 0 if the option isn't added.
• Add it to your crate config like below.

Crate:
  # The amount of keys required to use the crate.
  RequiredKeys: 0

• You can now define a default prize message in each crate instead of having to manually configure each prize.

Crate:
 # A default message if the prize doesn't have any Messages
 # i.e Messages: [] or the value isn't there.
 Prize-Message:
 - '&7You have won &c%reward% &7from &c%crate%.'

• Added an extra placeholder called %crate% which simply returns the Preview Name.
• Any current iterations of %crate% return the Preview Name. I might've missed one though lol..

Removed:

• Auto update config version as it's useless, You can remove it from your config.

Added:

• Armor Trims with all pattern/material support has been added. View how to use it below!
  • https://docs.crazycrew.us/crazycrates/prizes/items/armor-trim

Api Changes:

• com.badbones69.crazycrates:crazycrates-api:1.11.16 from this point on is outdated.
  • Please update your dependencies to match this version accordingly before updating!
• crazycrates-api has been split into crazycrates-core-api and crazycrates-paper-api due to future plans for CrazyCrates
• https://docs.crazycrew.us/crazycrates/api/intro