config.yml

You will learn step by step what every option of the regular config file means and how to configure them.

General Settings

These are the general settings the plugin offers you to configure. Please learn about yaml before editing the configuration since yaml doesn't tolerate any errors.

language: (str)

The setting for locale. Possible values: en-us, fi_fi

language: en-us

debug: (bool)

The first option is a boolean which makes the plugin print debugging info to the console.

debug: false

update_checker: (bool)

Here you can set if you want to check for new updates. If it's set to true, it will tell if new updates are available for download.

update_checker: true

Effect settings

All the settings for all effects. You can configure them how you like.

lightning:

You can set if the time is set to night when the effect is ran. It's set to true by default.

  lightning:
    # Will the time set to night with the effect? Default: true
    night: true

particle:

Configure what particle will be used when using particle as the effect and how many particles will be spawned upon vanishing.

type only allows one of these enums: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Particle.html#enum-constant-summary

  particle:
    # What particle will be used when using particle as the effect. Docs: https://animvanish.mikart.eu/configuration/config.yml#particle
    type: DRAGON_BREATH
    # How many particles will be spawned. Default: 50
    amount: 50

sound:

Configure what sound will the player hear.

This value only allows these enums: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html#enum-constant-summary

  sound:
    # What sound the player will hear. Default: BLOCK_AMETHYST_BLOCK_HIT Docs: https://animvanish.mikart.eu/configuration/config.yml#sound
    type: BLOCK_AMETHYST_BLOCK_HIT

blindness:

Configure the settings what happens when blindness effect is ran.

blindness:
    # How many seconds the blindness effect will last. Default: 3
    duration: 3
    # Radius of how many blocks the blindness effect will reach. Default: 10
    radius: 10

firework:

Set the colors and type for firework effect. You can make it look really cool by setting some nice colors. Use hex color formatting.

Type must be one of these enums: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/FireworkEffect.Type.html#enum-constant-summary

firework:
    # What type of firework you want to have. Default: BURST Docs: https://animvanish.mikart.eu/configuration/config.yml#firework
    type: BURST
    # Colors of the firework. Default: ['#FF0000', '#00FF00', '#0000FF', '#FFFF00', '#00FFFF']
    colors:
    - '#FF0000'
    - '#00FF00'
    - '#0000FF'
    - '#FFFF00'
    - '#00FFFF'

npc:

Set how many seconds will the npc be visible.

Duration can't be set to more than 30 seconds. It will default to 3 in a case where it's anywhere higher than that.

npc:
    # How many seconds the NPC will be visible. Default: 3
    duration: 3

launch:

Configure if launch effect Armor Stands should use the players' own armor.

  launch:
    # Enable if launch effect Armor Stands should use the players' own armor. Default: true
    use_player_armor: true

Default Configurations

config.yml

# ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
# ┃       AnimVanish Config      ┃
# ┃    Developed by ArikSquad    ┃
# ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
# ┣╸ Information: https://github.com/ArikSquad/AnimVanish
# ┣╸ Config Help: https://animvanish.mikart.eu/configuration/config.yml
# ┗╸ Documentation: https://animvanish.mikart.eu/

# Locale of the default language file to use. Docs: https://animvanish.mikart.eu/configuration/language-files
language: en-us
# Whether to enable debug mode. This will print additional information to the console.
debug: false
# Whether to enable the plugin's update checker.
update_checker: true
# All settings related to the effects.
effects:
  lightning:
    # Will the time set to night with the effect? Default: true
    night: true
  particle:
    # What particle will be used when using particle as the effect. Docs: https://animvanish.mikart.eu/configuration/config.yml#particle
    type: DRAGON_BREATH
    # How many particles will be spawned. Default: 50
    amount: 50
  sound:
    # What sound the player will hear. Default: BLOCK_AMETHYST_BLOCK_HIT Docs: https://animvanish.mikart.eu/configuration/config.yml#sound
    type: BLOCK_AMETHYST_BLOCK_HIT
  blindness:
    # How many seconds the blindness effect will last. Default: 3
    duration: 3
    # Radius of how many blocks the blindness effect will reach. Default: 10
    radius: 10
  firework:
    # Colors of the firework. Default: ['#FF0000', '#00FF00', '#0000FF', '#FFFF00', '#00FFFF']
    colors:
    - '#FF0000'
    - '#00FF00'
    - '#0000FF'
    - '#FFFF00'
    - '#00FFFF'
  npc:
    # How many seconds the NPC will be visible. Default: 3
    duration: 3
  launch:
    # Enable if launch effect Armor Stands should use the players' own armor. Default: true
    use_player_armor: true

messages-xx-xx.yml

# ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
# ┃     AnimVanish - Locales     ┃
# ┃    Developed by ArikSquad    ┃
# ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
# ┣╸ Thanks for using AnimVanish.
# ┗╸ Translate AnimVanish: https://github.com/ArikSquad/AnimVanish

locales:
  prefix: '[<gradient:#77DD77:#AFEEEE>AnimVanish</gradient>]'
  invalid_args: <prefix> <red>Invalid arguments.</red>
  not_player: <prefix> <red>You must be a player.</red>
  reload: <prefix> <color:#b0ff5c>Reloaded configs</color>
  player_not_found: <prefix> <red>Player not found.</red>
  no_permissions: <prefix> <red>You don't have permissions to use this command.</red>
    <green>(%1%)</green>
  only_to_vanish: <prefix> <red>This effect only applies when going into vanish.</red>
  not_found: <prefix> <red>Effect was not found.</red>
  particle_invalid_config: <prefix> <red>Invalid particle configuration. Ask an administrator
    to check config file.</red>
  blindness_message: <prefix> <yellow>You saw something and you now feel dizzy</yellow>
  blindness_author: <prefix> <green>You blinded all the players around you.</green>
  sound_invalid_config: <prefix> <red>Invalid sound configuration. Ask an administrator
    to check config file.</red>
  turn_none: <prefix> <color:#ff926e>Nobody was turned, because there is nobody close
    to you.</color>
  launch_no_space: <prefix> <red>There is no space to launch an armor stand</red>
  gui_title: <color:#e26eff>Select an effect</color>
  gui_placeholder_name: <gray>Select an effect</gray>
  gui_item_name: <green>%1%</green>
  gui_item_lore: <blue>%1%</blue>
  dependency_no_citizens: <prefix> <red>You must have Citizens installed to use this
    effect.</red>
  dependency_no_vanish: <prefix> <red>You must have a supported vanish plugin installed
    to use this command.</red>

PreviousEffects NextLanguage files

Last updated 9 months ago