Basics

Basics is a modular core plugin for modern Spigot versions!

Compile

To compile, use gradlew build.

You can also use gradlew distribution, which will create the plugin .jar and all modules in a drag-and-droppable layout into build/dist. You can also use gradlew zipDistribution to get the whole project .zip file.

For running Basics locally, you can also use the testserver tasks:

copyPluginToTestServer: Copies the main plugin .jar to your test server
copyModule<Name>ToTestServer: Copies the specific module .jar to your test server
copyAllModulesToTestServer: Copies all modules to the test server - same as running all copyModule<Name>ToTestServer tasks
copyAllToTestServer: Copies all modules and the main plugin .jar to your test server - same as running copyPluginToTestServer and copyAllModulesToTestServer

The path to your test server can be specified using a gradle property called "testserver.path" using one of the following methods:

as command line argument (gradlew copyAllToTestServer -Ptestserver.path=/my/test/server)
in the gradle.properties file in your gradle home directory (usually ~/.gradle): testserver.path=/my/test/server

Todo

Check the Trello Board!

Documentation

The documentation can be found here:

It is not often updated, so better create your own using gradlew dokkaHtml or gradlew dokkaJavadoc in the core project.

Note to Contributors

Contributions are always welcome from anyone!

Create a new module

Modules can be written in Java or Kotlin. To create a new module, use the createModule task. It will ask you which language (kotlin or java) you want to use, asks you for the module name, which should be [a-z0-9_-]+.

Debug information

Debug output can be enabled by setting the BASICS_DEBUG_LEVEL environment variable to 1 or higher, for example:

BASICS_DEBUG_LEVEL=99 java -jar spigot.jar

You can also change the debug level on the fly using /basicsdebug setdebugloglevel <number>.

Y2Kwastaken/basics