# Plugin d'auto whitelist

Le plugin d'auto whitelist nommé AutoWL a été développé par les gestionnaires du bot Discord d'host MC afin de permettre aux gestionnaires de serveur de pouvoir rendre compatible le système de whitelist automatique du bot d'host MC à leur serveur, en à peine quelques minutes de configuration.

Le plugin est disponible dans toutes les versions de Minecraft à partir de la 1.8 sous Spigot ou Paper, que ça soit sur un serveur Linux ou Windows, et n'a besoin d'aucune autre dépendance pour fonctionner. Le plugin est entièrement optimisé et ne causera aucun lag sur votre serveur, les tâches étant réalisées en dehors du thread principal du serveur, les coûts en performance sont dérisoires.

Cette page donne toutes les étapes nécessaires afin de rendre fonctionnel le plugin sur votre serveur.

# Étape 1: Télécharger le plugin et l'ajouter sur votre serveur

Vous pouvez télécharger le plugin en cliquant en dessous, le fichier est très léger, faisant environ 300KB.

Télécharger le plugin d'auto whitelist

autowl.jar

Une fois téléchargé, faites glisser le plugin dans le dossier plugins/ de votre serveur. Vous pouvez accéder à ce dossier en accédant à logiciel de FTP, ou directement via votre explorateur de fichier de votre PC si vous hébergez votre serveur en local.

Si votre serveur est sous Linux et que vous ne possédez pas d'accès FTP, mais seulement un accès au terminal, naviguez via la commande cd vers le dossier plugins/, et réalisez dedans la commande:

wget https://docs.host-mc.fr/files/autowl.jar

# Étape 2: Accéder au fichier de configuration du plugin

Une fois le plugin placé dans le dossier plugins/, vous pouvez redémarrer votre serveur afin que le plugin se charge. Une fois chargé, vous devriez désormais voir apparaître un dossier nommé "AutoWL" dans le dossier plugins/ de votre serveur. Accédez à ce dossier, qui devrait contenir le fichier de configuration config.yml du plugin. Ouvrez le fichier config.yml avec un éditeur de texte pour y accéder.

Le fichier de configuration "config.yml" par défaut devrait contenir ces lignes ci-dessous:

# AutoWL - Liaison de la liste des participants entre votre serveur et le bot Discord d'host MC
# Ce plugin fait office de simple liaison avec le bot d'host MC en communiquant via une API
# et réalise automatiquement les commandes pour ajouter ou retirer des joueurs de la whitelist.
# Modifiez les configurations ci-dessous à votre guise, en pensant à bien indiquer une clé API valide.
# Utilisez la commande /wl setup help en ayant les permissions pour obtenir les commandes disponibles.
# Développé par androzz - Rejoignez le Discord du bot d'host MC: https://discord.gg/3aujpakwPY

# Liste des messages du plugin, vous pouvez les éditer à votre guise.
messages:
  replies:
    noApiKey: "§6[AutoWL] §fAucune clé API n'est configurée, la whitelist automatique §cne peut pas fonctionner§f."
    invalidKey: "§6[AutoWL] §fLa clé API dans la configuration est §cinvalide§f."
    noGameFound: "§6[AutoWL] §fLe code rentré est §cinvalide§f, aucune partie n'a été trouvée."
    ratelimit: "§6[AutoWL] §fLe système réalise §ctrop de requêtes §fà la fois, veuillez attendre quelques secondes."
    successSetup: "§6[AutoWL] §fLa whitelist automatique a été §aactivée §f! La liste des participants est désormais liée."
    alreadyCode: "§6[AutoWL] §fLe code rentré est §adéjà actif §fpour la whitelist automatique actuellement."
    configReload: "§6[AutoWL] §fLa configuration de la whitelist automatique a été §aactualisée§f."
    invalidConfig: "§6[AutoWL] §fLa configuration de la whitelist automatique est §cinvalide§f, celle-ci n'a pas pu être chargée."
    stop: "§6[AutoWL] §fLa whitelist automatique a bien été §cstoppée§f."
    alreadyStopped: "§6[AutoWL] §fLa whitelist automatique est §cdéjà stoppée§f."
  broadcast:
    disableInvalidKey: "§8[§c!§8] §fLa whitelist automatique a été §cdésactivée§f, la clé API n'est plus valide."
    disableGameNotFound: "§8[§c!§8] §fLa whitelist automatique a été §cdésactivée§f, la partie n'existe plus auprès du bot d'host MC."
  help: "§6[AutoWL] §fListe des commandes disponibles:n §f- §6/wl setup <code>§f: Activer la whitelist auton §f- §6/wl setup stop§f: Désactiver la whitelist auton §f- §6/wl setup reload§f: Actualiser la confign §f- §6/wl setup help§f: Obtenir cette page d'aide"

# Il est important que la console de votre serveur puisse exécuter les commandes de whitelist, sinon le plugin ne fonctionnera pas
commands:
  add: "/whitelist add <player>" # Commande pour ajouter un joueur à la whitelist
  remove: "/whitelist remove <player>" # Commande pour retirer un joueur de la whitelist

# Permission nécessaire pour réaliser la commande /wl setup <code>, auquel cas la commande ne sera pas visible.
permission: "*"

# Vous devez indiquer ici une clé API valide, obtenable sur le discord du bot d'host MC en réalisant un ticket
api_key: ""

# Indiquez "true" pour obtenir dans votre console des messages de log des actions de l'auto whitelist
debug: false

Si en ouvrant le fichier config.yml vous obtenez un contenu similaire, alors vous êtes au bon endroit et vous pouvez procéder à l'étape 3 qui vous expliquera à quoi chaque configuration sert, et ce qui est nécessaire de modifier.

# Étape 3: Modifier le fichier de configuration du plugin

En accédant au fichier de configuration nommé config.yml, vous pourrez accéder à toutes les configurations du plugin. Tous les différents messages du plugin sont rédigés sur ce fichier, vous pouvez les modifier librement selon votre souhait, ceux-ci ne sont pas des configurations importantes, donc nous n'allons pas les traiter ici.

Commandes de whitelist: Indiquez les commandes de whitelist de votre serveur

Le plugin utilise des commandes pour ajouter ou retirer des joueurs à la whitelist de votre serveur, par défaut ces commandes sont configurées pour la commande par défaut de Minecraft, mais si vous utilisez un plugin de whitelist, alors la commande pourrait être différente, dès lors vous avez la possibilité de les changer dans la configuration.

Dans la section "commands" du fichier config.yml, modifiez les commandes selon ce dont vous avez besoin:

commands:
  add: "/whitelist add <player>"
  remove: "/whitelist remove <player>"

Si votre plugin utilise la commande raccourcie /wl à la place de /whitelist, alors remplacez les commandes par /wl au lieu de /whitelist dans la configuration.

IMPORTANT: La console de votre serveur doit pouvoir réaliser les commandes de whitelist, si votre plugin réserve la commande de whitelist seulement pour les joueurs, alors le plugin ne pourra pas fonctionner.

Le texte dans chaque commande sera remplacé dynamiquement par le pseudo des joueurs lors de l'exécution des commandes de whitelist.

Permission: Configurez la permission de la commande /wl setup du plugin

Pour fonctionner, le plugin utilise la commande /wl setup ou /whitelist setup, qui est protégée par une permission qui est configurable dans le fichier de configuration.

Dans la section "permission" du fichier config.yml, modifiez la permission selon ce dont vous avez besoin:

permission: "*"

La permission "*" correspond à la permission OP du serveur. Si vous souhaitez laisser seulement les joueurs étant OP à pouvoir utiliser le système de whitelist automatique, alors laissez la permission par défaut.

À noter: Les joueurs n'ayant pas la permission d'effectuer la commande, ne pourront même pas voir la commande échouer, celle-ci sera invisible.

Clé API: Configurez la clé API attribuée à votre serveur pour que le plugin fonctionne

Pour fonctionner, le fichier de configuration doit impérativement obtenir une clé API afin de pouvoir accéder à l'API auprès du bot Discord d'host MC. Sans clé API, votre serveur ne pourra pas s'authentifier auprès de l'API, et le plugin ne pourra pas fonctionner.

Si vous n'avez pas obtenu de clé API, vous devez créer un ticket sur ce serveur Discord dans la catégorie "Demande d'accès à l'API" afin d'obtenir une clé API. Un gestionnaire vous répondra en vous posant quelques questions, puis vous donnera accès à un panel où vous pourrez accéder à votre clé API.

Si vous possédez une clé API, alors dans la section "api_key", rentrez la clé API en faisant attention à ne pas modifier un caractère par défaut:

api_key: "VOTRE CLÉ API ICI"

Il est important de ne pas modifier de caractères, ou de rentrer sans faire exprès un espace, auquel cas la clé API sera invalide et les requêtes seront refusées, le plugin ne pourra pas fonctionner avec une erreur.

Une fois que vous avez configuré les 3 configurations nécessaires au bon fonctionnement du plugin, vous êtes prêts ! Réalisez la commande /wl setup reload afin de recharger votre fichier de configuration, et le plugin sera prêt !

Lors d'une partie, récupérez la commande de whitelist automatique dans le salon modération, et réalisez la commande /wl setup code sur votre serveur, et la magie devrait opérer en réalisant automatiquement la whitelist de votre serveur.

Liste des commandes disponibles du plugin:

/wl setup code: Activer la whitelist automatique avec une partie
/wl setup stop: Stopper la whitelist automatique en cours
/wl setup reload: Recharger le fichier de configuration du plugin
/wl setup help: Afficher en jeu cette liste de commandes disponibles

Seules les personnes ayant la permission configurée dans le fichier de configuration peuvent réalisées la commande, et la console de votre serveur ne peut pas exécuter les commandes ci-dessus, seul un joueur ayant la permission peut réaliser les commandes.

# Dépannage rapide en cas de problème ou d'erreur

Utilisez la commande /plugins sur votre serveur, et vérifiez si le plugin AutoWL est affiché.

Si le plugin n'apparaît pas, vérifiez si vous avez bien placé le fichier dans le dossier plugins/ de votre serveur.
Si le plugin apparaît, mais est affiché en rouge, alors un problème a été rencontré au démarrage, contactez un gestionnaire sur ce serveur Discord pour qu'il puisse vous aider à fixer votre problème.
Si le plugin apparaît et est affiché en vert, alors aucun problème n'a été rencontré, et le plugin est bien chargé sur votre serveur. Si vous ne pouvez pas réaliser les commandes /wl setup, vérifiez que vous êtes bien OP pour réaliser les commandes.

Si le plugin vous renvoie une erreur comme quoi la configuration de la whitelist automatique est invalide, cela veut dire que le fichier config.yml du plugin a mal été formatté. Vous pouvez utiliser le site https://yamlchecker.com/ pour copier coller le contenu de votre fichier, le site pourra vous indiquer avec précision s'il y a un problème de format dans votre fichier. Si vous avez besoin d'aide concernant le format de votre fichier, vous pouvez contacter un gestionnaire sur ce serveur Discord pour qu'il puisse vous aider

Si le plugin vous renvoie une erreur comme quoi votre clé API est invalide, vérifiez dans votre fichier de configuration config.yml que la clé API indiquée est valide. Contactez un gestionnaire sur ce serveur Discord pour qu'il puisse vous aider si même après vérification le problème persiste.

Si les commandes de whitelist ne se réalisent pas, tout en bas du fichier de configuration config.yml, remplacez "debug: false" par "debug: true" afin d'activer le mode debug. Réalisez la commande /wl setup reload afin de recharger la configuration, et consultez désormais les messages envoyés dans la console par le plugin. Vous devriez voir les messages comme quoi le plugin récupère la liste des participants avec les pseudos, et les commandes exécutées. Si même après cela vous ne comprenez pas d'où peut venir le problème, contactez un gestionnaire sur ce serveur Discord en lui envoyant les messages de debug du plugin afin qu'il puisse vous aider.