Addon files explained

---

a.k.a Plugin configuration section

Additional files generated on the main plugin folder

ranks.yml

note

Here you can add as many ranks as you want which will be triggered by statistic types

Ranks:
  # Should custom ranks be enabled?
  Enabled: true
  # Should ranks be formatted in global chat?
  Global-Chat: false
  List:
    Rookie:
      # Statistic to check for, if player has x wins and higher his messages in game will be formatted like that
      # Valid Statistic Types:
      # - WINS           - LOSES
      # - GAMES_PLAYED   - SCORED_POINTS
      Statistic: WINS
      # Minimum amount of statistic needed to format user message into this one
      Amount-Needed: 0
      # Message formatting. Placeholders: %player% - player name, %message% - player message
      Format: "&fRookie &7%player%: %message%"

custom_kits.yml

note

Here we save all the kits you create. It is recommended to use the In-Game configurator, but you can also edit the files.

Example:

  Pyromaniac:
    Name: '&6Pyromaniac'
    Description:
      - '&7Your every weapon has fire enchant.'
      - '&7You''re not scared of fire. Pyromania is'
      - '&7your second nature. Burn them all!'
    Material: FIREBALL
    Type: LEVEL_KIT
    Required-Level: 30
    Permission-To-Unlock: villagedefense.kit.pyromaniac
    Start-Equipment:
      Inventory:
        - ==: org.bukkit.inventory.ItemStack
          type: IRON_SWORD
          meta:
            ==: ItemMeta
            meta-type: UNSPECIFIC
            enchants:
              FIRE_ASPECT: 2
              DURABILITY: 10
        - ==: org.bukkit.inventory.ItemStack
          type: BOW
          meta:
            ==: ItemMeta
            meta-type: UNSPECIFIC
            enchants:
              ARROW_FIRE: 2
        - ==: org.bukkit.inventory.ItemStack
          type: ARROW
          amount: 32
        - ==: org.bukkit.inventory.ItemStack
          type: GRILLED_PORK
          amount: 10
      Helmet:
        ==: org.bukkit.inventory.ItemStack
        type: LEATHER_HELMET
        meta:
          ==: ItemMeta
          meta-type: LEATHER_ARMOR
          color:
            ==: Color
            RED: 25
            BLUE: 25
            GREEN: 25
      Chestplate:
        ==: org.bukkit.inventory.ItemStack
        type: LEATHER_CHESTPLATE
        meta:
          ==: ItemMeta
          meta-type: LEATHER_ARMOR
          color:
            ==: Color
            RED: 153
            BLUE: 51
            GREEN: 51
      Leggings:
        ==: org.bukkit.inventory.ItemStack
        type: LEATHER_LEGGINGS
        meta:
          ==: ItemMeta
          meta-type: LEATHER_ARMOR
          color:
            ==: Color
            RED: 153
            BLUE: 51
            GREEN: 51
      Boots:
        ==: org.bukkit.inventory.ItemStack
        type: LEATHER_BOOTS
        meta:
          ==: ItemMeta
          meta-type: LEATHER_ARMOR
          color:
            ==: Color
            RED: 153
            BLUE: 51
            GREEN: 51
      Potions:
        - data:FIRE_RESISTANCE;99999999;1
      Other: {}
    Restock-Equipment:
      Potions: {}
      Other: {}
      Inventory:
        - ==: org.bukkit.inventory.ItemStack
          type: ARROW
          amount: 20
    Attributes:
      Max-Health: 20.0
      Position: 13

extended_shops.yml

note

Here we save all the shops you create. It is recommended to use the In-Game configurator, but you can also edit the files.

# Should extended game shop be enabled?
# Extended shop will override all other arena shops, extended shop is a global shop.
Enabled: true
Shop-Name: '&e&lSelect category'
Categories:
  Test1:
    Material: GRASS
    Name: '&a&lItems of Test1'
    Lore: '&7Click to open Test1'
    Arena: quarry
    Referral: quarry,24.0,81.0,11.0

achievements.yml

note

Here you can add as many achievements as you want. We recommend the In-Game creator.

# Set this section to "Achievements: []" to disable it completely
Achievements:
  # Achievement ID
  Scorer1:
    # Name of achievement visible in game
    Name: "&cScorer I"

    # Description of achievement visible in game
    # Use ';' to move text to next line
    # Use %progress% placeholder to add current progress of achievement
    # if current progress is above Objective-Amount it will set it to Objective-Amount
    Description: "&7Score 250 times!;&7Progress: &e%progress%/250"

    # Material displayed in GUI when achievement is unlocked
    Unlocked-Material: "EMERALD"

    # Material displayed in GUI when achievement is locked
    Locked-Material: "COAL"

    # Achievement objective. Valid objectives:
    #  GAMES_PLAYED - when x amount of games are played
    #    GAMES_PLAYED will be called ONLY when player leave arena! It's plugin's API limitation
    #  DEATHS - when player died for x times
    Objective: GAMES_PLAYED

    # Amount of objective points player need to have to get this achievement.
    # Players can have this OR MORE amount of points to get this achievement.
    Objective-Amount: 250

    # Command rewards executed from console after achievement is unlocked
    #
    #                    Placeholders list:
    #             %player% - Current player name
    #             %wave% - Current wave number
    #             %mapname% - Name of map
    #             %arena-id% - Arena Identifier
    #             %playeramount% - Number of players in game
    #
    #        Commands are executed by default BY CONSOLE, use "p:" to preform command by player
    #  You can use chance to execute command adding "chance(NUMBER):" (ex chance(10):) at the beginning of command
    #
    #  Commands examples:
    #    - p:say New achievement, yeah!                 # Player will say "New achievement, yeah!"
    #    - bc %player% unlocked achievement Killer!     # Will broadcast "<player name> unlocked achievement Killer" message
    #    - chance(1):p:say I was very lucky!            # Player has 1% chance to say "I was very lucky!"
    #    - p:chance(99):spawn                           # Player has 99% chance to teleport to spawn
    #       ^ YOU CAN EVEN SWAP CHANCE WITH PLAYER!
    #    - chance(50):eco give %PLAYER% 10              # Console has 10% chance to give player 10$
    Reward:
      - eco give %player% 10
      - p:say I got new achievement!!!

replay_notifier.yml

note

Here you can find any setting about the replay module

# Should replay notifier be enabled?
# REMEMBER to add villagedefense.join.* permission to allow access to all random arenas!
Enabled: true

# Replay message sent to all players in arena
Replay-Message: "&aGame has ended! &eWant to play again? &b&lClick here!"

# Message when hover Replay-Message
Replay-Message-Hover: "&eClick to play again!"

# Replay action when player click Replay-Message. Available actions:
#   RANDOM - join random arena (if not full)
#   RANDOM_WAITING - join random arena which state is waiting for players or starting
Replay-Action: RANDOM

# Plugin will automatically hook with these configured servers if bungee mode is activated in main
# villagedefense plugin
#
# Type here villagedefense server names that are hooked to Bungee Cord
Bungee-Server-Names:
  - "TB01"

achievement_storage.yml

note

If you use MySQL on the main plugin it will also use MySQL

caution

It saves the achievements for the players! You do not need to edit anything here, except you want to manipulate the achievements!

internal/achievements_menu_design.yml

caution

This is just an internal file! Do not edit it! It saves your menu design.