Vanish

Vanish

How to Install

1. Download the .jar file from GitHub, Modrinth or CurseForge
2. Drop the file into your mods folder
3. Restart your server!

Features

• You are completely invisible and undetectable
• No open/close container (chests, barrels, ender chests, and shulker boxes) animations
• You don't make noise (placing, breaking, walking, using items...)
• You are removed from command selectors (/msg, /gamemode...)
• You get removed from /list command
• You don't appear in the server list player sample and player count
• You don't obstruct block placement
• Your advancement, death, join/leave messages, and others are hidden
• Fake join/leave messages are sent on vanish/un-vanish
• Hide from entities
• Bluemap support
• Dynmap support
• Squaremap support
• Hide sleep status
• Exclude vanished players from player count
• Prevents block interactions (pressure plates, dripleaf, tripwire, farmland, redstone ore, sculk sensor/shrieker and turtle egg)
• Prevents player vibrations (sculk sensor/shrieker and warden)
• Prevents mob spawning
• Prevents chunk loading / generation
• Prevents entity collisions
• Prevents entity pickups (arrows, experience orbs, items and tridents)
• Prevents special mob spawning (spawners, skeleton traps, zombie reinforcements, raids, phantoms)
• Prevents sweeping edge attacking players
• Prevents dispensers equipping armor
• Prevents trial spawner detection
• Prevents vault detection
• Hide traceable entities (arrows, firework rockets, fishing rod...)
• Hide player waypoints (1.21.6+)

Config

The config file is located at ./config/vanish.hocon. Use /vanish reload to reload it.

# Show vanish status in the action bar
action-bar=true
# Prevents vanished players from using chat
disable-chat=true
# Prevents vanished players from using /msg
disable-msg=true
# Hide vanished players from entities, prevents hostile entities from targeting players, and more
hide-from-entities=true
# Prevent vanished player world interactions
interaction {
    # Prevent progressing advancements
    advancement-progress=false
    # Prevent block interactions (pressure plates, dripleaf, tripwire, farmland, redstone ore, sculk sensor/shrieker and turtle egg
    blocks=true
    # Prevent chunk loading / generation
    chunk-loading=false
    # Prevent entity collisions
    entity-collisions=true
    # Prevent entity pickups (arrows, experience orbs, items and tridents)
    entity-pickup=true
    # Prevent mob spawning
    mob-spawning=true
    # Prevent player vibrations
    vibrations=true
}
# Text to be displayed when placeholder vanish:vanished is used for a vanished player
place-holder-display=" <gray>☠"

Commands

• /vanish - Toggle vanish
• /vanish reload - Reload config file
• /vanish on <players> - Enable vanish for other players
• /vanish off <players> - Disable vanish for other players

Permissions

You need to be an operator or have these permissions to be able to use the mod

• vanish.command.vanish - Access to /vanish command
• vanish.command.vanish.reload - Use /vanish reload to reload the config
• vanish.command.vanish.other - Set the vanish-status of others
• vanish.feature.view - See vanished player

Meta keys

• vanish_on_join:true - Always join vanished

Placeholders

• vanish:vanished - Displays a text (configurable via config) if a player is vanished
• vanish:online - The number of players that the player viewing the placeholder can see

Developers

Add the modrinth maven repository to your build.gradle.

repositories {
    // There might be other repos there too, just add it at the end
    maven { url "https://api.modrinth.com/maven" }
}

Declare vanish as an optional dependency!

dependencies {
    // You will have other dependencies here too
    modCompileOnly "maven.modrinth:vanish:[VERSION]"
}

Before using the API you need to make sure the mod is actually loaded, by checking FabricLoader.getInstance().isModLoaded("melius-vanish");.
If the mod is present you can use VanishAPI and VanishEvents to integrate your own mods.

Datapacks

Datapacks can use an entity predicate like vanish:visible
to check if an entity is vanished. You should add this predicate to your datapack and use it to check whether a player
can be seen by other players (in respect to vanish). It is designed to return true when the vanish mod is not installed
to stay compatible with vanilla.