#  ______ _ _       _     _    _____            _             _
# |  ____| (_)     | |   | |  / ____|          | |           | |
# | |__  | |_  __ _| |__ | |_| |     ___  _ __ | |_ _ __ ___ | |
# |  __| | | |/ _` | '_ \| __| |    / _ \| '_ \| __| '__/ _ \| |
# | |    | | | (_| | | | | |_| |___| (_) | | | | |_| | | (_) | |
# |_|    |_|_|\__, |_| |_|\__|\_____\___/|_| |_|\__|_|  \___/|_|
#              __/ |
#             |___/                                  by Spazzinq

# Discord: https://spazzinq.org/discord
# Github: https://github.com/Spazzinq/FlightControl/issues
# Spigot Page: https://www.spigotmc.org/resources/flightcontrol.55168/
# Donate: https://spazzinq.org/donate

# Before you leave a negative review:
# ✓ Read through ALL the information in this configuration
# ✓ Contact me on Discord (if the config does not solve your problem)
# ✓ Create an official bug report or feature request on GitHub

#   ____             __ _                       _   _
#  / ___|___  _ __  / _(_) __ _ _   _ _ __ __ _| |_(_) ___  _ __
# | |   / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \
# | |__| (_) | | | |  _| | (_| | |_| | | | (_| | |_| | (_) | | | |
#  \____\___/|_| |_|_| |_|\__, |\__,_|_|  \__,_|\__|_|\___/|_| |_|
#                         |___/

# An EXTREMELY IMPORTANT idea to understand for part of this configuration is that flight only enables when it
# has a reason to (it does not stay enabled in a neutral/un-enabled location).

# Should FlightControl automatically update to the latest version?
# (It will update the config automatically and add new features!)
auto_update: true

settings:
  # Enables flight automatically (no command necessary)
  auto_enable: true
  # Controls flight speed (default speed is 1)
  # The speed values match Essential's /flyspeed command (the number range is 0-10)
  flight_speed: 1.0
  # Requires CombatTagPlus, CombatLogX, CombatLogPro, AntiCombatLogging, or DeluxeCombat
  # NOTE: in the combat plugin config, deactivate its option to disable flight while in combat to prevents issues
  disable_flight_in_combat: false
  # Prevents fall damage when flight is disabled mid-air by FlightControl
  prevent_fall_damage: true
  # Requires EssentialsX or PremiumVanish
  # Bypasses the disabling of flight while in vanish (or spectating)
  vanish_bypass: true
  # Requires Factions (by MassiveCraft), FactionsUUID, or SavageFactions
  # Disables flight while a faction enemy is within a certain block range (set to -1 to disable)
  # NOTE: this feature may cause performance issues on larger servers
  disable_enemy_range: -1

worlds:
  # Change "enable" to "disable" if you want it to disable in certain worlds instead
  # (and enable in the ones not listed)
  enable:
  - Spawn

# Requires WorldGuard (and WorldEdit)
# If you have multiple regions overlapping each other, please use /rg setpriority REGIONNAME NUMBER
# FlightControl checks the HIGHEST priority region (otherwise it checks the first in REVERSE alphabetical order)
regions:
  # Change "enable" to "disable" if you want flight to disable in certain regions instead
  # (and enable in the ones not listed)
  enable:
    exampleworld:
    - exampleregion
    exapleworld2:
    - exampleregion2

# Requires Factions (by MassiveCraft), FactionsUUID, or SavageFactions
# There are eight types of faction territories (OWN, ALLY, TRUCE, NEUTRAL, ENEMY, WARZONE, SAFEZONE, WILDERNESS)
# OWN enables flight in the player's own faction territory
factions:
  # "example" is a category (the permission to use it is flightcontrol.factions.example)
  # Keep in mind you can set category names to whatever you want (only alphanumeric characters, no spaces)
  example:
    # Change "enable" to "disable" if you want flight to disable in certain faction territories instead
    # (and enable in the ones not listed)
    enable:
    - OWN
    - ALLY
  # "example2" is another category (the permission to use it is flightcontrol.factions.example2)
  example2:
    enable:
    - SAFEZONE
    - WARZONE

# Requires Towny
towny:
  # Enables flight in player's own town
  enable_own_town: false
  # Disables all Towny-related flight during war
  # (this also affects the permission!)
  disable_during_war: false

# Requires Lands
lands:
  # Enables flight in player's own land
  enable_own_land: false

# Compatible: EssentialsX, PremiumVanish (disables while vanished)
trail:
  enabled: false
  # 1.8 List: https://spazzinq.org/particles/1.8.html
  # 1.14 List: https://spazzinq.org/particles/1.14.html
  particle: "CLOUD"
  amount: 2
  # This option is used with colored particles (format: "red,green,blue")
  # Color picker: https://www.google.com/search?q=color+picker
  # For one specific color, you MUST set the amount to 0 if you use
  # COLOURED_DUST on 1.8, SPELL_MOB on 1.14, SPELL_MOB_AMBIENT on 1.14, or NOTE on 1.14.
  rgb: "0,0,0"

sounds:
  # Plays the enable sound on EVERY player-activated flight (double tap of the
  # space bar) rather than when FlightControl allows the player to activate it
  every_enable: false
  # Please use the sound names from the "Sound Event" column
  # 1.8 List: https://minecraft.gamepedia.com/Sounds.json/Java_Edition_values_before_1.9
  # 1.14 List: https://minecraft.gamepedia.com/Sounds.json/Java_Edition_values
  enable:
    sound: "NONE"
    pitch: 1
    volume: 1
  disable:
    sound: "NONE"
    pitch: 1
    volume: 1
  # "can_enable" and "cannot_enable" are used when "auto_enable" is false
  # or if the player disables their own flight with /fly
  can_enable:
    sound: "NONE"
    pitch: 1
    volume: 1
  cannot_enable:
    sound: "NONE"
    pitch: 1
    volume: 1

# If you do not wish for a certain message to be sent, make it empty (set it to "")
# You can use "&" for color codes just like any other plugin!
messages:
  # Use the actionbar (area above hotbar) instead of chat for notifications
  actionbar: true
  flight:
    enable: "&aYou are in spawn, so you can fly!"
    disable: "&cYou are no longer in spawn, fly has been disabled!"
    # "can_enable" and "cannot_enable" are used when "auto_enable" is false
    # or if the player disables their own flight with /fly
    can_enable: "&bYou can use /fly now."
    cannot_enable: "&cYou cannot fly right now."
  trail:
    enable: "&aYou enabled the flight trail!"
    disable: "&cYou disabled the flight trail!"
  permission_denied: "&cYou do not have permission to use this command."

#  ____                     _         _
# |  _ \ ___ _ __ _ __ ___ (_)___ ___(_) ___  _ __  ___
# | |_) / _ \ '__| '_ ` _ \| / __/ __| |/ _ \| '_ \/ __|
# |  __/  __/ |  | | | | | | \__ \__ \ | (_) | | | \__ \
# |_|   \___|_|  |_| |_| |_|_|___/___/_|\___/|_| |_|___/

# Replace WORLDNAME in the permission with the name of the world
#         REGIONNAME with the name of the region
#         CATEGORY with the name of the category

# Important Permissions
# flightcontrol.admin - Ability to use FlightControl administrative commands (automatically given to OPs)
# flightcontrol.bypass - Bypasses all fly restrictions and always allows flight
# flightcontrol.factions.CATEGORY - Controls flight based upon the defined category
# flightcontrol.flyall - Ability to automatically fly in all regions that are not disabled
# flightcontrol.fly - Access to /fly when the command option is enabled in the config (the Essentials permission "essentials.fly" works too)
# Optional Permissions
# flightcontrol.flyother - Ability to enable another player's fly and bypass all restrictions (like bypass permission) until server restart
# flightcontrol.fly.WORLDNAME - Ability to fly in a certain world
# flightcontrol.fly.WORLDNAME.REGIONNAME - Ability to fly in a certain region
# flightcontrol.nofly.WORLDNAME - Denies flight in a certain world
# flightcontrol.nofly.WORLDNAME.REGIONNAME - Denies flight in a certain region
# flightcontrol.owntown - Ability to fly in player's own town