/// SUPPORTED THIRD-PARTY PLUGIN

Vanish

Free guide for configuring this third-party plugin in the Hub. Install the plugin separately from its official source.

Version: 2.1.4
Framework: oxide
Target file: oxide/config/Vanish.json

Open configurator →View configuration page →View the official source ↗

Prepare your file

Check the installed version
This guide describes Vanish 2.1.4. Use the same version in the configurator.
Import your configuration
Open the configurator and import your current JSON. For a new installation, you can start from the provided example.
Edit and download
Adjust the settings, fix reported errors, and download the JSON. Keep a copy of your old file before replacing it.

Your configuration is not saved on the site. Keep the exported file; you can import it again later.

Settings for this version

General 25

Enable noclip: On / off · required
Run the noclip command when vanishing.
JSON path
NoClip on Vanish (runs noclip command)
Inventory commands: List · required
Command aliases used by the inventory viewer.
JSON path
Inventory view cmd
Damage hook: On / off · required
Enable damage handling and vanish.damage; disabling reduces hook cost.
JSON path
Use 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 path
Use 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 vanish eligible players when they connect.
JSON path
Automatically vanish players (with the vanish.use perm) on player connect
Vanish on disconnect: On / off · required
Automatically vanish eligible players when they disconnect.
JSON path
Automatically vanish players (with the vanish.use perm) on player disconnect
Stay hidden offline: On / off · required
Keep disconnected vanished players hidden.
JSON path
Keep a vanished player hidden on disconnect
Move below map on disconnect: On / off · required
Move a vanished player below the map when disconnecting.
JSON path
Teleport a vanished player under the map on disconnect
Move above map on connect: On / off · required
Move a vanished player above the map when connecting.
JSON path
Teleport a vanished player above the map on connect
Bypass violations: On / off · required
Bypass player violation handling while vanished.
JSON path
Bypass violation checks for vanished players
Disable fly-hack detection: On / off · required
Disable fly-hack detection for vanished players.
JSON path
Turn off fly hack detection for players in vanish
Disable metabolism: On / off · required
Pause metabolism effects while vanished.
JSON path
Disable metabolism in vanish
Marker teleport: On / off · required
Allow map-marker teleport for players with vanish.teleport.
JSON path
Enable teleport to marker when vanished
Sound effects: On / off · required
Play effects when vanishing or reappearing.
JSON path
Enable vanishing and reappearing sound effects
Public sounds: On / off · required
Let nearby players hear vanish effects.
JSON path
Make sound effects public
Chat notifications: On / off · required
Notify players in chat when vanish state changes.
JSON path
Enable chat notifications
Vanish effect: Text · required
Rust prefab path played when vanishing.
JSON path
Sound effect to use when vanishing
Reappear effect: Text · required
Rust prefab path played when reappearing.
JSON path
Sound effect to use when reappearing
Enable GUI: On / off · required
Show the built-in Rust CUI vanish indicator.
JSON path
Enable GUI
Use native icon: On / off · required
Use the Rust sprite instead of the remote image URL.
JSON path
Use Native Invis Icon
Icon URL: Text · required
Remote PNG or JPG used by the GUI.
JSON path
Icon URL (.png or .jpg)
Icon sprite: Text · required
Rust sprite path used for the native icon.
JSON path
Icon Sprite
Image color: Text · required
Rust CUI RGBA color string.
JSON path
Image Color
Minimum anchor: Text · required
Minimum normalized anchor for the indicator.
JSON path
Image AnchorMin
Maximum anchor: Text · required
Maximum normalized anchor for the indicator.
JSON path
Image 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.

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.

Install the file

After keeping a copy of the previous file, place the exported JSON at this location on your server:

oxide/config/Vanish.json

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