Skip to Content
ApolloDevelopersModulesStaff Mod

Staff Mod Module

Overview

The staff mod module allows you to interact with Lunar Client’s built in staff mods.

  • Ability to grant and remove staff mods found in Lunar Client for players.
    • Ability to allow players to enable/disable the X-ray, BHop and Nametags mods.

Staff Mod Module Example

Allow your staff to use hidden staff only mods, like xray!

Enabling a staff mod may cause compatibility issues with anti-cheats. For example, your anti-cheat may flag staff members who use BHop, so exempt them from movement checks while it is granted.

Integration

Sample Code

Explore each integration by cycling through each tab, to find the best fit for your requirements and needs.

Apollo API examples. See General for common patterns and helpers.

Enable Staff Mods

public void enableStaffModsExample(Player viewer) {
    if (!viewer.hasPermission("apollo.staff")) {
        return;
    }
 
    Optional<ApolloPlayer> apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId());
    apolloPlayerOpt.ifPresent(apolloPlayer -> this.staffModModule.enableStaffMods(apolloPlayer,
        Arrays.asList(StaffMod.XRAY, StaffMod.BHOP, StaffMod.NAMETAGS), true));
}

Disable Staff Mods

public void disableStaffModsExample(Player viewer) {
    Optional<ApolloPlayer> apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId());
    apolloPlayerOpt.ifPresent(apolloPlayer -> this.staffModModule.disableStaffMods(apolloPlayer,
        Arrays.asList(StaffMod.XRAY, StaffMod.BHOP, StaffMod.NAMETAGS)));
}

enableStaffMods & disableStaffMods Parameters

  1. Recipients recipients
    • A list of all the player(s) you want to enable or disable the staff mod.
  2. StaffMod.TYPE
    • The type of staff mod(s) you want to enable for the Recipients player. See the staff mod types section for more.
  3. boolean enabledByDefault
    • Only available on enableStaffMods. When true, the staff mod is automatically enabled on the player’s client; when false, it is unlocked but left disabled for the player to toggle on themselves.

StaffMod Types

  • XRAY
    • Lets players see through blocks.
  • BHOP
    • Automatically jumps while moving and keeps air speed up.
  • NAMETAGS
    • Shows player nametags through walls and from far away, including sneaking, invisible and team-hidden players.
Server RuleStopwatch