From 19c28830b2d9edd409342847205f4e2f8e441c72 Mon Sep 17 00:00:00 2001
From: Ryder Belserion <no-reply@ryderbelserion.com>
Date: Tue, 13 Aug 2024 17:11:32 -0400
Subject: [PATCH] update changelog describing the change

---
 CHANGELOG.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 193348403..151a4c70f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,32 @@
 - Ability to migrate crate configurations from ExcellentCrates.
   - active locations from ExcellentCrates are also migrated!
 
+#### 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 the /crazycrates migrate CratesDeprecated to migrate deprecated options.
+```yml
+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."
+```
+
 ### Changes:
 - Check if the prizes section is empty before opening a crate, previews unneeded chance calculation.
 - Overhauled the `/crazycrates migrate` command, sends a more detailed message of what was migrated.