Server Waypoint

# Server Waypoint [中文](https://github.com/2676959/server_waypoint/blob/master/README_zh.md) [](https://opensource.org/licenses/MIT)   [](https://modrinth.com/plugin/server_waypoint) [](https://www.curseforge.com/minecraft/mc-mods/server-waypoint) [](https://modrinth.com/plugin/server_waypoint/versions?l=fabric) [](https://modrinth.com/plugin/server_waypoint/versions?l=forge) [](https://modrinth.com/plugin/server_waypoint/versions?l=neoforge) [](https://modrinth.com/plugin/server_waypoint/versions?l=paper) [](https://discord.com/invite/tKtSSYDkHx) [](https://crowdin.com/project/server-waypoint) Manage waypoints and sync them to other players' clients automatically. Compatible with Xaero's minimap. ## Features - Syncing waypoints from the server automatically. - Customizable waypoints rendering. - Allow players to manage waypoints by both GUI (need client installation) and commands (only need server installation). - Commands auto-completion. - Custom permission for `/wp ` commands. Compatible with [LuckPerms](https://modrinth.com/plugin/luckperms). - Support adding waypoint conveniently from Xaero's minimap waypoint chat sharing message without requiring client side installation. ## Dependencies Required: - [Fabric API](https://modrinth.com/mod/fabric-api) Optional: - [LuckPerms](https://modrinth.com/plugin/luckperms) - [Xaero's Minimap](https://modrinth.com/mod/xaeros-minimap) ## Keybinds - Press `Right Shift` (default keybind) or use `/wp_gui` to open the waypoint manager screen in game. - In the waypoint manager screen, hover over a waypoint and press `T` to teleport (requires `/wp tp` command permission). - In the waypoint manager screen, press `C` to open client configuration screen. ## Commands - `/wp add` add a new waypoint. No duplicate name allowed. Prompts user to use `/wp edit` to replace the existing one. - `/wp add ` 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 `/config/server_waypoint/lang`, 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 ` remove an empty waypoint list. - `/wp tp` teleport the executor player to a waypoint ## Server-side Translations Messages and command feedbacks sent by this mod will be automatically translated based on the language setting on the receiver's client. This works entirely on the server-side; players can see the translated message without client-side installation of this mod. Right now, the mod comes with translations for English and Simplified Chinese. If you’re interested, you can help out by adding translations on [Crowdin](https://crowdin.com/project/server-waypoint)! - ### Add translations Place the lang files under the directory: `/server_waypoint/lang/`. 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`](./common/src/main/resources/lang/en_us.json), [`zh_cn.json`](./common/src/main/resources/lang/zh_cn.json). Name the lang file with a [valid language code](https://minecraft.wiki/w/Language#Languages). - ### Translation order If the translation you’ve added uses the same language code as the built-in language, this mod will try to find the translation key in the file you added first. If that key isn’t there, it’ll fall back to the built-in translation. So, if you’d like to use your own translation version, you can easily do that by adding your own file and overriding the built-in translation. Community translator credits and credit pull request guidelines are documented in [`TRANSLATOR_CREDITS.md`](./TRANSLATOR_CREDITS.md). ## Translation Credits Thank you to the community translators who help make Server Waypoint available to more players in more languages. - #### Hebrew [hotspotty](https://discord.com/users/575744894593663006) - #### Spanish shimonsolo - #### Traditional Chinese Ymaomi - #### Traditional Chinese (Hong Kong) Ymaomi ## Waypoints - #### Location For a dedicated server: `/server_waypoint/waypoints/` For a single player world: `/saves//server_waypoint/waypoints/` - #### 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`. ## Server Configurations Fabric, Quilt: `/config/server_waypoint/config.json` NeoForge, Forge: `/defaultconfigs/server_waypoint/config.json` Paper, Purpur: `/plugins/ServerWaypoint/config.json` Some changes made in `config.json` may take effects after server restarts. - ### Command Permission Changes the vanilla [permission level](https://minecraft.wiki/w/Permission_level) required to execute the command. This will be overridden by the permission set by [LuckPerms](https://modrinth.com/plugin/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](https://leavesmc.org/) server or some similar features provided by other plugin or mod is enabled.** Example: ```json5 { "Features": { "sendXaerosWorldId": true } } ``` ## Client Configurations - #### Enable Waypoint Rendering Default value: `true` - #### Waypoint Rendering Scaling Factor (Percentage) Default value: `100` - #### Waypoint Background Transparence Default value: `128` - #### Waypoint Vertical Offset (Percentage) Default value: `0` - #### Local Waypoint View Distance (Chunks) Default value: `12` - #### Auto Sync to Xaero's Minimap Default value: `true` Requires Xaero's Minimap mod installed. - #### Manually Sync to Xaero's Minimap Default value: `None` Triggered manually, requires Xaero's Minimap mod installed. This will replace any waypoint sets on Xaeros' Minimap that has the same name as a list on the server. - What stays: Waypoint sets with unique names that do not exist on the server. - What is lost: Any waypoints you added to these shared lists. Any list you created that happens to share a name with a server list.