Skip to content

Commit

Permalink
docs: add missing documentation about hex colors
Browse files Browse the repository at this point in the history
  • Loading branch information
Silthus committed Nov 17, 2021
1 parent 0d7dc26 commit aaa1b10
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
11 changes: 10 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,13 @@ channels:
The use of [PlaceholderAPI][2] placeholders in the channel format is possible. For
example `[<channel_name>]%vault_rank% %player_name%: <message>` will work and replace the placeholders.

## Frequently Asked Questions

### Are HEX colors supported?

Yes they are. Use them just like the other colors, e.g. `<#ffffff><message>`. See this [formatting documentation][6] for
more details.

[1]: https://papermc.io/

[2]: https://www.spigotmc.org/resources/vault.34315/
Expand All @@ -97,4 +104,6 @@ example `[<channel_name>]%vault_rank% %player_name%: <message>` will work and re

[4]: https://www.spigotmc.org/resources/protocollib.1997/

[5]: https://github.com/Silthus/sChat/releases
[5]: https://github.com/Silthus/sChat/releases

[6]: https://docs.adventure.kyori.net/minimessage#format
1 change: 1 addition & 0 deletions src/main/resources/config.default.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ channels:
# You can use the mini message format documented here: https://docs.adventure.kyori.net/minimessage#format
# You can use the web viewer to preview how your chat will look: https://webui.adventure.kyori.net/
# You can use any PlaceholderAPI placeholders with the {placeholder} syntax.
# You can use any hex color inside the <...> brackets, e.g. <#ffffff> instead of <yellow> or <green></green> <#ffffff></#ffffff>
# The following custom mini message placeholders are available:
# - <channel_name>: The name of the channel (see above).
# - <sender_vault_prefix>: The Vault prefix of the sending player. Requires Vault to work. "Bleeding" color codes in prefix and suffix currently do not work.
Expand Down
1 change: 1 addition & 0 deletions src/main/resources/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ channels:
# You can use the mini message format documented here: https://docs.adventure.kyori.net/minimessage#format
# You can use the web viewer to preview how your chat will look: https://webui.adventure.kyori.net/
# You can use any PlaceholderAPI placeholders with the {placeholder} syntax.
# You can use any hex color inside the <...> brackets, e.g. <#ffffff> instead of <yellow> or <green></green> <#ffffff></#ffffff>
# The following custom mini message placeholders are available:
# - <channel_name>: The name of the channel (see above).
# - <sender_vault_prefix>: The Vault prefix of the sending player. Requires Vault to work. "Bleeding" color codes in prefix and suffix currently do not work.
Expand Down

0 comments on commit aaa1b10

Please sign in to comment.