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/Colour-codes.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 docs/Colour-codes.md

(limited to 'docs/Colour-codes.md')

diff --git a/docs/Colour-codes.md b/docs/Colour-codes.md
new file mode 100644
index 00000000..aba83ee4
--- /dev/null
+++ b/docs/Colour-codes.md
@@ -0,0 +1,51 @@
+Jump to section:
+* [Using Colour Codes](#using-colour-codes)
+* [Using Hexadecimal Colour](#using-hexadecimal-colour)
+
+You can use colour codes anywhere the plugin accepts a message (plugin messages, display items, and in task configurations themselves).
+
+Your server version dictates which codes are allowed:
+|  | Before 1.16 | 1.16+ |
+| ---- | ---- | ---- |
+| Colour Codes  | ✔️ | ✔️ |
+| Hexadecimal | ❌ | ✔️ |
+
+## Colour codes
+The plugin will automatically translate colour codes from '&' to '§' for you.
+
+| Name | Chat Code | Hex Equivalent |
+| ---- | ---- | ---- |
+| Black | `&0` | #000000 |
+| Dark Blue | `&1` | #0000AA |
+| Dark Green | `&2` | #00AA00 | 
+| Dark Aqua | `&3` | #00AAAA |
+| Dark Red | `&4` | #AA0000 | 
+| Dark Purple | `&5` | #AA00AA | 
+| Gold | `&6` | #FFAA00 | 
+| Gray | `&7` | #AAAAAA | 
+| Dark Gray | `&8` | #555555 |
+| Blue | `&9` | #5555FF | 
+| Green | `&a` | #55FF55 |
+| Aqua | `&b` |  #55FFFF |
+| Red | `&c` | #FF5555 |
+| Light Purple | `&d` | #FF55FF |
+| Yellow | `&e` | #FFFF55 |
+| White | `&f` | #FFFFFF |
+| Obfuscated | `&k` | - |
+| Bold | `&l` | - |
+| Strikethrough | `&m` | - |
+| Underline | `&n` | - |
+| Italic | `&o` | - |
+| Reset | `&r` | - |
+
+## Hexadecimal colour
+For compatible Minecraft versions, the plugin will also translate hex colour codes for you.
+
+You can include a hex colour code as you would with a normal colour code: `&#<hex colour code>`. **Note: the `#` is important and must be there.**
+
+For example, the following messages are identical:
+```
+&cThis is a red message.
+
+&#FF5555This is a red message.
+```
-- 
cgit v1.2.3-70-g09d2