You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONFIG.md
+58-4Lines changed: 58 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,59 @@
1
1
# Configuration Overview:
2
2
3
+
## MiniMessage Format
4
+
5
+
All color and text formatting in this configuration uses **MiniMessage format**. This is a modern, flexible text formatting system that replaces legacy color codes.
6
+
7
+
### Common Colors
8
+
9
+
Named colors are the simplest way to add color:
10
+
-`<red>` - Red text
11
+
-`<green>` - Green text
12
+
-`<blue>` - Blue text
13
+
-`<yellow>` - Yellow text
14
+
-`<aqua>` - Aqua/Cyan text
15
+
-`<gray>` - Gray text
16
+
-`<white>` - White text
17
+
-`<black>` - Black text
18
+
-`<dark_red>` - Dark red
19
+
-`<dark_green>` - Dark green
20
+
-`<dark_blue>` - Dark blue
21
+
-`<dark_gray>` - Dark gray
22
+
-`<dark_aqua>` - Dark aqua
23
+
-`<gold>` - Gold/Orange
24
+
25
+
### RGB Colors
26
+
27
+
For precise color control, use RGB hex colors:
28
+
-`<color:#FF0000>` - Red (RGB format: #RRGGBB)
29
+
-`<color:#00FF00>` - Green
30
+
-`<color:#0000FF>` - Blue
31
+
-`<color:#FF6B35>` - Custom orange
32
+
-`<color:#A0E7E5>` - Custom teal
33
+
34
+
### Text Formatting
35
+
36
+
Combine colors with formatting:
37
+
-`<b>` - Bold text
38
+
-`<i>` - Italic text
39
+
-`<u>` - Underlined text
40
+
-`<st>` - Strikethrough text
41
+
-`<obf>` - Obfuscated text
42
+
-`<reset>` - Reset formatting
43
+
44
+
### Examples
45
+
46
+
```
47
+
<red>Error:</red> <gray>Something went wrong</gray>
48
+
<green><b>Success!</b></green> Your kit has been saved.
49
+
<color:#FF6B35><b>Important:</b></color> This is a custom orange color.
50
+
<aqua>Type <u>/kit</u> to get started!</aqua>
51
+
```
52
+
53
+
For a complete reference of all available options, see the [MiniMessage documentation](https://docs.papermc.io/adventure/minimessage/).
54
+
55
+
---
56
+
3
57
### **Database Credentials**
4
58
5
59
Select either storage type. SQLite is recommended for small servers, while MySQL is recommended for larger servers or multi-server setups.
@@ -63,7 +117,7 @@ scheduled-broadcast:
63
117
64
118
### **Kit Room**
65
119
66
-
Defines kits and their visual representation in the UI. This section uses the old text formating using & color codes.
120
+
Defines kits and their visual representation in the UI. Kit names are displayed in their default color.
67
121
68
122
```yaml
69
123
kitroom:
@@ -89,20 +143,20 @@ kitroom:
89
143
90
144
### **Disabled Command Worlds**
91
145
92
-
Lists worlds where kit commands are disabled. Players in these worlds will see a custom error message if they attempt to use the commands. This section uses the old text formating using & color codes.
146
+
Lists worlds where kit commands are disabled. Players in these worlds will see a custom error message if they attempt to use the commands. This section uses mini message format for styling.
93
147
94
148
```yaml
95
149
disabled-command-worlds:
96
150
- "example_world"# Add worlds where kit commands should be restricted.
97
151
98
-
disabled-command-message: "&cKits are disabled here!"# Message displayed to players in disabled worlds.
152
+
disabled-command-message: "<red>Kits are disabled here!</red>"# Message displayed to players in disabled worlds (MiniMessage format).
99
153
```
100
154
101
155
---
102
156
103
157
### **Public Kits**
104
158
105
-
Allows customization of publicly available kits. By default, this section is commented out and needs to be configured based on requirements. This section uses the old text formating using & color codes.
159
+
Allows customization of publicly available kits. By default, this section is commented out and needs to be configured based on requirements. Kit names are displayed in their default color.
publicstaticfinalItemStackREGEAR_SHULKER_ITEM = ItemUtil.createItem(Material.WHITE_SHULKER_BOX, 1, StyleManager.get().getPrimaryColor() + "Regear Shulker", "&7● Restocks Your Kit", "&7● Use " + StyleManager.get().getPrimaryColor() + "/rg &7to get another regear shulker");
30
-
publicstaticfinalItemStackREGEAR_SHELL_ITEM = ItemUtil.createItem(Material.SHULKER_SHELL, 1, StyleManager.get().getPrimaryColor() + "Regear Shell", "&7● Restocks Your Kit", "&7● Click to use!");
29
+
publicstaticfinalItemStackREGEAR_SHULKER_ITEM = ItemUtil.createItem(Material.WHITE_SHULKER_BOX, 1, StyleManager.get().getPrimaryColor() + "Regear Shulker", "<gray>● Restocks Your Kit</gray>", "<gray>● Use </gray>" + StyleManager.get().getPrimaryColor() + "<gray>/rg to get another regear shulker</gray>");
30
+
publicstaticfinalItemStackREGEAR_SHELL_ITEM = ItemUtil.createItem(Material.SHULKER_SHELL, 1, StyleManager.get().getPrimaryColor() + "Regear Shell", "<gray>● Restocks Your Kit</gray>", "<gray>● Click to use!</gray>");
0 commit comments