Apollo

Lunar Client's Official Server-Sided API.

[![Lunar Client Maven](https://img.shields.io/badge/maven-Repo-green?link=https%3A%2F%2Flunarclient.dev%2Fapollo%2Fintroduction)](https://lunarclient.dev/maven-repository) [![Apollo Documentation](https://img.shields.io/badge/documentation-Intro-blue?link=https%3A%2F%2Flunarclient.dev%2Fapollo%2Fintroduction)](https://lunarclient.dev/apollo/introduction) [![Apollo GitHub release](https://img.shields.io/github/v/release/lunarclient/apollo)](https://github.com/LunarClient/Apollo/releases) [![Apollo GitHub issues](https://img.shields.io/github/issues/lunarclient/apollo)](https://github.com/LunarClient/Apollo/issues) [![Apollo GitHub license](https://img.shields.io/github/license/lunarclient/apollo)](https://github.com/LunarClient/Apollo/?tab=MIT-1-ov-file)

Note: Some features require external integration for utilization.

![What is Apollo?](https://i.imgur.com/pKkOrJj.png)
Apollo is a complete revamp of Lunar Client’s legacy API with tons of new features. Apollo allows server owners to interact and utilize unique features for Lunar Client users. Apollo offers a range of features, modules, and opportunities to enrich the experience of servers way further than what’s possible within vanilla Minecraft. Allowing server owners and developers to explore new possibilities, from simply disabling mods, to providing users quality of life features to capture their creativity. Let’s dive into some of the capabilities and opportunities that can be found within Apollo. ![Apollo Integration Visual](https://i.imgur.com/IZygKDd.png)

![Apollo Capabilities](https://i.imgur.com/8gBhS82.png)
Apollo has most of its features broken down into modules. These modules can be enabled by the server so Lunar Client users can utilize them. Here is a brief breakdown of all the current Apollo modules and their capabilities. If you’re interested in one of the modules click the read more following the description. Beam
The beam module allows you to create custom beams resembling beacon beams, which can be placed on your server to highlight specific points of interest. [[Read More]](https://lunarclient.dev/apollo/developers/modules/beam)

Beam Showcase

![Beam Module Example](https://i.imgur.com/F539tcr.jpeg)
Beams can be at any location and be any color!

Border
The border module not only enhances Minecraft's current world border system by allowing multiple borders in the world, but also backports all the improvements and vanilla features to Minecraft 1.7.10 players. [[Read More]](https://lunarclient.dev/apollo/developers/modules/border) Chat
The chat module allows you to interact with and modify users chat feeds. [[Read More]](https://lunarclient.dev/apollo/developers/modules/chat)

Chat Showcase

![Chat Module Example](https://i.imgur.com/4kMmYJZ.gif)
Example of simulating live chat!

Colored Fire
The colored fire module allows you to modify the color of a flame both on burning entities and normal flame blocks. [[Read More]](https://lunarclient.dev/apollo/developers/modules/coloredfire)

Colored Fire Showcase

![Colored Fire Module Example](https://i.imgur.com/IuNR68A.png)
Make users burn with any color!

Combat
The combat module allows you to modify certain aspects of combat that are usually handled client-sided. Allows you to remove the 1.8 'hit-miss' or 'hit-delay' penalty. [[Read More]](https://lunarclient.dev/apollo/developers/modules/combat) Cooldown
The cooldown module allows servers to interact with the Cooldown mod found within Lunar Client. [[Read More]](https://lunarclient.dev/apollo/developers/modules/cooldown)

Cooldown Showcase

![Cooldown Module Example](https://i.imgur.com/EPPNIQw.png)
Display any in-game item, SVGs or textures found within resourcepacks! (1.7+)

Entity
The entity module allows you to interact with entities client-sided. [[Read More]](https://lunarclient.dev/apollo/developers/modules/entity) Glint
The glint module allows you to control, display, and override a custom glint effect on an item. [[Read More]](https://lunarclient.dev/apollo/developers/modules/glint)

Glint Showcase

![Glint Module Example](https://i.imgur.com/UcIY0YO.png)
Set enchantment glints on any item with any color! (1.7-1.12)

Glow
The glow module allows you to take advantage of the vanilla Minecraft Glow Effect that is usually applied when hit by spectral arrows. [[Read More]](https://lunarclient.dev/apollo/developers/modules/glow)

Glow Showcase

![Glow Module Example](https://i.imgur.com/Ra3r363.png)
Highlight any user with the glow effect, of any color on all versions!

Hologram
The hologram module enhances vanilla Minecraft's current system for holograms and backports all the improvements and vanilla features to Minecraft 1.7 players. [[Read More]](https://lunarclient.dev/apollo/developers/modules/hologram) Limb
The limb module allows you to hide any Armor piece and Body parts of a player. [[Read More]](https://lunarclient.dev/apollo/developers/modules/limb)

Limb Showcase

![Limb Module HideBody Example](https://i.imgur.com/nzq1aht.jpeg) ![Limb Module HideArmor Example](https://i.imgur.com/7HDKcZk.jpeg)
Hide select body parts and armor pieces!

Mod Settings
The mod setting module allows you to interact with Lunar Client users mods or mod settings when joining your server. [[Read More]](https://lunarclient.dev/apollo/developers/modules/modsetting)

Mod Settings Showcase

![Mod Settings Module Example](https://i.imgur.com/KJqpGfa.png)
When mods are disabled on the server, players will receive a notification!

Nametag
The nametag module enhances the vanilla Minecraft nametag. Allows you to have unlimited multi-line nametags for players, instead of a singular line. [[Read More]](https://lunarclient.dev/apollo/developers/modules/nametag)

Nametag Showcase

![Nametag Module Example](https://i.imgur.com/kE5CyLm.png)
Display an unlimited amount of lines above a users head.

Nick Hider
The Nick Hider module allows you to pass in a nickname you want to hide for the user. [[Read More]](https://lunarclient.dev/apollo/developers/modules/nickhider) Notification
The notification module allows you to send Lunar Client notifications to players actively on your server. Lunar Client notifications appear in the upper right of the user's screen. [[Read More]](https://lunarclient.dev/apollo/developers/modules/notification)

Notification Showcase

![Notification Module Example](https://i.imgur.com/pBgRxda.png)
Send notifications using Lunar Client, with any icon, title, and description!

Packet Enrichment
The packet enrichment module provides servers with additional information about already existing packets and/or adds additional packets to provide servers with extra information about a player. [[Read More]](https://lunarclient.dev/apollo/developers/modules/packetenrichment) Rich Presence
The rich presence module allows you to interact with Lunar Client's rich presence to display your server and game modes directly on Discord. [[Read More]](https://lunarclient.dev/apollo/developers/modules/richpresence)

Rich Presence Showcase

![Rich Presence Module Example](https://i.imgur.com/v5EsxV2.png)
Display information about your server on Discord and Lunar Client's rich presence!

Saturation
The saturation module allows you to interact with and set custom saturation and hunger values for the Saturation mod on Lunar Client. [[Read More]](https://lunarclient.dev/apollo/developers/modules/saturation)

Saturation Showcase

![Saturation Example](https://i.imgur.com/HcyvVWr.gif)
Set custom saturation and hunger display values for items!

Server Rule
The server rule module contains pre-created settings servers can enable or disable, comparable to Minecraft's /gamerule command. [[Read More]](https://lunarclient.dev/apollo/developers/modules/serverrule) Staff Mod
The staff mod module allows you to interact with Lunar Client's built in staff mods. [[Read More]](https://lunarclient.dev/apollo/developers/modules/staffmod)

Staff Mod Showcase

![Staff Mod Module Example](https://i.imgur.com/8muCExp.png)
Allow your staff to use hidden staff only mods, like xray!

Stopwatch
The stopwatch module allows you to control the stopwatch mod inside Lunar Client. [[Read More]](https://lunarclient.dev/apollo/developers/modules/stopwatch)

Stopwatch Showcase

![Stopwatch Example](https://i.imgur.com/HEX9q0H.gif)
Start, Stop, and Reset the Lunar Client stopwatch mod!

Team
The team module will allow you to interact with the Team View mod in Lunar Client and enable various features for teammates in various other mods. [[Read More]](https://lunarclient.dev/apollo/developers/modules/team)

Team Showcase

![Team Module Example](https://i.imgur.com/Cp2YMbe.jpeg) Teammates will have markers over their head, appear on Minimap Mod, and appear in the Direction HUD mod!

Title
The title module backports all vanilla title & subtitle features found in 1.8+ to 1.7 Lunar Client players. [[Read More]](https://lunarclient.dev/apollo/developers/modules/title) TNT Countdown
The TNT Countdown module allows you to interact with and set custom TNT timers for the TNT Countdown mod on Lunar Client. [[Read More]](https://lunarclient.dev/apollo/developers/modules/tntcountdown) Transfer
The transfer module allows you to transfer players from one server to another, without the need of additional proxy setups, using the transfer packet. We've also introduced a ping packet to get a players ping to other servers. [[Read More]](https://lunarclient.dev/apollo/developers/modules/transfer)

Transfer Showcase

![Transfer Module Example](https://i.imgur.com/TjdBfYn.png)
Attempt to transfer users from one server to another! (1.20.4 & lower)

Vignette
The vignette module gives the ability to apply a full-screen image overlay with transparency to the player's view. [[Read More]](https://lunarclient.dev/apollo/developers/modules/vignette) Waypoint
The waypoint module allows you to interact with the Waypoints mod and place waypoints at various different points of interest in your worlds. [[Read More]](https://lunarclient.dev/apollo/developers/modules/waypoint)

Waypoint Showcase

![Waypoint Module Example](https://i.imgur.com/WN2MY5u.jpeg) Waypoints allow players on your server to know where the action is at!

![Apollo Commands](https://i.imgur.com/nwCZvZJ.png)
- `/apollo` - **Description:** The main command inside of Apollo, with no extra args it’ll respond with the current Apollo version running. - **Permission:** apollo.command - `/apollo reload` - **Description:** Reloads the Apollo configuration files, both config.yml and mods.yml - **Permission:** apollo.command - `/apollo update` - **Description:** Forcefully updates Apollo to the latest version. - **Permission:** apollo.command - `/lunarclient ` - **Description:** Checks if the provided `` is running Lunar Client. - **Permission:** apollo.lunarclient

![Apollo Configuration](https://i.imgur.com/VlwMkRT.png)
The Apollo configurations are split into two parts; - General and module specific settings for Apollo are located in the `config.yml`. - Settings for Lunar Client mod options are located in the `mods.yml`. The settings for the `config.yml` are generated with examples and comments, which you can modify to your liking. The `mods.yml` is not generated with its settings or comments, which will require you to refer to each mod's documentation ([example](https://lunarclient.dev/apollo/developers/mods/2ditems)) for the keys and value(s) you can set. The settings in the `mods.yml` will override the mod options for players on Lunar Client while they are on your server and revert them back after they leave. `mods.yml` - Configuration Example
Note: The following example is not a complete list of mod settings or guaranteed to be up to date. You should refer to the mod's documentation ([example](https://lunarclient.dev/apollo/developers/mods/2ditems)) for the latest settings. ```yaml mod_setting: # Set to ‘true’ to enable these mod overrides, otherwise set ‘false’. enable: true zoom: # Set ‘true’ to enable the mod, otherwise set ‘false’. enabled: true # Quickly pressing and releasing the key will toggle zoom. toggle-key-zoom: false # When zoomed in the camera movement will move smoothly (cinematic camera). smooth-camera: true # Add a transition when zooming in and out. smooth-zoom: true # Adjust the zoom depth using Mouse Scroll Wheel. variable-zoom: false # Change the initial zoom depth. zoom-divisor: 4 chat: # Set ‘true’ to enable the mod, otherwise set ‘false’. enabled: true # Choose whether or not you want to increase the message history in chat. unlimited-chat: true # Choose whether or not you want to stack multiple of the same messages in chat. stack-messages: false # Moves the chat up 12 pixels so it doesn’t block health bar. chat-height: false # Set the opacity of the chat background. chat-background-opacity: 1.0 # Show text shadow on chat lines. chat-shadow: true # Set whether the chat should be disabled. disable-chat: false nametag: # Set ‘true’ to enable the mod, otherwise set ‘false’. enabled: true # Set whether the nametag should have a shadow. nametag-shadow: false # An option to see your own nametag in third person. nametag: true # An option to toggle LC logos in nametags. nametag-logo: true # Determines if we should send the message when nametags are toggled. toggle-nametags: true # Set the opacity of the nametag background. nametag-background-opacity: 1.0 bossbar: # Set ‘true’ to enable the mod, otherwise set ‘false’. enabled: true # Sets the scale of the boss bar. scale: 1.0 # Sets whether to render the boss bar. render-bar: true # Sets whether to use the custom boss bar. custom-boss-bar: true # Set the boss bar color. bar-color: ‘#F249F2’ freelook: # Set ‘true’ to enable the mod, otherwise set ‘false’. enabled: false # Set whether to invert the pitch when using freelook. invert-pitch: false # Set whether to invert the yaw when using freelook. invert-yaw: false # Quickly pressing and releasing the key will toggle freelook. toggle-key-freelook: false # When zoomed in the camera movement will move smoothly (cinematic camera). smooth-camera: true lighting: # Set ‘true’ to enable the mod, otherwise set ‘false’. enabled: true # Set whether or not to use full-bright. full-bright: true # Set the brightness boost. brightness-boost: 1.0 damage-tint: # Set ‘true’ to enable the mod, otherwise set ‘false’. enabled: false # Set the color of the tint. vignette-color: ‘#000000’ # Set the intensity of the tint. vignette-intensity: 1.0 # Show the tint when you have less than this amount of health as a percentage. show-vignette-below: 100 # Plays a heartbeat, becoming faster the lower your health. heartbeat-audio: false ```

![Why use Apollo?](https://i.imgur.com/sOvdgfu.png) Apollo offers a complete overhaul of the legacy API with numerous innovative features. It empowers server owners and developers to engage with Lunar Client users with unique functionalities, extending beyond the bounds and capabilities of vanilla Minecraft. From incorporating quality of life features to fully in-depth modules, Apollo allows you to fully display your creativity and enrich your gamemodes. Adopting Apollo significantly elevates your servers, projects, or events functionality, creativity, and unique experiences. If you have any concerns, questions, feature requests, or need support adding Apollo into your server, project, or event, you can contact us on our [Developer Discord](https://discord.com/invite/3T9Atyb6pf). [![CTA Download Apollo](https://i.imgur.com/XsUffFb.png)](https://lunarclient.dev/apollo/downloads)

![Apollo Installations](https://i.imgur.com/xG5ia7d.png)
We support Maven and Gradle (Groovy & Kotlin) integration compatibilities. You can learn how to use these [here](https://lunarclient.dev/maven-repository#adding-apollo-as-a-dependency).