Plugin-API
Je eigen plugins lezen het netwerk uit via de Atlas-API. Ze zien elke draaiende server met zijn spelers en metadata, publiceren metadata over hun eigen server, en horen wanneer servers komen en gaan. De volledige referentie staat op javadoc.io.
De dependency toevoegen
Een Paper-, Velocity- of BungeeCord-plugin compileert tegen atlas-api en krijgt die tijdens het draaien van de Atlas-plugin, dus het is een compile-only dependency:
dependencies {
compileOnly("gg.getatlas:atlas-api:0.1.1-beta.5")
}Beide bibliotheken staan op Maven Central, dus je hebt geen extra repository nodig.
Minestom-servers
Een Minestom-server voegt in plaats daarvan atlas-minestom toe, die atlas-api meebrengt. De Atlas-plugin laat zien hoe je die start.
De API ophalen
Zet op Paper de Atlas-plugin als afhankelijkheid in plugin.yml met depend: [Atlas] en haal de API op uit de services manager:
Atlas atlas = this.getServer()
.getServicesManager()
.load(Atlas.class); Op Velocity en BungeeCord geeft de Atlas-plugin hem via zijn eigen instantie met atlas(). Op Minestom geeft AtlasMinestom.start() hem terug.
Servers
servers() is een actuele weergave van elke draaiende server in het netwerk. Die volgt het paneel vanzelf.
for (AtlasServer server : atlas.servers().inGroup("lobby")) {
int online = server.players().online();
this.getLogger().info(server.name() + ": " + online + " players");
} Elke AtlasServer heeft zijn id, zijn naam, zijn groep, zijn privéadres, zijn spelers en zijn metadata. Zoek één server met byId of named, of vraag ze allemaal op met all().
Deze server
self() is de server waarop je plugin draait. Zijn id is leeg tot de worker voor het eerst verbindt, en connected() zegt of de worker er nu is.
Map-setup
setup() bevat de map-setup op een setupserver en is overal anders leeg. map() is de naam van de map zoals de bouwer hem typte, en finish() bewaart de setupbestanden in het concept, stuurt de bouwer terug en stopt de server. Twee keer finish() aanroepen bewaart niets nieuws. Zie Map-deploys.
Metadata
Een server publiceert benoemde waarden over zichzelf, zoals de map die hij draait. Elke server in het netwerk kan ze lezen, en het paneel toont ze.
atlas.self().metadata().set("map", "dunes"); Een sleutel is tot 64 kleine letters, cijfers, punten, streepjes of underscores, en een waarde tot 256 tekens. Eén server heeft hoogstens 64 sleutels.
Wil je meerdere waarden tegelijk veranderen, geef ze dan aan update. Het netwerk ziet alle wijzigingen samen of geen enkele, dus geen server leest ooit een halve update.
atlas.self().metadata().update(changes -> changes
.set("map", "dunes")
.set("alive", 2)
.remove("winner")
.phase(GamePhase.IN_ROUND)); Getallen worden als tekst opgeslagen, dus set("alive", 2) bewaart "2". Breekt één wijziging een regel, dan gooit update een fout en verandert er niets.
Spelfase
Een minigame vertelt Atlas waar hij in zijn ronde is. Atlas stopt nooit een server die midden in een ronde zit, dus afschalen wacht tot de ronde voorbij is.
atlas.self().phase(GamePhase.IN_ROUND); De fases zijn WAITING, IN_ROUND en ENDING. Een server die er geen zet, telt als wachtend.
Events
Luister naar ServerAdded, ServerUpdated en ServerRemoved, of naar ServerEvent om ze alle drie te horen:
Subscription joined = atlas.events().on(ServerAdded.class, event ->
this.getLogger().info(event.server().name() + " joined")); Events komen één voor één binnen, in de volgorde waarin ze gebeurden, op de eigen thread van Atlas. Geef traag werk door aan de scheduler van je platform, en sluit het abonnement als je plugin stopt.