Skip to content

Commit abfe3b0

Browse files
authored
Update README.md
1 parent 9a254dd commit abfe3b0

File tree

1 file changed

+80
-3
lines changed

1 file changed

+80
-3
lines changed

README.md

Lines changed: 80 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,81 @@
1-
# ChatFormatter
2-
📋 The most intelligent chat formatting plugin with minimessages support!
1+
<div align="center">
2+
3+
![Readme Banner](https://i.imgur.com/AUI4Rnu.png)
4+
5+
[![Discord](https://img.shields.io/discord/889460117953720351?color=%237289DA&logo=discord&logoColor=white&style=for-the-badge)](https://discord.gg/FQ7jmGBd6c)
6+
[![Website](https://img.shields.io/badge/-website-orange?style=for-the-badge&logo=internet-explorer&logoColor=white)](https://eternalcode.pl/)
7+
8+
![Percentage of issues still open](https://img.shields.io/github/issues/EternalCodeTeam/ChatFormatter?style=for-the-badge)
9+
[![GitHub forks](https://img.shields.io/github/forks/EternalCodeTeam/ChatFormatter?style=for-the-badge)](https://github.com/EternalCodeTeam/ChatFormatter/network)
10+
[![GitHub stars](https://img.shields.io/github/stars/EternalCodeTeam/ChatFormatter?style=for-the-badge)](https://github.com/EternalCodeTeam/ChatFormatter/stargazers)
11+
[![GitHub license](https://img.shields.io/github/license/EternalCodeTeam/ChatFormatter?style=for-the-badge)](https://github.com/EternalCodeTeam/ChatFormatter/blob/master/LICENSE)
12+
13+
</div>
14+
15+
##### WARRNING! This plugin requires PlaceholderAPI and Vault to run!
16+
17+
### Features:
18+
- PlaceholderAPI Support
19+
- [MiniMessages Support](https://docs.adventure.kyori.net/minimessage/format.html) with Legacy Colors Support!
20+
- Template System
21+
- Custom Placeholders System
22+
23+
### Useful links:
24+
- [Web UI](https://webui.adventure.kyori.net)
25+
- [MiniMessages Format](https://docs.adventure.kyori.net/minimessage/format.html)
26+
27+
28+
### config.yml
29+
```yaml
30+
# ____ _ _ _____ ChatFormatter _ _
31+
# / ___| |__ __ _| |_| ___|__ _ __ _ __ ___ __ _| |_| |_ ___ _ __
32+
# | | | '_ \ / _` | __| |_ / _ \| '__| '_ ` _ \ / _` | __| __/ _ \ '__|
33+
# | |___| | | | (_| | |_| _| (_) | | | | | | | | (_| | |_| || __/ |
34+
# \____|_| |_|\__,_|\__|_| \___/|_| |_| |_| |_|\__,_|\__|\__\___|_|
35+
36+
# Do you want to use pre chat format? (Other plugins could join custom prefixes etc.)
37+
# INFO: This option requires to use custom badges like {displayname} and {message} in each message.
38+
preFormatting: false
39+
defaultFormat: "{displayname} {arrow_right} {message}"
40+
41+
# Chat format for ranks (Vault) Support mini-messages and legacy colors
42+
43+
# We're recommending to use webui for mini-messages: https://webui.adventure.kyori.net/
44+
45+
# documentation is here: https://docs.adventure.kyori.net/minimessage/format.html
46+
# Example usages:
47+
#
48+
# Hover message:
49+
# One line: <hover:show_text:'<red>test'>TEST
50+
# Multiple lines: <hover:show_text:'<red>test'>Test<newline>Test2</hover>
51+
#
52+
# Click message:
53+
# Open URL: <click:open_url:'https://webui.adventure.kyori.net'>TEST</click>
54+
# Run command: <click:run_command:/say hello>Click</click> to say hello
55+
# Suggest command: <click:suggest_command:'/msg {displayname}'></click>
56+
#
57+
# RGB and gradient message usage:
58+
# <color:#ff00ee>Example message</color>
59+
# <gradient:#ff00ee:#f79459>Example message</gradient>
60+
61+
format:
62+
default: "{member} &f{displayname} &8{arrow_right} {message} "
63+
admin: "$template({admin}, &c)"
64+
65+
# It is used to shorten the text even more and keep the clean file!
66+
templates:
67+
- "$template($rank, $color) -> '$rank $color{displayname} &8{arrow_right} $color{message}'"
68+
69+
# Placeholders, it allows you to make a shorter text, you can use some prefixes, characters etc.
70+
placeholders:
71+
{displayname}: "%1$s"
72+
{message}: "%2$s"
73+
{prefix}: "<b><gradient:#29fbff:#38b3ff>ChatFormatter</gradient></b>"
74+
{member}: "<b><color:#6e6764>Member</color></b>"
75+
{admin}: "<b><color:#ff4400>Admin</color></b>"
76+
{arrow_right}: "»"
77+
{arrow_left}: "«"
78+
```
79+
80+
381

4-
[See ChatFormatter wiki (In progress)](https://github.com/EternalCodeTeam/ChatFormatter/wiki)

0 commit comments

Comments
 (0)