Repository navigation
FAQ
Does Shulkaero need to be on the server? No. It is 100 % client-side and works on any server, including vanilla servers. Nothing is sent to or stored on the server.
I placed a box but no waypoint appeared.
The waypoint appears about half a second after placing (so that protection-plugin
rollbacks never leave ghost waypoints). If it still does not appear: is Xaero's Minimap
installed and is Shulkaero enabled (/shulkaero toggle)? Is onlyNamedBoxes on while
the box has no anvil name?
I broke a box but the waypoint is still there.
That is the pickup tracking: the waypoint stays while the dropped box item lies near the
break position and disappears once it is picked up, despawns or burns. Set
waitForPickup to false for immediate removal. Note that while you are far away
(roughly beyond 32 blocks) the item's state cannot be seen, so the waypoint waits until
you come closer.
Do waypoints survive relogs and restarts?
Yes. Waypoints are stored through Xaero's own waypoint system, and Shulkaero's tracking
list is persisted per world in config/shulkaero/tracked_waypoints.json.
I deleted/renamed a waypoint myself and it came back / disappeared. It should not: Shulkaero only removes waypoints that still have exactly the position and name it created. Deleted or renamed waypoints are left alone. If you see otherwise, please open a bug report.
Why do boxes placed by other players get no waypoint? Their box names are not available client-side, so only your own placements are tracked.
Which boxes count? All 17 shulker boxes (16 dye colors + undyed). The waypoint color matches the dye; the undyed box is purple.
Does it work with Xaero's World Map? Yes. Waypoints are created in the minimap's waypoint system, which the world map renders as well.
The waypoint color looks wrong on an old Xaero version. Old Xaero versions lack the extended palette (magenta, light blue, lime, pink, brown); Shulkaero then falls back to the closest classic color. Update Xaero's Minimap to 26.4.x.
Can I use Shulkaero in my modpack? Yes, free or paid, as long as the jar stays exactly as published. See License and permissions.