API

Repository & Dependencies

repositories {
    maven("https://repo.nexomc.com/releases")
}

dependencies {
    compileOnly("com.nexomc:nexo:<version>") //Nexo 1.X -> 1.X.0
}

Add Nexo-support to your plugin

Repository & Dependency Info

You can find the repository and dependency notice here.

All methods and better explanations of their functionality and parameters can be found in the actual Classes. Simply open them in your IDE to get a full list of them.

Examples of use

Nexo is built around an ItemBuilder class that allows you to create items easily. When the plugin starts it parses the configurations to generate builders for each type of items. Each builder can be used to generate itemstacks.

NexoItems class:

Get an ItemBuilder from a Nexo-ItemID

NexoItems.itemFromId(itemID);

Get the Nexo-ItemID from an ItemStack

You can use to check if an ItemStack is an NexoItem (it will return null if the Nexo-ItemID doesn't exist)

NexoItems.idFromItem(itemstack);

Custom Blocks & Furniture

Place a NexoBlock

Place a NexoBlock at a given location

NexoBlocks.place(itemID, location)

Place an NexoFurniture at a given location, optionally setting a player for rotation purposes

NexoFurniture.place(itemID, location, @Nullable player)

Custom Mechanics

Nexo allows you to add your own mechanics to the plugin, new ones or extending existing ones An example repository can be found here, with examples for both Java and Kotlin You can register your mechanic in your onEnable or wherever you want. This will register it when Nexo registers its own Mechanics, and parse them for items Mechanics consist of a Mechanic class with properties and methods. MechanicFactory consists of parsing method for global Mechanic properties & linking item -> mechanic NexoMechanicsRegisteredEvent - Called when Nexo loads/reloads Mechanics NexoItemsLoadedEvent - Called when Nexo finishes loading/reloading NexoItems

Custom PackServer

If you want a PackServer type that Nexo does not provide, you can make an addon that registers one. Make a class that extends NexoPackServer and override the methods you need.

Kotlin

class MyPackServer : NexoPackServer {
    override fun uploadPack(): CompletableFuture<Void>
    override fun sendPack(player: Player)
    override fun start()
    override fun stop()
    override fun packUrl(): String
    override fun packInfo(): ResourcePackInfo?
}

Java

public class PackServer extends NexoPackServer {
    @Override
    public CompletableFuture<Void> uploadPack()
    
    @Override
    public void sendPack(Player player)
    
    @Override
    public void start()
    
    @Override
    public void stop()
    
    @Override
    public String packUrl()
    
    @Override
    @Nullable
    public ResourcePackInfo packInfo()
}

To register this with Nexo, you simply call PackServerRegistry.register(type, packServer)