Add configurable GUI for inventory operations

Author: NotRyken

.github/workflows/release.yml

@@ -34,9 +34,9 @@ jobs:
         if: ${{ runner.os != 'Windows' }}
         run: chmod +x ./gradlew
       - name: Build
-#        run: ./gradlew build neoforge:publishGithub fabric:publishGithub --stacktrace
+        run: ./gradlew build neoforge:publishGithub fabric:publishGithub --stacktrace
 #        run: ./gradlew build neoforge:publishGithub neoforge:publishModrinth fabric:publishGithub fabric:publishModrinth --stacktrace
-        run: ./gradlew build neoforge:publishGithub neoforge:publishModrinth neoforge:publishCurseforge fabric:publishGithub fabric:publishModrinth fabric:publishCurseforge --stacktrace
+#        run: ./gradlew build neoforge:publishGithub neoforge:publishModrinth neoforge:publishCurseforge fabric:publishGithub fabric:publishModrinth fabric:publishCurseforge --stacktrace
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           MODRINTH_TOKEN: ${{ secrets.MODRINTH_TOKEN }}

README.md

@@ -5,7 +5,7 @@
 
 ## ClientSort
 
-A standalone implementation of the sorting algorithm from [Mouse Wheelie](https://modrinth.com/mod/u5Ic2U1u).
+A client-side inventory sorting mod with keybind and GUI support.
 
 [![Environment](https://img.shields.io/badge/Environment-Client-blue?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAABhWlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw0AYht+malUqDnYQEclQneyiIo6likWwUNoKrTqYXPoHTRqSFBdHwbXg4M9i1cHFWVcHV0EQ/AFxdnBSdJESv0sKLWI8uLuH97735e47QGhUmGp2RQFVs4xUPCZmc6ti4BU9CKCP1jGJmXoivZiB5/i6h4/vdxGe5V335xhQ8iYDfCJxlOmGRbxBPLtp6Zz3iUOsJCnE58STBl2Q+JHrsstvnIsOCzwzZGRS88QhYrHYwXIHs5KhEs8QhxVVo3wh67LCeYuzWqmx1j35C4N5bSXNdZqjiGMJCSQhQkYNZVRgIUK7RoqJFJ3HPPwjjj9JLplcZTByLKAKFZLjB/+D3701C9NTblIwBnS/2PbHOBDYBZp12/4+tu3mCeB/Bq60tr/aAOY+Sa+3tfARMLgNXFy3NXkPuNwBhp90yZAcyU9TKBSA9zP6phwwdAv0r7l9a53j9AHIUK+Wb4CDQ2CiSNnrHu/u7ezbvzWt/v0ATphymIBZ6aQAAAAGYktHRAAKAAwAGd6C8noAAAAJcEhZcwAADdcAAA3XAUIom3gAAAAHdElNRQfoBgcOHRYlcgoRAAABRklEQVR42u2YMUoDQRRAX0axUzCteIZ4hKn0FDmFhalSWKkgnkHt9AQWwhzBNr2tBGNno82ACwm6EZvxvwdTzP8s7P8zu8w8EJHIDABKKfvAFXAIbP/zmt+AR2CSc54NavFPwDDY4s+BUaorPwy4+3eBy1S3fVSOUoBv/jt2UmMv/A6cAHt1TGqsb36JzcYaMM05X3Tm56UUgLOe+SVa2wE3K2LXa+Sbb8BgRWxjjXzzDRj/EBv3fOarY6WUj8Z+glPgtlPcKbDVM998A/6cVM/GUXlN9WIQlYdUDwvzgMW/AMcp5zwDRsA9sAhQ+AK4Aw5yzs8aEZHY6AR1gjpBnaBOsLHrsE6wM9cJohPUCeoE0Qn+Hp0gOkGdoE5QRMKiE9QJ6gR1gjrBxq7DOsHOXCeITlAnqBNEJ/h7dILoBHWCOkERCcsncuextWq5TzoAAAAASUVORK5CYII=)]()
 [![Latest Minecraft](https://img.shields.io/modrinth/game-versions/K0AkAin6?label=Latest%20Minecraft&color=%2300AF5C&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAABhWlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw0AYht+malUqDnYQEclQneyiIo6likWwUNoKrTqYXPoHTRqSFBdHwbXg4M9i1cHFWVcHV0EQ/AFxdnBSdJESv0sKLWI8uLuH97735e47QGhUmGp2RQFVs4xUPCZmc6ti4BU9CKCP1jGJmXoivZiB5/i6h4/vdxGe5V335xhQ8iYDfCJxlOmGRbxBPLtp6Zz3iUOsJCnE58STBl2Q+JHrsstvnIsOCzwzZGRS88QhYrHYwXIHs5KhEs8QhxVVo3wh67LCeYuzWqmx1j35C4N5bSXNdZqjiGMJCSQhQkYNZVRgIUK7RoqJFJ3HPPwjjj9JLplcZTByLKAKFZLjB/+D3701C9NTblIwBnS/2PbHOBDYBZp12/4+tu3mCeB/Bq60tr/aAOY+Sa+3tfARMLgNXFy3NXkPuNwBhp90yZAcyU9TKBSA9zP6phwwdAv0r7l9a53j9AHIUK+Wb4CDQ2CiSNnrHu/u7ezbvzWt/v0ATphymIBZ6aQAAAAGYktHRAAKAAwAGd6C8noAAAAJcEhZcwAADdcAAA3XAUIom3gAAAAHdElNRQfoBgcOGBJfaDpNAAAE40lEQVR42u2bbYhUVRjHf/tiaRFkWVEaZJG2YNq2mYRFf0o/RPatDYk0ssAIKi0zbfMtXKxILRJqowy3FyqjD2ZvlPEQFlLh1qpIRVLWEq7p+rK11tpuH+ZZmqZ7Z3Zm79x5aZ5vc8+9557/f87//5zznBmoxP87qgr1YjMbBpzpHzsl9ZY9AQ56JjAbmAqM8KYeYCvQCrweJxlVMQGvAhqBVcD5GW7fAywGNkrqL3kCzKwBWAtcleWjnwPzJX1WkgSY2TnAMuB2oCbHbvqBN4EHJP1YEgSY2QjgHqAJOCWibn8HngZWSuouWgLM7AbgKWBsniZWB/AQ8FJU/lAVEfDLXOdXxmTeX7g/fFpQApJ0fgdQHXMKj8QfqnIEfhJwd8Q6H6o/NEs6mlcCPJ/fCDwOnFdkq9oO4BHgeUl9kRNgZpNd51OLfHn/pfvD1kgIMLPRwNIC6Xyo/rBQ0g85E2Bmc4HVwMklutn7DbhfUkvYDdVpwA/3fF5D6UYNMNax5CyBc4Fm4JZCbp9ziM3AvZL2RGWCU9wEryhy4NvdBD/JyQTNrAa4E2iRdDylrRqY5TNidBGmwSZfJveljLsWmAs8K+mvTB5wFrAO2GVmM5IbJPVJ2gCMAxYB3UUAvAd4DKiTtCEA/DSfFev4pwKVdgZMBL5OuvSeO+nuEH9YBdxcAH/oB14FFkv6KWBsdZ7Brku6PElSeyYCLgHaUi4fB9YDD0vaX8ybITMbCTwIzAdOSGmul/RVLgQMRJdPt7WS/izAdvjnJJ33B+h8DrASOCPk+f8QkO3KbiTwKLDDzBpTGyW9DVwEzAOORLygWQGMk9QaAH6af2ktacAPOgukmwGpscWn4o6Afs4GlhNNSWyBpL0B7xgPPAHMGGR/Q5ZAUAz4wxJJnQH91bs/XJ0l+G1O7raAPk8DFoboPHYCUv3hSUl/hPjDWuCCDP3sBZaE6HwYcFsGnWdFQJS7uwF/aE/jD3XuD4cDnu92nY9Po/Ptueg8nx6QyR/uS827/o7TfYt9l38Jr3hpa1+IzlcD10cwprxKIMwfWoBlkg4EvGuCz46dISSt8CVsbUTjiZ2AgTjk8gj0hxCdNwOjIh5HXj0gXZyabv0Qks9HxTGwWuKNC4E3zOxDYKakg0lp7TVgetw7qULV+KYDY5I+jykE+EISUDRRIaBCQIWACgEVAioE/DuOlTHeY4Mh4JcyJqAjIwGSDgNHyxD8kaAfUIR5wAdlSMD72ZhgM9BbRuB7HNPgCPA985wyIaHXd57tWaVBSS8DU4D2EgbfDlwuaVNO6wBJbUADibLU/hIC3kXi8HZyagUoNTIWRPyI/Dkz20j4mVuxRNozzJwISCKiC1hkZutJ1OUbiwz8RyQOUnZm81DWJTFJ3wI3mdm1wBpgYoGBf0Pi+P6dWPcCkrYA9cCtQGcBgB8kccgyIVfwOc2AFBL6gFYz2+SmMw84MYa09iLQJOnXoXYWSVVY0iH3hxd8wdGYR53Pk7Qrqg4jLYtL+s794Rr3h0kRdb2bxBH5uyVRD5D0MXCp+8O+IXR1wGV1cT7ARz4DQvzhLWCBryGGZ6HzZ4ClvjvNW+T9ZMj/47M8af0wK8Mjm13n38eRSmI7GvOfuMx2ItYE3NJG4jjd4sylsdcEHWCDG1uyyTXEDb4SlYC/AW0t3IQpiA17AAAAAElFTkSuQmCC)](https://modrinth.com/mod/K0AkAin6/versions)
@@ -20,16 +20,40 @@ A standalone implementation of the sorting algorithm from [Mouse Wheelie](https:
 
 </center></div>
 
-### Sorting
+### Usage
 
 To sort an inventory, simply hover over it with your mouse and press the keybind (default: middle mouse button).
 
 You can hold `Shift`, `Control` or `Alt` when pressing the sort button to use a different sorting order.
 
+#### Other Actions (v2)
+
+In addition to sorting, ClientSort v2 provides keybinds (unbound by default) for the following actions:
+
+- Stack Fill
+  - For all partial stacks in the other inventory, attempts to complete them using items in the target inventory.
+- Transfer
+  - Moves as many items as possible from the target inventory to the other inventory.
+
+#### Interaction GUI (v2)
+
+ClientSort v2 includes support for adding interaction buttons to the inventory screen, as an alternative to using the
+keybinds.
+
+- All buttons are disabled by default, but can be enabled via the config menu.
+- When the buttons are visible, you can right-click on them to adjust the position and enable or disable specific ones.
+- If the buttons are enabled but not visible, you can use the editor keybind (unbound by default) to select a group of
+buttons to edit.
+- ClientSort uses a whitelist to decide when to show the buttons. You can enable or disable the buttons for a particular
+inventory via the position editor, or by manually editing the whitelist in the main config menu.
+
+### Installation
+
 #### Client Required, Server Optional
 
-As the name suggests, ClientSort works completely fine if only installed on the client. However, if it is installed on
-a server, connected clients with the mod will be able to use 'instant' sorting instead of the normal rate-limited sort.
+As the name suggests, ClientSort works completely fine when it is only installed on the client. However, if it is also
+installed on a server, connected clients with the mod will be able to use 'instant' sorting instead of the normal
+rate-limited sort.
 
 ### Dependencies
 
@@ -39,13 +63,25 @@ Neo/Forge: [Cloth Config API](https://modrinth.com/mod/9s6osm5g)
 
 ### Credits
 
-ClientSort uses code from [Mouse Wheelie](https://github.com/Siphalor/mouse-wheelie) by
-[Siphalor](https://github.com/Siphalor), under license.
+ClientSort uses code from the following mods, in both raw and modified form, in accordance with their respective
+licenses.
+
+- [Mouse Wheelie](https://github.com/Siphalor/mouse-wheelie) by [Siphalor](https://github.com/Siphalor)
+  - Item comparison
+  - Client and server-side sorting
+  - Client-side interaction manager
+
+
+- [Inventory Management](https://github.com/Roundaround/mc-fabric-inventory-management) by
+[Roundaround](https://github.com/Roundaround)
+  - Inventory control buttons
+  - Button generation
+  - Button position editor
 
 ### Related Mods
 
 - [Mouse Tweaks](https://modrinth.com/mod/aC3cM3Vq) - item scrolling, mouse dragging.
-- [More Mouse Tweaks](https://modrinth.com/mod/S8drsznD) - quick-crafting/trading, quick-move and quick-drop.
+- [More Mouse Tweaks](https://modrinth.com/mod/S8drsznD) - single-click crafting and trading, quick-move and quick-drop.
 - [Tweakeroo](https://modrinth.com/mod/t5wuYk45) - hand restock, auto tool-switch, tool break prevention (+ lots more).
 
 ### Contact

build.gradle

@@ -22,16 +22,30 @@ subprojects {
             owner_name = mod_owner
             year = java.time.LocalDate.now().getYear().toString()
         }
-        // Alternate license
+        // Attribution licenses
         matching(includes: [
-                "**/client/inventory/**",
+                "**/client/inventory/screen/**",
+                "**/client/inventory/control/SingleUseController.java",
+                "**/client/inventory/control/client/ClientSurvivalController.java",
                 "**/client/network/InteractionManager.java",
                 "**/client/order/**",
-                "**/mixin/**",
-                "**/network/handler/**",
+                "**/mixin/client/slot/**",
+                "**/mixin/client/AbstractContainerScreenMixin.java",
+                "**/mixin/client/ClientPacketListenerMixin.java",
+                "**/mixin/client/LocalPlayerMixin.java",
+                "**/network/handler/util/**",
+                "**/network/handler/SortHandler.java",
+                "**/network/payload/SortPayload.java",
         ]) {
             header = rootProject.project("common").file(licenseDir + "mouse-wheelie/HEADER.txt")
         }
+        matching(includes: [
+                "**/client/gui/widget/**",
+                "**/client/gui/ControlButtonManager.java",
+                "**/client/gui/screen/edit/PositionEditScreen.java",
+        ]) {
+            header = rootProject.project("common").file(licenseDir + "inventory-management/HEADER.txt")
+        }
     }
 
     if (name != "common") {
@@ -146,17 +160,21 @@ String versionChangelog() {
             String line = lines.get(i)
             if (line.startsWith("## ")) {
                 break
-            } else if (!line.isBlank()) {
+            } else {
                 if (!builder.isEmpty()) builder.append("\n")
-                builder.append(line)
+                if (!line.isBlank()) builder.append(line)
             }
         }
     } else {
         throw new IllegalArgumentException(
                 String.format("Mod version '%s' does not match changelog version '%s'",
                         mod_version, lines.get(2).substring(3)))
     }
-    return builder.toString()
+    String changelog = builder.toString()
+    while (changelog.endsWith("\n")) {
+        changelog = changelog.substring(0, changelog.length() - 2);
+    }
+    return changelog;
 }
 
 static String capsLoader(String loader) {

changelog.md

@@ -1,9 +1,15 @@
 # Changelog
 
-## 2.0.0
+## 2.0.0-alpha.1
+
+Note: `v2.x.x` versions are not compatible with `v1.x.x` config files, or vice versa.
+
+Note: `alpha` versions use `-alpha` config files which may not be compatible with other alpha or release versions.
 
 - Moved stack collection to server when using server-accelerated sort
-- Fixed inventory sorting in creative mode
+- Fixed player inventory sorting in creative mode
+- Added support for stack fill and transfer operations
+- Added GUI buttons (off by default) as an alternative to using keybinds
 
 ## 1.3.3
 

common/src/main/java/dev/terminalmc/clientsort/ClientSort.java

@@ -22,6 +22,12 @@ public class ClientSort {
     public static final String MOD_ID = "clientsort";
     public static final String MOD_NAME = "ClientSort";
     public static final ModLogger LOG = new ModLogger(MOD_NAME);
-    
+
+    /**
+     * Whether to show debug info on the GUI and write debug logs.
+     * <p>
+     * While this value can be set via the config menu, it is intentionally
+     * non-persistent.
+     */
     public static boolean debug;
 }

common/src/main/java/dev/terminalmc/clientsort/client/ClientSort.java

@@ -17,44 +17,45 @@
 package dev.terminalmc.clientsort.client;
 
 import com.mojang.blaze3d.platform.InputConstants;
+import dev.terminalmc.clientsort.client.gui.ControlButtonManager;
 import dev.terminalmc.clientsort.client.order.SortOrder;
 import dev.terminalmc.clientsort.client.config.Config;
 import dev.terminalmc.clientsort.client.network.InteractionManager;
+import dev.terminalmc.clientsort.util.ModLogger;
 import net.minecraft.client.KeyMapping;
 import net.minecraft.client.Minecraft;
+import net.minecraft.client.gui.screens.Screen;
 import net.minecraft.resources.ResourceLocation;
 
-import java.util.ArrayList;
 import java.util.List;
 
 import static dev.terminalmc.clientsort.util.Localization.translationKey;
 
 public class ClientSort {
+    public static final String MOD_ID = dev.terminalmc.clientsort.ClientSort.MOD_ID;
+    public static final String MOD_NAME = dev.terminalmc.clientsort.ClientSort.MOD_NAME;
+    public static final ModLogger LOG = dev.terminalmc.clientsort.ClientSort.LOG;
+
+    public static final KeyMapping EDIT_KEY = new KeyMapping(
+            translationKey("key", "group.edit"), InputConstants.Type.KEYSYM,
+            InputConstants.UNKNOWN.getValue(), translationKey("key", "group"));
     public static final KeyMapping SORT_KEY = new KeyMapping(
-            translationKey("key", "group.sort"), InputConstants.Type.MOUSE,
+            translationKey("key", "group.op.sort"), InputConstants.Type.MOUSE,
             InputConstants.MOUSE_BUTTON_MIDDLE, translationKey("key", "group"));
-    public static final KeyMapping TRANSFER_KEY = new KeyMapping(
-            translationKey("key", "group.transfer"), InputConstants.Type.KEYSYM,
+    public static final KeyMapping STACK_FILL_KEY = new KeyMapping(
+            translationKey("key", "group.op.stackFill"), InputConstants.Type.KEYSYM,
             InputConstants.UNKNOWN.getValue(), translationKey("key", "group"));
-    public static final KeyMapping FILL_STACKS_KEY = new KeyMapping(
-            translationKey("key", "group.fillStacks"), InputConstants.Type.KEYSYM,
+    public static final KeyMapping TRANSFER_KEY = new KeyMapping(
+            translationKey("key", "group.op.transfer"), InputConstants.Type.KEYSYM,
             InputConstants.UNKNOWN.getValue(), translationKey("key", "group"));
     public static final List<KeyMapping> KEYBINDS = List.of(
+            EDIT_KEY,
             SORT_KEY,
-            TRANSFER_KEY,
-            FILL_STACKS_KEY
+            STACK_FILL_KEY,
+            TRANSFER_KEY
     );
 
-    public static final List<ScheduledAction> SCHEDULED_ACTIONS = new ArrayList<>();
-    public static class ScheduledAction {
-        int ticks;
-        final Runnable action;
-
-        public ScheduledAction(int ticks, Runnable action) {
-            this.ticks = ticks;
-            this.action = action;
-        }
-    }
+    public static long ticks = 0;
 
     public static boolean searchOrderUpdated = false;
 
@@ -65,31 +66,24 @@ public static void init() {
         Config.getAndSave();
     }
 
-    public static void onEndTick(Minecraft mc) {
-        SCHEDULED_ACTIONS.removeIf((sa) -> {
-            if (--sa.ticks <= 0) {
-                sa.action.run();
-                return true;
-            }
-            return false;
-        });
+    public static void afterClientTick(Minecraft mc) {
+        ticks++;
+    }
+
+    public static void afterScreenInit(Screen screen) {
+        ControlButtonManager.afterScreenInit(screen);
     }
 
     public static void onConfigSaved(Config config) {
         Config.Options options = config.options;
+        // Convert config sort order strings into enum values
         options.sortOrder = SortOrder.SORT_MODES.get(options.sortOrderStr);
         options.shiftSortOrder = SortOrder.SORT_MODES.get(options.shiftSortOrderStr);
         options.ctrlSortOrder = SortOrder.SORT_MODES.get(options.ctrlSortOrderStr);
         options.altSortOrder = SortOrder.SORT_MODES.get(options.altSortOrderStr);
-        options.sortSoundLoc = ResourceLocation.tryParse(options.sortSound);
-        setInteractionManagerTickRate(config.options);
-    }
-
-    public static void setInteractionManagerTickRate(Config.Options options) {
-        if (Minecraft.getInstance().getSingleplayerServer() == null) {
-            InteractionManager.setTickRate(options.interactionRateServer);
-        } else {
-            InteractionManager.setTickRate(options.interactionRateClient);
-        }
+        // Parse sound location string
+        options.sortSoundLoc = ResourceLocation.tryParse(options.interactionSound);
+        // Update interaction manager tick rate
+        InteractionManager.setTickRate(options.interactionInterval);
     }
 }

common/src/main/java/dev/terminalmc/clientsort/client/compat/itemlocks/ItemLocksCompat.java

@@ -32,7 +32,7 @@ public class ItemLocksCompat {
      */
     static boolean isLocked(Slot slot) {
         if (!(slot.container instanceof Inventory)) return false;
-        int index = adjustForInventory(((ISlot) slot).clientSort$getIndexInInv());
+        int index = adjustForInventory(((ISlot)slot).clientSort$getIndexInInv());
         return getComponent(LockManager.class).isLockedSlotRaw(index) && !isBypass();
     }