Apollo
Lunar Client 官方服务端 API。
注意:部分功能需要外部集成才能使用。
Apollo 是对 Lunar Client 旧版 API 的全面重构,带来了大量新功能。Apollo 允许服务器管理员与 Lunar Client 用户进行交互并利用其独特功能。Apollo 提供了一系列功能、模块和机会,能够极大地丰富服务器体验,远超原版 Minecraft 所能实现的范围。它让服务器管理员和开发者能够探索新的可能性,从简单地禁用模组,到为用户提供提升生活质量的功能以激发他们的创造力。让我们深入了解 Apollo 中的一些功能和机遇。
Apollo 的大部分功能都被拆分为模块。这些模块可由服务器启用,以便 Lunar Client 用户可以使用它们。以下是当前所有 Apollo 模块及其功能的简要介绍。如果您对某个模块感兴趣,请点击描述后的“阅读更多”。
Beam
光束(Beam)模块允许您创建类似信标光束的自定义光束,您可以将其放置在服务器上以突出显示特定的兴趣点。[阅读更多]
Beam 展示
光束可以位于任何位置,并拥有任意颜色!
Border
边界(Border)模块不仅通过允许世界中存在多个边界来增强 Minecraft 现有的世界边界系统,还将所有改进和原版特性回溯移植到了 Minecraft 1.7.10 玩家端。[阅读更多]
Chat
聊天(Chat)模块允许您与修改用户的聊天信息流进行交互。[阅读更多]
Chat 展示
模拟实时聊天的示例!
Colored Fire
彩色火焰(Colored Fire)模块允许您修改燃烧实体和普通火焰方块上的火焰颜色。[阅读更多]
Colored Fire 展示
让用户燃烧起任意颜色的火焰!
Combat
战斗(Combat)模块允许您修改通常由客户端处理的某些战斗方面。允许您移除 1.8 版本的“命中未命中”或“命中延迟”惩罚。[阅读更多]
Cooldown
冷却(Cooldown)模块允许服务器与 Lunar Client 内置的冷却模组进行交互。[阅读更多]
Cooldown 展示
显示任何游戏内物品、SVG 图片或资源包中的纹理!(1.7+)
Entity
实体(Entity)模块允许您与客户端侧的实体进行交互。[阅读更多]
Glint
光泽(Glint)模块允许您控制、显示并覆盖物品上的自定义光泽效果。[阅读更多]
Glint 展示
为任何物品设置任意颜色的附魔光泽!(1.7-1.12)
Glow
发光(Glow)模块允许您利用原版 Minecraft 中通常在被光谱箭击中时应用的发光效果。[阅读更多]
Glow 展示
在所有版本中以任意颜色高亮显示具有发光效果的任何用户!
Hologram
全息投影(Hologram)模块增强了原版 Minecraft 当前的全息图系统,并将所有改进和原版特性回溯移植到了 Minecraft 1.7 玩家端。[阅读更多]
Limb
肢体(Limb)模块允许您隐藏玩家的任何盔甲部件和身体部位。[阅读更多]
Limb 展示
隐藏选定的身体部位和盔甲部件!
Mod Settings
模组设置(Mod Settings)模块允许您在加入服务器时与 Lunar Client 用户的模组或模组设置进行交互。[阅读更多]
Mod Settings 展示
当服务器禁用了某些模组时,玩家将收到通知!
Nametag
Nametag 模块增强了原版 Minecraft 的名牌功能。允许为玩家设置无限制的多行名牌,而非仅有一行。[了解更多]
Nametag 展示
在用户头顶显示无限多行文字。
Nick Hider
Nick Hider 模块允许你传入一个希望为用户隐藏的昵称。[了解更多]
Notification
Notification 模块允许你向在线玩家发送 Lunar Client 通知。Lunar Client 通知会显示在用户屏幕的右上角。[了解更多]
Notification 展示
使用 Lunar Client 发送带有任意图标、标题和描述的通知!
Packet Enrichment
Packet Enrichment 模块为服务器提供有关已有数据包的额外信息,并/或添加额外的数据包,以便服务器获取关于玩家的更多信息。[了解更多]
Rich Presence
Rich Presence 模块允许你与 Lunar Client 的 Rich Presence(丰富状态)交互,直接在 Discord 上显示你的服务器和游戏模式信息。[了解更多]
Rich Presence 展示
在 Discord 和 Lunar Client 的 Rich Presence 中显示你的服务器信息!
Saturation
Saturation 模块允许你与 Lunar Client 中的 Saturation 模组交互,并为该模组设置自定义饱和度和饥饿值。[了解更多]
Saturation 展示
为物品设置自定义的饱和度和饥饿值显示数值!
Server Rule
Server Rule 模块包含预设的设置项,服务器可以启用或禁用它们,类似于 Minecraft 的 /gamerule 命令。[了解更多]
Staff Mod
Staff Mod 模块允许你与 Lunar Client 内置的管理员模组交互。[了解更多]
Staff Mod 展示
允许你的管理员使用隐藏的管理员专用模组,例如 xray!
Stopwatch
Stopwatch 模块允许你控制 Lunar Client 内的 Stopwatch 模组。[了解更多]
Stopwatch 展示
启动、停止和重置 Lunar Client 的 Stopwatch 模组!
Team
Team 模块允许你与 Lunar Client 中的 Team View 模组交互,并在其他各种模组中为队友启用多种功能。[了解更多]
Team 展示
队友头顶会出现标记,在小地图模组中显示,并在方向 HUD 模组中可见!
Title
Title 模块将 1.8+ 版本中原版的所有标题和副标题功能移植回 Lunar Client 1.7 玩家。[了解更多]
TNT Countdown
TNT Countdown 模块允许你与 Lunar Client 中的 TNT Countdown 模组交互,并为该模组设置自定义的 TNT 倒计时。[了解更多]
Transfer
Transfer 模块允许你通过传输数据包将玩家从一个服务器转移到另一个服务器,无需额外的代理设置。我们还引入了一个延迟检测数据包,用于获取玩家到其他服务器的延迟。[了解更多]
Transfer 展示
尝试将用户从一个服务器转移到另一个服务器!(适用于 1.20.4 及更低版本)
Vignette
Vignette 模块允许你在玩家视野上应用带有透明度的全屏图像叠加效果。[了解更多]
Waypoint
Waypoint 模块允许你与 Waypoints 模组交互,并在世界中的各个不同兴趣点放置地标。[了解更多]
Waypoint 展示
地标可以让服务器上的玩家知道活动发生在哪里!
-
/apollo
- 描述: Apollo 的主命令,不带额外参数时将响应当前运行的 Apollo 版本。
- 权限: apollo.command
-
/apollo reload
- 描述: 重新加载 Apollo 配置文件,包括 config.yml 和 mods.yml。
- 权限: apollo.command
-
/apollo update
- 描述: 强制将 Apollo 更新到最新版本。
- 权限: apollo.command
-
/lunarclient <player>
- 描述: 检查提供的
<player> 是否正在运行 Lunar Client。
- 权限: apollo.lunarclient
Apollo 的配置分为两部分;
config.yml 中的设置会生成带有示例和注释,您可以根据需要进行修改。
mods.yml 不会自动生成其设置或注释,因此您需要参考每个模组的文档(示例)以了解可以设置的键和值。在玩家处于您的服务器期间,mods.yml 中的设置将覆盖 Lunar Client 上的模组选项;当玩家离开服务器后,这些设置会恢复原状。
mods.yml - 配置示例
注意:以下示例并非完整的模组设置列表,且不能保证是最新的。请参阅模组的文档(示例)以获取最新设置。
mod_setting:
# 设置为 ‘true’ 以启用这些模组覆盖设置,否则设置为 ‘false’。
enable: true
zoom:
# 设置为 ‘true’ 以启用该模组,否则设置为 ‘false’。
enabled: true
# 快速按下并释放按键将切换缩放功能。
toggle-key-zoom: false
# 放大时,摄像机移动将更加平滑(电影式摄像机)。
smooth-camera: true
# 在放大和缩小添加过渡效果。
smooth-zoom: true
# 使用鼠标滚轮调整缩放深度。
variable-zoom: false
# 更改初始缩放深度。
zoom-divisor: 4
chat:
# 设置为 ‘true’ 以启用该模组,否则设置为 ‘false’。
enabled: true
# 选择是否要在聊天中增加消息历史记录。
unlimited-chat: true
# 选择是否要在聊天中堆叠多条相同的消息。
stack-messages: false
# 将聊天上移 12 像素,以免遮挡血条。
chat-height: false
# 设置聊天背景的透明度。
chat-background-opacity: 1.0
# 在聊天行上显示文字阴影。
chat-shadow: true
# 设置是否禁用聊天。
disable-chat: false
nametag:
# 设置为 ‘true’ 以启用该模组,否则设置为 ‘false’。
enabled: true
# 设置名称标签是否带有阴影。
nametag-shadow: false
# 第三人称视角下查看自己名称标签的选项。
nametag: true
# 切换名称标签中 LC 标志的选项。
nametag-logo: true
# 确定是否在切换名称标签时发送消息。
toggle-nametags: true
# 设置名称标签背景的透明度。
nametag-background-opacity: 1.0
bossbar:
# 设置为 ‘true’ 以启用该模组,否则设置为 ‘false’。
enabled: true
# 设置Boss栏的比例。
scale: 1.0
# 设置是否渲染Boss栏。
render-bar: true
# 设置是否使用自定义Boss栏。
custom-boss-bar: true
# 设置Boss栏的颜色。
bar-color: ‘#F249F2’
freelook:
# 设置为 ‘true’ 以启用该模组,否则设置为 ‘false’。
enabled: false
# 设置在使用自由视角时是否反转俯仰角。
invert-pitch: false
# 设置在使用自由视角时是否反转偏航角。
invert-yaw: false
# 快速按下并释放按键将切换自由视角。
toggle-key-freelook: false
# 放大时,摄像机移动将更加平滑(电影式摄像机)。
smooth-camera: true
lighting:
# 设置为 ‘true’ 以启用该模组,否则设置为 ‘false’。
enabled: true
# 设置是否使用全亮模式。
full-bright: true
# 设置亮度提升幅度。
brightness-boost: 1.0
damage-tint:
# 设置为 ‘true’ 以启用该模组,否则设置为 ‘false’。
enabled: false
# 设置滤镜颜色。
vignette-color: ‘#000000’
# 设置滤镜强度。
vignette-intensity: 1.0
# 当生命值低于此百分比时显示滤镜效果。
show-vignette-below: 100
# 播放心跳声,生命值越低心跳越快。
heartbeat-audio: false
Apollo 彻底重构了旧版 API,提供了众多创新功能。它赋予服务器所有者和开发者与 Lunar Client 用户互动的能力,提供独特的功能体验,超越了原版 Minecraft 的限制和能力范围。从融入生活便利性功能到完全深入的模块,Apollo 允许您充分展示创意并丰富游戏模式。采用 Apollo 能显著提升您的服务器、项目或活动的功能性、创意性和独特体验。
如果您有任何疑虑、问题、功能请求,或需要在您的服务器、项目或活动中集成 Apollo 时需要支持,请通过我们的 Developer Discord 联系我们。
我们支持 Maven 和 Gradle (Groovy & Kotlin) 的集成兼容性。您可以在此处了解如何使用它们 here。
Apollo
Lunar Client's Official Server-Sided API.
Note: Some features require external integration for utilization.
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 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]
Beam Showcase
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]
Chat
The chat module allows you to interact with and modify users chat feeds. [Read More]
Chat Showcase
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]
Colored Fire Showcase
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]
Cooldown
The cooldown module allows servers to interact with the Cooldown mod found within Lunar Client. [Read More]
Cooldown Showcase
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]
Glint
The glint module allows you to control, display, and override a custom glint effect on an item. [Read More]
Glint Showcase
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]
Glow Showcase
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]
Limb
The limb module allows you to hide any Armor piece and Body parts of a player. [Read More]
Limb Showcase
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]
Mod Settings Showcase
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]
Nametag Showcase
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]
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]
Notification Showcase
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]
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]
Rich Presence Showcase
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]
Saturation Showcase
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]
Staff Mod
The staff mod module allows you to interact with Lunar Client's built in staff mods. [Read More]
Staff Mod Showcase
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]
Stopwatch Showcase
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]
Team Showcase
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]
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]
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]
Transfer Showcase
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]
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]
Waypoint Showcase
Waypoints allow players on your server to know where the action is at!
-
/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 <player>
- Description: Checks if the provided
<player> is running Lunar Client.
- Permission: apollo.lunarclient
The Apollo configurations are split into two parts;
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) 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) for the latest settings.
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
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.
We support Maven and Gradle (Groovy & Kotlin) integration compatibilities. You can learn how to use these here.
评论 0
登录后参与评分
还没有评论,来抢沙发吧