Referenz

Konfiguration

Alle Einstellungen des MC-Sync-Plugins und der Mod, mit Standardwert und Wirkung.

Die Datei entsteht beim ersten Start des Servers. Plugin und Mod kennen dieselben Einstellungen in zwei Schreibweisen: Aus api: → token: in YAML wird api.token= in der Properties-Datei. Zwei Einstellungen gibt es nur auf Spigot, Paper und Folia.

Server	Datei
Spigot, Paper, Folia	`plugins/mc-sync/config.yml`
Fabric, Quilt, Forge, NeoForge	`config/mc-sync.properties`

yaml

# plugins/mc-sync/config.yml
commands:
  mode: allow
  allow: ["say", "lp user * parent add"]

properties

# config/mc-sync.properties
commands.mode=allow
commands.allow=say,lp user * parent add

Listen stehen in YAML in eckigen Klammern, in der Properties-Datei durch Komma getrennt. Schreib "off" und "on" in YAML in Anführungszeichen.

Neu laden oder neu starten

/mcsync reload liest die Datei neu. Sofort gelten danach:

commands.mode, commands.allow und commands.consoleFallback
performance.report, error.report und dev.mode

Einen Neustart brauchen:

api.token
queue.*, update.mode, console.live, http.mode, http.allow und flows.mode
flowCommands.enabled. Nach einem Reload gilt es erst, wenn sich die Befehle im Dashboard ändern.

Fehlt in einer älteren Datei eine Einstellung, trägt MC-Sync sie beim Start und bei /mcsync reload mit ihrem Standardwert nach. Vorhandene Werte bleiben unverändert, die alte Datei liegt daneben als config.yml.bak-… oder mc-sync.properties.bak-….

api

Schlüssel	Standard	Wirkung
`api.token`	`YOUR_API_TOKEN`	Der Token aus dem Dashboard oder von `/server add`. Der Platzhalter zählt als leer.

Auf Fabric, Quilt, Forge und NeoForge liest die Mod den Token aus der Umgebungsvariable MC_SYNC_TOKEN, wenn in der Datei keiner steht. Wie du den Token bekommst, steht unter Chat-Sync.

queue

Ist Discord nicht erreichbar, warten Chat, Beitritte und Tode auf der Festplatte: in plugins/mc-sync/queue/ oder config/mc-sync-queue/. Sie überstehen einen Neustart und gehen danach in der richtigen Reihenfolge raus.

Schlüssel	Standard	Wirkung
`queue.maxAgeMinutes`	`60`	Wie lange ein Ereignis wartet, in Minuten. 1 bis 1440. Ältere werden verworfen.
`queue.maxEvents`	`10000`	Wie viele Ereignisse höchstens warten. Darüber fallen die ältesten weg. Höchstens 100000.
`queue.maxSizeMb`	`10`	Wie viel Platz die wartenden Ereignisse belegen, in MB. Darüber fallen die ältesten weg. Höchstens 1024.

Ein Wert über der Grenze gilt als die Grenze. 0, ein leerer Wert oder Text gilt als Standard.

update

Schlüssel	Standard	Wirkung
`update.mode`	`notify`	`notify` meldet eine neue Version im Serverlog und in `/mcsync status`. `off` schaltet die Prüfung ab.

Gesucht wird nur nach Versionen für die Minecraft-Version des Servers. MC-Sync lädt nie selbst etwas herunter; die neue Datei tauschst du von Hand.

commands

Welche Befehle der Minecraft-Server aus Discord, aus dem Dashboard und aus Abläufen annimmt. Wer in Discord Befehle schicken darf, stellst du dort ein, siehe Befehle aus Discord.

Schlüssel	Standard	Wirkung
`commands.mode`	`whitelist`	`off`: keine Befehle. `whitelist`: nur `whitelist add`, `whitelist remove` und `whitelist list`. `allow`: die Whitelist und alles aus `commands.allow`. `all`: jeder Befehl.
`commands.allow`	leer	Weitere Befehle für `allow`. Ein Eintrag passt auf den Anfang des Befehls, Wort für Wort. `*` steht für genau ein Wort.
`commands.consoleFallback`	`false`	Nur Spigot, Paper, Folia. Lehnt ein Plugin-Befehl die Konsole ab, über die MC-Sync die Ausgabe mitliest, führt `true` ihn ohne Ausgabe noch einmal auf der echten Konsole aus. Er kann dann zweimal laufen.

Mit lp user * parent add geht lp user Notch parent add vip, aber nicht lp user Notch parent remove vip.

console

Schlüssel	Standard	Wirkung
`console.live`	`true`	Admins des verbundenen Discord-Servers sehen die Konsole live im Dashboard, siehe Konsole. Darin können IP-Adressen von Spielern stehen.

performance

Schlüssel	Standard	Wirkung
`performance.report`	`true`	Schickt einmal pro Minute TPS, MSPT, Speicher, Chunks, Entities und Laufzeit. Daraus entstehen der Verlauf im Dashboard und die Meldung bei niedriger TPS.

error

Schlüssel	Standard	Wirkung
`error.report`	`true`	Meldet Fehler in MC-Sync selbst an die Entwickler: Fehler, Stelle, Loader und Versionen. Netzwerk- und Konfigurationsprobleme meldet es nie. Spielernamen, Chat und IP-Adressen gehen nicht mit.

dev

Schlüssel	Standard	Wirkung
`dev.mode`	`false`	Schreibt jede Anfrage an den Bot ausführlich ins Serverlog. Mit `false` nur Fehler.

http

Ausgehende HTTPS-Anfragen aus Abläufen, mit dem Block „HTTP-Anfrage über den Minecraft-Server“.

Schlüssel	Standard	Wirkung
`http.mode`	`off`	`off`: keine Anfragen. `allow`: nur an die Hosts aus `http.allow`.
`http.allow`	leer	Erlaubte Hosts, etwa `api.example.com`. Ein Host gilt auch für seine Subdomains.

Private und lokale Adressen sind immer gesperrt, auch wenn ein Host aus http.allow auf sie zeigt. Nur https:// ist erlaubt.

flowCommands

Schlüssel	Standard	Wirkung
`flowCommands.enabled`	`true`	Nur Spigot, Paper, Folia. Abläufe dürfen auf dem Server eigene Befehle anlegen. Was diese Befehle ausführen, prüft weiterhin `commands.mode`.

Ist der Name schon vergeben, etwa online, erreichst du den Befehl als /mcsync:online.

flows

Schlüssel	Standard	Wirkung
`flows.mode`	`off`	`off`: Abläufe laufen beim Bot. `on`: Abläufe, die nur diesen Server betreffen, laufen auf dem Server selbst.

Auch dann gelten commands.mode und http.mode. Welche Abläufe in Frage kommen, steht unter Abläufe.