Articles on: Rust Guides

Vanish Plugin Guide: Moderate Your Server With Ease While Invisible

Plugin Available on Umod: https://umod.org/plugins/vanish
This plugin is allowed for all server types since it does not alter the gameplay experience

Introduction


Vanish, a powerful plugin developed by Whispers88, allows Rust server owners to grant specific players the ability to become completely invisible. Invisible players cannot be seen, heard, or touched by other players, turrets, helicopters, NPCs, and more. In this guide, we will cover the key features, permissions, commands, and configuration of the Vanish plugin.

Section 1: Key Features of the Vanish Plugin


1.1 Complete Invisibility
When vanished, players are entirely undetectable by others, as well as by in-game entities like turrets, helicopters, and NPCs.

1.2 Permissions-Based
The Vanish plugin uses Rust's permission system to grant or revoke the ability to become invisible, unlocking locks, and dealing damage while invisible.

1.3 Customizable Configuration
Server owners can modify numerous settings to tailor the plugin's behavior according to their server's needs.

Section 2: Vanish Permissions and Commands


2.1 Permissions
To manage permissions, use oxide.grant or oxide.revoke commands. The Vanish plugin provides the following permissions:

vanish.allow — Allows a player to become invisible
vanish.unlock — Enables an invisible player to unlock all locks
vanish.damage — Allows an invisible player to damage other entities (requires a configuration setting to be enabled)
vanish.permanent — Permanently forces a player to be vanished


2.2 Commands
The plugin offers a single command that can be used in both chat and console:

vanish — Toggles invisibility on/off for the player who issues the command

Section 3: Configuration and Localization


3.1 Configuration

Server owners can customize the Vanish plugin's settings by modifying the configuration file located in the config directory. An editor and validator are recommended to avoid formatting errors.

3.2 Localization

By default, the plugin's messages are in English. To support other languages, create a new language folder, copy the default language file into it, and customize the messages as needed.

Section 4: Developer API and Hooks


4.1 API

The Vanish plugin provides an API that developers can use to interact with the plugin:

Disappear(BasePlayer player) — Makes a player disappear
Reappear(BasePlayer player) — Makes a player reappear
IsInvisible(BasePlayer player) — Checks if a player is invisible

4.2 Hooks

Two hooks are available for developers to utilize:

OnVanishReappear(BasePlayer player) — Triggered when a player reappears
OnVanishDisappear(BasePlayer player) — Triggered when a player disappears

Conclusion

The Vanish plugin empowers Rust server owners to create unique gameplay experiences by granting players the power of invisibility. By understanding its features, permissions, commands, and configuration, you can enhance your server with this versatile plugin. Add the Vanish plugin to your Rust server today and explore the endless possibilities of invisibility.

Updated on: 10/04/2023

Was this article helpful?

Share your feedback

Cancel

Thank you!