aboutsummaryrefslogtreecommitdiffstats
path: root/docs/configuration/creating-a-category.md
blob: c0b41d865fbfbd13331a3cad3d780a662ac5712a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
---
title: Creating a category
parent: Configuration
nav_order: 3
---

# Creating a category
{: .no_toc }

Categories are stored in `categories.yml`. On older versions of Quests
they were stored in the main `config.yml`; quests will read categories
from `config.yml` if a `categories.yml` file is not present.


## Table of contents
{: .no_toc .text-delta }

1. TOC
{:toc}

## Category ID

ID of category, this is the text you should enter when putting quests
inside a category.

## GUI title


*`gui-name`*

The custom GUI title to be shown in this category quest menu

## Display

  
*`display`*

The item that is shown in the GUI.

### Name

  
*`display.name`*

The name of the item.

### Lore

  
*`display.lore`*

The lore (description) of the item.

### Type

  
*`display.type`*

The type (material name/id) of item.

## Permission required

  
*`permission-required`*

Whether permission is needed to open this category, or start quests
within it. This permission will follow this format:
`quests.category.<category>`\`.

## Hidden

  
*`hidden`*

Whether this category is shown in the main quests menu.