Configuration

Référence de config.yml #

CléPar défautSignification
languageenLangue de tous les messages et des explications des constats : en, tr, es, de, fr ou ru. Les explications des constats utilisent la même langue ; les codes et les gravités restent en anglais.
auto-scan-on-startuptrueLance automatiquement une analyse complète quelques secondes après la fin du démarrage du serveur.
auto-scan-delay-seconds5Durée d'attente après le démarrage avant l'exécution de l'analyse automatique.
report.save-to-filetrueEnregistre le rapport complet de chaque analyse dans plugins/PluginGuard/reports/.
report.default-formattxtFormat utilisé pour le fichier de rapport enregistré automatiquement : txt, json, yaml, md ou html.
report.keep-last30Nombre de rapports enregistrés à conserver dans plugins/PluginGuard/reports/ ; les plus anciens sont supprimés. 0 conserve tout.
discord-webhook-url(vide)Si défini, PluginGuard publie un court message sur ce webhook Discord lorsqu'une analyse trouve des problèmes CRITICAL. Vide = désactivé ; rien n'est jamais envoyé à moins que vous ne le définissiez vous-même.
show-optional-dependenciesfalseLes listes du chat et de la console omettent les notes sur les dépendances facultatives manquantes (MISSING_SOFT_DEPENDENCY), normales sur presque tous les serveurs ; une ligne indique combien ont été omises. Le rapport enregistré et /pluginguard export les contiennent toujours. true = les liste partout.
discord-only-new-findingstrueN'annonce que les constats critiques qui n'ont pas déjà été annoncés (mémorisés dans discord-state.txt). false = annonce à chaque analyse comportant des constats critiques.
integrations.plugin-updates.enabledfalseRecherche des versions plus récentes de vos plugins (UPDATE_AVAILABLE, niveau info). Voir « Vérification des mises à jour » ci-dessous pour ce que chaque source peut ou ne peut pas reconnaître.
integrations.plugin-updates.modrinthtrueAvec la vérification des mises à jour activée : identifie les plugins sur Modrinth par l'empreinte du fichier. Envoie à api.modrinth.com, à chaque analyse, l'empreinte SHA-1 de chaque jar de plugin et votre version de Minecraft - rien d'autre.
integrations.plugin-updates.spigotmctrueAvec la vérification des mises à jour activée : recherche les plugins qui indiquent leur page spigotmc.org comme website dans plugin.yml (via le miroir public Spiget). Seul le numéro de la ressource est envoyé.
integrations.plugin-updates.builtbybit-api-token(vide)Votre propre jeton d'API « Shared » BuiltByBit. Avec lui, les plugins qui indiquent leur page builtbybit.com dans plugin.yml sont aussi vérifiés. Vide = BuiltByBit est ignoré.
ignore[]Une liste de règles "CODE:PluginName" (ou "CODE:*" / "*:PluginName") pour faire taire définitivement des constats précis que vous avez examinés et acceptés.
checks.*tous trueDésactive une catégorie entière de vérification si elle ne s'applique pas à votre installation : java-version, api-version, dependencies, shaded-library-collision, native-library-duplicate, sqlite-jni-relocation, command-collision, bundled-server-api, loaded-state.
integrations.update-checker.*désactivéNotification facultative de mise à jour BuiltByBit ; nécessite votre propre jeton d'API « Shared », jamais un jeton Private.

Vérification des mises à jour #

Activez-la avec integrations.plugin-updates.enabled: true. Chaque analyse se termine alors par une ligne indiquant combien de vos jar de plugins ont pu être associés, et chaque plugin obsolète reçoit un constat UPDATE_AVAILABLE avec un lien.

Ce qui peut être associé et ce qui ne le peut pas :

  • Modrinth : correspondance exacte par empreinte de fichier. Tout plugin (et fichier exact) publié sur Modrinth est reconnu.
  • SpigotMC et BuiltByBit : il n'existe aucun moyen d'identifier un jar à partir de son fichier, et PluginGuard ne devine jamais les plugins d'après leur nom (une mauvaise supposition signalerait une « mise à jour » pour un autre plugin). Un plugin n'est vérifié que lorsque son propre plugin.yml contient un lien website: vers sa page spigotmc.org ou builtbybit.com. Les plugins qui n'en indiquent pas - nombreux sont dans ce cas - restent non vérifiés, tout comme les plugins qui ne sont publiés sur aucun de ces sites (par exemple ceux vendus ailleurs).
  • Les numéros de version sont comparés comme des nombres (1.9 est plus ancien que 1.10). Les versions qui ne peuvent pas être lues comme des nombres ne sont jamais signalées.
  • Ces sites n'indiquent pas quelles versions de Minecraft une mise à jour prend en charge ; lisez donc la page du plugin avant de mettre à jour.
  • Les réponses de SpigotMC et de BuiltByBit sont mises en cache quelques heures ; une analyse effectue au plus 40 requêtes de ce type et abandonne au bout d'environ 25 secondes. Les jar de plugins ne sont jamais envoyés nulle part.

Langues #

Les constats, les messages des commandes et les rapports exportés utilisent le language de config.yml (en, tr, es, de, fr, ru). Les codes de constat (par exemple SQLITE_JNI_RELOCATED) et les gravités restent toujours en anglais afin que les règles d'ignorance, les demandes d'assistance et les résultats de recherche aient le même aspect sur tous les serveurs. Chaque constat dit ce qui ne va pas, quand cela compte et que faire. Vous pouvez modifier les textes dans plugins/PluginGuard/lang/ ; un texte absent de votre fichier est repris de la copie contenue dans le jar.