DOCSEARCHbyAlgolia
Submit Docs

Inventory Sorter Documentation

website·Indexed 32 days ago

https://inventorysorter.meza.gg

A lightweight Minecraft mod designed to keep inventories organized with a server-side-first approach. Documentation covers installation for multiplayer servers, client and server configuration, available sort types, player permissions via fabric-permissions-api, and community translation contributions.

Tokens
5.9K
Snippets
20
Records
52
Agent score
53%

What's inside Inventory Sorter

  1. Understand Inventory Sorter's server-side-first architecture

    Inventory Sorter is designed to perform sorting operations on the server rather than simulating manual item movement from the client. When a sort is triggered, the client sends a request and the server applies the sort. This architecture allows the mod to work with vanilla (unmodded) clients and ensures cleaner networking in multiplayer environments.

  2. Contribute bug fixes and feature enhancements

    Contributors can find tasks on the GitHub issue tracker using the following labels:

    • Bugs: Look for issues tagged with bug.
    • Features: Look for issues tagged with both enhancement and please-help.

    When implementing features, do not combine multiple enhancements into a single pull request.

  3. Use a remote compatibility configuration

    Inventory Sorter can fetch a JSON configuration from a remote URL on startup. The values for preventSortForScreens and hideButtonsForScreens are merged in memory with the local config and are not saved to disk. This allows server networks or modpacks to maintain consistent rules across multiple machines.
    {
  "preventSortForScreens": [],
  "hideButtonsForScreens": [
    "minecraft:shulker_box"
  ]
}

    Server Admin Commands:

    /invsort admin remote set [url] # Set remote config source /invsort admin remote clear # Remove remote config /invsort admin remote show # Display current URL

    Client Commands (for sharing settings without server enforcement):

    /invsort remote set [url] /invsort remote clear /invsort remote show

  4. Hide sort buttons for specific screens

    Use the hideButtonsForScreens list to remove the visible sort button from specific screens (using screen IDs like minecraft:shulker_box). This only hides the UI element; sorting via keybinds, double-clicks, or commands remains functional. Server-defined hidden buttons override individual player preferences.
    # Add the screen you are looking at to the hidden button list
/invsort admin hidebutton add

# Remove the screen you are looking at from the hidden button list
/invsort admin hidebutton remove

# List all screens with hidden buttons
/invsort admin hidebutton list

  5. Submit feature requests and feedback

    Feedback and feature proposals should be submitted as issues on the GitHub issue tracker. Feature proposals should:

    • Explain in detail how the feature would work.
    • Keep the scope narrow to facilitate implementation.

  6. Change sort type via commands or UI

    The sort type is stored per player and persists between sessions. For vanilla clients, the setting is saved per player per server.

    Methods to change sort type:

    1. Command (Vanilla/Automated): Use /invsort sortType [category|mod|name|id].
    2. Mouse Scroll (Client Mod): Hover over the sort button and scroll the mouse wheel to cycle through Category, Mod, Name, and Id.
    3. Configuration (Client Mod): Use the in-game configuration screen or edit the config/inventorysorter.json file.
    /invsort sortType category
/invsort sortType mod
/invsort sortType name
/invsort sortType id

  7. Trigger sorting via double-click

    If enabled in the configuration, double-clicking an empty slot will trigger a sort. This works for vanilla clients if the server has the mod installed.

    Commands to manage double-click sorting:

    • Enable: /invsort doubleClickSort on
    • Disable: /invsort doubleClickSort off
    • Check status: /invsort doubleClickSort
    /invsort doubleClickSort on

  8. Inventory Sorter version support policy for Minecraft 26.1+

    Starting with Minecraft 26.1, Inventory Sorter has shifted its active development focus to 26.1 and newer versions. This change is driven by the removal of obfuscation in Minecraft: Java Edition and Fabric's move away from Yarn as the officially supported mapping layer for these versions.

    Key impacts include:

    • New Features: Only added to Minecraft 26.1 and newer.
    • Legacy Versions: Existing releases for versions prior to 26.1 remain available for download.
    • Maintenance: Critical fixes for older versions may be released if they are small and safe, but they are no longer the primary development target.

  9. Install Inventory Sorter in client-only mode

    While Inventory Sorter can be installed on a client without a corresponding server installation, this is not recommended. Client-only installation may cause UI spam and synchronization issues with the server.

  10. Inventory Sorter feature availability and requirements

    Inventory Sorter features vary based on whether the user has the client mod installed or is using a vanilla client. Commands like /invsort sort and /invsort sortme work on vanilla clients, whereas the Sort Button, Keybinds, and Config Menu require the client mod.
    FeatureRequires Client ModWorks with Vanilla ClientConfigurable
    Sort Button✅❌✅
    Keybind✅❌✅
    Config Menu✅❌✅
    Double-Click❌✅✅
    /invsort sort❌✅❌
    /invsort sortme❌✅✅

  11. Prevent sorting on specific screens

    Use the preventSortForScreens list to block sorting for specific containers via sort buttons, keybinds, double-clicks, or commands. This is useful for modded containers that break when sorted. You must use the screen ID (e.g., minecraft:generic_9x3) rather than the display name. Note that this does not block the player's own inventory sorting while the container is open.
    # Add the screen you are looking at to the blocked list
/invsort admin nosort add

# Remove the screen you are looking at from the blocked list
/invsort admin nosort remove

# List all currently blocked screens
/invsort admin nosort list

  12. Use Keybinds for inventory sorting

    The sort keybind behavior depends on the mouse position and configuration. If sortHighlightedItem is true, the keybind targets the inventory currently under the mouse. If no inventory screen is open, the default P key opens the config menu instead of sorting.