FeatherBoard Configuration

Oct 3, 2017
FeatherBoard Configuration
  • NOTE THIS INFORMATION IS FOR THE UPCOMING FEATHERBOARD 4. CONFIGURATION DOES NOT APPLY ON THE CURRENT VERSION


    Default configurations(top)

    These are the default configuration files
    Code (Text):
    # ------------------------------------ #
    #
    #  FeatherBoard 4
    #  Runs like a feather on your server
    #  (c) Maxim Van de Wynckel
    #
    # ------------------------------------ #

    # Permissions: To use the action groups give them the permission
    #              featherboard.group.<group>
    #              Make sure to remove them from the other groups
    #              when giving a new permission.

    # Variables: These variables can be used in the TEXT section
    #            of both the header as the footer.
    #      
    #            {PLAYER}       - Player name
    #            {PLAYERNICK}   - Player nickname
    #            {SERVER}       - Server name
    #            {PLAYERCOUNT}  - Server player count
    #            {BUNGEECOUNT}  - Bungee network player count
    #            5000+ more ... see spigot page

    # Formatting: These are formatting tags allowing you to format the animations
    #             or placeholders.
    #
    #             Substring: This allows you to split a word (even a placeholder) in parts
    #               example: <substring begin=0 end=3>Hello World</substring> = Hel
    #               usage: This can be used to split placeholders when creating a typewriter
    #                      or to split the colors in a placeholder.
    #
    #             Scroll: This creates a scrolling animation of the text inside it. It accepts
    #                     two arguments (the length and space between scrolls).
    #               example: <scroll width=20 spaces=20>&2This is a &atest</scroll>
    #
    #             PLENTY MORE! See spigot page

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
    # GENERAL PLUGIN SETTINGS
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#

    ## Config version (DO NOT EDIT)
    config: 4

    ## Language file
    lang: 'en'

    ## Debug mode
    debug: false

    ## Log to file
    log:
      enabled: true
      # Reset log on startup
      reset: true

    ## Update checking
    update:
      check: true # RECOMMENDED YOU LEAVE THIS TRUE

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
    # PLUGIN SPECIFIC SETTINGS
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
     
    # Toggling allows you to disable the scoreboard
    database:
      # If you want the toggle to stay even when your users
      # log off you can enable this. Keep in mind that this requires a
      # MySQL or SQLite database.
      # If you are configuring the plugin for the first time it is advised
      # to stay away from these settings until you managed the scoreboard
      # set up.
      persistent: false
      # Database configuration is SIMILAR to http://wiki.bukkit.org/Bukkit.yml#database
      # with isolation, url, driver, ...
      # Database name
      database: "featherboard"
      # Database username
      username: bukkit
      # Database isolation type
      isolation: SERIALIZABLE
      # Database driver
      driver: org.sqlite.JDBC
      # Database password
      password: walrus
      # Database driver URL
      # {DIR} will be replaced with the plugin directory
      # {NAME} will be replaced wit the plugin name
      url: jdbc:sqlite:{DIR}{NAME}.db
      # Save interval in ticks
      save-interval: 6000

    # Disabled worlds. Add your world name in this list to
    # disable it.
    disabled-worlds:
    - 'example_world'

    # Scoreboard assigning. The boards can be assigned by various ways.
    # default the scoreboards will be assigned by permissions.
    # You can have multiple ways of assigning a scoreboard, but
    # keep in mind that it uses a "first come first served" principal
    # Multiple assign methods is only recommended when using things like
    # TIME or WORLD in combination with something else.
    #
    # PERMISSION     -     Assign scoreboards based on permissions
    #                   This is the default setting (since 2014)
    #                   featherboard.group.<scoreboard>
    #
    # GROUP            -    Assign scoreboards based on Vault groups
    #                    this means the scoreboard name has to
    #                    have the name of your Vault group.
    #
    # WORLD            -    Assign scoreboards based on the world
    #                    the player is in.
    #
    # TIME          -   Assign the scoreboard based on the day.
    #                   "day" for Day and "night" for night.
    #
    # NONE            -    Do no assign scoreboards and just rely on
    #                    manual assigning (triggers, etc...)
    #
    # {PLACEHOLDER}    -    Assign the scoreboard based on a placeholder
    #                    this method can be very intensive for certain non cached
    #                    placeholders.
    #                    It will look for scoreboardname.yml files matching the result
    #                    of the placeholder.
    #                    KEEP IN MIND: Fast switching scoreboards is not a good thing.
    scoreboard-assigning:
    - 'PERMISSION'

    # GUI: This is a feature enabling a GUI to select a specific scoreboard
    # The GUI will show all scoreboards you have permission to. It is not very
    # configurable in the way you can't control the location or order of the scoreboards
    # For a more configurable GUI I recommend DeluxeMenus
    gui:
      # This is the title of the GUI
      title: "Scoreboards"
      # Size of the GUI (leave to -1 to make it dynamic)
      # Sizes: 9,27,54
      size: -1

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
    # ADVANCED SETTINGS
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#

    # Placeholder settings
    placeholder:
      # logs the memory usage of placeholders on startup
      log-memory: false
      # Clear unused placeholders that are not enabled.
      clear-unused: true
      # Config cache only
      # This will only use placeholders in the config
      # HOWEVER: IT WILL BREAK ALL CUSTOM PLACEHOLDERS!
      # IT WILL ALSO PREVENT ANY HOOKS (PlaceholderAPI)
      # Enable this if you are sure that:
      # 1) You do not use MVdWPlaceholderAPI
      # 2) You have no custom placeholders
      config-cache: false

    # Scoreboard file path. This is the folder path containing the .yml files containing
    # the scoreboards.
    scoreboard-location: "scoreboards/"

    # Tweaks to increase performance (Use at own risk)
    tweaks:
      # This option does not send scoreboard remove packets
      # to the client on quit. This can increase performance on servers
      # where players quit a lot (hubs, ...)
      #
      # Removal of the plugin requires you to manually delete the scoreboard.dat in the worlds
      # /data folder
      #
      # Enabling this can cause the scoreboard not to work anymore. Use at your own risk
      keepScoreboardOnQuit: false
      # Some placeholders have a slow process behind them. Meaning they might contact a database
      # and take a while to 'resolve'. This will never cause lag since the placeholders are loaded
      # separate from the sending. But can slow down the animation because it has to wait
      # for the placeholder to be loaded. When having multiple lines like a text that shows
      # the information about the placeholders you put below it, this can cause problems.
      # Enabling this will output a message in the console and ingame to operators
      # saying when a placeholder is causing delays.
      detect-placeholderdelay: false
      # Putting this to true will SPAM your console with timings report per placeholder/animation
      # refresh. Used for debugging purposes.
      # This requires detect-placeholderdelay to true
      verbose-placeholder-timings: false
      # Show delay on join. Useful if you wish to let the user
      # enjoy a Title MOTD without having the scoreboard obstructing
      # the view.
      show-delay: 0
      # Anti Flicker will use a new engine that will allow you to use fast animations
      # without any flicker.
      # You can disable this feature if you do not have fast refresh rates.
      antiflicker: true
      # Efficiency mode is a tweak you can use to increase the CPU efficiency even more
      # it does however cause some changes:
      # - All lines on the scoreboard are synchronized refreshed
      #   this means that slow placeholders means longer animations
      # - The minimum animation speed is limited to 4 ticks by default
      # - The global updater checking for scoreboard changes is set to 2 ticks
      #   instead of every tick: This means that intervals may have a 50ms variation
      efficiency-mode:
        enabled: false
        # DO NOT CHANGE THESE THINGS BELOW IF YOU
        # DO NOT KNOW WHAT YOU ARE DOING
        # Global interval tick timer
        global-interval: 2
        # Minimum inerval for individual lines
        minimum-interval: 4

    config.yml(top)

    General settings(top)

    lang
    This config setting will set the locale file that will be used for translations.

    log
    This applies to the log file that contains errors and other valuable information for troubleshooting problems. However when a lot of errors occur this file can become very big.

    If you think you got FeatherBoard working without need for support you can turn this off.

    update
    Update checking will contact spigot to check for a new version. Operators will get a message ingame when they log in with an update notification.

    Plugin specific settings(top)


    Database(top)

    The database is used to keep track of who toggled their scoreboard on/off. This is definitely not a required feature, but can be helpful.

    Disabled worlds(top)

    If you want to disable the scoreboard in specific worlds regardless of the scoreboard assigning method you can use this list.

    Scoreboard assigning(top)

    The scoreboard default assigns to the permission group (being featherboard.group.SCOREBOARDNAME). However the plugin allows for one or more different scoreboard assigning methods.

    PERMISSION: Default option, users with the permission featherboard.group.NAMEOFBOARD will get the scoreboard assigned.
    GROUP: This will use the Vault groups to assign a scoreboard. For example the group "moderators" will get the scoreboard names "moderators" assigned.
    WORLD: This will assign the scoreboard based on the world name. The board called "world_nether" will show when the player is in the Nether world with that name.
    TIME:
    NONE:
    Use no scoreboard assigning. Use either the GUI or event triggers.
    {PLACEHOLDER}: This will use a placeholder to assign the scoreboard. You have to use this as: "{playername} (so don't write {placeholder}, you actually have to use a placeholder). The scoreboard will be assigned if its value is the same as the outcome of the placeholder. NOTE: This can be a performance hoggy feature if the placeholders require remote connections such as a MySQL database ,... .

    When multiple of these methods are assigned they will be assigned according to the order they are in.
    For example if you have 1 board called "minigames" and other boards with the group specific boards (moderator, admin, ...) and configure the assigning so:
    Code (Text):
    scoreboard-assigning:
    - 'WORLD'
    - 'GROUP'
    The scoreboard will always be assigned to the group EXCEPT for when the player is in the world called "minigames" - in that case the minigames board will be shown instead.

    Scoreboard GUI(top)

    The plugins comes with a simple GUI that can be configured to show a specific scoreboard.

    Advanced settings(top)

  • Loading...
  • Loading...