Documentation Owners

Installation du Plugin

Installez l'Agent LeavePulse sur Paper, Spigot, Folia, Velocity, Bungee, Waterfall, Fabric ou NeoForge et connectez-le à LeavePulse.

Sur cette page
  1. Pourquoi installer l'Agent
  2. Agent connecté ou non connecté
  3. Où télécharger l'Agent
  4. Plateformes prises en charge
  5. Installation sur Proxy ou Backend
  6. Processus d'installation
  7. Préfixes de commande par plateforme
  8. Emplacement de la configuration générée
  9. Reconnexion d'un serveur
  10. Étape suivante

L'Agent LeavePulse est le plugin ou mod côté serveur qui connecte votre serveur Minecraft à LeavePulse. Il rapporte la télémétrie, maintient la connexion de la passerelle (gateway) active, et permet les flux de liste blanche et de modération.

Pourquoi installer l'Agent

Sans l'Agent, LeavePulse peut toujours afficher les informations publiques que vous avez saisies sur le site web. Avec l'Agent connecté, LeavePulse peut interagir avec l'environnement d'exécution Minecraft réel.

L'Agent est utilisé pour :

  • Propriété et connexion : échanger le code de connexion du site web, enregistrer le server_id lié, configurer le jeton de la passerelle et inscrire l'environnement de vérification.
  • Télémétrie en direct : envoyer le nombre de joueurs en ligne/maximum, le MOTD, le favicon si disponible, la version de Minecraft, l'état de santé de la JVM/de l'environnement d'exécution, les compteurs de temps de jeu, l'état de maintenance et des données supplémentaires de plateforme sélectionnées.
  • Fonctionnalités de la passerelle : garder une session WebSocket ouverte afin que LeavePulse puisse synchroniser l'état de la liste blanche, pousser des actions de modération, demander des aperçus (snapshots), contrôler la maintenance et mettre à jour les champs de présentation pris en charge tels que le MOTD ou l'avatar.
  • Application de la liste blanche : appliquer les décisions LeavePulse dans Minecraft via un kick (expulsion) ou un restrict (restriction), importer le fichier vanilla whitelist.json, et permettre aux modérateurs d'examiner les candidatures en jeu.
  • Liaison de compte : permettre aux joueurs de soumettre des codes de vérification en jeu afin de faire correspondre les profils du site web, les candidatures sur liste blanche et les identités Minecraft.
  • Diagnostics : produire un rapport JSON avec des vérifications de la passerelle, du jeton, du réseau, de l'inscription, de la liste blanche, du système de fichiers, du planificateur et des commandes.
  • Intégrations optionnelles : relayer le chat/les événements Discord lorsqu'ils sont configurés, exposer les espaces réservés (placeholders) LeavePulse, synchroniser les rôles d'équipe adossés à LuckPerms s'ils sont disponibles, et préparer des mises à jour de plugin en toute sécurité.

Agent connecté ou non connecté

L'Agent peut démarrer et fonctionner avant d'être lié à LeavePulse. Dans cet état, il peut générer la configuration, enregistrer les commandes locales, afficher l'état et les diagnostics, gérer l'état local des mises à jour et attendre un code de connexion.

Tant qu'il n'est pas connecté, il ne publie pas la télémétrie vérifiée sur le site, n'ouvre pas de session gateway authentifiée, ne synchronise pas la liste blanche ou l'état des candidatures, ne finalise pas l'inscription de liaison de compte et n'accepte pas les actions de modération distantes.

Où télécharger l'Agent

Pour une installation manuelle, téléchargez d'abord l'Agent depuis Modrinth. Le flux de configuration serveur de LeavePulse inclut une carte de téléchargement qui lit Modrinth en premier et vous aide à choisir le bon build de plateforme : ouvrez votre workspace, ajoutez ou ouvrez un serveur, choisissez Verify via LeavePulse Agent, puis comparez la carte avec le build Modrinth que vous installez.

La carte n'utilise LeavePulse update-service en fallback que lorsque Modrinth ne peut pas fournir de build utilisable. Elle affiche aussi le canal de release, la plateforme, la version, le nom du fichier et le checksum. Les règles complètes sont dans Téléchargements de l'Agent.

Plateformes prises en charge

Utilisez l'artefact qui correspond au processus de serveur sur lequel vous souhaitez que LeavePulse s'exécute :

  • Paper, Spigot ou Folia pour les serveurs autonomes compatibles Bukkit.
  • Velocity pour les réseaux proxy Velocity.
  • BungeeCord ou Waterfall pour les réseaux proxy compatibles Bungee.
  • Fabric pour les serveurs Fabric.
  • NeoForge pour les serveurs NeoForge.

Installation sur Proxy ou Backend

Pour un serveur Paper, Spigot, Folia, Fabric ou NeoForge unique, installez l'artefact serveur normal sur ce serveur.

Pour un réseau Velocity ou BungeeCord/Waterfall, installez l'artefact proxy sur le proxy lorsque vous souhaitez que LeavePulse représente le point d'entrée du réseau, centralise les fonctionnalités de la passerelle et relaie les métriques des backends mappés. Installez également des artefacts backend uniquement lorsqu'un backend a besoin de sa propre télémétrie locale, d'un comportement de liste blanche spécifique ou d'une surface de modération propre au serveur.

Si les agents proxy et backend sont tous deux installés, connectez chaque environnement d'exécution au bon enregistrement de serveur LeavePulse. Ne réutilisez pas un jeton ou un fichier de configuration entre eux.

Processus d'installation

  1. Téléchargez l'artefact LeavePulse Agent pour votre plateforme depuis Modrinth, en utilisant la carte de téléchargement du site pour confirmer la plateforme et le checksum.
  2. Arrêtez le serveur Minecraft ou le proxy.
  3. Placez l'artefact dans le dossier habituel de plugins ou de mods de la plateforme.
  4. Démarrez le serveur une fois afin que le fichier de configuration soit généré.
  5. Dans LeavePulse, ouvrez l'écran de configuration du serveur et copiez le code de connexion.
  6. Exécutez la commande de connexion de la plateforme depuis la console du serveur ou un compte opérateur.

Utilisez ceci sur les builds serveur Paper, Spigot, Folia, Fabric ou NeoForge.

Commande de connexion
/leavepulse connect CONNECT_CODE

Alias court : /lpa

  1. Exécutez la commande d'état de la plateforme et confirmez que le serveur a un statut de transport de passerelle.
  2. Exécutez une exportation de diagnostics et conservez le rapport généré si quelque chose ne semble pas correct.

La configuration générée existe pour que l'agent puisse persister son état. Vous n'avez normalement pas besoin de l'ouvrir pendant la configuration.

Préfixes de commande par plateforme

La commande racine diffère entre les versions de serveur normales et les versions proxy :

EnvironnementCommande racineAlias court
Paper, Spigot, Folia, Fabric, NeoForge/leavepulse/lpa
Velocity/leavepulsevelocity/lpav
BungeeCord, Waterfall/leavepulsebungee/lpabg

Ainsi, la commande de connexion est /leavepulse connect <code> sur Paper, Spigot, Folia, Fabric ou NeoForge ; /leavepulsevelocity connect <code> sur Velocity ; et /leavepulsebungee connect <code> sur BungeeCord ou Waterfall. Consultez aussi Compatibilité du plugin si vous hésitez entre proxy et backend.

Après la connexion, exécutez :

Utilisez ceci sur les builds serveur Paper, Spigot, Folia, Fabric ou NeoForge.

Commande de statut
/leavepulse status

Alias court : /lpa

Utilisez ceci sur les builds serveur Paper, Spigot, Folia, Fabric ou NeoForge.

Export diagnostics
/leavepulse diagnostics export

Alias court : /lpa

Remplacez /leavepulse par la commande racine du proxy lorsque l'agent est installé sur Velocity ou BungeeCord/Waterfall.

Emplacement de la configuration générée

Le fichier de configuration est nommé leavepulse-verified avec l'extension sélectionnée par le système de configuration de la plateforme. Sur les environnements Bukkit, Velocity et de type Bungee, il est généré sous le répertoire de données de plugin ou de configuration de cette plateforme. Sur Fabric et NeoForge, il est généré sous le répertoire de configuration du chargeur (loader).

Utilisez la configuration pour la récupération et les réglages avancés, pas pour la première liaison normale. Si la configuration contient un gateway.token, traitez-le comme un secret.

Reconnexion d'un serveur

Si le plugin est déjà lié à un autre serveur LeavePulse, /leavepulse connect <code> affichera un avertissement avant de modifier la liaison. Ré-exécutez avec confirm uniquement lorsque vous en êtes sûr :

Serveur Paper, Spigot, Folia, Fabric ou NeoForge
/leavepulse connect CONNECT_CODE confirm

Utilisez la commande racine de proxy correspondante sur Velocity ou BungeeCord/Waterfall.

Étape suivante

Lisez Configuration du plugin avant de modifier manuellement les valeurs générées.