From e85f8eea9dfe76dacc86728b20c4a0036ec71c1d Mon Sep 17 00:00:00 2001
From: LMBishop <13875753+LMBishop@users.noreply.github.com>
Date: Wed, 5 Jul 2023 15:28:17 +0100
Subject: Add /docs directory

This is part of a migration from GitHub wikis to GitHub pages
---
 docs/Creating-a-category.md | 54 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 docs/Creating-a-category.md

(limited to 'docs/Creating-a-category.md')

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.
-- 
cgit v1.2.3-70-g09d2