aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Colour-codes.md
blob: aba83ee4d077da79a7599260037b945b078b7a9e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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.
```