Skip to content

Commit 9c8a962

Browse files
HSGamerHSGamer
committed
add GroupTopper wiki
1 parent af2cd3b commit 9c8a962

File tree

15 files changed

+266
-0
lines changed

15 files changed

+266
-0
lines changed

‎content/grouptopper/_index.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
+++
2+
title = "GroupTopper"
3+
type = "chapter"
4+
weight = 3
5+
+++
6+
7+
The documentation of GroupTopper, a Spigot plugin for group leaderboards

‎content/grouptopper/config/_index.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
+++
2+
title = "Config"
3+
weight = 1
4+
+++
5+
6+
```yaml
7+
# The type of storage the plugin will use to store the value
8+
# Available: YAML, SQLITE, MYSQL
9+
storage-type: sqlite
10+
# The settings for each group holders
11+
holders:
12+
jump_group: # The group holder name
13+
top: jump # The top holder it will be based on
14+
15+
type: placeholder # Group settings
16+
owner: '%player_uuid%'
17+
display: '%player_name%'
18+
online: true
19+
task:
20+
save:
21+
# How many entries should be saved per tick
22+
entry-per-tick: 10
23+
# How many ticks should the plugin wait before saving the leaderboard
24+
delay: 0
25+
```

‎content/grouptopper/holder/_index.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
+++
2+
title = "Holder"
3+
type = "chapter"
4+
weight = 2
5+
+++
6+
7+
This will guide you to set up a Holder

‎content/grouptopper/holder/group/_index.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
+++
2+
title = "Set up Group settings"
3+
type = "chapter"
4+
weight = 2
5+
+++
6+
7+
Now you will set up some settings for the type of Group.
8+
9+
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.

‎content/grouptopper/holder/group/bentobox/_index.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
+++
2+
title = "BentoBox"
3+
+++
4+
5+
> [!NOTE]
6+
> Requires [BentoBox](https://bentobox.world/) and one or more Gamemode addons
7+
8+
## Format
9+
10+
```yaml
11+
type: bentobox
12+
gamemode: <gamemode> # the name of the gamemode
13+
```
14+
15+
## Example
16+
17+
```yaml
18+
holders:
19+
jump_group:
20+
top: jump
21+
22+
type: bentobox
23+
gamemode: bskyblock
24+
```

‎content/grouptopper/holder/group/factionsuuid/_index.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
+++
2+
title = "FactionsUUID"
3+
+++
4+
5+
> [!NOTE]
6+
> Requires [FactionsUUID](https://www.spigotmc.org/resources/1035/)
7+
8+
## Format
9+
10+
```yaml
11+
type: factionsuuid
12+
```
13+
14+
## Example
15+
16+
```yaml
17+
holders:
18+
jump_group:
19+
top: jump
20+
21+
type: factionsuuid
22+
```

‎content/grouptopper/holder/group/husktowns/_index.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
+++
2+
title = "HuskTowns"
3+
+++
4+
5+
> [!NOTE]
6+
> Requires [HuskTowns](https://www.spigotmc.org/resources/92672/)
7+
8+
## Format
9+
10+
```yaml
11+
type: husktowns
12+
```
13+
14+
## Example
15+
16+
```yaml
17+
holders:
18+
jump_group:
19+
top: jump
20+
21+
type: husktowns
22+
```

‎content/grouptopper/holder/group/kingdomsx/_index.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
+++
2+
title = "KingdomsX"
3+
+++
4+
5+
> [!NOTE]
6+
> Requires [KingdowsX](https://www.spigotmc.org/resources/77670/)
7+
8+
## Format
9+
10+
```yaml
11+
type: kingdoms
12+
```
13+
14+
## Example
15+
16+
```yaml
17+
holders:
18+
jump_group:
19+
top: jump
20+
21+
type: kingdoms
22+
```

‎content/grouptopper/holder/group/placeholderapi/_index.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
+++
2+
title = "PlaceholderAPI"
3+
+++
4+
5+
> [!NOTE]
6+
> Requires [PlaceholderAPI](https://placeholderapi.com/) and some placeholders to fetch the required group values
7+
8+
## Format
9+
10+
```yaml
11+
type: placeholderapi
12+
owner: "<owner-placeholder>" # The placeholder to get the owner of the group (could be player name or uuid)
13+
display: "<display-placeholder>" # The placeholder to get the display name of the group
14+
online: <true/false> # Whether or not to handle the value for online players only
15+
```
16+
17+
## Example
18+
19+
```yaml
20+
holders:
21+
jump_group:
22+
top: jump
23+
24+
type: placeholder
25+
owner: '%player_uuid%'
26+
display: '%player_name%'
27+
online: true
28+
```

‎content/grouptopper/holder/group/superiorskyblock/_index.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
+++
2+
title = "SuperiorSkyblock"
3+
+++
4+
5+
> [!NOTE]
6+
> Requires [SuperiorSkyblock2](https://www.spigotmc.org/resources/87411/)
7+
8+
## Format
9+
10+
```yaml
11+
type: superiorskyblock
12+
```
13+
14+
## Example
15+
16+
```yaml
17+
holders:
18+
jump_group:
19+
top: jump
20+
21+
type: superiorskyblock
22+
```

0 commit comments

Comments
 (0)