vskah/apollo

Next-generation Lunar Client server API

Apollo

Apollo is a powerful tool that allows developers to create custom integrations with Lunar Client.

You can find the latest downloads, wiki, and more at lunarclient.dev.

Creating custom integrations for Apollo requires adding the Apollo API as a dependency from our maven repository to your project.

Building

Apollo uses Gradle to handle dependencies and compile the project.

Prerequisites

• Java 8 JDK
• Build Tools for Spigot 1.8.8

Compiling

Running the following will compile the Apollo source for Java 8.

./gradlew build

The output jars can be found in the build/libs directory relative to each platform.

• Bukkit: bukkit/plugin/build/libs
• BungeeCord: bungee/build/libs
• Velocity: velocity/build/libs

Examples

An example plugin can be compiled to provide a variety of commands that allow you to try different features Apollo provides. When compiled the output jar can be found in the directory bukkit/example/build/libs.

Contributing

The Apollo project is split into several modules.

• API - The publicly available interface for developers wishing to create custom integrations with Lunar Client.
• Common - The abstraction used by platform modules to reduce duplicate code and implement the protocol for Lunar Client.
• Bukkit, BungeeCord, Velocity - Are modules that implement the common module for each respective platform.

Contributions can be made to Apollo by creating a pull request for improvements or fixes. For new feature ideas please consider making a suggestion by creating an issue or joining our discord.

License

Apollo is licensed under the MIT license.