diff options
| author | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-06 14:10:24 +0100 |
|---|---|---|
| committer | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-06 14:11:42 +0100 |
| commit | 0aac85ff5c27e98564243a9f43ae58685bd18ff2 (patch) | |
| tree | 1146693fe615b85be35447cd9fd2457ce1f3d180 /docs/configuration/creating-a-category.md | |
| parent | 4c9a7d83a19828e64ea7f90ddf69f9212bb7a7d9 (diff) | |
Migrate docs to GitHub pages
Diffstat (limited to 'docs/configuration/creating-a-category.md')
| -rw-r--r-- | docs/configuration/creating-a-category.md | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/docs/configuration/creating-a-category.md b/docs/configuration/creating-a-category.md new file mode 100644 index 00000000..e777b260 --- /dev/null +++ b/docs/configuration/creating-a-category.md @@ -0,0 +1,68 @@ +--- +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. + +## 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. |
