The path to the addons main class, e.g. com.example.MyAddon. The main class needs to be a singleton object extending xyz.xenondevs.nova.addon.Addon.

name

abstract val name: Property<String>

The name of the addon. The lowercase version is used as the addon's id (namespace).

novaDev

val novaDev: Property<Boolean>

Whether Nova development mode should be enabled for Origami run-server tasks. Adds the -DNovaDev JVM argument when enabled. Defaults to true.

pluginMain

abstract val pluginMain: Property<String>

(optional) The path to the JavaPlugin implementation.

prefix

abstract val prefix: Property<String>

(optional) The prefix of the addon. Used for logging.

version

abstract val version: Property<String>

The version of the addon. This is parsed using xenondevs' commons-version and needs to be valid according to that.

website

abstract val website: Property<String>

(optional) The website of the addon.

Functions

dependency

fun dependency(name: String, load: PluginDependency.Load = Load.OMIT, required: Boolean = true, joinClasspath: Boolean = true)

Creates a dependency on a plugin named name in both the Stage.BOOTSTRAP and Stage.SERVER stages. The load order is defined by load, the plugin will require the dependency if required is true, and the plugin's classes will be accessible if joinClasspath is true.

fun dependency(name: String, stage: PluginDependency.Stage, load: PluginDependency.Load = Load.OMIT, required: Boolean = true, joinClasspath: Boolean = true)

Creates a dependency on a plugin named name in the specified stage. The load order is defined by load, the plugin will require the dependency if required is true, and the plugin's classes will be accessible if joinClasspath is true.