Configure Addon
Now that you've created your project, you need to set several values in the addon
task.
If you're using the addon template, most of these values are already set for you.
Options marked with a * are required.
id*
This is the id of your addon. It is used for multiple things like the addon's config folder name or the namespace for items and blocks. This id has to start with a letter and can only contain lowercase letters, numbers and underscores. There are also a few reserved words that can't be used as id. These are:
nova
minecraft
itemsadder
oraxen
mmoitems
Example:
In most cases, you can just use your project name:
name*
This is the displayed name of your addon. Unlike the addon id, there are no naming restrictions.
Example:
In most cases, you can just use your project name:
version*
The version of the addon.
Example:
Or to automatically get the version from your project:
novaVersion*
The minimum version of Nova that your addon requires.
Example:
Or use the version set in your version catalog:
main*
Full path to your main class (without the .class extension).
Example:
author/authors
A list of author(s) of your addon.
Example:
Or for multiple authors:
spigotResourceId
The id of your addon's Spigot resource. This is used to automatically check for updates. You can find this id after the period in the url of your addon's Spigot page.
Example (With Nova's id):
depend/softdepend
You can use these options to specify which addons your addon depends on and thus needs to be loaded before your addon
is.
The difference between depend
and softdepend
is that softdepend
will not cause the addon to fail if the
dependency is not
loaded.
Example:
Info
Unlike in spigot plugins, depdend
and softdepend
actually change which classes can be accessed from your addon.
Without a (soft)dependency configured, you will not be able to access the classes of different addons at runtime.