Update README.md

[ci skip] Update README.md
Add an option to trigger hopper optimization
2023-05-01 15:39:46 +02:00 · 2023-04-28 03:26:18 +03:00 · 2023-04-27 04:21:20 +03:00 · 2023-04-25 02:51:02 +03:00 · 2023-04-23 23:50:53 +03:00
4 changed files with 237 additions and 9 deletions
--- a/README.md
+++ b/README.md
@@ -12,30 +12,39 @@

 ## Features

-### Main additions
+### Primary
 - **Xymb Linear Format**: Saves about 50% of disk space in OW/Nether and 95% in The End.
 - **Auto update**: Automatic upstream updates.

+### Notable
+- **Optimize Hopper**: Enable/Disable Paper "Optimize Hopper" patch that break a lot of redstone farms.
+- **Fix void trading**: Enable/Disable void trading.
+
 ### Configuration

 ```yaml
-region-format:
-  debug: false
+verbose: false
+gameplay:
+  server-mod-name: Kaiiju
 network:
  send-null-entity-packets: true
  alternate-keepalive: false
-gameplay:
-  server-mod-name: Kaiiju
+region-format:
+  debug: false
 world-settings:
  default:
+    gameplay:
+      shulker-box-drop-contents-when-destroyed: true
+      fix-void-trading: true
+      optimize-hoppers: true
    region-format:
      format: LINEAR
      linear:
        compression-level: 1
        crash-on-broken-symlink: true
-    gameplay:
-      shulker-box-drop-contents-when-destroyed: true
+config-version: 1
 ```
+Documentation: [Kaiiju Wiki](https://github.com/KaiijuMC/Kaiiju/wiki/Configuration)

 ### Roadmap
 - **Static view distance**: Reduce RAM usage / Region size with a "static" view distance.
--- a/patches/server/0012-Purpur-Gameplay-FixVoidTrading.patch
+++ b/patches/server/0012-Purpur-Gameplay-FixVoidTrading.patch
@@ -21,7 +21,7 @@ index 0f0cfd958f7d2c6d2ca4192be1b986900a2bfa53..c267b0cd52448246c7701081028ff098
 }
 \ No newline at end of file
 diff --git a/src/main/java/net/minecraft/server/level/ServerLevel.java b/src/main/java/net/minecraft/server/level/ServerLevel.java
-index 35ae624be25b66d5615dc19cbe7eb8785c7029b5..4e0b8ab1d7ba06be96bd9deabb6b0f83dc83cca6 100644
+index 35ae624be25b66d5615dc19cbe7eb8785c7029b5..92cc38353d25f3749186dbc062402c9bafb25fca 100644
 --- a/src/main/java/net/minecraft/server/level/ServerLevel.java
 +++ b/src/main/java/net/minecraft/server/level/ServerLevel.java
@@ -2824,7 +2824,7 @@ public class ServerLevel extends Level implements WorldGenLevel {
@@ -29,7 +29,7 @@ index 35ae624be25b66d5615dc19cbe7eb8785c7029b5..4e0b8ab1d7ba06be96bd9deabb6b0f83
             if (entity.getBukkitEntity() instanceof org.bukkit.inventory.InventoryHolder && (!(entity instanceof ServerPlayer) || entity.getRemovalReason() != Entity.RemovalReason.KILLED)) { // SPIGOT-6876: closeInventory clears death message
                 // Paper start
 -                if (entity.getBukkitEntity() instanceof org.bukkit.inventory.Merchant merchant && merchant.getTrader() != null) {
-+                if (entity.level.kaiijuConfig.fixVoidTrading && entity.getBukkitEntity() instanceof org.bukkit.inventory.Merchant merchant && merchant.getTrader() != null) {
+                if (entity.level.kaiijuConfig.fixVoidTrading && entity.getBukkitEntity() instanceof org.bukkit.inventory.Merchant merchant && merchant.getTrader() != null) { // Kaiiju
                     merchant.getTrader().closeInventory(org.bukkit.event.inventory.InventoryCloseEvent.Reason.UNLOADED);
                 }
                 // Paper end
--- a/patches/server/0013-Kaiiju-Gameplay-OptimizeHoppersToggle.patch
+++ b/patches/server/0013-Kaiiju-Gameplay-OptimizeHoppersToggle.patch
@@ -0,0 +1,219 @@
+From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
+From: "Sofiane H. Djerbi" <46628754+kugge@users.noreply.github.com>
+Date: Thu, 27 Apr 2023 03:49:08 +0300
+Subject: [PATCH] Kaiiju Gameplay OptimizeHoppersToggle
+
+
+diff --git a/src/main/java/dev/kaiijumc/kaiiju/KaiijuWorldConfig.java b/src/main/java/dev/kaiijumc/kaiiju/KaiijuWorldConfig.java
+index c267b0cd52448246c7701081028ff0986dde2fa2..2624e074e0a14f5e05aca8fa910b5e5d71f320a9 100644
+--- a/src/main/java/dev/kaiijumc/kaiiju/KaiijuWorldConfig.java
+++ b/src/main/java/dev/kaiijumc/kaiiju/KaiijuWorldConfig.java
+@@ -148,9 +148,11 @@ public class KaiijuWorldConfig {
+ 
+     public boolean shulkerBoxDropContentsWhenDestroyed = true;
+     public boolean fixVoidTrading = true;
+    public boolean optimizeHoppers = true;
+ 
+     private void gameplaySettings() {
+         shulkerBoxDropContentsWhenDestroyed = getBoolean("gameplay.shulker-box-drop-contents-when-destroyed", shulkerBoxDropContentsWhenDestroyed);
+         fixVoidTrading = getBoolean("gameplay.fix-void-trading", fixVoidTrading);
+        optimizeHoppers = getBoolean("gameplay.optimize-hoppers", optimizeHoppers);
+     }
+ }
+\ No newline at end of file
+diff --git a/src/main/java/net/minecraft/world/level/block/entity/HopperBlockEntity.java b/src/main/java/net/minecraft/world/level/block/entity/HopperBlockEntity.java
+index 0134370081182260d578ee1d8a16d544c03b6a0d..555d86f0a9132c2292470c60f263e59082f0c26e 100644
+--- a/src/main/java/net/minecraft/world/level/block/entity/HopperBlockEntity.java
+++ b/src/main/java/net/minecraft/world/level/block/entity/HopperBlockEntity.java
+@@ -401,49 +401,51 @@ public class HopperBlockEntity extends RandomizableContainerBlockEntity implemen
+             if (HopperBlockEntity.isFullContainer(iinventory1, enumdirection)) {
+                 return false;
+             } else {
+                // Kaiiju start - Toggle paper broken redstone
+                 // Paper start - replace logic; MAKE SURE TO CHECK FOR DIFFS ON UPDATES
+-                return hopperPush(world, iinventory1, enumdirection, hopper);
+-                // for (int i = 0; i < iinventory.getContainerSize(); ++i) {
+-                //     if (!iinventory.getItem(i).isEmpty()) {
+-                //         ItemStack itemstack = iinventory.getItem(i).copy();
+-                //         // ItemStack itemstack1 = addItem(iinventory, iinventory1, iinventory.removeItem(i, 1), enumdirection);
+-
+-                //         // CraftBukkit start - Call event when pushing items into other inventories
+-                //         CraftItemStack oitemstack = CraftItemStack.asCraftMirror(iinventory.removeItem(i, world.spigotConfig.hopperAmount)); // Spigot
+-
+-                //         Inventory destinationInventory;
+-                //        // Have to special case large chests as they work oddly
+-                //         if (iinventory1 instanceof CompoundContainer) {
+-                //             destinationInventory = new org.bukkit.craftbukkit.inventory.CraftInventoryDoubleChest((CompoundContainer) iinventory1);
+-                //         } else if (iinventory1.getOwner() != null) {
+-                //             destinationInventory = iinventory1.getOwner().getInventory();
+-                //         } else {
+-                //             destinationInventory = new CraftInventory(iinventory);
+-                //         }
+-
+-                //         InventoryMoveItemEvent event = new InventoryMoveItemEvent(iinventory.getOwner().getInventory(), oitemstack.clone(), destinationInventory, true);
+-                //         world.getCraftServer().getPluginManager().callEvent(event);
+-                //         if (event.isCancelled()) {
+-                //             hopper.setItem(i, itemstack);
+-                //             hopper.setCooldown(world.spigotConfig.hopperTransfer); // Spigot
+-                //             return false;
+-                //         }
+-                //         int origCount = event.getItem().getAmount(); // Spigot
+-                //         ItemStack itemstack1 = HopperBlockEntity.addItem(iinventory, iinventory1, CraftItemStack.asNMSCopy(event.getItem()), enumdirection);
+                if (world.kaiijuConfig.optimizeHoppers) return hopperPush(world, iinventory1, enumdirection, hopper);
+                for (int i = 0; i < iinventory.getContainerSize(); ++i) {
+                    if (!iinventory.getItem(i).isEmpty()) {
+                        ItemStack itemstack = iinventory.getItem(i).copy();
+                        // ItemStack itemstack1 = addItem(iinventory, iinventory1, iinventory.removeItem(i, 1), enumdirection);
+
+                        // CraftBukkit start - Call event when pushing items into other inventories
+                        CraftItemStack oitemstack = CraftItemStack.asCraftMirror(iinventory.removeItem(i, world.spigotConfig.hopperAmount)); // Spigot
+
+                        Inventory destinationInventory;
+                       // Have to special case large chests as they work oddly
+                        if (iinventory1 instanceof CompoundContainer) {
+                            destinationInventory = new org.bukkit.craftbukkit.inventory.CraftInventoryDoubleChest((CompoundContainer) iinventory1);
+                        } else if (iinventory1.getOwner() != null) {
+                            destinationInventory = iinventory1.getOwner().getInventory();
+                        } else {
+                            destinationInventory = new CraftInventory(iinventory);
+                        }
+
+                        InventoryMoveItemEvent event = new InventoryMoveItemEvent(iinventory.getOwner().getInventory(), oitemstack.clone(), destinationInventory, true);
+                        world.getCraftServer().getPluginManager().callEvent(event);
+                        if (event.isCancelled()) {
+                            hopper.setItem(i, itemstack);
+                            hopper.setCooldown(world.spigotConfig.hopperTransfer); // Spigot
+                            return false;
+                        }
+                        int origCount = event.getItem().getAmount(); // Spigot
+                        ItemStack itemstack1 = HopperBlockEntity.addItem(iinventory, iinventory1, CraftItemStack.asNMSCopy(event.getItem()), enumdirection);
+                         // CraftBukkit end
+ 
+-                //         if (itemstack1.isEmpty()) {
+-                //             iinventory1.setChanged();
+-                //             return true;
+-                //         }
+                        if (itemstack1.isEmpty()) {
+                            iinventory1.setChanged();
+                            return true;
+                        }
+ 
+-                //         itemstack.shrink(origCount - itemstack1.getCount()); // Spigot
+-                //         iinventory.setItem(i, itemstack);
+-                //     }
+-                // }
+                        itemstack.shrink(origCount - itemstack1.getCount()); // Spigot
+                        iinventory.setItem(i, itemstack);
+                    }
+                }
+ 
+-                // return false;
+                return false;
+                 // Paper end
+                // Kaiiju end
+             }
+         }
+     }
+@@ -467,6 +469,12 @@ public class HopperBlockEntity extends RandomizableContainerBlockEntity implemen
+         if (iinventory != null) {
+             Direction enumdirection = Direction.DOWN;
+ 
+            // Kaiiju start - toggle paper broken redstone
+            if (!world.kaiijuConfig.optimizeHoppers)
+            return HopperBlockEntity.isEmptyContainer(iinventory, enumdirection) ? false : HopperBlockEntity.getSlots(iinventory, enumdirection).anyMatch((i) -> {
+                return HopperBlockEntity.a(hopper, iinventory, i, enumdirection, world); // Spigot
+            });
+            // Kaiiju end
+             // Paper start - optimize hoppers and remove streams
+             worldData.skipPullModeEventFire = worldData.skipHopperEvents; // Folia - region threading
+             return !HopperBlockEntity.isEmptyContainer(iinventory, enumdirection) && anyMatch(iinventory, enumdirection, (item, i) -> {
+@@ -499,48 +507,50 @@ public class HopperBlockEntity extends RandomizableContainerBlockEntity implemen
+     private static boolean a(Hopper ihopper, Container iinventory, int i, Direction enumdirection, Level world) { // Spigot
+         ItemStack itemstack = iinventory.getItem(i);
+ 
+        // Kaiiju start - toggle paper broken redstone
+         // Paper start - replace pull logic; MAKE SURE TO CHECK FOR DIFFS WHEN UPDATING
+         if (!itemstack.isEmpty() && HopperBlockEntity.canTakeItemFromContainer(ihopper, iinventory, itemstack, i, enumdirection)) { // If this logic changes, update above. this is left unused incase reflective plugins
+-            return hopperPull(world, ihopper, iinventory, itemstack, i);
+-            // ItemStack itemstack1 = itemstack.copy();
+-            // // ItemStack itemstack2 = addItem(iinventory, ihopper, iinventory.removeItem(i, 1), (EnumDirection) null);
+-            // // CraftBukkit start - Call event on collection of items from inventories into the hopper
+-            // CraftItemStack oitemstack = CraftItemStack.asCraftMirror(iinventory.removeItem(i, world.spigotConfig.hopperAmount)); // Spigot
+-
+-            // Inventory sourceInventory;
+-            // // Have to special case large chests as they work oddly
+-            // if (iinventory instanceof CompoundContainer) {
+-            //     sourceInventory = new org.bukkit.craftbukkit.inventory.CraftInventoryDoubleChest((CompoundContainer) iinventory);
+-            // } else if (iinventory.getOwner() != null) {
+-            //     sourceInventory = iinventory.getOwner().getInventory();
+-            // } else {
+-            //     sourceInventory = new CraftInventory(iinventory);
+-            // }
+-
+-            // InventoryMoveItemEvent event = new InventoryMoveItemEvent(sourceInventory, oitemstack.clone(), ihopper.getOwner().getInventory(), false);
+-
+-            // Bukkit.getServer().getPluginManager().callEvent(event);
+-            // if (event.isCancelled()) {
+-            //     iinventory.setItem(i, itemstack1);
+-
+-                // if (ihopper instanceof HopperBlockEntity) {
+-                //     ((HopperBlockEntity) ihopper).setCooldown(world.spigotConfig.hopperTransfer); // Spigot
+-                // }
+-
+-                // return false;
+-            // }
+-            // int origCount = event.getItem().getAmount(); // Spigot
+-            // ItemStack itemstack2 = HopperBlockEntity.addItem(iinventory, ihopper, CraftItemStack.asNMSCopy(event.getItem()), null);
+-            // // CraftBukkit end
+-
+-            // if (itemstack2.isEmpty()) {
+-            //     iinventory.setChanged();
+-            //     return true;
+-            // }
+-
+-            // itemstack1.shrink(origCount - itemstack2.getCount()); // Spigot
+-            // iinventory.setItem(i, itemstack1);
+            if (world.kaiijuConfig.optimizeHoppers) return hopperPull(world, ihopper, iinventory, itemstack, i);
+            ItemStack itemstack1 = itemstack.copy();
+            // ItemStack itemstack2 = addItem(iinventory, ihopper, iinventory.removeItem(i, 1), (EnumDirection) null);
+            // CraftBukkit start - Call event on collection of items from inventories into the hopper
+            CraftItemStack oitemstack = CraftItemStack.asCraftMirror(iinventory.removeItem(i, world.spigotConfig.hopperAmount)); // Spigot
+
+            Inventory sourceInventory;
+            // Have to special case large chests as they work oddly
+            if (iinventory instanceof CompoundContainer) {
+                sourceInventory = new org.bukkit.craftbukkit.inventory.CraftInventoryDoubleChest((CompoundContainer) iinventory);
+            } else if (iinventory.getOwner() != null) {
+                sourceInventory = iinventory.getOwner().getInventory();
+            } else {
+                sourceInventory = new CraftInventory(iinventory);
+            }
+
+            InventoryMoveItemEvent event = new InventoryMoveItemEvent(sourceInventory, oitemstack.clone(), ihopper.getOwner().getInventory(), false);
+
+            Bukkit.getServer().getPluginManager().callEvent(event);
+            if (event.isCancelled()) {
+                iinventory.setItem(i, itemstack1);
+
+                if (ihopper instanceof HopperBlockEntity) {
+                    ((HopperBlockEntity) ihopper).setCooldown(world.spigotConfig.hopperTransfer); // Spigot
+                }
+
+                return false;
+            }
+            int origCount = event.getItem().getAmount(); // Spigot
+            ItemStack itemstack2 = HopperBlockEntity.addItem(iinventory, ihopper, CraftItemStack.asNMSCopy(event.getItem()), null);
+            // CraftBukkit end
+
+            if (itemstack2.isEmpty()) {
+                iinventory.setChanged();
+                return true;
+            }
+
+            itemstack1.shrink(origCount - itemstack2.getCount()); // Spigot
+            iinventory.setItem(i, itemstack1);
+             // Paper end
+            // Kaiiju end
+         }
+ 
+         return false;
--- a/patches/server/0012-Static-Distance-WIP.patch
+++ b/patches/server/0012-Static-Distance-WIP.patch
Author	SHA1	Message	Date
Sofiane H. Djerbi	7c618748c6	Update README.md	2023-05-01 15:39:46 +02:00
Sofiane H. Djerbi	f63cf7c1fa	[ci skip] Update README.md	2023-04-28 03:26:18 +03:00
Sofiane H. Djerbi	ea9ab3f27c	Add an option to trigger hopper optimization This patch break random redstone farm We want kaiiju to be as vanilla as possible And to respect every end user So here is a toggle.	2023-04-27 04:21:20 +03:00
Sofiane H. Djerbi	ae5526ff76	Add comment	2023-04-25 02:51:02 +03:00
Sofiane H. Djerbi	f6f2314be6	Add todo dir	2023-04-23 23:50:53 +03:00