summaryrefslogtreecommitdiffstats
path: root/docs/configuration/colour-codes.md
diff options
context:
space:
mode:
authorLMBishop <13875753+LMBishop@users.noreply.github.com>2023-07-06 14:10:24 +0100
committerLMBishop <13875753+LMBishop@users.noreply.github.com>2023-07-06 14:11:42 +0100
commit0aac85ff5c27e98564243a9f43ae58685bd18ff2 (patch)
tree1146693fe615b85be35447cd9fd2457ce1f3d180 /docs/configuration/colour-codes.md
parent4c9a7d83a19828e64ea7f90ddf69f9212bb7a7d9 (diff)
Migrate docs to GitHub pages
Diffstat (limited to 'docs/configuration/colour-codes.md')
-rw-r--r--docs/configuration/colour-codes.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/configuration/colour-codes.md b/docs/configuration/colour-codes.md
new file mode 100644
index 00000000..0d3de95d
--- /dev/null
+++ b/docs/configuration/colour-codes.md
@@ -0,0 +1,58 @@
+---
+title: Colour codes
+parent: Configuration
+nav_order: 8
+---
+# Colour (color) codes
+
+You can use colour codes anywhere the plugin accepts a message (plugin messages, display items, and in task configurations themselves).
+
+The following table shows the colour capabilities of specific server versions:
+
+| | 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>`.
+
+{: .important }
+The `#` symbol indicates a hexadecimal colour code. These must be exactly six characters long.
+
+For example, the following messages are identical:
+```
+&cThis is a red message.
+
+&#FF5555This is a red message.
+```