apollo.yml¶

Lunar Client features through Apollo: waypoints, team view, cooldowns and nametags. Needs the Apollo-Bukkit plugin on the server; without it nothing here does anything.

How it plays: read the guide

Every example on this page is taken from the shipped apollo.yml. Changes apply with /hcf reload: everything sent is taken back and sent again. Apollo's own configuration can switch a module off for the whole server, whatever this file says.

General settings¶

apollo.yml

enabled: true

# How often everything is brought up to date, in ticks (20 = one second). Only
# what changed is sent, except teammates' positions, which move.
update-ticks: 10

Key	As shipped	What it does
`enabled`	`true`	Every Lunar Client feature
`update-ticks`	`10`	How often everything is brought up to date; only what changed is sent

Waypoints¶

apollo.yml

# Waypoints on the map and in the world. Names come from lang/en.yml
# (apollo.waypoint.*); capture events use their own display names.
waypoints:
  enabled: true
  hq: true          # your team's HQ
  base: true        # your team's second base
  rally: true       # your team's rally point, while it lasts
  focus: true       # a focused player, where they are; a focused team's HQ
  events: true      # KOTH and Citadel zones, Conquest zones, the King in KTK,
                    # a running DTC/Last Break's core, a running Slide's zone and a running Totem's column
  colors:
    hq: "#55FF55"
    base: "#00AA00"
    rally: "#FFFF55"
    focus: "#FF55FF"
    event: "#FFAA00"

Key	As shipped	What it does
`enabled`	`true`	Waypoints at all
`hq`, `base`, `rally`	`true`	The team's HQ, base and rally point
`focus`	`true`	A focused player, and a focused team's HQ
`events`	`true`	KOTH, Citadel and Conquest zones, the King, a running DTC/Last Break's core, and a running Slide's zone
`colors`	hex colours	One per kind

Team view¶

apollo.yml

# Teammates marked above their heads and on the minimap. Beyond tracking-range
# blocks, where the client no longer has them, their position and name are sent.
team-view:
  enabled: true
  marker-color: "#55FF55"
  tracking-range: 48

Key	As shipped	What it does
`enabled`	`true`	Teammates marked above their heads and on the minimap
`marker-color`	`#55FF55`	The marker's colour
`tracking-range`	`48`	Beyond this many blocks, position and name are sent

Cooldowns¶

apollo.yml

# Timers shown as Lunar cooldown icons - every cooldown the plugin keeps: the
# combat tag, the ender pearl, the item cooldowns of pvp.yml, a running countdown
# (/spawn, /logout, /team hq, /team stuck...), the partner items (each, the
# shared one, the Pocket Bard's sets), the class items (a Bard's clicks, a
# Rogue's backstab) and the crowbar. Each shows its own item, unless an icon is
# set here. Icons are item names, as the server spells materials.
cooldowns:
  enabled: true
  combat-tag: true
  combat-tag-icon: DIAMOND_SWORD
  warmups: true
  warmup-icon: CLOCK
  abilities: true
  # The shared cooldown after any partner item.
  ability-global-icon: NETHER_STAR
  ender-pearl: true
  ender-pearl-icon: ENDER_PEARL
  # The item cooldowns of pvp.yml (Gapple, Crapple...), each with its own item.
  item-cooldowns: true
  # A class's click items (a Bard's sugar, blaze powder...) and a Rogue's backstab.
  classes: true
  crowbar: true

Key	As shipped	What it does
`enabled`	`true`	Lunar cooldown icons
`combat-tag`, `combat-tag-icon`	`true`, `DIAMOND_SWORD`	The combat tag, and its icon
`warmups`, `warmup-icon`	`true`, `CLOCK`	Running countdowns (`/spawn`, `/team hq`...)
`abilities`	`true`	Partner item cooldowns, each with its own item — and the shared one, and the Pocket Bard's sets
`ability-global-icon`	`NETHER_STAR`	The shared partner item cooldown's icon
`ender-pearl`, `ender-pearl-icon`	`true`, `ENDER_PEARL`	The ender pearl cooldown, and its icon
`item-cooldowns`	`true`	The item cooldowns of `pvp.yml`, each with its own item
`classes`	`true`	A class's click items (a Bard's effects) and a Rogue's backstab, each with its own item
`crowbar`	`true`	The crowbar's cooldown

Nametags¶

apollo.yml

# The nametag above each player: a team line (left out for a player with no team)
# and a name line. %color% is the colour for how their team relates to yours;
# %team%, %dtr% and %player% are what they say. A focused player - or a member of
# a focused team - takes the focus colour, except to their own team.
nametags:
  enabled: true
  team-line: "%color%%team% {dark}| {warning}%dtr%"
  name-line: "%color%%player%"
  colors:
    self: "&a"
    ally: "&9"
    enemy: "&c"
    focus: "&d"
    neutral: "&f"
  # Your own nametag too - your team and its DTR - shown by Lunar in third person
  # (F5). Lunar draws it only if "show own nametag" is on in its settings.
  show-self: true

Key	As shipped	What it does
`enabled`	`true`	Nametags
`team-line`	`%color%%team% &7\\| &e%dtr%`	The line above the name; left out for a player with no team
`name-line`	`%color%%player%`	The name line
`show-self`	`true`	Your own nametag too — your team and its DTR — for Lunar to show in third person; Lunar draws it only with its "show own nametag" setting on
`colors`	`self`, `ally`, `enemy`, `focus`, `neutral`	`%color%` for each relation

The whole shipped file¶

View it on GitHub.

apollo.yml

# ---------------------------------------------------------------------------
# apollo.yml - Lunar Client features
#
# For players on Lunar Client only, through Lunar's Apollo. Needs the Apollo
# plugin on the server - Apollo-Bukkit, from lunarclient.dev/apollo/downloads.
# Without it nothing here does anything, and nothing else changes: the rest of
# the plugin never depends on it. Players not on Lunar Client are sent nothing.
#
# Apollo's own configuration can switch each module off for the whole server;
# a module off there stays off whatever this file says.
#
# Changes take effect on /hcf reload: everything sent is taken back and sent
# again as this file now says.
#
# Lines "# --8<-- [start:...]" and "# --8<-- [end:...]" mark the parts the online
# documentation quotes from this file. They are comments and change nothing.
# ---------------------------------------------------------------------------

enabled: true

# How often everything is brought up to date, in ticks (20 = one second). Only
# what changed is sent, except teammates' positions, which move.
update-ticks: 10

# Waypoints on the map and in the world. Names come from lang/en.yml
# (apollo.waypoint.*); capture events use their own display names.
waypoints:
  enabled: true
  hq: true          # your team's HQ
  base: true        # your team's second base
  rally: true       # your team's rally point, while it lasts
  focus: true       # a focused player, where they are; a focused team's HQ
  events: true      # KOTH and Citadel zones, Conquest zones, the King in KTK,
                    # a running DTC/Last Break's core, a running Slide's zone and a running Totem's column
  colors:
    hq: "#55FF55"
    base: "#00AA00"
    rally: "#FFFF55"
    focus: "#FF55FF"
    event: "#FFAA00"

# Teammates marked above their heads and on the minimap. Beyond tracking-range
# blocks, where the client no longer has them, their position and name are sent.
team-view:
  enabled: true
  marker-color: "#55FF55"
  tracking-range: 48

# Timers shown as Lunar cooldown icons - every cooldown the plugin keeps: the
# combat tag, the ender pearl, the item cooldowns of pvp.yml, a running countdown
# (/spawn, /logout, /team hq, /team stuck...), the partner items (each, the
# shared one, the Pocket Bard's sets), the class items (a Bard's clicks, a
# Rogue's backstab) and the crowbar. Each shows its own item, unless an icon is
# set here. Icons are item names, as the server spells materials.
cooldowns:
  enabled: true
  combat-tag: true
  combat-tag-icon: DIAMOND_SWORD
  warmups: true
  warmup-icon: CLOCK
  abilities: true
  # The shared cooldown after any partner item.
  ability-global-icon: NETHER_STAR
  ender-pearl: true
  ender-pearl-icon: ENDER_PEARL
  # The item cooldowns of pvp.yml (Gapple, Crapple...), each with its own item.
  item-cooldowns: true
  # A class's click items (a Bard's sugar, blaze powder...) and a Rogue's backstab.
  classes: true
  crowbar: true

# The nametag above each player: a team line (left out for a player with no team)
# and a name line. %color% is the colour for how their team relates to yours;
# %team%, %dtr% and %player% are what they say. A focused player - or a member of
# a focused team - takes the focus colour, except to their own team.
nametags:
  enabled: true
  team-line: "%color%%team% {dark}| {warning}%dtr%"
  name-line: "%color%%player%"
  colors:
    self: "&a"
    ally: "&9"
    enemy: "&c"
    focus: "&d"
    neutral: "&f"
  # Your own nametag too - your team and its DTR - shown by Lunar in third person
  # (F5). Lunar draws it only if "show own nametag" is on in its settings.
  show-self: true