pkWaystones Companion (Bedrock Compatibility)

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 models for Bedrock players!

Bedrock players see the actual destination icons. No more cooked cod!

New features with v1.3: Waystones have a new rendering method for Bedrock Players! There are three to choose from; classic, legacy, and modern. You can also customize the inventory window. Refer to the commmands section below for more info.

Installation

• As mentioned above, Kawamood's Waystones and PacketEvents are required.
• Simply drop this plugin into your minecraft\plugins folder and restart your server.

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 models to the Bedrock client. These models 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, it will behave the same way as it would for a Java player. Kawamood's Waystones datapack handles all teleportation logic, XP costs, cooldowns, and GUI population.
• 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!
• Waystone Recipes and Iventory Items — recipes and inventory items have icons to replace the glowing item frames that would be seen without this plugin. A small mcpack is required for this. pkWaystones Companion will automatically create this mcpack and place it into the proper Geyser folder so that it can be pushed to Bedrock players.

Expected behavior

• Visuals — The plugin uses invisible armor stands to build the Waystone models. Due to how Bedrock functions, you can expect to see a barrel phase through the model if you're standing right next to 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.
• Changing Waystone Models — type /pkcom set waystones followed by classic, legacy, modern, or default.
  • classic — a model reminiscent of the original models I used for this plugin.
  • legacy — mimics Kawamood's legacy models from the Waystones datapack.
  • modern — mimics Kawamood's modern models from the Waystones datapack.
  • default — sets the Waystones to represent the Waystone models that are set in the Waystones datapack. Note that changes to the datapack are not immediate and will take effect the next time a Bedrock player loads a chunk.
• Customize The Waystone Inventory Screen — type /pkcom set interface followed by classic or legacy.
  • classic — the inventory screen native to Bedrock.
  • legacy — mimics the java inventory screen by swapping the glass panes to look closer to what Java players see.

Possibility in a future release

• Include support for phiphi's Waystones RP resource pack.
• Include a visual gui to manage options in Kawamood's Waystones datapack more easily.