Configuration

Jul 19, 2019
Configuration

  • Main configuration(top)


    Statistic configuration(top)

    You can create your own statistics using MVdWPlaceholderAPI's placeholders. If you are not familiar with this API, the placeholders are formatted with curly brackets: { }.
    A full list of placeholders can be found on this wiki page: https://www.spigotmc.org/wiki/mvdw-placeholders/

    Support for PlaceholderAPI placeholders is possible by converting the placeholders (e.g. %player_ip% becomes {placeholderapi_player_ip} , without the '%').

    Statistics are tracked. This means that the very first time you start the plugin, the plugin only knows the current state of the statistics. The longer you use Leaders, the more dynamic data you can have (Top per day, top per week, top per month,...).

    Syntax(top)

    name:(top)

    OPTIONAL: This is the name of your statistic. By default, the name of the YML file is used. You can override the YML name using this option. The name is used as identification inside commands and the database.

    displayname:(top)

    This is the visual display name. This name will be shown to players.

    placeholder:(top)

    The placeholder surrounded by curly brackets ({}). This is the data that you are tracking.

    order:(top)

    How does the data need to be ordered (ASC or DESC). For example, if the score is 'the lower the better' - the value should be ASC (ascending).

    Keep in mind that this does not always provide the expected results. When tracking deaths for example, new players will always be on top.

    sync:(top)

    Section of synchronization settings.

    online-interval:(top)
    Formatted as: "xxd" for days, "xxh" for hours, "xxm" for minutes and "xxs" for seconds. This is the interval between complete synchronizations for online players.

    offline-interval:(top)
    Formatted as: "xxd" for days, "xxh" for hours, "xxm" for minutes , "xxs" for seconds or "never". This is the interval between complete synchronizations for offline players.

    onjoin:(top)
    When true, the statistics will update on player join. When offline-interval is set to "never" it is recommended to set this to true.

    onquit:(top)
    When true, the statistics will update on player quit. When offline-interval is set to "never" it is recommended to set this to true.

    Example: XP tracking(top)

    To create a new statistic, follow the following steps:
    1. Identify what you want to create a statistic of. In this example, I want to create a high score of the people that gained the most XP.
    2. Go to /plugins/Leaders/statistics
    3. Create a new YML file, naming it to your statistic (choose wisely, changing this name will require a new synchronization). Example: "xp.yml"
    4. Edit the YML file
      Code (Text):

      displayname: "XP"
      placeholder: "{xp_total}"
      type: INTEGER
      order: DESC
      sync:
        online-interval: 30m
        offline-interval: never
        onjoin: true
        onquit: true
       

    Module configuration(top)

    Module configuration is specific per module. These configuration files can be found in:
  • Loading...
  • Loading...