Skip to content

Configuration Reference

Jump to bottom
TheCommandCraft edited this page Apr 6, 2026 · 1 revision

Configuration Reference

All settings live in plugins/Vanishpp/config.yml. Edit in-game with /vconfig <key> [value] or directly in the file and reload with /vreload.

messages

messages:
  fake-join: ""         # Fake join message shown when unvanishing. Empty = native translation.
  fake-quit: ""         # Fake quit message shown when vanishing. Empty = native translation.
  staff-notify:
    enabled: true       # Notify staff when a player's vanish state changes.

vanish-appearance

vanish-appearance:
  tab-prefix: "&7[VANISHED] "     # Prefix in the tab list (visible to staff only).
  nametag-prefix: "&7[V] "        # Prefix above the player's head (staff only).
  action-bar:
    enabled: true
    text: "&bYou are currently VANISHED"
  adjust-server-list: true        # Exclude vanished players from the server list count.
  staff-glow: true                # Glowing outline for vanished players (staff only, requires ProtocolLib).

vanish-gamemodes

vanish-gamemodes:
  enabled: true    # Master switch for the Spectator Quick-Switch feature.

flight-control

flight-control:
  vanish-enable-fly: true       # Enable flight automatically on vanish.
  unvanish-disable-fly: true    # Disable flight automatically on unvanish.
                                # Set false if players have rank-based fly permissions.

chat-format

chat-format:
  vanished-player-format: "%prefix%&7%player%: %message%"

How vanished players appear in chat to those who can see them. Supports %prefix%, %player%, %message%.

invisibility-features

invisibility-features:
  god-mode: true                  # Invincible while vanished.
  prevent-potion-effects: true    # Block splash/lingering potions from hitting vanished players.
  night-vision: true              # Auto night vision while vanished.
  disable-mob-targeting: true     # Mobs cannot target vanished players.
  disable-hunger: true            # No hunger loss while vanished.
  silent-chests: true             # Open containers silently.
  ignore-projectiles: true        # Projectiles pass through vanished players.
  prevent-raid-trigger: true      # Cannot trigger village raids.
  prevent-sculk-sensors: true     # Cannot activate sculk sensors.
  prevent-trample: true           # Cannot trample farmland or turtle eggs.
  hide-from-tab-complete: true    # Removed from tab-completion (requires ProtocolLib).
  prevent-sleeping: true          # Cannot sleep in beds while vanished.
  prevent-entity-interact: true   # Cannot ride horses or interact with entities.
  prevent-accidental-chat: true   # Chat messages require /vchat confirm.

vanish-effects

vanish-effects:
  hide-from-server-list: true      # Remove from server list player sample.
  hide-real-quit-messages: true    # Suppress the real quit message on vanish.
  hide-real-join-messages: true    # Suppress the real join message on unvanish.
  broadcast-fake-quit: true        # Send fake quit message when vanishing.
  broadcast-fake-join: true        # Send fake join message when unvanishing.
  disable-block-triggering: true   # Prevent pressure plates and buttons triggering.

hide-announcements

hide-announcements:
  death-messages: true          # Hide death messages for vanished players.
  advancements: true            # Hide advancement announcements for vanished players.
  hide-from-plugin-list: true   # Hide Vanish++ from /plugins for non-staff.

default-rules

Default values for Personal Rules (VRules) applied to all players without individual overrides.

default-rules:
  can_break_blocks: false
  can_place_blocks: false
  can_hit_entities: false
  can_pickup_items: false
  can_drop_items: false
  can_trigger_physical: false
  can_interact: true
  can_throw: false
  can_chat: false
  mob_targeting: false
  show_notifications: true
  spectator_gamemode: true

hooks

hooks:
  simple-voice-chat:
    enabled: true
    isolate-vanished-players: true
  essentials:
    simulate-join-leave: false    # Use EssentialsX custom join/quit messages.

storage

See Storage for full setup instructions.

storage:
  type: "YAML"      # YAML, MYSQL, or POSTGRESQL
  mysql:
    host: "localhost"
    port: 3306
    database: "vanishpp"
    username: "root"
    password: ""
    use-ssl: false
    pool-size: 10
  redis:
    enabled: false
    host: "localhost"
    port: 6379
    password: ""

scoreboard

scoreboard:
  enabled: true
  auto-show-on-vanish: true

See Scoreboard Configuration for layout and placeholders.

update-checker

update-checker:
  enabled: true
  modrinth-id: "vanishpp"
  notify-mode: "PERMISSION"
  notify-list: []

permissions

permissions:
  layered-permissions-enabled: true
  default-vanish-level: 1
  default-see-level: 1
  max-level: 100

See Layered Permissions (Vanish Levels).

Clone this wiki locally