A gathering list that ticks itself off as you collect.
Heading out for logs and coming back without the glass? Every player on your server can keep a list of what they need, and watch it count itself off at the side of the screen as they gather: "24/64 Oak Planks", green once there's enough, and a chime when the whole list is done.
This is Pocket List as a plugin for Paper 26.3 servers. Drop it in your plugins folder; players need nothing installed. (Pocket List is also a Fabric and NeoForge mod, on CurseForge, with a corner HUD and a list screen.)
What your players get
- The list at the side of the screen, as a sidebar: the list's name and "2/5" in gold, then a line for each item, the ones still to gather first. Lines turn green when there's enough; the title turns green and "All gathered!" shows with a chime when everything is done.
/pocket shows the list in chat with buttons to click: [-] [+] [+64] [break down] [x] on each line, and Clear done, New list, Copy and Delete list below.- Add anything:
/pocket add oak_log 32 (Tab lists every item), /pocket add hand for what you're holding, /pocket add recipe lantern for what a lantern takes. Add stack for a whole stack.
- Break it down:
/pocket breakdown lantern swaps a line for its ingredients, minus what you already have, using the server's own recipes (data packs included). When something is made more than one way, you pick.
- Several lists: one for the cottage, one for the farm.
/pocket new, use, next, rename and delete.
- Counting: your inventory and off-hand, the shulker boxes and bundles you carry, and whatever container is open.
- Chest memory: chests, barrels, shulker boxes, hoppers, dispensers and droppers you've opened, and shelves you've used, count toward your list while you're within 32 blocks. Only ones you opened yourself count. The server can see inside them, so the count is what's in them now: if a friend or a hopper drops planks in, your list goes up. Ender chests don't count, and a double chest counts once.
- Paste a list:
/pocket paste 64 oak planks, 32 cobblestone; 3 torches for a short one. For a long one, or a Litematica material list, write it in a book and quill, one item a line, hold it and type /pocket paste book. Names it can't match are listed back, never guessed.
/pocket hud off hides the sidebar, /pocket hud lines 5 shows five lines, /pocket help lists everything.
For server owners
- Players need nothing. It's a plain Paper plugin. Vanilla and modded clients join as usual.
- Lists live on the server, saved with each player, so they're there next time they join.
- The sidebar is shared with other plugins, such as a stats board. Pocket List uses it only while a player's list has something on it, and hands it back when the list is empty or turned off.
- Permissions:
pocketlist.use (everyone, for /pocket) and pocketlist.admin (operators, for /pocket selftest, which checks the recipe reading against your server's recipes; it works from the console too).
- Four settings in
plugins/PocketList/config.yml, read when the server starts:
| Setting |
Default |
What it does |
sidebarForNewPlayers |
true |
Whether a player who has never used /pocket hud sees their list in the sidebar. |
defaultLines |
8 |
How many lines the sidebar shows for a player who hasn't picked a number (1 to 15). |
chestMemory |
true |
Containers a player opened count toward their list while they're near. false: only what they carry and the container open on their screen. |
chestRadius |
32 |
How near (in blocks) a remembered container must be to count (8 to 64). |
What it doesn't do (yet)
A server can't draw in the corner of the screen or listen for keys, so the plugin is plainer than the mod: no corner HUD with icons, no keys, no pinning from the inventory or the recipe book, and no JEI or REI.
Good to know
- Needs Paper 26.3 and Java 25. Not tested on Folia.
- A player who also runs the Pocket List mod sees both lists;
/pocket hud off hides the plugin's.
- MIT licence.
About this plugin
I kept losing track halfway through a build, so I made a list that keeps count for me. Found a bug or have an idea? Open an issue on GitHub. The source is on GitHub too, and the plugin is also on Hangar.
Made by Gabby
If you'd like to support my work: Ko-fi
