diff --git a/README.md b/README.md index cb1b78f..c7875b1 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![Readme Banner](assets/img/chatformatter.png) -[![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/) +[![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) [![Available on modrinth](https://raw.githubusercontent.com/intergrav/devins-badges/68af3da1d56294934ece854c43dac9ab1b0eb3e9/assets/cozy/available/modrinth_vector.svg)](https://modrinth.com/plugin/chatformatter) [![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 @@ -##### WARRNING! This plugin requires PlaceholderAPI and Vault to run! +> ⚠ **This plugin requires PlaceholderAPI and Vault to run!** -### Features: +## Preview: +![1](assets/gif/ChatFormatterHoverPlayerInfo.gif) +![2](assets/gif/ChatFormatterClickableMessage2.gif) + +## Features: - PlaceholderAPI Support - [MiniMessages Support](https://docs.adventure.kyori.net/minimessage/format.html) with Legacy Colors Support! - Template System - Custom Placeholders System -- Per permission miniMessages Tags (check permissions 👇) +- Per-permission miniMessages Tags (see permissions below) -### Useful links: +## Useful links: - [Web UI](https://webui.adventure.kyori.net) -- [MiniMessages Format](https://docs.adventure.kyori.net/minimessage/format.html) - -### Permissions: - -- chatformatter.decorations.* - ``, ``, ``, ``, and `` tags. -- chatformatter.decorations.bold - `` -- chatformatter.decorations.italic - `` -- chatformatter.decorations.underlined - `` -- chatformatter.decorations.strikethrough - `` -- chatformatter.decorations.obfuscated - `` -- chatformatter.reset - `` -- chatformatter.gradient - `` -- chatformatter.hover - `` -- chatformatter.click - `` -- chatformatter.insertion - `` -- chatformatter.font - `` -- chatformatter.transition - `` -- chatformatter.translatable - `` -- chatformatter.selector - `` -- chatformatter.keybind - `` -- chatformatter.newline - `` -- chatformatter.chat.reload - reload the plugin `/chatformatter reload` -- chatformatter.receiveupdates - receive updates announce for this plugin +- [MiniMessages Format](https://docs.adventure.kyori.net/minimessage/format.html) + +## Permissions: + +- `chatformatter.decorations.*` gives access to ``, ``, ``, ``, and `` tags. +- `chatformatter.decorations.bold` - `` +- `chatformatter.decorations.italic` - `` +- `chatformatter.decorations.underlined` - `` +- `chatformatter.decorations.strikethrough` - `` +- `chatformatter.decorations.obfuscated` - `` +- `chatformatter.reset` - `` +- `chatformatter.gradient` - `` +- `chatformatter.hover` - `` +- `chatformatter.click` - `` +- `chatformatter.insertion` - `` +- `chatformatter.font` - `` +- `chatformatter.transition` - `` +- `chatformatter.translatable` - `` +- `chatformatter.selector` - `` +- `chatformatter.keybind` - `` +- `chatformatter.newline` - `` +- `chatformatter.chat.reload` - reloads the plugin with `/chatformatter reload` +- `chatformatter.receiveupdates` - receive update announcements for this plugin ### Additional color permissions: -- chatformatter.color.* - ``, ``, etc. tags. -- chatformatter.legacycolor - Allows the use of legacy color codes, such as `&c`, `&4`, `&l`, etc. -- chatformatter.color.black - `` -- chatformatter.color.dark_blue - `` -- chatformatter.color.dark_green - `` -- chatformatter.color.dark_aqua - `` -- chatformatter.color.dark_red - `` -- chatformatter.color.dark_purple - `` -- chatformatter.color.gold - `` -- chatformatter.color.gray - `` -- chatformatter.color.dark_gray - `` -- chatformatter.color.blue - `` -- chatformatter.color.green - `` -- chatformatter.color.aqua - `` -- chatformatter.color.red - `` -- chatformatter.color.light_purple - `` -- chatformatter.color.yellow - `` -- chatformatter.color.white - `` - +- `chatformatter.color.*` gives access to ``, ``, etc. tags. +- `chatformatter.legacycolor` - Allows the use of legacy color codes, such as `&c`, `&4`, `&l`, etc. +- `chatformatter.color.black` - `` +- `chatformatter.color.dark_blue` - `` +- `chatformatter.color.dark_green` - `` +- `chatformatter.color.dark_aqua` - `` +- `chatformatter.color.dark_red` - `` +- `chatformatter.color.dark_purple` - `` +- `chatformatter.color.gold` - `` +- `chatformatter.color.gray` - `` +- `chatformatter.color.dark_gray` - `` +- `chatformatter.color.blue` - `` +- `chatformatter.color.green` - `` +- `chatformatter.color.aqua` - `` +- `chatformatter.color.red` - `` +- `chatformatter.color.light_purple` - `` +- `chatformatter.color.yellow` - `` +- `chatformatter.color.white` - `` ### config.yml ```yaml diff --git a/assets/gif/ChatFormatterClickableMessage2.gif b/assets/gif/ChatFormatterClickableMessage2.gif new file mode 100644 index 0000000..a72dea1 Binary files /dev/null and b/assets/gif/ChatFormatterClickableMessage2.gif differ diff --git a/assets/gif/ChatFormatterHoverPlayerInfo.gif b/assets/gif/ChatFormatterHoverPlayerInfo.gif new file mode 100644 index 0000000..6e6d1c0 Binary files /dev/null and b/assets/gif/ChatFormatterHoverPlayerInfo.gif differ