Config overview

This page will have an overview of the plugins configuration.

Configuration Issues

One of the current issues with loading new things into the config is that it doesn't save the comments nor does it keep the current layout of the config.

Config File when it first Loads

#
# - THANK YOU FOR DOWNLOADING -
#
# Thank you so much for downloading my plugin! <3
# This plugin is a basic AutoAnnouncer that announces different
# text which is customizable and you are able to add as many announcers
# as you want. All the announcers are selected at random and then put into
# the chat for every player to see after the designated time in "Delay"
#
# If you require any support or you want to add a suggestion then please
# add me on discord (PolarDyth#9999) or join my discord (https://discord.gg/94k5qMb)
#
# In "AutoAnnouncer" there are currently 2 things that can be customized.
# First is the "Announcers" this requires a String for every line
# (a string is just a line of text) and the Delay is in seconds and requires
# a number and only a number.
#
# Standard bukkit codes are fully supported!

AutoAnnouncer:
  AnnouncerMessage:
    Announcer:
      - "You can join our discord at https://discord.gg/25TVBY"
      - "Don't forget to vote for the server using /vote!"
      - "Come visit our shop: https://shop.example.com"
    Delay: 5 seconds
    Enabled: true
  AnnouncerHeader:
    Message: "&7[---------&8[&4&lAnnouncement&8]&7---------]"
    Enabled: true
    Enable_Space: true
  AnnouncerFooter:
    # PlaceholderAPI is fully supported with this plugin.
    Message: "&4Thank you for playing on play.example.com, %server_online% out of %server_max_players% are online"
    Enabled: true
    Enable_Space: true

Prefix_Settings:
  Prefix: "&8[&4&lAnnouncer&8]"
  Enable_Prefix: true

Commands:
  Reload:
    Message: "&6{plugin_name} {plugin_version} has been reloaded."
    Enable: true
    Disable_Message: 'Command disabled! If you want to enable this command set "Enabled" in the config to true!'

Permission:
  Reload_Permission: "announcer.reload"
  Reload_NoPermission_Message: "Insufficient permission (announcer.reload)"

# Don't mess anything below this comment

Log_Lag_Over_Milis: 100
Debug: []
Version: 1

Config when I add new lines to the config

# -------------------------------------------------------------------------------------------
# 
#  Your file has been automatically updated at 03.08.2020 12:12:57
#  to AutoAnnouncer 1.0.0
# 
#  Unfortunatelly, due to how Bukkit saves all .yml files, it was not possible
#  preserve the documentation comments in your file. We apologize.
# 
#  If you'd like to view the default file, you can either:
#  a) Open the AutoAnnouncer-1.0.0.jar with a WinRar or similar
#  b) or, join my discord to get support!
# 
# -------------------------------------------------------------------------------------------

AutoAnnouncer:
  AnnouncerMessage:
    Announcer:
    - Change me!
    - New line!
    - Join my discord!
    Delay: 5 seconds
    Enabled: true
  AnnouncerHeader:
    Message: '&7[---------&8[&4&lAnnouncement&8]&7---------]'
    Enabled: false
    Enable_Space: true
  AnnouncerFooter:
    Message: '&4Thank you for playing on play.example.com, %server_online% out of
      %server_max_players% are online'
    Enabled: false
    Enable_Space: true
Prefix_Settings:
  Prefix: '&8[&4&lAnnouncer&8]'
  Enable_Prefix: true
Debug: []
Version: 1
Log_Lag_Over_Milis: 100
Permission:
  Reload_Permission: announcer.reload
  Reload_NoPermission_Message: Insufficient permission (announcer.reload)
Commands:
  Reload:
    Message: '&6{plugin_name} {plugin_version} has been reloaded.'
    Enable: true
    Disable_Message: Command disabled! If you want to enable this command set "Enabled"
      in the config to true!

If you want your config to look better then download a software called WinRAR and right-click the jar and press Open with WinRAR then open config.yml and copy and paste the relevant information over.

Another issue with the config is that it won't remove old config lines. Say for example I remove "Enabled: true" in the "Announcers" section it will not be removed from your config. This shouldn't affect anything but if again, you want it to look better then you can either open with WinRAR or remove the line yourself.