settings.yml

Overview

The settings.yml file is one of the main config files for FateHub! This contains major plugin settings.

Last Updated: 5/30/23

Default files are created on a 1.8 version base. Newer versions will need item name changes made before use. We are working to create pre-made config files for each version.

Default Config File

join:
  message:
    enabled: false
  donator:
    enabled: true
    groups:
      - permission: 'fatehub.donatorjoin1'
        messages:
          - '&6[Donator 1] &e%player% &ajoined the game!'
          - '&6[Donator 1] &e%player% &bmakes an entrance!'
      - permission: 'fatehub.donatorjoin2'
        messages:
          - '&b[Donator 2] &e%player% &cjoined with style!'
          - '&b[Donator 2] &e%player% &darrives like a boss!'
  send-message:
    enabled: true
    message:
      - "&c&m-----&7&m---------------------------------&c&m-----"
      - "&bWelcome &f<player>&7, &bto FateHub &fv2.2"
      - ""
      - " &7* &fWebsite: &bwww.site-example.com"
      - " &7* &fStore: &bwww.store-example.com"
      - " &7* &fTeamspeak: &bts.ts-example.com"
      - " &7* &fDiscord: &bwww.discord-example.com"
      - "&c&m-----&7&m---------------------------------&c&m----`-"
  apply-firework: false
first-join-commands:
  enabled: false
  commands:
    - '[CONSOLE] say Welcome, <player>!'
    - 'say Enjoy your first join, <player>!'
join-commands:
  enabled: false
  commands:
    - '[CONSOLE] say <player> has joined the server!'
    - 'say Welcome back, <player>!'
joinpotions:
  enabled: false
  hidden: true
  effects:
    JUMP: 4
    NIGHT_VISION: 1
    # Add more potion effects as needed
    # https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionEffectType.html
spawn:
  world: world
  x: -53.51914263566925
  y: 124.0
  z: -36.50468143755527
  yaw: -178.75711
  pitch: 1.869222
#Should players be teleported to the set spawn on every join?
TP-TO-SPAWN-ON-JOIN: true
quit:
  message:
    enabled: false
  donator:
    enabled: true
    groups:
      - permission: 'fatehub.donatorleave1'
        messages:
          - '&6[Donator 1] &e%player% &aleft the game!'
          - '&6[Donator 1] &e%player% &bmakes an exit!'
      - permission: 'fatehub.donatorleave2'
        messages:
          - '&b[Donator 2] &e%player% &cleft with style!'
          - '&b[Donator 2] &e%player% &ddisconnected like a boss!'
queue:
  portal-hook: false
  enabled: true
  #This will send 1 player every 2 seconds
  send-every-seconds: 2
  notify-message:
    - ""
    - "&eYou're currently &a#<pos> &eout of &a<in_queue> players &ein &b<server> &equeue."
    - "&eIf you want to skip the queue, you can purchase rank at &bshop.example.com&e."
    - ""
#Only some bungeecord/spigot jars can support turning this to false. If you have issues keep at true.
REMOVE_PLAYER_FROM_QUEUE_IF_NOT_CONNECTED_TO_TARGET_SERVER: true
#Types are RIDING and VELOCITY
ender-butt-type: "VELOCITY"
ender-butt-sound: "ORB_PICKUP"
ender-butt-velocity: 3.0
#Should EnderButt be enabled? Disabling will disable the ability to use it!
ender-butt-enabled: true
chat-format:
  enabled: true
  format: "&a<prefix><player><suffix>&7: &e<message>"
servers:
  Hub-01:
    name: "Hub-01"
    bungee-name: "hub01"
    address: "127.0.0.1"
    port: 25565
  Hub-02:
    name: "Hub-02"
    bungee-name: "hub02"
    address: "127.0.0.1"
    port: 25566
  Hub-03:
    name: "Hub-03"
    bungee-name: "hub03"
    address: "127.0.0.1"
    port: 25565
  Factions:
    name: "Factions"
    bungee-name: "factions"
    address: "127.0.0.1"
    port: 25566
  UHC:
    name: "UHC"
    bungee-name: "uhc"
    address: "127.0.0.1"
    port: 25565
  SkyBlock:
    name: "SkyBlock"
    bungee-name: "skyblock"
    address: "127.0.0.1"
    port: 25565
options:
  break-blocks: false
  place-blocks: false
  explosions: false
  item-drop: false
  item-pickup: false
  monster-spawn: false
  animal-spawn: false
  damage: false
  fall: false
  chat-use: true
  weather-change: false
  no-death-tp: false
  food-change: false
launch-pads:
  enabled: false
  #What should the pressure-plate be?
  pressure-plate-type: "STONE_PLATE"
  #What block should the pressure plate need to be on? Set to AIR to disable this.
  below-block: "REDSTONE_BLOCK"
  #What sound should be sent?
  launch-sound: "EXPLODE"
  velocity:
    multiply: 1.5
    vertical: 1.1
double-jump:
  enabled: true
  sound: "EXPLODE"
  velocity:
    multiply: 1.5
    vertical: 0.8
#Should FateHub use the new double jump? This means you cannot infinitely jump.
NEWDOUBLEJUMP: true
#Configure the sound played when a player joins the game. Set to "none" to disable.
join-sound: "none"
join-sound-volume: 2
join-sound-pitch: 2
join-items:
  compass:
    name: "&7(&b!&7) &eServer Navigation &7(&b!&7)"
    material: "NETHER_STAR"
    durability: 0
    slot: 5
    amount: 1
    command:
      enabled: false
      #Put command without /
      execute: ""
    action: "{openmenu:server-navigation}"
    lore:
      - ""
      - "&7&oRight-Click to navigate"
      - "&7&othroughout servers."
      - ""
  cosmetics:
    name: "&7(&b!&7) &eCosmetics &7(&b!&7)"
    material: "CHEST"
    durability: 0
    slot: 9
    amount: 1
    command:
      enabled: false
      #Put command without /
      execute: ""
    action: "gadgets"
    lore:
      - ""
      - "&7&oRight-Click to view"
      - "&7&oyour cosmetics."
      - ""
  hubservers:
    name: "&7(&b!&7) &eLobby Navigation &7(&b!&7)"
    material: "BOOK"
    durability: 0
    slot: 8
    amount: 1
    command:
      enabled: false
      #Put command without /
      execute: ""
    action: "{openmenu:hub-servers}"
    lore:
      - ""
      - "&7&oRight-Click to navigate"
      - "&7&othroughout lobby servers."
      - ""
  firework:
    name: "&7(&b!&7) &eFirework Launch &7(&b!&7)"
    #If this material doesn't work for your version, probably 1.12+, try to use 'FIREWORK_ROCKET'
    material: "FIREWORK"
    durability: 0
    slot: 1
    amount: 1
    command:
      enabled: false
      #Put command without /
      execute: ""
    action: "firework"
    lore:
      - ""
      - "&7&oRight-Click to launch"
      - "&7&oyourself with firework."
      - ""
  enderpearl:
    name: "&7(&b!&7) &eEnderButt &7(&b!&7)"
    material: "ENDER_PEARL"
    durability: 0
    slot: 2
    amount: 1
    command:
      enabled: false
      #Put command without /
      execute: ""
    action: "enderbutt"
    lore:
      - ""
      - "&7&oRight-Click to launch"
      - "&7&oyourself with ender pearl."
      - ""
  player-invisibility-off:
    name: "&7(&b!&7) &ePlayers &7(&cOFF&7) &7(&b!&7)"
    material: "INK_SACK"
    durability: 8
    slot: 3
    amount: 1
    command:
      enabled: false
      #Put command without /
      execute: ""
    action: "players_on"
    lore:
      - ""
      - "&7&oRight-Click to show"
      - "&7&oall online players"
      - ""
  player-invisibility-on:
    name: "&7(&b!&7) &ePlayers &7(&aON&7) &7(&b!&7)"
    material: "INK_SACK"
    durability: 10
    slot: 3
    amount: 1
    command:
      enabled: false
      #Put command without /
      execute: ""
    action: "players_off"
    lore:
      - ""
      - "&7&oRight-Click to hide"
      - "&7&oall online players"
      - ""
armor-cosmetics:
  owner:
    permission: "hub.owner"
    contents:
      helmet:
        enabled: false
        color: "MAROON"
        name: "&4&l<rank>"
        lore:
          - ""
          - "&7You're an operator"
          - "&7Your rank is &4&l<rank>"
          - ""
      chestplate:
        enabled: true
        color: "MAROON"
        name: "&4&l<rank>"
        lore:
          - ""
          - "&7You're an operator"
          - "&7Your rank is &4&l<rank>"
          - ""
      leggings:
        enabled: true
        color: "MAROON"
        name: "&4&l<rank>"
        lore:
          - ""
          - "&7You're an operator"
          - "&7Your rank is &4&l<rank>"
          - ""
      boots:
        enabled: true
        color: "MAROON"
        name: "&4&l<rank>"
        lore:
          - ""
          - "&7You're an operator"
          - "&7Your rank is &4&l<rank>"
          - ""
HIDE-LOBBY-PLAYERS:
  ENABLED: false
  PERMISSION-TO-SHOW: 'fatehub.lobby.view'
#Should bungeecord player count errors be shown?
SHOW-ERRORS:
  ENABLED: false
#Toggles the speed on join using spigot methods not potions.
JOINSPEED:
  ENABLED: false
  #The level is not based on potions but on the Spigot #setWalkSpeed method. All values must be between 0 and 1. Default .6
  LEVEL: .6
#This is the legacy version of join speed that uses potions. I recommend using the new version unless it does not work for you.
JOINSPEED-LEGACY:
  ENABLED: false
  LEVEL: 8
PausedQueueMessage:
  enabled: true
  #Delay is in ticks.
  delay: 150
  message:
    - ""
    - "&eQueue for &6<server> &eis currently paused. Please wait!"
    - ""
#Hub fly will automatically set the user to flying if enabled and if they have the fatehub.fly perm.
hub-fly:
  enabled: false
  command: true
#If enabled this will clear the players inventory when they join the server. HIGHLY RECOMMENDED TO KEEP ENABLED
CLEARINV:
  ENABLED: true
CLEARENTITIES:
  ENABLED: true
#Should on the ground be enforced when using gadgets?
ON-THE-GROUND-ENFORCED: false
#Should the message from the messages.yml be sent when you can't use a gadget?
ON-THE-GROUND-ERROR-MESSAGE: true
#What slot should the player be holding when they login?
INVENTORY-SLOT: 4
#Players will be blocked from interacting with these blocks. Please use the Material name not ID's.
#When using WorldBorder this may break, this is due to their event handling and cannot be fixed currently.
BLOCKED_INTERACTION_BLOCKS:
  - 'IRON_DOOR'
  - 'LEVER'
#Should the update notification be enabled in-game?
UPDATENOTIFICATION: true
#Should the daylight cycle be enabled?
DAYLIGHTCYCLE: false
#Should events like dropping items, breaking blocks, placing blocks send the error message from messages.yml?
SENDOPTIONERRORMESSAGES: false
#Should a height limit be in place?
HEIGHT-LIMIT:
  ENABLED: false
#What Y value should the height limit be at?
  LEVEL: 56
#Should a menu open when you walk into a nether portal?
PORTAL-MENU:
  ENABLED: false
  #What menu.yml should be opened?
  MENU-NAME: "server-navigation"
  #What portal material? (Changes at points through versions)
  MATERIAL: PORTAL
#What gamemode should players be when they join? SURVIVAL, CREATIVE, ADVENTURE
JOIN-GAMEMODE: "SURVIVAL"
#Should a Y limit be in place? If the player reaches this value it will TP back to spawn.
Y-LIMIT:
  ENABLED: false
  #What Y value should the Y limit be at?
  LEVEL: 0
#Should menu commands be delayed. Set to false unless you have an issue opening GUI's.
DELAY-MENU-COMMAND: false
#What message should be sent to first time players?
FIRST-JOIN-MESSAGE:
  ENABLED: false
  MESSAGE:
    - "&b&lWelcome to the server!"
    - "&a&lWe thank you for joining for the first time!"
#When this is enabled the world will be reset each time the server restarts. Nothing done will be saved.
#To enable please put a world in the \plugins\FateHubCore\ folder that matches WORLDNAME.
#Wiki: https://fatehub.bghddevelopment.com/world-backup-system
USEWORLDBACKUPSYSTEM:
  ENABLED: false
  WORLDNAME: world
#Sound Settings
SOUND:
  VOLUME: 2
  PITCH: 2
#Do not enable unless told.
FLYDEBUG: false
#Announcement Format:
announceformat:
  - ""
  - "&a&lAnnouncement"
  - "{announcement}"
  - ""
#Announcement Time Settings: (All Times In Milliseconds)
announcetime: 300000