Module: Vanish - Module ID: vanish

Introduction

The Vanish module allows players to turn themselves invisible to other entities on the server. This is a good way to hide yourself while doing work on your server in peace when other players are on your server.

Configuration

Don’t be deceived when looking at the configuration options in your main.conffile. While only a couple options reside in the vanish section of your configuration file, other modules have options for /vanish. These modules are:

The one configuration you can adjust currently is to hide your connection and disconnection messages while in vanish. Set this to true to have your vanished players not show a disconnection message. This will also hide the login message as long as you have the vanish.persist assigned to said player or group.

Vanish on Login

If a player has the nucleus.vanish.onlogin permission, they will log in vanished. This will happen if you use the permission wildcard - this is not a Nucleus bug.

Vanish Status on Logout

Nucleus can remember what your vanish status was when you logged out. To enable this function you need to assign the nucleus.vanish.persist permission to the user or group.

/vanish
Module: vanish
Toggles whether you are invisible on the server.

Aliases: vanish v

Root command aliases: /nvanish

Usage: /vanish [<player>] [<toggle>]

Default Role: ADMIN

Basic Command Permission: nucleus.vanish.base

Permissions

  • nucleus.vanish.persist - Default Role: ADMIN
    If granted, the player is able to retain their vanish status upon logout and login.
  • nucleus.vanish.see - Default Role: ADMIN
    If granted, and the version of Sponge/Nucleus supports this, allows players to see other vanished players and tab their names in commands.
  • nucleus.vanish.base - Default Role: ADMIN
    Allows the user to run the command /vanish
  • nucleus.vanish.others - Default Role: ADMIN
    Allows the user to target other players using the command "vanish".
  • nucleus.vanish.onlogin - Default Role: NONE
    If granted, the target player will always logon vanished.

This command is an equivalent to the following command(s) in Essentials: /vanish, /v

Permission Suggested Role Description
nucleus.vanish.base ADMIN Allows the user to run the command /vanish
nucleus.vanish.onlogin NONE If granted, the target player will always logon vanished.
nucleus.vanish.others ADMIN Allows the user to target other players using the command "vanish".
nucleus.vanish.persist ADMIN If granted, the player is able to retain their vanish status upon logout and login.
nucleus.vanish.see ADMIN If granted, and the version of Sponge/Nucleus supports this, allows players to see other vanished players and tab their names in commands.
The following configuration is the default for this module:
# [EXPERIMENTAL - use with caution] If true, Nucleus will try to alter the tab list when a player vanishes.
alter-tab-list=false
# If true, players who leave or join the server under vanish will not have a login or logout message broadcast.
hide-connection-messages-on-vanish=false