Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 1.76 KB

README.md

File metadata and controls

43 lines (33 loc) · 1.76 KB
Raw

PagineDown

Discord

PagineDown is a library for generating paginated MineDown-formatted chat menu lists.

Requires Java 11+. PagineDown is a library that is intended to be used with MineDown-adventure (not standalone) -- your project will need to shade MineDown-adventure to use it.

PagineDown (v1.1+) runs on the adventure platform, or on platforms with adventure adapters.

Installation

PagineDown is available on JitPack. You can browse the Javadocs here.

Note that your plugin will also need to shade (or shade a library that includes) MineDown.

Maven

To use the library on Maven, in your pom.xml file, first add the JitPack repository:

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

Then, add the dependency in your <dependencies> section. Remember to replace Tag with the current PagineDown version.

    <dependency>
        <groupId>net.william278</groupId>
        <artifactId>PagineDown</artifactId>
        <version>Tag</version>
        <scope>compile</scope>
    </dependency>

Gradle & others

JitPack has a handy guide for how to use the dependency with other build platforms.

License

PagineDown is licensed under Apache-2.0.