☰ Contents: MRwaypoints
For admins

Configuration

Easiest in the browser: with MRadmin under Plugins → MRwaypoints → Configuration - every setting with an explanation, saving reloads MRwaypoints right away (permission mradmin.config). Everything is also commented in plugins/MRwaypoints/config.yml; you apply changes by hand with /mrwaypoints reload. The categories are kept separately in categories.yml (see Categories).

Section What for
general Languages (language, fallback-language, server-language) - every player automatically in theirs
waypoints Longest name (max-name-length)
guide Guide: how often the arrow updates (update-ticks), from how many blocks counts as "arrived" (arrive-distance), sound
mod Mod for Xaero: minimum version (minimum-version), download link
view The players' settings for Xaero: selectable view distances in chunks (ranges: chunks in every direction around the player, 0 = unlimited) and defaults (default-range, default-display everywhere/world-map, default-far-on-world-map)
discord Discord log - see Discord log
updates · gui Update notices, menus

Files

File Content
config.yml Settings (above)
categories.yml The categories
waypoints.yml All waypoints
players.yml The players' settings (categories in Xaero, view distance, display) - only differences from the default
lang/<language>.yml All messages, more under Languages & messages

The console is always English.

All settings

Every setting of config.yml with its default - the same fields as in MRadmin's browser form. The list is generated automatically from the plugin and therefore always matches this version.

General

Language of the texts in game.

Setting Default Meaning
general.language Automatic (auto) Language of the players - Automatic = every player gets the language of their Minecraft client.
general.fallback-language English (en) Fallback language - For players whose language has no file of its own.
general.server-language English (en) Server language - For texts not meant for a single player (MRwaypoints has none yet).

Waypoints

Who may create waypoints and how many is set per category (page Map).

Setting Default Meaning
waypoints.max-name-length 32 characters Longest name

Guide

A click on a waypoint shows an arrow and the distance above the hotbar.

Setting Default Meaning
guide.update-ticks 5 ticks Refresh the arrow every - 20 ticks = 1 second.
guide.arrive-distance 5 blocks Arrived within - That close to the target the guide ends ("You have arrived").
guide.sound on Sound on arrival

Mod for Xaero

Players with the MRwaypoints mod see the server waypoints in Xaero's Minimap and World Map.

Setting Default Meaning
mod.minimum-version empty Oldest allowed mod version - E.g. 0.2.1 - locks out older versions (empty = any compatible one).
mod.download-url https://mrtechnology.marcelr.at/download/mrwaypoints/ Download link - Where players get the mod (link in the notices).

View in Xaero

Players set in /waypoints → Settings how far and where they see the waypoints. Here the choices and the defaults.

Setting Default Meaning
view.ranges 10, 20, 50, 100, 0 chunks Ranges to choose from - In chunks to every side, 0 = unlimited.
view.default-range 0 chunks Default range - For players who changed nothing (0 = unlimited).
view.default-display Everywhere (everywhere) Default display
view.default-far-on-world-map on Far ones on the world map - Waypoints beyond the range stay visible on Xaero's World Map (default for players).

Discord logs

Send events to a Discord channel. Webhook: Edit channel → Integrations → Webhooks → New webhook → copy URL.

Setting Default Meaning
discord.enabled off Send Discord logs
discord.webhook-url empty Webhook URL - Starts with https://discord.com/api/webhooks/
discord.use-mradmin-webhook off Use MRadmin's webhook - Without a webhook URL of its own, the events go to MRadmin's Discord log.
discord.username MRwaypoints Name in the channel - Empty = setting from Discord.
discord.avatar-url empty Avatar URL - Empty = setting from Discord.
discord.use-embeds on Coloured embeds - Off = plain text messages.
discord.footer Minecraft-Server Footer - E.g. the server name (empty = none).
discord.events Waypoint created: Send true · Colour #2ECC71
Waypoint renamed: Send true · Colour #3498DB
Waypoint to another category: Send true · Colour #3498DB
Waypoint relocated: Send true · Colour #3498DB
Waypoint deleted: Send true · Colour #E74C3C
Several to another category: Send true · Colour #3498DB
Several deleted: Send true · Colour #E74C3C
Category created: Send true · Colour #9B59B6
Category changed: Send true · Colour #9B59B6
Category deleted: Send true · Colour #C0392B
Order changed: Send true · Colour #9B59B6
Teleport to waypoint: Send true · Colour #1ABC9C
Team: reloaded: Send true · Colour #3498DB
Events - Which events are sent and in which colour. The texts are in the language files.

Updates

Look for new versions of MRwaypoints.

Setting Default Meaning
updates.enabled on Look for updates - On start and regularly afterwards. A notice appears in the console.
updates.source GitHub (github) Source
updates.include-prereleases off Pre-releases too - When a pre-release (0.x) runs they are always reported.
updates.interval-hours 6 hours Check every
updates.notify-on-join on Tell the team on join - Players with mrwaypoints.admin.update get a notice.

The menus of /waypoints.

Setting Default Meaning
gui.refresh-ticks 20 ticks Refresh every - 20 ticks = 1 second - distances stay up to date.
gui.sounds on Click sounds

Generated automatically from plugin/src/main/resources/web-config.yml + config.yml.

✎ Edit on GitHub·docs/wiki/en/konfiguration.md ↗·View unreleased state