Ein Modul schreiben

Ein Modul läuft im Master. Es sieht das ganze Netzwerk und kann es verändern: Server starten und stoppen, Gruppen bearbeiten, Spielern schreiben, auf Events reagieren und Konsolenbefehle hinzufügen. Das RestModule hinter dem Webpanel ist selbst ein Modul.

Die vollständige Referenz ist die Javadoc der Module-API (auf Englisch).

Projekt einrichten

Füge das rexlCloud-Repository und module-api als compileOnly-Abhängigkeit hinzu, denn der Master enthält sie bereits:

plugins {
    id 'java'
}

repositories {
    mavenCentral()
    maven { url = 'https://repo.rexlcloud.de/snapshots' }
}

dependencies {
    compileOnly 'de.rexlcloud:module-api:2.0.22'
}

java {
    toolchain.languageVersion = JavaLanguageVersion.of(25)
}

module.json

Jede Modul-Jar enthält eine module.json im Hauptverzeichnis (src/main/resources/module.json):

{
  "name": "WelcomeModule",
  "main": "com.example.welcome.WelcomeModule",
  "author": "du",
  "version": "1.0"
}

Die Hauptklasse

Die Hauptklasse erweitert CloudModule:

package com.example.welcome;

import de.rexlcloud.core.api.module.CloudModule;

public class WelcomeModule extends CloudModule {

    @Override
    public void onEnable() {
        getEventManager().registerEvent(new PlayerListener(getModuleApi()));
        getCommandManager().registerCommands(this, new WelcomeCommands(getModuleApi()));
    }

    @Override
    public void onDisable() {
        getCommandManager().unregisterAllCommands(this);
    }

    @Override
    public void onReload() {
    }
}

getDataFolder() ist der eigene Ordner des Moduls, modules/<name>/, für seine Konfiguration.

Events

Listener-Methoden tragen @EventHandler und nehmen genau ein Event:

import de.rexlcloud.core.api.events.EventHandler;
import de.rexlcloud.core.api.events.events.player.PlayerCloudJoinEvent;
import de.rexlcloud.core.api.module.ModuleApi;

public class PlayerListener {

    private final ModuleApi api;

    public PlayerListener(ModuleApi api) {
        this.api = api;
    }

    @EventHandler
    public void onJoin(PlayerCloudJoinEvent event) {
        api.messagePlayer(event.getPlayer().getUuid(), "<aqua>Willkommen im Netzwerk!");
    }
}

Es gibt Events für Spieler (Join, Quit, Serverwechsel), Server (Start, Stop) und Wrapper (verbunden, getrennt); siehe das Paket de.rexlcloud.core.api.events.events.

Konsolenbefehle

import de.rexlcloud.core.command.Argument;
import de.rexlcloud.core.command.CommandDescription;
import de.rexlcloud.core.command.CommandMethod;
import de.rexlcloud.core.api.module.ModuleApi;
import de.rexlcloud.core.console.Console;

public class WelcomeCommands {

    private final ModuleApi api;

    public WelcomeCommands(ModuleApi api) {
        this.api = api;
    }

    @CommandMethod("welcome start <group> <amount>")
    @CommandDescription("Starts servers of a group")
    public void start(@Argument("group") String group, @Argument("amount") int amount) {
        if (!api.start(group, amount)) {
            Console.error("The group %s does not exist", group);
        }
    }
}

Die ModuleApi

getModuleApi() kann alles, was Konsole und Webpanel können. Ein paar Beispiele:

var api = getModuleApi();

api.getServerInfos(null);                 // alle Server als JSON
api.start("BedWars", 2);                  // zwei Server starten
api.execute("Lobby-1", "say Hallo");      // einen Konsolenbefehl ausführen
api.setMaintenance(true);                 // Wartungsmodus für das ganze Netzwerk
api.kickPlayer(uuid, "<red>Tschüss");     // MiniMessage
api.subscribeConsole("Lobby-1", line -> Console.info(line));

Methoden, die etwas ändern, geben ein ModuleApiResult mit Status und Nachricht zurück; Abfragen liefern JSON mit denselben Schlüsseln wie die REST-API.

Installieren

Baue die Jar und kopiere sie in den Ordner modules/ des Masters. Lade sie mit modules load <datei> oder starte den Master neu; modules reload <name> ruft onReload() auf.