MRwaypoints besteht aus zwei Teilen:
| Teil | Ordner | Läuft auf | Aufgabe |
|---|---|---|---|
| Plugin (Paper) | plugin/ |
Server | Kategorien, Wegpunkte, Rechte, Menü /waypoints, Wegweiser, Web und Karte über MRadmin, welche Kategorien ein Spieler in Xaero sehen will (players.yml) |
| Mod (Fabric) | mod/ |
Client | Zeigt die Server-Wegpunkte in Xaero's Minimap und World Map, Taste J und Knopf in Xaeros Wegpunkt-Menü öffnen /waypoints (dort auch die Kategorien) - kein eigener Bildschirm |
Der Mod ist optional: Ohne ihn funktionieren Menü und Wegweiser ganz normal. Er braucht Xaero's Minimap (die World Map zeigt die Wegpunkte der Minimap mit an).
Zwei Nummern: Version und Protokoll
- Version (
plugin-mc26.3-v0.1.0,mod-mc26.3-v0.1.0): eigene Versionen und Releases (RELEASES.md). - Protokoll (ganze Zahl): Format der Nachrichten.
- Mod:
Protocol.VERSION(mod/.../Protocol.java) - Plugin:
Compatibility.MIN_PROTOCOL..MAX_PROTOCOL(plugin/.../Compatibility.java)
- Mod:
Kompatibel ist, was ein gemeinsames Protokoll spricht - nicht, was dieselbe Version hat.
Handshake
- Der Mod schickt nach dem Betreten
mrwaypoints:hello(Protokoll, Mod-Version, Minecraft-Version). - Das Plugin prüft (
Compatibility.check): Protokoll zu klein → zu alt, zu groß → zu neu, Mod-Version untermod.minimum-version→ zu alt. - Antwort
mrwaypoints:welcome(Status, Protokollbereich, Plugin-Version, Mindestversion, Download-Link), bei „zu alt / zu neu“ zusätzlich eine Chatzeile mit Link. - Bei OK schickt das Plugin
mrwaypoints:state- danach nach jeder Änderung neu.
Die Formate von hello und welcome ändern sich nie (Felder nur hinten anhängen), damit jede Mod-Version jeder Plugin-Version sagen kann, ob sie passen.
Nachrichten (Protokoll 2)
| Kanal | Richtung | Inhalt |
|---|---|---|
mrwaypoints:hello |
Mod → Plugin | VarInt Protokoll, String Mod-Version, String Minecraft-Version (eingefroren) |
mrwaypoints:welcome |
Plugin → Mod | VarInt Status (0 OK, 1 zu alt, 2 zu neu), VarInt min, VarInt max, String Plugin-Version, String Mindestversion, String Download-Link (eingefroren) |
mrwaypoints:state |
Plugin → Mod | VarInt n, n × (String id, String Name in der Sprache des Spielers, Int Farbe, Boolean an); VarInt m, m × (VarInt id, String Kategorie, String Name, String Dimension wie minecraft:overworld, Int x, Int y, Int z); VarInt Sichtweite (Chunks in jede Richtung um den Spieler, 0 = unbegrenzt), Boolean nur Weltkarte, Boolean Entfernte auf der Weltkarte |
mrwaypoints:keys |
Plugin → Mod | leer - öffnet Minecrafts Tastenbelegung (Knopf in /waypoints → Einstellungen) |
mrwaypoints:action |
Mod → Plugin | Byte Aktion: 0 /waypoints öffnen, 1 Wegpunkt hier erstellen (Server zeigt seinen Dialog), 2 Wegweiser beenden (seit der Taste weg ist ungenutzt, Code bleibt belegt) - unbekannte Codes ignoriert das Plugin, neue Aktionen nur hinten anhängen (kein neues Protokoll nötig) |
Strings sind VarInt-Länge + UTF-8, Zahlen Big-Endian - wie Minecrafts FriendlyByteBuf (Plugin: util/Wire, getestet in WireTest).
Xaero
Xaero hat keine offizielle API. Der Mod nutzt Xaeros Ablage für Wegpunkte anderer Mods (ThirdPartyWaypoints, wie Xaero selbst für Waystones): pro sichtbarer Kategorie eine Herkunft mrwaypoints:<kategorie> im Ordner jeder Dimension. Diese Wegpunkte landen nicht in den Wegpunkt-Dateien des Spielers. Alles steckt in XaeroBridge; passt eine Xaero-Version nicht, schreibt der Mod einmal einen Fehler ins Log und zeigt nichts an - das Spiel läuft weiter. Gebaut und getestet gegen Xaero's Minimap 26.6.2 (MC 26.3).
Die Einstellungen des Spielers setzt XaeroBridge.follow pro Wegpunkt um, sobald er sich ein paar Blöcke bewegt: innerhalb der Sichtweite LOCAL (Welt + Minimap + World Map), sonst bzw. bei „nur Weltkarte“ WORLD_MAP_LOCAL (nur World Map - Xaeros Minimap- und Welt-Anzeige überspringen diesen Typ), ohne „Entfernte auf der Weltkarte“ setDisabled(true). Minimap und Welt lassen sich pro Wegpunkt nicht getrennt schalten.
Bei Änderungen
- Neue Nachricht oder geändertes Format von
state:Protocol.VERSIONim Mod undMAX_PROTOCOLim Plugin erhöhen. Alte Mods weiter unterstützen, solange es geht (MIN_PROTOCOLerst anheben, wenn es nicht mehr anders geht). - Neue Xaero-Version:
xaero_minimap_versioninmod/gradle.propertiesanheben, bauen, im Spiel prüfen.
Verlauf des Protokolls
| Protokoll | Änderung |
|---|---|
| 1 | erste Fassung (nie veröffentlicht) |
| 2 | state endet mit den Einstellungen des Spielers (Sichtweite, nur Weltkarte, Entfernte auf der Weltkarte); toggle und open entfallen (Kategorien nur noch im Menü /waypoints). Plugin spricht nur noch 2 (1 war nie veröffentlicht). |