Update Categories authored by Vierdant's avatar Vierdant
......@@ -4,6 +4,56 @@ These are added/edited in the `category.yml` file in your MythicAchievements plu
Categories have their own tabs in the advancement menu, and also display as the first "node" in the category.
Table Of Contents:
[[_TOC_]]
## Adding New Category
```yml
CATEGORY_KEY:
Display: 'Name of your category'
Description: 'Description of Category'
Background: 'textures/block/polished_blackstone.png'
Frame: TASK
Icon:
Material: IRON_SWORD
Model: 0
```
## Category Breakdown
### Display
```yml
Display: 'Hunting Monsters'
```
Display the name of your category. This name is shown in the tab's icon and the starting node item.
### Description
```yml
Description: 'Adventure awaits you in the wilderness'
```
Provide a short description of your category. This is only shown in the starting node item.
![image](uploads/9ead2354a0d2909e8984f67d2730e727/image.png)
### Background
```yml
Background: 'textures/block/black_concrete.png'
```
The background image of your category. This can be a path to any block texture inside of the player's loaded resource pack.
So if you want diamond ore as the background of your category, you would provide `textures/block/diamond_ore.png` as the value.
### Frame
```yml
Frame: CHALLENGE
```
The frame shape of your starting node item.
This can be a `TASK`, `GOAL`, or `CHALLENGE`.
### Icon
```yml
Icon:
Material: IRON_SWORD
Model: 0
```
The icon is the item displayed in the tab button in the advancement menu, and in the starting node of the category.
You have to provide a valid material name, **MAKE SURE IT IS UPPERCASE**.
Optionally, you have the choice to provide a model data value (CustomModelData).
## Example
```
SPECIAL:
......@@ -13,3 +63,7 @@ SPECIAL:
Material: NETHER_STAR
```
![image](uploads/f8447f1449ec03975fe62621ac4b1810/image.png "")
This example only uses the required values to generate a valid category.
To learn how to add achievements to the category you created, see [Creating Achievements](Usage)
\ No newline at end of file