Référence

Config

Chaque réglage du plugin et du mod MC-Sync, avec sa valeur par défaut et son effet.

Le fichier est créé au premier démarrage du serveur. Plugin et mod partagent les mêmes réglages dans deux notations : api: → token: en YAML devient api.token= dans le fichier properties. Deux réglages n'existent que sur Spigot, Paper et Folia.

ServeurFichier
Spigot, Paper, Foliaplugins/mc-sync/config.yml
Fabric, Quilt, Forge, NeoForgeconfig/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

Les listes vont entre crochets en YAML et sont séparées par des virgules dans le fichier properties. En YAML, mets "off" et "on" entre guillemets.

Recharger ou redémarrer

/mcsync reload relit le fichier. Ces réglages s'appliquent tout de suite :

  • commands.mode, commands.allow et commands.consoleFallback
  • performance.report, error.report et dev.mode

Ceux-ci nécessitent un redémarrage :

  • api.token
  • queue.*, update.mode, console.live, http.mode, http.allow et flows.mode
  • flowCommands.enabled. Après un rechargement, il ne s'applique qu'une fois que les commandes changent dans le tableau de bord.

S'il manque un réglage dans un fichier plus ancien, MC-Sync l'ajoute avec sa valeur par défaut au démarrage et lors de /mcsync reload. Les valeurs existantes restent telles quelles, et l'ancien fichier est conservé à côté sous le nom config.yml.bak-… ou mc-sync.properties.bak-….

api

CléPar défautEffet
api.tokenYOUR_API_TOKENLe jeton du tableau de bord ou de /server add. L'espace réservé compte comme vide.

Sur Fabric, Quilt, Forge et NeoForge, le mod lit le jeton dans la variable d'environnement MC_SYNC_TOKEN quand le fichier n'en contient pas. Comment obtenir un jeton est expliqué dans Synchro du chat.

queue

Tant que Discord est injoignable, le chat, les arrivées et les morts attendent sur le disque : dans plugins/mc-sync/queue/ ou config/mc-sync-queue/. Ils survivent à un redémarrage et partent ensuite dans leur ordre d'origine.

CléPar défautEffet
queue.maxAgeMinutes60Combien de temps un événement attend, en minutes. De 1 à 1440. Les plus anciens sont abandonnés.
queue.maxEvents10000Combien d'événements attendent au maximum. Au-delà, les plus anciens sont abandonnés. 100000 au maximum.
queue.maxSizeMb10Combien d'espace disque prennent les événements en attente, en Mo. Au-delà, les plus anciens sont abandonnés. 1024 au maximum.

Une valeur au-dessus de la limite compte comme la limite. 0, une valeur vide ou du texte compte comme la valeur par défaut.

update

CléPar défautEffet
update.modenotifynotify signale une nouvelle version dans le journal du serveur et dans /mcsync status. off désactive la vérification.

Seules les versions pour la version Minecraft du serveur sont prises en compte. MC-Sync ne télécharge jamais rien lui-même ; tu remplaces le fichier à la main.

commands

Quelles commandes le serveur Minecraft accepte depuis Discord, le tableau de bord et les flux. Qui peut envoyer des commandes depuis Discord se règle là-bas, voir Commandes depuis Discord.

CléPar défautEffet
commands.modewhitelistoff : aucune commande. whitelist : seulement whitelist add, whitelist remove et whitelist list. allow : la whitelist plus tout ce qui est dans commands.allow. all : toutes les commandes.
commands.allowvideCommandes supplémentaires pour allow. Une entrée correspond au début de la commande, mot par mot. * remplace exactement un mot.
commands.consoleFallbackfalseSpigot, Paper, Folia uniquement. Si une commande de plugin refuse la console que MC-Sync utilise pour capter la sortie, true l'exécute une nouvelle fois sur la vraie console, sans sortie. Elle peut alors s'exécuter deux fois.

Avec lp user * parent add, lp user Notch parent add vip fonctionne, lp user Notch parent remove vip non.

console

CléPar défautEffet
console.livetrueLes admins du serveur Discord connecté peuvent suivre la console en direct dans le tableau de bord, voir Console. Elle peut contenir les adresses IP des joueurs.

performance

CléPar défautEffet
performance.reporttrueEnvoie TPS, MSPT, mémoire, chunks, entités et durée de fonctionnement une fois par minute. Cela alimente le graphique du tableau de bord et la notification de TPS faibles.

error

CléPar défautEffet
error.reporttrueSignale les pannes de MC-Sync lui-même à ses développeurs : l'erreur, où elle s'est produite, le loader et les versions. Les problèmes de réseau et de config ne sont jamais signalés. Les noms des joueurs, le chat et les adresses IP ne sont pas envoyés.

dev

CléPar défautEffet
dev.modefalseÉcrit chaque requête au bot en détail dans le journal du serveur. Avec false, seulement les erreurs.

http

Requêtes HTTPS sortantes des flux, avec le bloc « Requête HTTP via le serveur Minecraft ».

CléPar défautEffet
http.modeoffoff : aucune requête. allow : seulement vers les hôtes de http.allow.
http.allowvideHôtes autorisés, comme api.example.com. Un hôte couvre aussi ses sous-domaines.

Les adresses privées et locales sont toujours bloquées, même quand un hôte de http.allow pointe vers l'une d'elles. Seul https:// est autorisé.

flowCommands

CléPar défautEffet
flowCommands.enabledtrueSpigot, Paper, Folia uniquement. Les flux peuvent créer leurs propres commandes sur le serveur. Ce que ces commandes exécutent reste vérifié par rapport à commands.mode.

Si le nom est déjà pris, par exemple online, tu atteins la commande sous /mcsync:online.

flows

CléPar défautEffet
flows.modeoffoff : les flux tournent chez le bot. on : les flux qui ne concernent que ce serveur tournent sur le serveur lui-même.

commands.mode et http.mode s'appliquent toujours. Les flux concernés sont décrits dans Flux.