Skip to content

Commit ac1e14e

Browse files
committed
update
1 parent 5be05e2 commit ac1e14e

File tree

3 files changed

+1338
-1770
lines changed

3 files changed

+1338
-1770
lines changed
Lines changed: 50 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11

22
# Categories
33

4-
Achievements are organized into categories. For each category, you can specify the servers where the achievements can be completed.
4+
Achievements are organized into categories. <br/>
5+
Categories are especially helpful for grouping achievements that belong to the same server/game mode.
56

67
:::info
78
The server id is defined in the `config.yml` file:
@@ -10,24 +11,58 @@ The server id is defined in the `config.yml` file:
1011
server: survival
1112
:::
1213

13-
Below is an example configuration:
14+
## Required Fields
15+
### `name`
16+
The name of the category.
17+
```yaml
18+
name: "Global"
19+
```
1420

15-
```yaml title="categories.yml"
21+
### `description`
22+
The description of the category.
23+
```yaml
24+
description:
25+
- "&7Achievements that can be completed"
26+
- "&7across all servers."
27+
```
28+
29+
### `servers`
30+
A list of servers where the category is enabled. <br/>
31+
**Use `ALL` to enable it on all servers.**
32+
```yaml
33+
servers:
34+
- ALL
35+
```
36+
37+
### `item`
38+
The item displayed in the main menu for the category.
39+
- `material`: The item's material.
40+
- `slot`: The slot in the menu where the item will be displayed.
41+
```yaml
42+
item:
43+
material: COMPASS
44+
slot: 12
45+
```
46+
47+
## Optional Fields
48+
### `permission`
49+
A permission required to access the category. <br/>
50+
**Default:** `None`
51+
```yaml
52+
permission: "achievements.global"
53+
```
54+
55+
## Example Configuration
56+
57+
```yaml title="categories.yml" showLineNumbers=true
1658
# Unique category identifier
17-
global:
18-
# Category name
19-
name: "Global"
20-
# Category description
59+
survival:
60+
name: "Survival"
2161
description:
22-
- "&7Achievements that can be completed"
23-
- "&7across all servers."
24-
# Servers where the category is enabled
62+
- "&7Mine, craft and explore!"
2563
servers:
26-
- ALL
27-
# Item displayed in the main menu
64+
- survival
2865
item:
29-
material: COMPASS
66+
material: DIAMOND_PICKAXE
3067
slot: 12
31-
# (Optional) Permission required to access the category
32-
# permission: achievements.global
3368
```

0 commit comments

Comments
 (0)