Skip to content

Commit

Permalink
feat: add info, typos
Browse files Browse the repository at this point in the history
  • Loading branch information
rootEnginear committed Nov 12, 2023
1 parent 53537b4 commit 6ab1363
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,14 @@

# Sort Chest

Organize your chests instantly with a single keystroke
Organize your chests instantly with a single click

This mod added several buttons in chest GUI.

- **Sort:** sort items by id, metadata, and quantity.
- **Refill:** move same items (between chest and inventory) to chest.
- **Fill:** move items from inventory to chest.
- **Dump:** move items from chest to inventory.

> **Important**
> Required [Babric](https://github.com/Turnip-Labs/babric-instance-repo/releases) to run the mod.
Expand All @@ -14,14 +21,14 @@ Organize your chests instantly with a single keystroke
**Yes**, you can use the sort chest mod on a server. However, the item might jump for a while after sorting because the
mod will emulate mouse clicks rather than directly changing the inventory data.

### How does the sort chest mod sort items?

Items are sorted by their item ID (ascending), followed by its metadata (like wool color code, ascending), and finally
by its stack size (descending).

### Rebind keys?

1. Open the mod menu (from [ModMenu](https://github.com/Turnip-Labs/ModMenu) mod)
2. Select "Sort Chest" mod from the left
3. Click at ⚙️ icon on the right
4. Rebind keys that you want

### How does the sort chest mod sort items?

Items are sorted by their item ID (ascending), followed by its metadata (like wool color code, ascending), and finally
by its quantity (descending).
2 changes: 1 addition & 1 deletion src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"id": "sortchest",
"version": "${version}",
"name": "Sort Chest",
"description": "Organize your chests instantly with a single keystroke",
"description": "Organize your chests instantly with a single click",
"authors": [
"rootEnginear"
],
Expand Down

0 comments on commit 6ab1363

Please sign in to comment.