Chapter 3

GroupTopper

The documentation of GroupTopper, a Spigot plugin for group leaderboards

Where to find the plugin:

Subsections of GroupTopper

Config

# The type of storage the plugin will use to store the value
# Available: YAML, SQLITE, MYSQL
storage-type: sqlite
# The settings for each group holders
holders:
  jump_group: # The group holder name
    top: jump # The top holder it will be based on

    type: placeholder # Group settings
    owner: '%player_uuid%'
    display: '%player_name%'
    online: true
task:
  save:
    # How many entries should be saved per tick
    entry-per-tick: 10
    # How many ticks should the plugin wait before saving the leaderboard
    delay: 0
Chapter 2

Holder

This will guide you to set up a Group Holder

Subsections of Holder

Link a Top Holder

First, you add some settings to link a Top Holder to this Group Holder, which means the Group Holder will listen to the Top Holder for value changes and updates.

holders:
  jump_group: # The group holder name
    top: jump # The top holder it will be based on

This example will set that the Group Holder jump_group will listen to the Top Holder jump (Click here if you don’t know what jump is).

Continue reading to learn how to set up group settings.

Chapter 2

Set up Group settings

Now you will set up some settings for the type of Group.

Continue reading to learn how to set up based on the Group plugin you desire. Check the sidebar for a list of supported Group plugins.

Subsections of Set up Group settings

BentoBox

Note

Requires BentoBox and one or more Gamemode addons

Format

type: bentobox
gamemode: <gamemode> # the name of the gamemode

Example

holders:
  jump_group:
    top: jump

    type: bentobox
    gamemode: bskyblock

FactionsUUID

Note

Requires FactionsUUID

Format

type: factionsuuid

Example

holders:
  jump_group:
    top: jump

    type: factionsuuid

HuskTowns

Note

Requires HuskTowns

Format

type: husktowns

Example

holders:
  jump_group:
    top: jump

    type: husktowns

KingdomsX

Note

Requires KingdowsX

Format

type: kingdoms
kingdoms-type: <KINGDOM/NATION> # The type of the kingdoms to get, KINGDOM for the kingdom of the player, NATION for the capital kingdom of the nation of the player

Example

holders:
  jump_group:
    top: jump

    type: kingdoms
    kingdoms-type: KINGDOM

Lands

Note

Requires Lands

Format

type: lands
lands-type: <LAND/NATION> # The type of the kingdoms to get, KINGDOM for the kingdom of the player, NATION for the capital kingdom of the nation of the player

Example

holders:
  jump_group:
    top: jump

    type: lands
    lands-type: LAND

PlaceholderAPI

Note

Requires PlaceholderAPI and some placeholders to fetch the required group values

Format

type: placeholderapi
owner: "<owner-placeholder>" # The placeholder to get the owner of the group (could be player name or uuid)
display: "<display-placeholder>" # The placeholder to get the display name of the group
online: <true/false> # Whether or not to handle the value for online players only

Example

holders:
  jump_group:
    top: jump

    type: placeholder
    owner: '%player_uuid%'
    display: '%player_name%'
    online: true

SuperiorSkyblock

Note

Requires SuperiorSkyblock2

Format

type: superiorskyblock

Example

holders:
  jump_group:
    top: jump

    type: superiorskyblock

Towny

Note

Requires Towny

Format

type: towny

Example

holders:
  jump_group:
    top: jump

    type: towny

Query

The query system is the same as the one used in Topper, with the addition that:

  • the <holder> is the name of the Group Holder speficied in the configuration file of GroupTopper.
  • the top_name query returns the name of the Group
  • the top_key query returns the UUID of the owner of the Group

Refer to the Topper Query page for more information.

Chapter 4

Hook

Details about the hooks provided by the plugin.

Subsections of Hook

PlaceholderAPI

The plugin provides a PlaceholderAPI placeholder to allow you to query data from the Group Holder.

Usage

%grouptopper_<query>%

Check the Query for more information about how to set the <query>

Example

%grouptopper_jump_group;top_name;1%
%grouptopper_jump_group;top_value;1%
%grouptopper_jump_group;top_value;1;#,###%
%grouptopper_jump_group;top_rank%