Learn how to use the EternalCore API in your own plugins.
This documentation page was created by volunteers. Learn how to contribute
Recent editors for this page
Latest edits
Expand to view recent commits.
We support developers who want to create their own plugins using our API. We provide a simple and easy-to-use API.
To use our API, you need to install the correct artifact. Our plugin supports Maven, Gradle Kotlin, Gradle Groovy, and SBT. Check the Maven Repository for the latest release.
You must add EternalCore as a dependency in your plugin.yml or paper-plugin.yml file.
Create an instance of EternalCoreAPI:
EternalCoreAPI eternalCoreAPI = EternalCoreApiProvider.provide();
| Class | Provide method |
|---|---|
| AfkService | getAfkService() |
| SpawnService | getSpawnService() |
| CatboyService | getCatboyService() |
| TeleportService | getTeleportService() |
| RandomTeleportService | getRandomTeleportService() |
public class YourPlugin extends JavaPlugin {
private EternalCoreApi eternalCoreApi;
private AfkService afkService;
@Override
public onEnable() {
this.eternalCoreApi = EternalCoreProvider.provide();
this.afkService = eternalCoreApi.getAfkService();
}
}
Check if player is AFK:
if (afkService.isAfk(player.getUniqueId())) {
// Player is AFK
}
Mark player as AFK:
if (!afkService.isAfk(player.getUniqueId())) {
Afk afkPlayer = afkService.markAfk(player.getUniqueId(), AfkReason.PLUGIN);
}
if (player.getName().equals("Rollczi")) {
catboyService.markAsCatboy(player, Cat.Type.BLACK);
}