Instant server side sorting for the ClientSort mod.

Modrinth GitHub Releases

ClientSort Paper is the server side of the ClientSort mod, made for Paper. One jar runs on Paper, Spigot, Purpur and Folia. Open source, no dependencies.

ClientSort is a client mod for Fabric, NeoForge and Forge that sorts inventories and chests. It can also be installed on a server, where it makes sorting instant, but that server part only exists as a mod. This plugin is that server part for plugin servers. Players keep the normal ClientSort mod, nothing changes for them.

Without it the mod sorts by moving items one click at a time, which is slow and visible on a server. With the plugin the mod sends one request and the server rearranges everything at once. Sorting, filling stacks and moving everything between two inventories become instant.

Unofficial community plugin. ClientSort Paper is not made by, endorsed by or affiliated with TerminalMC or the authors of ClientSort. It is an independent plugin that speaks the same protocol as their mod, see NOTICE.

Features

• Works with the Fabric, NeoForge and Forge builds of the ClientSort mod, no setup on the client
• Instant sort, fill stacks and move all, in your own inventory and in containers
• The server checks every request: slots, container, permutation, shulker nesting, item counts
• Everything is undone if the item count before and after does not match
• Switch single operations off, pick allowed inventories, disable worlds, rate limit
• Shift + right click on an empty slot sorts for Java players without the mod, and /sort for everybody else
• Respects protection plugins: a cancelled click or right click event refuses the operation, and plugins like CoreProtect see the item moves
• Menu for Bedrock players through Floodgate
• Cancellable event for other plugins
• 10 languages and every message is editable
• One jar for Paper, Spigot, Purpur and Folia, Minecraft 1.21 to 26.3

Requirements

• A Bukkit based server on Minecraft 1.21 or newer: Paper, Spigot, Purpur, Folia and forks of them
• Java 21 or newer
• Players need the ClientSort mod to use the instant operations

Quick start

1. Put the jar into plugins and start the server.
2. Join with the ClientSort mod and sort a chest.
3. Run /clientsort status to see who has the mod.

Everybody may use it by default. See Installation for details.

Documentation

	Topic	About
	Installation	Requirements and first steps
	Commands and permissions	/clientsort, /sort, permissions
	Operations	What the mod asks and what the server checks
	Configuration reference	Every option and its default
	Compatibility	Platforms, versions, Geyser, the mod
	Languages	Ten languages, custom texts, placeholders
	Troubleshooting	Common problems
	Bedrock and Floodgate	Sorting menu for Geyser players
	Developer API	The cancellable operation event

Building

./gradlew build

The jar ends up in build/libs. Java 25 is used to build, the plugin itself targets Java 21.

Privacy

ClientSort Paper reports anonymous usage statistics to bStats. Turn it off for all plugins in plugins/bStats/config.yml. Nothing else leaves your server.

License and credits

Apache License 2.0, see LICENSE and NOTICE. The plugin speaks the network protocol of the ClientSort mod by TerminalMC, which is also Apache 2.0 licensed. It contains none of the mod's code.