Skip to content

README.md

Latest commit

 

History

History
56 lines (44 loc) · 1.23 KB

README.md

File metadata and controls

56 lines (44 loc) · 1.23 KB

NoteBlockAPI

This is a modified version of the original NoteBlockAPI plugin, designed to let developers shade the API directly into their plugin without requiring the separate NoteBlockAPI plugin to be installed on the server.

Important: According to the original authors’ license, your plugin must be open-source if you shade this code into your plugin.

This project also aims to support newer Minecraft versions (1.20+) only, while cleaning up and modernizing the existing codebase.

Maven Dependency

<repository>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repository>
<dependencies>
<dependency>
    <groupId>com.github.FilleDev</groupId>
    <artifactId>NoteBlockAPI</artifactId>
    <version>1.6.5-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>
</dependencies>

Gradle Dependency

repositories {
    maven {
        url 'https://jitpack.io/'
    }
}
dependencies {
    compileOnly "com.github.FilleDev:NoteBlockAPI:1.6.5-SNAPSHOT"
}

You can initialize the api using:

NoteBlockAPI noteBlockAPI = NoteBlockAPI.init(this);

On plugin disable:

NoteBlockAPI.shutdown();