exdj158 / AxiusCore

A super light-weight plugin development API, used to ease the hastle of some common development hurdles.

Welcome to AxiusCore

Hey! thanks for being interested in using AxiusCore. As of now, the core is in its early development, and therefore lacks many of the intended launch features of the project.

Features

• Data handling, with files stored as .yml files for easy configuration;
• Custom plugin framework, which breaks down the core functionality to 4 functions;
• Custom command handling / registration. Eliminating the need to add commands and permissions to the plugin.yml;
• GUI generation and manipulation classes;
• Player head auto-cache, used in unison with GUIs to provide next-level customisation;

Installation

Navigate to the AxiusCore spigot page, or the releases page on GitHub, and download the latest stable build of AxiusCore. The core will be downloaded as a .jar file, and must be placed in the plugins folder of your server.

Maven Repository

If you wish to use AxiusCore as the base of your plugin, add my maven repository to your project;

<repositories>
    <!-- This adds the AxiusCore Maven repository to the build -->
    <repository>
        <id>AxiusCore</id>
        <url>http://api.benkeoghcgd.co.uk/maven2/</url>
    </repository>
</repositories>

<!-- ... -->

<dependencies>
<!-- This adds the AxiusCore artifact to the build -->
    <dependency>
        <groupId>uk.co.benkeoghcgd.api</groupId>
        <artifactId>AxiusCore</artifactId>
        <version>${project.version}</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Non-Maven

What are you doing! Maven is a really useful resource for us developers :) Now you've been told, you'll either convert your project to Maven pronto or add the AxiusCore plugin as a library in your IDE

Prerequisites

Make sure you're using Java 17 and load your server as usual. Check console for any errors before developing with the downloaded build. If all steps have been followed correctly, your server should boot up normally; This is when you can begin development.

Usage

For usage information, see the wiki.