README.md

MusicBot

This is the core library of the MusicBot project. APIs should not be considered stable until version 1.0.0.

If you want to have a working version of the bot, have a look at the MusicBot-desktop project.

Usage

Gradle

Kotlin DSL

build.gradle.kts

dependencies {
    // ...
    implementation("com.github.bjoernpetersen:musicbot:${Lib.MUSICBOT}")
    // or
    implementation(
        group = "com.github.bjoernpetersen",
        name = "musicbot",
        version = Lib.MUSICBOT)
}

Groovy DSL

build.gradle

dependencies {
    // ...
    implementation 'com.github.bjoernpetersen:musicbot:$musicbotVersion'
}

Maven

pom.xml

<dependency>
    <groupId>com.github.bjoernpetersen</groupId>
    <artifactId>musicbot</artifactId>
    <version>${musicbot.version}</version>
</dependency>

Implementations

This is only the core library for the MusicBot, it needs to be wrapped by an implementation to actually work.

The only known implementation can be found in the MusicBot-desktop project.

Plugins

For documentation on how to implement plugins, have a look at the JavaDocs or at the docs hosted on github.io.

For several "official" plugins, have a look at the MusicBot-plugins project.

License

This project is released under the MIT License. That includes every file in this repository, unless explicitly stated otherwise at the top of a file. A copy of the license text can be found in the LICENSE file.