Merge branch 'main' into update

ArmaRealms · Mar 6, 2024 · e8af986 · e8af986
2 parents fa0d52b + 2e5b558
commit e8af986
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 156 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,157 +1,11 @@
-
 ## Additions:
-### Crate Types:
-* Added a new crate type called `Casino` ( Idea by slimemcstew )
-   * This allows a player to win 3 prizes with 3 animations while opening a crate.
-### Ability to have files categorized by folder.
-* It will search for folders in `crates` such as `crates/sub_folder`
-  * It will not search for folders inside `crates/sub_folder` such as `crates/sub_folder/secondary_folder`
-### Other:
-* Added War Crate as a default generated crate.
-* Added the ability to have holograms created using CMI or DecentHolograms have a configurable "block" range.
-```yml
-  Hologram:
-     # Toggle on and off the holograms for the crates.
-     Toggle: true
-     # The height of the hologram above the crate.
-     Height: 1.5
-     # The distance the hologram can be seen. Only works with CMI and DecentHolograms
-     Range: 8
-     # The message that will be displayed.
-     Message:
-        - '&7&lBasic Chest' 
- ```
-* Added the ability to configure sounds per crate.
-   * The places these sounds apply to are /crate, clicking buttons in /crate, clicking buttons in the crate previews like next/back or exit
-* You can configure the cycling sounds when crates are doing animations, the sounds played when a crate ends.
-* You can adjust the volume of sounds and the speed of the sounds.
-* Clicking each prize in the preview will not produce a sound as that has no purpose.
-#### An example of the configuration layout that you should add to your crate configurations, You can look in the `examples` folder for the default files.
-```yml
-Crate:
-   sound:
-      # The sound options when the animation is cycling.
-      cycle-sound:
-         # If sound should be enabled or not.
-         toggle: true
-         # The type of sound to use.
-         # https://jd.papermc.io/paper/1.20/org/bukkit/Sound.html
-         value: 'BLOCK_NOTE_BLOCK_XYLOPHONE'
-         # The volume of the pitch.
-         volume: 1.0
-         # The speed of the sound.
-         pitch: 1.0
-      # The sound options when an item is clicked.
-      click-sound:
-         # If sound should be enabled or not.
-         toggle: true
-         # The type of sound to use.
-         # https://jd.papermc.io/paper/1.20/org/bukkit/Sound.html
-         value: 'UI_BUTTON_CLICK'
-         # The volume of the pitch.
-         volume: 1.0
-         # The speed of the sound.
-         pitch: 1.0
-      # The sound options when a crate ends.
-      stop-sound:
-         # If sound should be enabled or not.
-         toggle: true
-         # The type of sound to use.
-         # https://jd.papermc.io/paper/1.20/org/bukkit/Sound.html
-         value: 'ENTITY_PLAYER_LEVELUP'
-         # The volume of the pitch.
-         volume: 1.0
-         # The speed of the sound.
-         pitch: 1.0
- ```
-
-## Changes:
-* A piece of the configuration for Cosmic Crate has been changed.
-```yml
-  tier-preview:
-    # Turn on and off the preview for this crate.
-    toggle: true
-    # How many lines the Tier Preview should have. Including Header and Bottom (Between 3 and 6)
-    rows: 5
-    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: 'RED_STAINED_GLASS_PANE'
-  # Tier related settings only for Casino should be random.
-  random:
-    # If the tiers should be random.
-    toggle: false
-    # The rows with pre-defined tiers.
-    types:
-      # Row 1
-      row-1: Basic
-      # Row 2
-      row-2: UnCommon
-      # Row 3
-      row-3: Rare
-  # Tiers are available in Cosmic and Casino crate types.
-  # The Tiers the rewards can be found in.
-  Tiers:
-    # The Config Name for the Crate
-    Basic:
-      # The in-game name of the tier.
-      Name: '&8Basic Tier'
-      # The in-game lore of the tier.
-      Lore:
-        - '&7A basic tier.'
-      # The item used for the secondary gui when you right-click for the preview.
-      Item: 'CHEST'
-      # Chance of that item getting picked. It would be 80/100 chance because MaxRange is 100.
-      Chance: 80
-      # The max range that the chance will go though.
-      MaxRange: 100
-      # The slot this item will be in the secondary gui.
-      Slot: 20
-    UnCommon:
-      Name: '&aUncommon Tier'
-      Lore:
-        - '&aAn uncommon tier.'
-      Item: 'CHEST'
-      Chance: 55
-      MaxRange: 100
-      Slot: 22
-    Rare:
-      Name: '&4Rare Tier'
-      Lore:
-        - '&cA rare tier.'
-      Item: 'ENDER_CHEST'
-      Chance: 20
-      MaxRange: 100
-      Slot: 24
-```
-* `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.
-* Note: We only have 3 rows, so you obviously can only have 1 tier per row. This is not likely to change for this Crate Type... 
+* Added the ability to override the menu button functionality to use your own menu through DeluxeMenus and nay other gui plugin.
+  * The config options have been automatically added to your config.yml and default to false, They can be found where you edit what the menu button looks like.
 
 ## Enhancements:
-* 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 /crate gui
-* Check uuids for quad crate sessions over player objects.
-* Update /cc additem to take input for tiers which only work for cosmic/casino, /cc additem <crate_name> <prize_number> [tier]
-* Update /cc additem again to take input for custom chance, Note: The max range by default is still 100 so keep it under 100. /cc additem <crate_name> <prize_number> <chance> [tier]
-  * [tier] is an optional arg.
-* 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.
-
-## Fixes:
- * Fixed issues with crates being broken in worlds created by world plugins.
- * Fixed a few other bugs I can't remember.
- * Fixed a bug where the refund event needed to be fired sync.
- * Fixed a bug with display damage where if you put a value that can't be parsed as an integer like 50f, It wouldn't just be empty durability.
- * Fixed a bug where cc additem wouldn't add tiers to casino/cosmic crate.
- * Fixed a bug where we stored the wrong value for PDC causing it to error when using QuadCrates.
+* 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.
+  * At the same time, This fixed an issue where the lore of the keys given were different. Will it be paginated? Someday
 
 ## Other:
 * [Feature Requests](https://github.com/Crazy-Crew/CrazyCrates/issues)
-* [Bug Reports](https://github.com/Crazy-Crew/CrazyCrates/issues)
+* [Bug Reports](https://github.com/Crazy-Crew/CrazyCrates/issues)
diff --git a/common/src/main/java/com/badbones69/crazycrates/common/config/types/ConfigKeys.java b/common/src/main/java/com/badbones69/crazycrates/common/config/types/ConfigKeys.java
@@ -127,6 +127,17 @@ public void registerComments(CommentsConfiguration conf) {
 
     public static final Property<String> menu_button_item = newProperty("Settings.Preview.Buttons.Menu.Item", "COMPASS");
 
+    @Comment({
+            "This will disable our current functionality of our main menu button in crate previews.",
+            "It allows you to override and use a menu of your choice from your plugin using a command."
+    })
+    public static final Property<Boolean> menu_button_override = newProperty("Settings.Preview.Buttons.Menu.override.toggle", false);
+
+    @Comment({
+            "A list of commands to run when the main menu button is clicked. The override option above has to be set to true.",
+    })
+    public static final Property<List<String>> menu_button_command_list = newListProperty("Settings.Preview.Buttons.Menu.override.list", List.of("see %player%"));
+
     public static final Property<String> menu_button_name = newProperty("Settings.Preview.Buttons.Menu.Name", "&7&l>> &c&lMenu &7&l<<");
 
     public static final Property<List<String>> menu_button_lore = newListProperty("Settings.Preview.Buttons.Menu.Lore", List.of(

diff --git a/paper/src/main/java/com/badbones69/crazycrates/api/builders/InventoryBuilder.java b/paper/src/main/java/com/badbones69/crazycrates/api/builders/InventoryBuilder.java
@@ -1,10 +1,12 @@
 package com.badbones69.crazycrates.api.builders;
 
+import ch.jalu.configme.SettingsManager;
 import com.badbones69.crazycrates.CrazyCrates;
 import com.badbones69.crazycrates.api.objects.Crate;
 import com.badbones69.crazycrates.api.objects.Tier;
 import com.badbones69.crazycrates.api.utils.MiscUtils;
 import com.badbones69.crazycrates.api.utils.MsgUtils;
+import com.badbones69.crazycrates.common.config.types.ConfigKeys;
 import me.clip.placeholderapi.PlaceholderAPI;
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.Inventory;
@@ -14,6 +16,8 @@
 
 import java.util.List;
 
+import static java.util.regex.Matcher.quoteReplacement;
+
 @SuppressWarnings("ALL")
 public abstract class InventoryBuilder implements InventoryHolder {
 
@@ -77,6 +81,32 @@ public InventoryBuilder(List<Tier> tiers, Crate crate, Player player, int size,
         this.inventory = this.plugin.getServer().createInventory(this, this.size, inventoryTitle);
     }
 
+    public boolean overrideMenu() {
+        SettingsManager config = this.plugin.getConfigManager().getConfig();
+
+        if (config.getProperty(ConfigKeys.menu_button_override)) {
+            List<String> commands = config.getProperty(ConfigKeys.menu_button_command_list);
+
+            if (!commands.isEmpty()) {
+                commands.forEach(value -> {
+                    String command = value.replaceAll("%player%", quoteReplacement(player.getName()))
+                            .replaceAll("%Player%", quoteReplacement(player.getName()))
+                            .replaceAll("%crate%", quoteReplacement(crate.getName()));
+
+                    MiscUtils.sendCommand(command);
+                });
+
+                return true;
+            }
+
+            if (plugin.isLogging()) plugin.getLogger().warning("The property " + ConfigKeys.menu_button_command_list.getPath() + " is empty so no commands were run.");
+
+            return true;
+        }
+
+        return false;
+    }
+
     public abstract InventoryBuilder build();
 
     public void size(int size) {

diff --git a/paper/src/main/java/com/badbones69/crazycrates/api/builders/types/CratePreviewMenu.java b/paper/src/main/java/com/badbones69/crazycrates/api/builders/types/CratePreviewMenu.java
@@ -167,6 +167,8 @@ public void onInventoryClick(InventoryClickEvent event) {
 
             if (container.has(PersistentKeys.main_menu_button.getNamespacedKey()) && this.crazyHandler.getConfigManager().getConfig().getProperty(ConfigKeys.enable_crate_menu)) { // Clicked the menu button.
                 if (this.inventoryManager.inCratePreview(player)) {
+                    if (holder.overrideMenu()) return;
+
                     crate.playSound(player, player.getLocation(), "click-sound","UI_BUTTON_CLICK", SoundCategory.PLAYERS);
 
                     if (crate.getCrateType() == CrateType.casino || crate.getCrateType() == CrateType.cosmic) {

diff --git a/paper/src/main/java/com/badbones69/crazycrates/api/builders/types/CrateTierMenu.java b/paper/src/main/java/com/badbones69/crazycrates/api/builders/types/CrateTierMenu.java
@@ -59,7 +59,8 @@ private void setDefaultItems() {
             }
         }
 
-        if (this.crazyHandler.getInventoryManager().inCratePreview(getPlayer()) && this.crazyHandler.getConfigManager().getConfig().getProperty(ConfigKeys.enable_crate_menu)) getInventory().setItem(getCrate().getAbsolutePreviewItemPosition(4), this.crazyHandler.getInventoryManager().getMenuButton(getPlayer()));
+        if (this.crazyHandler.getInventoryManager().inCratePreview(getPlayer()) && this.crazyHandler.getConfigManager().getConfig().getProperty(ConfigKeys.enable_crate_menu))
+            getInventory().setItem(getCrate().getAbsolutePreviewItemPosition(4), this.crazyHandler.getInventoryManager().getMenuButton(getPlayer()));
     }
 
     public static class CrateTierListener implements Listener {
@@ -101,9 +102,11 @@ public void onInventoryClick(InventoryClickEvent event) {
 
             PersistentDataContainer container = itemMeta.getPersistentDataContainer();
 
-            if (container.has(PersistentKeys.main_menu_button.getNamespacedKey()) && this.crazyHandler.getConfigManager().getConfig().getProperty(ConfigKeys.enable_crate_menu)) {
+            if (container.has(PersistentKeys.main_menu_button.getNamespacedKey()) && this.config.getProperty(ConfigKeys.enable_crate_menu)) {
                 if (this.inventoryManager.inCratePreview(player)) {
-                    crate.playSound(player, player.getLocation(), "click-sound","UI_BUTTON_CLICK", SoundCategory.PLAYERS);
+                    if (holder.overrideMenu()) return;
+
+                    crate.playSound(player, player.getLocation(), "click-sound", "UI_BUTTON_CLICK", SoundCategory.PLAYERS);
 
                     this.inventoryManager.removeViewer(player);
                     this.inventoryManager.closeCratePreview(player);
@@ -117,13 +120,13 @@ public void onInventoryClick(InventoryClickEvent event) {
             }
 
             if (container.has(PersistentKeys.preview_tier_button.getNamespacedKey())) {
-                crate.playSound(player, player.getLocation(), "click-sound","UI_BUTTON_CLICK", SoundCategory.PLAYERS);
+                crate.playSound(player, player.getLocation(), "click-sound", "UI_BUTTON_CLICK", SoundCategory.PLAYERS);
 
                 String tierName = container.get(PersistentKeys.preview_tier_button.getNamespacedKey(), PersistentDataType.STRING);
 
                 Tier tier = crate.getTier(tierName);
 
-                Inventory cratePreviewMenu = crate.getPreview(player, this.plugin.getCrazyHandler().getInventoryManager().getPage(player), true, tier);
+                Inventory cratePreviewMenu = crate.getPreview(player, this.inventoryManager.getPage(player), true, tier);
 
                 player.openInventory(cratePreviewMenu);
             }