Getting Started

Overview

This guide will help you get started with the apollo-protos library, which is used to handle Apollo-related packets from Lunar Client in your Minecraft server. The apollo-protos library provides strong typing and schema validation for all Apollo messages, ensuring seamless communication between the client and the server.

In this guide, you'll learn how to add the required repository and dependencies to your project. You'll also find links to various examples demonstrating how to integrate and work with Apollo packets, from detecting players using Lunar Client to handling advanced serverbound and roundtrip packets.

Available fields for each message, including their types, are available on the Buf Schema Registry at https://buf.build/lunarclient/apollo (opens in a new tab).

Adding the repository and dependencies

pom.xml

<repositories>
    <repository>
        <id>lunarclient</id>
        <url>https://repo.lunarclient.dev</url>
    </repository>
</repositories>
 
<dependencies>
    <dependency>
        <groupId>com.lunarclient</groupId>
        <artifactId>apollo-protos</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
</dependencies>

Integration Examples

🔗 Sending Apollo packets & Enabling Apollo modules
🔗 Detecting players using LunarClient
🔗 Common Apollo Objects
🔗 Adventure Util
🔗 Apollo Serverbound packets
🔗 Apollo Roundtrip packets

For examples of module integration, refer to the specific Module pages. Each page contains code samples under the apollo-protos library tab. For instance, you can find sample code for the BorderModule on its dedicated page BorderModule in the Sample Code section.

Introduction Player Detection