Een BungeeCord-plugin maken

Stap voor stap

1. 1.Controleer welke proxy je draait

   BungeeCord (of een fork zoals Waterfall) en Velocity zijn verschillende API's. Een BungeeCord-plugin draait niet op Velocity, en andersom ook niet.

2. 2.Zet het project op

   Een Maven- of Gradle-project met de dependency bungeecord-api in scope provided. De proxy levert die tijdens het draaien.

3. 3.Schrijf de hoofdklasse

   Een klasse die net.md_5.bungee.api.plugin.Plugin uitbreidt, met onEnable() om commando's en listeners te registreren via getProxy().getPluginManager().

4. 4.Beschrijf hem in bungee.yml

   name, version, main en author. BungeeCord leest ook plugin.yml, maar bungee.yml voorkomt verwarring met Spigot-plugins. Commando's worden in de code geregistreerd, niet in het bestand.

5. 5.Schrijf commando's en listeners

   Commando's breiden Command uit; listeners implementeren Listener met @EventHandler-methoden voor events zoals PostLoginEvent of ServerSwitchEvent.

6. 6.Communiceer zo nodig met backendservers

   De proxy kan geen inventories of werelden zien. Daarvoor wisselt een kleine begeleidende plugin op elke backendserver plugin messages uit met de proxyplugin.

7. 7.Installeer hem op de proxy

   Zet de .jar in de map plugins/ van de proxy en herstart de proxy, niet de backendservers.

Handige proxy-events

Het netwerk goed opzetten

• Zet ip_forward aan in de config.yml van de proxy en bungeecord: true in de spigot.yml van elke Spigot- of Paper-server, zodat spelersnamen en UUID's worden doorgegeven.
• Zet de backendservers op online-mode=false en zorg dat ze niet rechtstreeks vanaf het internet bereikbaar zijn, alleen via de proxy.
• Plugin messages gaan alleen over zolang er een speler met die backendserver verbonden is, dus een bericht naar een lege server wordt niet afgeleverd.

Voorbeeldbeschrijving

"Een BungeeCord 1.21-proxyplugin genaamd NetUtils. /lobby stuurt de speler naar de lobbyserver. /staffchat <message> (alias /sc) stuurt een bericht naar iedereen met netutils.staff op elke server. /maintenance on|off toont een onderhouds-MOTD en kickt spelers zonder netutils.bypass. Een joinbericht in de staffchat als een stafflid van server wisselt. Servernamen, MOTD en berichten in config.yml."

Met Codexe

Kies het type BungeeCord/Velocity en zeg welke proxy je draait, want het zijn verschillende API's. Codexe compileert de plugin met Maven en controleert of de .jar de juiste descriptor heeft voordat hij Klaar is; zonder versie in het verzoek wordt de BungeeCord-API 1.21 gebruikt. Heb je een begeleidende backendplugin nodig, vraag die dan aan als apart Spigot/Paper-project.

Probeer het nu draait nog geen proxyservers, dus test de proxyplugin op je eigen netwerk of een lokale proxy met één backendserver. Zie ook de BungeeCord-plugingenerator.

Vragen