diff options
| author | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-05 15:28:17 +0100 |
|---|---|---|
| committer | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-05 15:28:17 +0100 |
| commit | e85f8eea9dfe76dacc86728b20c4a0036ec71c1d (patch) | |
| tree | 3d67553c597e7851b657cfa2638887699b2b4ace /docs/Creating-a-category.md | |
| parent | 4c9a7d83a19828e64ea7f90ddf69f9212bb7a7d9 (diff) | |
Add /docs directory
This is part of a migration from GitHub wikis to GitHub pages
Diffstat (limited to 'docs/Creating-a-category.md')
| -rw-r--r-- | docs/Creating-a-category.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/Creating-a-category.md b/docs/Creating-a-category.md new file mode 100644 index 00000000..f41d919d --- /dev/null +++ b/docs/Creating-a-category.md @@ -0,0 +1,54 @@ +# Creating a category + +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. + +## 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. |
