README.md

Kawa 🚀

An open-source, powerful and modular Kotlin-enhanced event bus library for the JVM.

Importing

You can import Kawa from Maven Central by adding it to your dependencies block.

Gradle

repositories {
    mavenCentral()
}

dependencies {
    implementation("wtf.mizu.kawa:api:0.3.4")
    implementation("wtf.mizu.kawa:optimized-bus:0.3.4")

    // If you're using Kotlin:
    implementation("wtf.mizu.kawa:kotlin-listener-dsl:0.3.4")
}

Maven

<dependencies>
    <dependency>
        <groupId>wtf.mizu.kawa</groupId>
        <artifactId>api</artifactId>
        <version>0.3.4</version>
    </dependency>

    <dependency>
        <groupId>wtf.mizu.kawa</groupId>
        <artifactId>optimized-bus</artifactId>
        <version>0.3.4</version>
    </dependency>

    <!-- If you're using Kotlin: -->
    <dependency>
        <groupId>wtf.mizu.kawa</groupId>
        <artifactId>kotlin-listener-dsl</artifactId>
        <version>0.3.4</version>
    </dependency>
</dependencies>

Usage

To get a deep understanding of the library, check out the wiki.

Troubleshooting

If you encounter any kind of problem related to this library, you can open an issue describing what's up. We ask you to be as precise as you can, so that our developers can help you as fast as possible.

Non-project-related issues will most likely be closed without further ado.

Contributing

You can contribute to this project by forking it, making your changes, and creating a new pull request.

You have to be as precise as possible while doing it though, describing in the commits (or PR description) what you're changing, why and how.

Licensing

This project is licensed under the AGPLv3-only License.