ZentrixAPI

Developer API for creating Zentrix Battle Royale addons. Version 1.5.0 adds LocaleService for addon-safe access to Zentrix locale messages and text formatting while retaining the 1.4.0 binary surface.

Resources

• Developer API Wiki - Full documentation
• Javadocs - API reference
• Example Addon - Working example

Features

• Query games, players, teams, phases, and stats
• React to gameplay via events
• Register custom recipes with craft limits
• Store addon data under plugins/Zentrix/addons/<addon-id>/
• Resolve copied game-* instances and their waiting, Nether, and deathmatch worlds
• Query and control Nether access, deathmatch startup, force-start, and dynamic game rules
• Use party and runtime-game-scoped chat services

Installation

Gradle (Kotlin DSL)

repositories {
maven("https://jitpack.io")
}
dependencies {
compileOnly("com.github.ItsHarshXD:ZentrixAPI:1.5.0")
}

Gradle (Groovy)

repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
compileOnly 'com.github.ItsHarshXD:ZentrixAPI:1.5.0'
}

Maven

<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<dependency>
<groupId>com.github.ItsHarshXD</groupId>
<artifactId>ZentrixAPI</artifactId>
<version>1.5.0</version>
<scope>provided</scope>
</dependency>

Quick Start

1. Create Your Addon

publicfinalclassMyAddonextendsZentrixAddon {
@OverrideprotectedvoidonAddonEnable() {
// Access the APIZentrixAPIapi = ZentrixAPI.get();
// Use servicesapi.getGameService().getActiveGames();
// Register listenersgetServer().getPluginManager().registerEvents(newMyListener(), this);
}
}

2. Add plugin.yml

name: MyAddonversion: 1.0.0main: com.example.myaddon.MyAddondepend: [Zentrix]api-version: '1.21'

3. Use the API Anywhere

// Single, simple way to access the APIZentrixAPIapi = ZentrixAPI.get();
api.getGameService().getActiveGames();
api.getCurrencyService().getBalance(player);

API	Compatible plugin	Notes
1.1.x	Zentrix 1.2.x+	Legacy services
1.3.0	1.3.0-capable development builds	Runtime worlds and typed controls
1.4.0	1.4.0+	Dynamic sources and atomic matchmaking
1.5.0	1.5.0+	LocaleService for addon text formatting

Requirements

• Java 21+
• Paper 1.21.9-.1.21.10
• Zentrix plugin

License

All Rights Reserved