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

# Before leaving a negative review, you should first read through the information in this configuration
# and then contact me on Discord if it does not solve your problem (my Discord link is below).
# https://spazzinq.org/discord

# This configuration contains a LOT of instructions, but all are vital to understanding the features.
# Please DO NOT remove them unless you are familiar with the features you are using.

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

# A VERY 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).

settings:
  # Enables /fly instead of automatic flight
  # When "command" is enabled, "can_enable" and "cannot_enable" messages/sounds are used
  command: false

  # Requires: CombatTagPlus, CombatLogX, or AntiCombatLogging
  # NOTE: in the combat plugin config, disable its option to stop flight while in combat (prevents issues)
  disable_flight_in_combat: true

  # Prevents fall damage when flight is disabled mid-air by FlightControl
  prevent_fall_damage: true

  # Bypasses the disabling of flight while in vanish (or spectating)
  # Requires: EssentialsX or PremiumVanish
  vanish_bypass: true

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

# 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 it to disable in certain regions instead
  # (and enable in the ones unlisted)
  enable:
    world:
    - spawn

# Requires: Factions (by MassiveCraft), FactionsUUID, or SavageFactions
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 it to disable in certain faction territories instead
    # (and enable in the ones unlisted)
    enable:
    # 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
    - OWN
    - ALLY

  # "example2" is a category (the permission to use it is flightcontrol.factions.example2)
  example2:
    enable:
    - SAFEZONE
    - WARZONE

# The trail is only active while IN MOTION
# Requires: version/fork of SPIGOT (unless you are using 1.13)
# Compatible: EssentialsX, PremiumVanish (disables while vanished)
trail:
  enabled: true
  # 1.8 List: https://spazzinq.org/particles/1.8.html
  # Latest (1.13) List: https://spazzinq.org/particles/1.13.html - Sorry, Spigot did not provide a description
  particle: "CLOUD"
  amount: 0.5
  # Color picking is done by RGB values and a color picker can be found here: https://www.google.com/search?q=color+picker
  # Use the format "red,green,blue" (otherwise, do not touch the values
  # You MUST set the amount to 0 on 1.8 for one specific color!
  rgb: "0,0,0"

sounds:
  # 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
  # Latest (1.13) List: https://minecraft.gamepedia.com/Sounds.json/Java_Edition_values
  enable:
    sound: "fireworks.launch"
    pitch: 1
    volume: 1
  disable:
    sound: "NONE"
    pitch: 1
    volume: 1
  # "can_enable" and "cannot_enable" are only used when "command" is true
  # (do you have the chance to notify the player that they can/cannot if it's already enabled?)
  can_enable:
    sound: "fireworks.launch"
    pitch: 1
    volume: 1
  cannot_enable:
    sound: "NONE"
    pitch: 1
    volume: 1

# If you do not wish for a message to be sent, 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: false
  flight:
    enable: ""
    disable: ""
    # "can_enable" and "cannot_enable" are only used when "command" is true
    # (do you have the chance to notify the player that they can/cannot if it's already enabled?)
    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 commands (automatically given to OPs)
# flightcontrol.bypass - Bypasses all fly restrictions and always allows flight
# flightcontrol.factions.CATEGORY - Controls flight based upon the category
# flightcontrol.flyall - Ability to automatically fly in all regions that are not disabled
# flightcontrol.fly - Access to /fly when the command is enabled (the Essentials permission "essentials.fly" works too)
# Optional Permissions
# 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