Skip to content
← All documentation

/// SUPPORTED THIRD-PARTY PLUGIN

Vanish

Free guide for configuring this third-party plugin in the Hub. To install it, use its plugin page or official source.

Prepare your file

  1. Check the installed version

    This guide describes Vanish 2.1.4. Use the same version in the configurator.

  2. Get the settings

    Click Import, then From my server. Select the files and confirm loading them. Selecting a server does not replace the open document. You can also import files from this device or a configuration from My projects.

  3. Edit and send

    Adjust settings, fix errors, then use Send to transfer files to the selected server. A conflict blocks sending until you choose how to resolve it. You can still export only the files you need.

Server transfers have private backups. Save keeps your work in My projects; it does not send anything to the server. A download also lets you resume without a server connection.

Settings for this version

General 25
Enable noclip
On / off · required

Run the noclip command when vanishing.

JSON pathNoClip on Vanish (runs noclip command)
Inventory commands
List · required

Define commands opening a targeted or named player’s inventory. They require vanish.invviewer; adding an alias does not grant that permission.

JSON pathInventory view cmd
Damage hook
On / off · required

Filter damage involving an invisible player: an invisible attacker with vanish.damage may deal damage; other handled cases are cancelled. Disabling the hook removes this filtering, not just its processing cost.

JSON pathUse OnEntityTakeDamage hook (Set to true to enable use of vanish.damage perm. Set to false for better performance)
Locked entity hook
On / off · required

Allow vanish.unlock to bypass locks; disabling reduces hook cost.

JSON pathUse CanUseLockedEntity hook (Allows vanished players with the perm vanish.unlock to bypass locks. Set to false for better performance)
Vanish on connect
On / off · required

Automatically hide permitted players when they connect. Despite the field name, 2.1.4 checks vanish.allow. Restoring saved invisibility and vanish.permanent are handled separately.

JSON pathAutomatically vanish players (with the vanish.use perm) on player connect
Vanish on disconnect
On / off · required

Hide players with vanish.allow immediately before disconnect handling. The legacy name mentions vanish.use, but this version does not check that permission.

JSON pathAutomatically vanish players (with the vanish.use perm) on player disconnect
Reveal unauthorized players on disconnect
On / off · required

Make an invisible player reappear on disconnect if they have neither vanish.permanent nor vanish.allow, when this option is enabled. In 2.1.4, disabling it therefore does not reveal all disconnected players; its legacy name is misleading.

JSON pathKeep a vanished player hidden on disconnect
Move below map on disconnect
On / off · required

Move a player remaining invisible offline five meters below terrain if they are above terrain. Test reconnect recovery with the above-map option; this is not just a display preference.

JSON pathTeleport a vanished player under the map on disconnect
Move above map on connect
On / off · required

Move a limited-networking player reconnecting below terrain to 0.5 meters above terrain. This does not teleport every invisible player into the sky or change their horizontal position.

JSON pathTeleport a vanished player above the map on connect
Bypass violations
On / off · required

Bypass player violation handling while vanished.

JSON pathBypass violation checks for vanished players
Disable fly-hack detection
On / off · required

Disable fly-hack detection for vanished players.

JSON pathTurn off fly hack detection for players in vanish
Disable metabolism
On / off · required

Stabilize the invisible player’s needs: calories, hydration, temperature, oxygen, radiation and wetness are adjusted, then metabolism is paused. This is not merely hiding the needs bars.

JSON pathDisable metabolism in vanish
Marker teleport
On / off · required

Let an invisible player with vanish.teleport teleport by placing a map marker while holding RELOAD. The player must not be mounted; their current height is retained.

JSON pathEnable teleport to marker when vanished
Sound effects
On / off · required

Play the configured effects when vanishing and reappearing. Disabling stops playback without disabling Vanish.

JSON pathEnable vanishing and reappearing sound effects
Public sounds
On / off · required

Broadcast the effect at the player’s position. When disabled, only that player receives it; this does not change invisibility.

JSON pathMake sound effects public
Chat notifications
On / off · required

Notify players in chat when vanish state changes.

JSON pathEnable chat notifications
Vanish effect
Text · required

Rust effect prefab asset path played when vanishing, if effects are enabled. This is not an audio-file URL.

JSON pathSound effect to use when vanishing
Reappear effect
Text · required

Rust effect prefab asset path played when reappearing, if effects are enabled. This does not change Vanish permissions.

JSON pathSound effect to use when reappearing
Enable GUI
On / off · required

Show Vanish’s custom indicator when the player becomes invisible. This disables neither invisibility nor the native Rust icon, which has its own setting.

JSON pathEnable GUI
Use native icon
On / off · required

Also enable Rust’s own invisibility indicator for the invisible player. This does not select between Icon URL and Icon Sprite or replace the custom indicator controlled by Enable GUI.

JSON pathUse Native Invis Icon
Icon URL
Text · required

Change the remote image sent to Vanish’s custom indicator. This version sends it alongside Icon Sprite; Use Native Invis Icon does not select this image. Use a direct PNG or JPG address.

JSON pathIcon URL (.png or .jpg)
Icon sprite
Text · required

Change the Rust sprite sent to Vanish’s custom indicator alongside Icon URL. This does not choose the native Rust icon enabled by Use Native Invis Icon.

JSON pathIcon Sprite
Image color
Text · required

Tint Vanish’s custom indicator and adjust its transparency. Rust values are red, green, blue and opacity from 0 to 1; opacity 0 hides the indicator without disabling Vanish.

JSON pathImage Color
Bottom-left corner
Text · required

Place this corner within the screen. X: left (0) to right (1). Y: bottom (0) to top (1). Both corners define the area's size.

JSON pathImage AnchorMin
Top-right corner
Text · required

Place this corner within the screen. X: left (0) to right (1). Y: bottom (0) to top (1). Both corners define the area's size.

JSON pathImage AnchorMax

Plugin instructions

Vanish 2.1.4

Vanish makes authorized Rust players invisible. It has no plugin dependency and runs on Oxide. Grant only the permissions needed: vanish.allow, vanish.unlock, vanish.damage, vanish.permanent, vanish.invviewer, and vanish.teleport are registered by the pinned source. The two generated configuration key names mentioning vanish.use are retained verbatim even though the source registers vanish.allow.

Use it for authorized staff observation, with explicit movement, interaction and feedback choices. Reviewed on 2026-10-05 against Whispers88’s official guide, the pinned 2.1.4 source, schema and defaults. The Hub edits oxide/config/Vanish.json only; exporting does not install the plugin, assign permissions or change a player’s live state.

Configuration

  • Movement and lifecycle: NoClip on Vanish (runs noclip command), both automatic connect/disconnect settings, Keep a vanished player hidden on disconnect, and the below/above-map teleport settings control how vanished players move and persist. Automatic or map-edge teleport behavior can strand or kill a player after reconnecting; test it first.
  • Security and performance: the OnEntityTakeDamage and CanUseLockedEntity hooks enable vanish.damage and vanish.unlock behavior. The source itself recommends disabling them for better performance when unused. Bypass violation checks..., Turn off fly hack detection..., and Disable metabolism... weaken normal checks for vanished players and should be granted/configured narrowly.
  • Interaction: Inventory view cmd defines command aliases. Enable teleport to marker when vanished also requires vanish.teleport.
  • Feedback: the sound toggle, public-sound toggle, chat-notification toggle, and the two sound-effect prefab paths control vanish feedback. Invalid prefab paths may produce no effect; public sounds can reveal activity.
  • GUI: Enable GUI, Use Native Invis Icon, Icon URL (.png or .jpg), Icon Sprite, Image Color, Image AnchorMin, and Image AnchorMax control the built-in Rust CUI indicator. It is not PimpMyCUI. Remote image URLs introduce an external dependency, and invalid anchors/color strings can hide the indicator.

Target file: oxide/config/Vanish.json. Hidden-player state is stored separately and is outside this bundle.

Recipe: manual vanish with private feedback

  1. Keep both Automatically vanish players... options false and Make sound effects public false.
  2. Keep Enable chat notifications and Enable GUI true so staff see their own state. Decide deliberately whether NoClip on Vanish (runs noclip command) should be enabled.
  3. Grant vanish.allow to the intended staff group, reload Vanish, and test /vanish on and off with an ordinary player nearby.

Do not grant vanish.permanent for this manual-toggle workflow: it prevents the ordinary return-to-visible toggle. Granting visibility access does not require granting inventory inspection, damage or lock bypass.

Recipe: marker teleport for selected staff

  1. Set Enable teleport to marker when vanished to true.
  2. Grant vanish.allow and vanish.teleport only to selected staff.
  3. While vanished and unmounted, hold the reload key when adding a map marker. Try this in a safe test area: the pinned source keeps the player’s current height rather than finding safe ground.

Permissions and limits

  • vanish.allow: toggle vanish; also checked by automatic connect/disconnect rules.
  • vanish.unlock: bypass locks while vanished, with the lock hook enabled.
  • vanish.damage: permit damage from a vanished attacker, with the damage hook enabled.
  • vanish.permanent: remain vanished; incompatible with ordinary manual reappearance.
  • vanish.invviewer: inspect inventories through configured commands.
  • vanish.teleport: use enabled marker teleport while vanished.

Keep these permissions narrow. Noclip, anti-hack bypass and lifecycle teleports need safe server checks; the Hub does not evaluate those runtime effects. The built-in indicator is Rust CUI, not a PimpMyCUI project. Oxide and version 2.1.4 are the reviewed target; no gameplay/integration test or Carbon guarantee is claimed by this editorial review.

Questions

Should I grant vanish.use or vanish.allow?

Use vanish.allow for 2.1.4. The source registers and checks it, although two configuration key labels still say vanish.use. Leave the JSON labels unchanged so the plugin can read them.

Does granting damage or unlock permission enable the feature?

Not by itself. vanish.damage needs Use OnEntityTakeDamage hook... true; it is false by default. vanish.unlock needs Use CanUseLockedEntity hook... true; it is true by default. Review each hook together with its grants.

Install the files

With a connected server, click Send in the configurator. The result shows whether the files were sent and the plugin reloaded. Without RCON, reload the plugin from your server panel after sending.

Without a connected server: Keep a copy of the current files. Place each export in the folder shown before export, or follow the paths in the ZIP. Do not put data or translation files in the config folder.

Follow the plugin instructions above for dependencies and reloading. Exporting does not connect the site to your server.

Configuration and transfer guide →