Bookshelf API

Bookshelf API allows you to hook into the Bookshelf Plugin to access quality of life managers that you can integrate into your plugin.

The Bookshelf API also provides utility classes that you can use such as:

• Creating Custom Menus
• Utility Classes
  • ArrayUtil
  • ByteUtil
  • EnumUtil
  • LocationUtil
  • MiniMessageUtil
    • Kyori Adventure Utility
    • Centering Messages
    • Converting MiniMessage to Components
    • Persisting Component Styles
  • PackUtil
  • StringUtil
  • WorldUtil
• Cooldown Manager
• Events
  • Creating Events with BaseEvent
  • PlayerChatEvent
• Creating Custom Config Files
• Task Schedulers
• Modrinth Version Updater
• Fetching Players with Mojang API
• Another CommandAPI Builder

Table of Contents

1. Installing the Bookshelf API
2. What's in the Bookshelf API
3. Using the Bookshelf API
4. Contributing to the Bookshelf API
5. Bookshelf API's License
6. Donating to help support the Bookshelf API

---

Donating

Bookshelf among other various plugins I have worked on are free to use! Please consider donating to my ko-fi! It helps fund other projects that I am passionate about.

https://ko-fi.com/apollo30

---

Installation

Below shows you how to install Bookshelf API into your project.

Gradle

Add it in your root build.gradle at the end of repositories:

    dependencyResolutionManagement {
        repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
        repositories {
		mavenCentral()
		maven { url 'https://jitpack.io' }
        }
    }

Add the dependency

    dependencies {
        implementation 'com.github.Lodestones:Bookshelf:VERSION'
    }

Maven

Add the JitPack repository to your build file

    <repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </repository>
    </repositories>

Add the dependency

    <dependency>
        <groupId>com.github.Lodestones</groupId>
        <artifactId>Bookshelf</artifactId>
        <version>VERSION</version>
    </dependency>

Documentation

Usage

Hooking into the Bookshelf API.

import to.lodestone.bookshelfapi.BookshelfAPI;
import to.lodestone.bookshelfapi.IBookshelfAPI;

public class MainPlugin extends JavaPlugin {

  @Override
  public void onEnable() {

  }

  public IBookshelfAPI bookshelf() { // use this method to access the Bookshelf API.
    return BookshelfAPI.getApi(); // Retrieve the Bookshelf API instance.       
  }
}

---

Contributing

See something Bookshelf doesn't support, a bug or something that may be useful? We welcome contributions to improve the Bookshelf API. Open an issue here.

---

License

Bookshelf is ARR. Please view the license here.