Comment créer un plugin BungeeCord

Étape par étape

1. 1.Vérifiez le proxy que vous utilisez

   BungeeCord (ou un fork comme Waterfall) et Velocity sont des API différentes. Un plugin BungeeCord ne tourne pas sur Velocity, et inversement.

2. 2.Configurez le projet

   Un projet Maven ou Gradle avec la dépendance bungeecord-api dans la portée provided. Le proxy la fournit à l'exécution.

3. 3.Écrire la classe principale

   Une classe qui étend net.md_5.bungee.api.plugin.Plugin, avec onEnable() pour enregistrer les commandes et les écouteurs via getProxy().getPluginManager().

4. 4.Décrivez-le dans bungee.yml

   name, version, main et author. BungeeCord lit aussi plugin.yml, mais bungee.yml évite la confusion avec les plugins Spigot. Les commandes sont enregistrées dans le code, pas dans le fichier.

5. 5.Écrire les commandes et les écouteurs

   Les commandes étendent Command ; les écouteurs implémentent Listener avec des méthodes @EventHandler pour des événements comme PostLoginEvent ou ServerSwitchEvent.

6. 6.Communiquez avec les serveurs backend si besoin

   Le proxy ne voit ni les inventaires ni les mondes. Pour cela, un petit plugin compagnon sur chaque serveur backend échange des plugin messages avec le plugin du proxy.

7. 7.Installez-le sur le proxy

   Placez le .jar dans le dossier plugins/ du proxy et redémarrez le proxy, pas les serveurs backend.

Événements utiles du proxy

Bien configurer le réseau

• Activez ip_forward dans le config.yml du proxy et bungeecord: true dans le spigot.yml de chaque serveur Spigot ou Paper, pour que les pseudos et UUID des joueurs soient transmis.
• Réglez les serveurs backend sur online-mode=false et assurez-vous qu'ils ne sont pas accessibles directement depuis Internet, seulement via le proxy.
• Les plugin messages ne circulent que lorsqu'un joueur est connecté à ce serveur backend, donc un message envoyé à un serveur vide n'est pas livré.

Exemple de description

« Un plugin proxy BungeeCord 1.21 appelé NetUtils. /lobby envoie le joueur sur le serveur lobby. /staffchat <message> (alias /sc) envoie un message à toutes les personnes ayant netutils.staff, sur n'importe quel serveur. /maintenance on|off affiche un MOTD de maintenance et expulse les joueurs sans netutils.bypass. Un message dans le chat staff quand un membre du staff change de serveur. Noms des serveurs, MOTD et messages dans config.yml. »

Avec Codexe

Choisissez le type BungeeCord/Velocity et indiquez le proxy que vous utilisez, car ce sont des API différentes. Codexe compile le plugin avec Maven et vérifie que le .jar a le bon descripteur avant qu'il soit prêt ; sans version dans la demande, c'est l'API BungeeCord 1.21 qui est utilisée. Si vous avez besoin d'un compagnon backend, demandez-le comme projet Spigot/Paper séparé.

Tester maintenant ne lance pas encore de serveurs proxy, alors testez le plugin proxy sur votre propre réseau ou sur un proxy local avec un serveur backend. Voir aussi le générateur de plugins BungeeCord.

Questions