Content generated with AI — it may contain mistakes.

ExyliaStaff/GuidesUpdated in v1.9.0

Vanish from players

Become invisible to players, give ranks different vanish levels and join the server hidden every time.

Page 5 of 386 min read

Vanish makes you invisible to players while staff who are allowed to see you still do. You vanish with one command, you can stay vanished across relogs and servers, and you decide who among the staff can see you.

Before you start#

  • Give the staff rank exyliastaff.vanish. To let a rank see vanished players, also give it exyliastaff.vanish.see.
  • The module switch is modules.vanish in plugins/ExyliaStaff/config.yml.
  • PacketEvents is optional but recommended. With it, a vanished player is simply never sent to viewers who may not see them: no tab entry, no sound, no flicker. Without it, vanish still works but hides the player with Bukkit's hidePlayer, and nothing other plugins send (join or quit lines, chat lines mentioning the player) is filtered.

Steps#

Vanish

Run /vanish (alias /v), or click the lime dye in the staff mode hotbar. An action bar says "You are now invisible".

Reappear

Run /vanish again, or /vanish off. The dye turns gray when you are visible.

Join vanished every time (optional)

Run /vanish auto, or click the AUTO VANISH item (slot 32) in staff mode. From then on you arrive vanished on any server. %staff_vanish_auto% shows the state.

Check that it works#

Vanish, then ask a player without exyliastaff.vanish.see to look at the tab list and the player count: you are not there. A staff member who may see you sees you with a grey glowing nametag and a "joined silently" style line.

Who sees whom#

A viewer sees a vanished player when they hold exyliastaff.vanish.see and their level is at least the vanished player's level. The level is the highest exyliastaff.vanish.level.<n> node the player holds, from 1 to levels.max; no node means level 0. Equal levels see each other, so a team of the same rank still coordinates, and an admin at level 3 is hidden from a helper at level 1 even though the helper sees vanished players. Levels are cached for thirty seconds per player, and levels.enabled: false makes everyone level 0.

The same rule decides who gets the fake join and quit lines, who sees the nametag, and who keeps other plugins' join and quit messages about a vanished player. A player always sees themself. The plugin's own commands leave vanished players out of suggestions and answer as if they were offline to anyone who cannot see them.

Going further#

Vanish somebody else#

/vanish on|off|toggle <player> needs exyliastaff.vanish.others, and a player whose level is lower than the target's is refused with "outranks you". The target is told who did it. From the console, a player must be named.

Show yourself to lower staff#

/vanish level 1 lets staff of level 1 and up see you while you stay vanished to everybody else, for when an admin is showing a helper around. It never goes above your own level; /vanish level alone, a number at or above your level, or leaving the server puts you back at your full level. Nametags, join and quit lines and the staff list follow the lowered level.

Joining vanished#

Two switches make a staff member arrive vanished whatever they had on leaving: their own (/vanish auto, kept in staff_prefs, so it follows them to every server) and the server's on-join.always, which applies to everyone holding exyliastaff.vanish (off by default). Either one works with on-join.remember off.

While vanished#

Always: items are not picked up and mobs do not target you. Configurable: no damage taken (invulnerable), no hunger lost while eating still works (no-hunger), pressure plates and tripwires do not trigger (block-physical-interaction), no breaking or placing blocks (silent-mode, off by default). A vanished player also carries the vanished metadata other plugins read, so cosmetic plugins stop drawing particles around them. MCPets and MyPet pets are hidden too while you are vanished. New in v1.9.0 Sleeping, spawning, projectiles, sculk, raids, statistics and the server list also ignore you: see What the world does not notice.

Relogs and other servers#

With on-join.remember on, an enabled vanish is a row in staff_vanish. Before the player is logged in the row is read (waiting up to three seconds for the database), so the first tab list other players receive already excludes them. Their join message is nulled and, for two seconds, any chat line from another plugin containing their name is dropped for viewers who may not see them. Staff who may see them get the fake join line instead.

A player who lost exyliastaff.vanish while away joins visible and the row is deleted. Losing it while online is noticed within five seconds and makes them visible. On quit the row stays, so the vanish is restored on the next server.

With staff mode#

Staff mode vanishes you on enter and unvanishes you on exit through this module, silently. If the vanish module is off, staff mode does not vanish anyone.

Disabling the module makes everyone visible

/staffadmin module disable vanish unvanishes every vanished player online and deletes their rows, so they also rejoin visible.

Commands and permissions#

CommandWhat it doesPermission
/vanishVanish or reappear.exyliastaff.vanish
/vanish on [player]Vanish. With a player name, vanish them (needs vanish.others).exyliastaff.vanish
/vanish off [player]Reappear, or bring another player back.exyliastaff.vanish
/vanish toggle [player]Switch vanish on or off.exyliastaff.vanish
/vanish autoJoin the server vanished every time.exyliastaff.vanish
/vanish level [number]Lower your vanish level so staff from that level up can see you. Without a number, back to your full level.exyliastaff.vanish
PermissionWho has itWhat it allows
exyliastaff.vanishAdmins (op)Vanish.
exyliastaff.vanish.othersAdmins (op)Toggle vanish for another player.
exyliastaff.vanish.seeAdmins (op)See vanished players of your vanish level or below.

The level nodes exyliastaff.vanish.level.<n> (for example exyliastaff.vanish.level.3) are not listed because there is one per level.

Configuration (modules/vanish/config.yml)
plugins/ExyliaStaff/modules/vanish/config.yml
yaml
invulnerable: true
no-hunger: true
block-physical-interaction: true
silent-mode: false
levels:
  enabled: true
  max: 10
on-join:
  remember: true
  always: false
fake-messages:
  enabled: true
  swallow-others: true
nametag:
  enabled: true
  color: GRAY
  glow: true
KeyDefaultWhat it does
levels.enabledtruefalse makes everyone level 0.
levels.max10Highest level number looked up. Raise it only if you hand out more.
on-join.remembertrueKeep vanish across relogs and server switches.
on-join.alwaysfalseEvery holder of exyliastaff.vanish joins vanished.
fake-messages.enabledtrueSend the fake join and quit lines to staff who may see the player.
fake-messages.swallow-otherstrueDrop other plugins' join and quit lines about a vanished player. Needs PacketEvents.
nametag.colorGRAYA named text colour. Unknown names fall back to gray.
nametag.glowtrueOutline vanished players through walls for staff who may see them.

Messages are in lang/<language>/modules/vanish/messages.yml: enabled, disabled, enabled-other, disabled-other, enabled-by and disabled-by (%staff%), already-enabled, already-disabled, permission-lost, fake-join and fake-quit (%player%), restored, higher-level, auto-enabled, auto-disabled, level-lowered, level-restored and levels-disabled (%level%), status-on and status-off (what the status placeholder returns), and effects.enable / effects.disable (action bar and sound). See ExyliaLib messages and colours.

Placeholders: %staff_vanish_status% (status-on or status-off), %staff_vanish_count% (vanished staff on every server), %staff_vanish_auto%, %staff_vanished% and %staff_vanish_tag% (the tag message, [V] by default, empty when not vanished; handy as a TAB suffix). New in v1.9.0 See Placeholders.

Something missing on this page? Tell us on Discord