Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 1.93 KB

README.md

File metadata and controls

62 lines (40 loc) · 1.93 KB
Raw

ASpigotFramework

A framework library that simplifies interacting with the Spigot API.

Authors: katsumag, Conclure

Version License

Setup

You will need to shade and relocate ASpigotFramework to be able to use it at runtime.

Gradle

plugins {
    id 'com.github.johnrengelman.shadow' version '6.0.0' //Or newer version
}

repositories {
    maven { url "https://repo.katsumag.me/repository/maven-releases/" }
}

dependencies {
    implementation "me.katsumag:a-spigot-framework:[VERSION]"
}

shadowJar {
    relocate 'me.katsumag.aspigotframework', '[YOUR PACKAGE].itemactionslib'
}

An example of [YOUR PACKAGE] could be xyz.you.plugin. If you want to use latest version of ASpigotFramework, use version 1.0. It should be replace [VERSION].

Usage

General Extension Functions

Since this framework/library is written in kotlin, we wrote some general extension functions, which you can find here

Contribute

If you want to contribute you may open a pull request here, as we accept most of them.

Support

If you have any questions or are in need of support, you may join HelpChat discord server, or my own.

If you join HelpChat be sure to ping katsumag#7876 or Conclure#0001.

HelpChat

My Server