Skip to content

Commit 829a218

Browse files
authored
GH-103 Improve readme add preview. (#103)
* Start of improve git related files. * Add preview and improve readme.
1 parent 1fb0fe7 commit 829a218

File tree

3 files changed

+50
-47
lines changed

3 files changed

+50
-47
lines changed

README.md

Lines changed: 50 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![Readme Banner](assets/img/chatformatter.png)
44

5-
[![Available on Spigot](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/supported/spigot_vector.svg)](https://www.spigotmc.org/resources/%EF%B8%8F-chatformatter-%E2%9C%94%EF%B8%8F-minimessages-%E2%9C%94%EF%B8%8F-template-system-%E2%9C%94%EF%B8%8F-placeholders-%E2%9C%94%EF%B8%8F-vault-support.102212/)
5+
[![Available on Paper](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/supported/spigot_vector.svg)](https://raw.githubusercontent.com/intergrav/devins-badges/1aec26abb75544baec37249f42008b2fcc0e731f/assets/cozy/supported/paper_vector.svg)
66
[![Available on modrinth](https://raw.githubusercontent.com/intergrav/devins-badges/68af3da1d56294934ece854c43dac9ab1b0eb3e9/assets/cozy/available/modrinth_vector.svg)](https://modrinth.com/plugin/chatformatter)
77

88
[![Patreon](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/donate/patreon-plural_vector.svg)](https://www.patreon.com/eternalcode)
@@ -14,64 +14,67 @@
1414

1515
</div>
1616

17-
##### WARRNING! This plugin requires PlaceholderAPI and Vault to run!
17+
> **This plugin requires PlaceholderAPI and Vault to run!**
1818
19-
### Features:
19+
## Preview:
20+
![1](assets/gif/ChatFormatterHoverPlayerInfo.gif)
21+
![2](assets/gif/ChatFormatterClickableMessage2.gif)
22+
23+
## Features:
2024

2125
- PlaceholderAPI Support
2226
- [MiniMessages Support](https://docs.adventure.kyori.net/minimessage/format.html) with Legacy Colors Support!
2327
- Template System
2428
- Custom Placeholders System
25-
- Per permission miniMessages Tags (check permissions 👇)
29+
- Per-permission miniMessages Tags (see permissions below)
2630

27-
### Useful links:
31+
## Useful links:
2832

2933
- [Web UI](https://webui.adventure.kyori.net)
30-
- [MiniMessages Format](https://docs.adventure.kyori.net/minimessage/format.html)
31-
32-
### Permissions:
33-
34-
- chatformatter.decorations.* - `<bold>`, `<italic>`, `<underlined>`, `<strikethrough>`, and `<obfuscated>` tags.
35-
- chatformatter.decorations.bold - `<bold>`
36-
- chatformatter.decorations.italic - `<italic>`
37-
- chatformatter.decorations.underlined - `<underlined>`
38-
- chatformatter.decorations.strikethrough - `<strikethrough>`
39-
- chatformatter.decorations.obfuscated - `<obfuscated>`
40-
- chatformatter.reset - `<reset>`
41-
- chatformatter.gradient - `<gradient>`
42-
- chatformatter.hover - `<hover>`
43-
- chatformatter.click - `<click>`
44-
- chatformatter.insertion - `<insertion>`
45-
- chatformatter.font - `<font>`
46-
- chatformatter.transition - `<transition>`
47-
- chatformatter.translatable - `<lang>`
48-
- chatformatter.selector - `<selector>`
49-
- chatformatter.keybind - `<key>`
50-
- chatformatter.newline - `<newline>`
51-
- chatformatter.chat.reload - reload the plugin `/chatformatter reload`
52-
- chatformatter.receiveupdates - receive updates announce for this plugin
34+
- [MiniMessages Format](https://docs.adventure.kyori.net/minimessage/format.html)
35+
36+
## Permissions:
37+
38+
- `chatformatter.decorations.*` gives access to `<bold>`, `<italic>`, `<underlined>`, `<strikethrough>`, and `<obfuscated>` tags.
39+
- `chatformatter.decorations.bold` - `<bold>`
40+
- `chatformatter.decorations.italic` - `<italic>`
41+
- `chatformatter.decorations.underlined` - `<underlined>`
42+
- `chatformatter.decorations.strikethrough` - `<strikethrough>`
43+
- `chatformatter.decorations.obfuscated` - `<obfuscated>`
44+
- `chatformatter.reset` - `<reset>`
45+
- `chatformatter.gradient` - `<gradient>`
46+
- `chatformatter.hover` - `<hover>`
47+
- `chatformatter.click` - `<click>`
48+
- `chatformatter.insertion` - `<insertion>`
49+
- `chatformatter.font` - `<font>`
50+
- `chatformatter.transition` - `<transition>`
51+
- `chatformatter.translatable` - `<lang>`
52+
- `chatformatter.selector` - `<selector>`
53+
- `chatformatter.keybind` - `<key>`
54+
- `chatformatter.newline` - `<newline>`
55+
- `chatformatter.chat.reload` - reloads the plugin with `/chatformatter reload`
56+
- `chatformatter.receiveupdates` - receive update announcements for this plugin
5357

5458
### Additional color permissions:
5559

56-
- chatformatter.color.* - `<red>`, `<blue>`, etc. tags.
57-
- chatformatter.legacycolor - Allows the use of legacy color codes, such as `&c`, `&4`, `&l`, etc.
58-
- chatformatter.color.black - `<black>`
59-
- chatformatter.color.dark_blue - `<dark_blue>`
60-
- chatformatter.color.dark_green - `<dark_green>`
61-
- chatformatter.color.dark_aqua - `<dark_aqua>`
62-
- chatformatter.color.dark_red - `<dark_red>`
63-
- chatformatter.color.dark_purple - `<dark_purple>`
64-
- chatformatter.color.gold - `<gold>`
65-
- chatformatter.color.gray - `<gray>`
66-
- chatformatter.color.dark_gray - `<dark_gray>`
67-
- chatformatter.color.blue - `<blue>`
68-
- chatformatter.color.green - `<green>`
69-
- chatformatter.color.aqua - `<aqua>`
70-
- chatformatter.color.red - `<red>`
71-
- chatformatter.color.light_purple - `<light_purple>`
72-
- chatformatter.color.yellow - `<yellow>`
73-
- chatformatter.color.white - `<white>`
74-
60+
- `chatformatter.color.*` gives access to `<red>`, `<blue>`, etc. tags.
61+
- `chatformatter.legacycolor` - Allows the use of legacy color codes, such as `&c`, `&4`, `&l`, etc.
62+
- `chatformatter.color.black` - `<black>`
63+
- `chatformatter.color.dark_blue` - `<dark_blue>`
64+
- `chatformatter.color.dark_green` - `<dark_green>`
65+
- `chatformatter.color.dark_aqua` - `<dark_aqua>`
66+
- `chatformatter.color.dark_red` - `<dark_red>`
67+
- `chatformatter.color.dark_purple` - `<dark_purple>`
68+
- `chatformatter.color.gold` - `<gold>`
69+
- `chatformatter.color.gray` - `<gray>`
70+
- `chatformatter.color.dark_gray` - `<dark_gray>`
71+
- `chatformatter.color.blue` - `<blue>`
72+
- `chatformatter.color.green` - `<green>`
73+
- `chatformatter.color.aqua` - `<aqua>`
74+
- `chatformatter.color.red` - `<red>`
75+
- `chatformatter.color.light_purple` - `<light_purple>`
76+
- `chatformatter.color.yellow` - `<yellow>`
77+
- `chatformatter.color.white` - `<white>`
7578
### config.yml
7679

7780
```yaml
2.1 MB
Loading
1.68 MB
Loading

0 commit comments

Comments
 (0)