Server Waypoint

Server Waypoint

License: MIT

Modrinth Downloads

CurseForge Downloads

fabric

paper

Manage waypoints and sync them to other player's client automatically. Compatible with Xaero's minimap.

Features

- Syncing waypoints from server automatically. - Interactive waypoint list TUI allowing player click to teleport to a waypoint or edit it. - Commands auto-completion. - Custom permission for `/wp <options>` commands. Compatible with LuckPerms. - Support adding waypoint conveniently from Xaero's minimap waypoint chat sharing message without requiring client side installation.

Dependencies

Required: - Fabric API

Optional: - LuckPerms - Xaero's Minimap Not required for serverside installation.

Commands

- `/wp add` add a new waypoint. Cannot add waypoint with duplicate name. Prompts user to use `/wp edit` to replace the existing one. - `/wp add <dimension> <list>` add a waypoint list. - `/wp download` download waypoints and add to Xaero's Minimap (will not work without client installation). - `/wp edit` edit a waypoint. - `/wp list` list all waypoints. Shows all waypoints in a tree hierarchy. Allowing user to click to teleport, edit and remove the waypoint. - `/wp reload` reload `config.json` and translation files in `configserver_waypointlang`, feature `sendXaerosWorldId` requires restarting to take effect. - `/wp remove` remove a waypoint by name. Shows the removed waypoint and click it to restore that waypoint. - `/wp remove <dimension> <list>` remove an empty waypoint list. - `/wp tp` teleport the executor player to a waypoint

Translation

This mod currently has built-in translations for English and Simplified Chinese. Command feedbacks will be automatically translated based on the language setting on the sender's client if the corresponding lang file is loaded.

- ### Add translations Place the lang files under the directory: `<minecraft_root>configserver_waypointlang`. This mod will load them on server starting, use `/wp reload` if the server is already running.

- ### Create a lang file Follow the format used in `en_us.json`, `zh_cn.json`.

Name the lang file with a valid language code.

Waypoints

- #### Save Path For a dedicated server:

`<minecraft_root>configserver_waypointwaypoints`

For a single player world:

`<minecraft_root>saves<world_name>server_waypointwaypoints` - #### File Format All waypoints are saved in json files. Each json file contains all waypoints in one dimension and the filename is the converted full registry name of that dimension. For example, all waypoints in the overworld is stored in `minecraft$overworld.json`.

Configurations

The configuration file is stored at `<minecraft_root>configserver_waypointconfig.json`.

Changes made in `config.json` will take effects after server restarts.

- ### Command Permission Changes the vanilla permission level required to execute the command.

This will be overridden by the permission set by LuckPerms.

Default value: ```json5 { "CommandPermission": { // /wp add "add": 0, // /wp edit "edit": 0, // /wp remove "remove": 0, // /wp tp "tp": 2, // /wp reload "reload": 2 } } ``` - ### Features - #### addWaypointFromChatSharing Default value: `true`

Prompts the user to add the waypoint they shared in chat. Requires `/wp add` permission.

Example: ```json5 { "Features": { "addWaypointFromChatSharing": true } } ``` - #### sendXaerosWorldId Default value: `true`

Send world id to client to help Xaero's map mod recognize the server.

This should be set to `false` if `xaero-map-protocol` on the Leaves server or some similar features provided by other plugin or mod is enabled.

Example: ```json5 { "Features": { "sendXaerosWorldId": true } } ```