What is the Vanish plugin?
Vanish is a RUST plugin that enables admins or players with adequate permissions the ability to disappear and reappear from the sight of other players. Created by Wulf, Vanish is now patched and supported by Whispers88. The Vanish plugin is free to use and available for download on uMod. It is a favorite plugin amongst the RUST admin community due to its ongoing utility as an information-gathering tool.
Potential reasons to use the Vanish plugin
As indicated by its imaginative name, Vanish allows those players with the proper permissions to disappear from the sight of all players and cease making most noises. While actively “vanished,” the invisible party can use all commands they would otherwise have permission to use. Players under the effect of Vanish do not make footstep noises and, short of firing a gun or hitting something with a weapon, make no other sound.
Additional features that the Vanish plugin provides, permissions pending, include:
- The ability to access any locked entity within the game space
- Capacity to damage players or entities while invisible
- Toggle invisibility on or off, either through command or bind
- NoClip on Vanish
- Remain Vanished while disconnected
- Disable fly hack detection for players while they are Vanished
- Immunity to hunger or thirst while Vanished
- Reset hunger/hydration levels when unvanishing
- Scare the wits out of players by emitting an audible noise (configurable) when vanishing or unvanishing
Installing the Vanish plugin
As with all uMod plugins, the server you intend to install them on requires uMod (Oxide) to be installed to facilitate their function. For a step-by-step perspective on how to install this plugin, please reference the following list:
- First, you must have uMod/Oxide installed on your server. Use our Installing uMod (Oxide) on Your RUST server guide if you need help; otherwise, if you use a third-party hosting, their user interface will have instructions on how to get started. It may be tooled explicitly to their platform, so reach out to your host for details.
- Acquire the latest version of the plugin from uMod’s Vanish page or download the CS file directly.
- Locate the downloaded
Vanish.csfile and install the plugin on your RUST server, or follow your host-specific instructions.
- Once Vanish is installed in the plugins folder, and if the server is actively running, uMod will immediately create an alternate
Vanish.jsonfile in your config folder. It is essential to differentiate these files and not mistake them, as you must make configuration changes in the .json file in the config folder.
Like many other uMod plugins, Vanish may work as a standalone mod or in conjunction with other select mods. A complete list of such mods includes:
- Admin Logger
- Admin Panel
- Chat Head
- Discord Logger
- Heli Ride
- Human NPC
- NPC TP
- Prop Control
As with all uMod plugins, they will each have a small list of plugin-specific permissions. Make sure you reference our uMod Permissions Guide to better understand the
Oxide.grant permission system. Specific permission command lines for Vanish include:
|Vanish.allow||This permission is required for any group or individual the server owner wishes to have the vanish capability.|
|Vanish.damage||Pending ‘Use OnEntityTakeDamage hook’ being set to true in the |
|Vanish.permanent||This permission forces players within the permission group designated always to be invisible|
|Vanish.unlock||This permission is required for any group or individual the server owner wishes to have the capacity to open locked entities while vanished.|
Once installed and permitted to use the mod, players may activate it in-game via a simple
vanish command in chat or by typing
vanish in the F1 console.
Recommended plugin configurations
By default, the configuration of the
Vanish.json file should be adequate for most server owners’ purposes. To better understand potential option changes, this Vanish guide will go through the configuration file line by line as it pertains to the most commonly changed settings:
|NoClip on Vanish (runs noclip command)||True||Altering this to false will simply disable the noclip command from running when Vanish is toggled on or off.|
|Use OnEntityTakeDamage hook||False||Altering this to true will enable vanished players to damage other players and entities.|
|Use CanUseLockedEntity hook||True||Altering this to false will enable vanished players to open or interact with locked entities.|
|Keep a vanished player hidden on disconnect||True||Altering this to false will make players that disconnect while vanished reappear to everyone, player and AI, in-game.|
|Turn off fly hack detection for players in vanish||True||Not advised to alter this, as it will cause admins using the noclip function to be kicked more frequently.|
|Disable metabolism in vanish||True||Altering this false means that non-god mode admins can starve to death while invisible.|
|Reset hydration and health on un-vanishing||True||Altering this to false will disable player hydration and health from restoring to their default setting upon leaving vanish.|
|Enable vanishing and reappearing sound effects||False||Setting to true enables other players to hear your vanish noise.|
|Make sound effects public||False||Setting to false disables sound effects.|
|Enable chat notifications||True||Setting to false disables text notification of successful vanish|
|Sound effect to use when vanishing||assets/prefabs/npc/patrol helicopter/effects/rocket_fire.prefab||Advanced: Alters sound to prefab specified, not advised for those unfamiliar with file pathing.|
|Sound effect to use when reappearing||assets/prefabs/npc/patrol helicopter/effects/rocket_fire.prefab||Advanced: Alters sound to prefab specified, not advised for those unfamiliar with file pathing.|
|Enable GUI||True||Displays a small icon specified by the below configurable URL.|
|Icon URL (.png or .jpg)||http://i.imgur.com/Gr5G3YI.png||Changing allows for the custom image to display instead of the default ‘ghost’ image.|
|Image Color||1 1 1 0.3||Alters image color.|
|Image AnchorMin||0.175 0.017||Alters image position.|
|Image AnchorMax||0.22 0.08||Alters image position.|
How to update the Vanish plugin
Updating the Vanish plugin is simple and quick:
- Visiting the uMod Vanish plugin page
- Download the latest version of the Vanish plugin
- Overwrite the existing
Vanish.csfile in your Oxide plugins folder.
It is best practice not to uninstall the mod, as you do not need to alter the JSON file. It will remain with your existing settings (unless the developer otherwise suggests a complete reinstall).
How to remove the Vanish plugin
As the Vanish plugin doesn’t impact player experience or game features necessary to run processes within the game itself, removing the plugin is as simple as deleting
Vanish.cs from your plugins folder.
Suppose you want to disable the Vanish plugin for a short period. You can use the
Oxide.unload Vanish command, which you may also run in the F1 console, RCON, or Web Console. While not necessary when uninstalling, players may also remove the
Vanish.json file in the config folder after removing
Vanish.cs, so that it doesn’t keep auto-generating.
Disclaimer and seeking assistance
Corrosion Hour does not maintain Vanish, nor do we assist with modifying the plugin outside the config scope. To support the creators, report bugs, or propose feature requests, please reach out to the developer of the plugin here. For help with steps and instructions found in this guide, please reach out to an admin via our discord.