Skip to content

Commit 9e779b1

Browse files
committed
Update config in readme.
1 parent b364d55 commit 9e779b1

File tree

1 file changed

+34
-15
lines changed

1 file changed

+34
-15
lines changed

README.md

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@ receiveUpdates: true
9292
# We're recommending to use webui for mini-messages: https://webui.adventure.kyori.net/
9393

9494
# documentation is here: https://docs.adventure.kyori.net/minimessage/format.html
95+
96+
# You can check LuckPerms setup and placeholders here: https://luckperms.net/wiki/Placeholders
97+
#
9598
# Example usages:
9699
#
97100
# Hover message:
@@ -106,26 +109,42 @@ receiveUpdates: true
106109
# RGB and gradient message usage:
107110
# <color:#ff00ee>Example message</color>
108111
# <gradient:#ff00ee:#f79459>Example message</gradient>
112+
#
113+
# You can use three more internal placeholders: <displayname> <name> <message>
114+
#
115+
defaultFormat: "{displayname} » {message}"
109116

110-
defaultFormat: "{displayname} {arrow_right} {message}"
117+
# Here you can set different formats for each rank.
118+
# Remember! Rank name must be exactly the same as in you permission plugin configuration.
119+
# If player have more than one rank remember to correctly setup rank weight configuration
111120
format:
112-
default: "{member} &f{displayname} &8{arrow_right} {message} "
113-
admin: "$template({admin}, &c)"
114-
115-
# It is used to shorten the text even more and keep the clean file!
116-
templates:
117-
- "$template($rank, $color) -> '$rank $color{displayname} &8{arrow_right} $color{message}'"
121+
default: "{member} &7$hoverName({displayname}) &8» <gradient:#d4d4d4:white>{message} "
122+
vip: "{vip} &f$hoverName({displayname}) <dark_gray>» <gradient:#ffd270:white>{message}"
123+
mod: "{mod} &f$hoverName({displayname}) <dark_gray>» <gradient:#a3ff9e:white>{message}"
124+
admin: "{admin} &f$hoverName({displayname}) <dark_gray>» <gradient:#bac8ff:white><b>{message}"
125+
owner: "{owner} &f$hoverName({displayname}) <dark_gray>» <gradient:#ff9195:white><b>{message}"
118126

119127
# Placeholders, it allows you to make a shorter text, you can use some prefixes, characters etc.
128+
# You can use here PAPI placeholders.
120129
placeholders:
121-
{ displayname }: "<displayname>"
122-
{ name }: "<name>"
123-
{ message }: "<message>"
124-
{ prefix }: "<b><gradient:#29fbff:#38b3ff>ChatFormatter</gradient></b>"
125-
{ member }: "<b><color:#6e6764>Member</color></b>"
126-
{ admin }: "<b><color:#ff4400>Admin</color></b>"
127-
{ arrow_right }: "»"
128-
{ arrow_left }: "«"
130+
{displayname}: "<displayname>"
131+
{name}: "<name>"
132+
{message}: "<message>"
133+
{member}: "<#6e6764>Member"
134+
{vip}: "<gold>VIP"
135+
{mod}: "<b><#00c900>Mod</b>"
136+
{admin}: "<b><#6e86ff>Admin</b>"
137+
{owner}: "<b><gradient:#c40000:#e04b4b>Owner</b>"
138+
{rankDescription}: "<dark_gray>Rank: <white>%vault_group%"
139+
{joinDate}: "<dark_gray>Joined: <white>%player_first_join_date%"
140+
{health}: "<dark_gray>Health: <red>%player_health%"
141+
{lvl}: "<dark_gray>LVL: <gold>%player_level%"
142+
{privateMessage}: "<gradient:#36ff39:#75ff75><i>Click to send private message</i></gradient>"
143+
144+
# This section is made for experienced users
145+
# It is used to shorten the text even more and keep the clean file!
146+
templates:
147+
- "$hoverName($name) -> '<hover:show_text:'<dark_gray>Name: <white>$name<br><br>{rankDescription}<br>{joinDate}<br>{health}<br>{lvl}<br><br>{privateMessage}'><click:suggest_command:'/msg {displayname} '>{displayname}</click></hover>'"
129148
```
130149
131150

0 commit comments

Comments
 (0)