What is this?
pkWaystones Companion is a Paper plugin that provides Bedrock client compatibility for Kawamood's Waystones datapack via Geyser/Floodgate. Additionally, Kawamood's Waystones and PacketEvents are required.
NOTE: If you're updating from v1.0, I recommend running /pkcom sync after updating to refresh your cache file. While it isn't necessary, it does remove fields in the cache file that are no longer required.
Features
Provides decorative Waystone markers for Bedrock players!
Bedrock players see the actual destination icons. No more cooked cod!
Installation
About the plugin
- Waystone Detection — On first startup, the plugin scans Waystones storage and caches all Waystone entries. The cache also updates automatically when Waystones are placed or removed.
- Visual Replacement — When a Bedrock player receives a chunk containing a Waystone, the plugin will use the cache to identify Waystone locations and push fake blocks to the Bedrock client. These fake blocks replace the floating barrel with a decorative appearance that corresponds to that Waystone's variant.
- Waystone Interaction — When a Bedrock player interacts with a Waystone, the plugin sends the real barrel block to the Bedrock client so it knows there's a container there, allowing the datapack's session to trigger normally. Kawamood's Waystones datapack handles all teleportation logic, XP costs, cooldowns, and GUI population. When the player closes the inventory, all fake blocks are refreshed.
- Inventory Icon Patching — The plugin uses PacketEvents to intercept the Waystone's inventory destination buttons and replaces them with the correct block icon that Java players see. No more cooked cod!
Expected behavior
- Visuals — Due to Bedrock limitations, the Bedrock client has to be told that there is a barrel present for the Waystone's inventory management so seeing the barrel blink into existence is expected. The decorative appearance of the Waystone is created with fake blocks so they will disappear and reappear when interacting with the Waystone. When selecting a destination in the Waystone's inventory, a cooked cod may be seen.
- Sound — The opening barrel sound would be heard when interacting with a Waystone. This is now suppressed but may still be heard from time to time due to Bedrock being Bedrock. The portal travel sound from the datapack wouldn't play when teleporting on the Bedrock player's side so it is now played at the destination after the player lands.
Commands
- /pkcom (requires op) provides commands for resyncing the cache, reloading config, viewing status, listing cached Waystones, and toggling all log flags as well as toggling the visuals.
Possibility in a future release
- Include a visual gui to manage options in Kawamood's Waystones datapack more easily.
- Register recipes for Bedrock players to find Waystones in their recipe books if at all possible so they're not having to build the Waystones manually.
