> 🚨 **HuskChat has been discontinued** 🚨 and is no longer actively maintained. It may cease to function with newer versions of Spigot/Paper/Velocity/Waterfall. We no longer provide support for it. Thank you for your understanding.

Spigot — Setup — Docs — Issues

**HuskChat** is a no-frills, simple and customisable chat system for Minecraft networks. It supports both running on BungeeCord and Velocity frontend servers for cross-server chat, or on a single-server Spigot setup. It's designed to be easy to configure with an elegant out-of-box setup, while also being highly configurable, suiting a variety of use cases by allowing you to define channels and manage who can send and receive messages within them. ## Features **⭐ Works great out of the box** — Install on your Spigot server or Velocity/BungeeCord-based proxy and use right away **⭐ Placeholder support** — Hooks with LuckPerms to display user roles, PAPI support via [PAPIProxyBridge](https://william278.net/docs/huskchat/formatting) **⭐ Private messaging** — Private messages—including group DMs&mdash and replying, admin spy features **⭐ Fine-tune channels** — Set send/receive permissions for channels, send messages to a discord webhook, filter [& more](https://william278.net/docs/huskchat/channels)! **⭐ Quick and easy to use** — Super simple set of [commands](https://william278.net/docs/huskchat/commands). Define channel shortcut commands, too! **⭐ Advanced profanity checking** — Machine learning powered profanity filter **⭐ Filters & replacers** — Customisable spam limiting filter, anti-advertising & special emoji **⭐ Modern formatting** — Utilise modern formatting, with RGB and Gradient support via [MineDown](https://github.com/Phoenix616/MineDown) ## Building To build HuskChat, you'll need python (>=`v3.6`) with associated packages installed; `jep` and `alt-profanity-check`. You can install these with `pip install jep` and `pip install alt-profanity-check`. These are needed to run the profanity filter tests. Then, simply run the following in the root of the repository: ``` ./gradlew clean build ``` ## License HuskChat is licensed under the Apache 2.0 license. - [License](https://github.com/WiIIiam278/HuskChat/blob/master/LICENSE) ## Translations Translations of the plugin locales are welcome to help make the plugin more accessible. Please submit a pull request with your translations as a `.yml` file. - [Locales Directory](https://github.com/WiIIiam278/HuskChat/tree/master/common/src/main/resources/locales) - [English Locales](https://github.com/WiIIiam278/HuskChat/tree/master/common/src/main/resources/locales/en-gb.yml) ## Links - [Docs](https://william278.net/docs/huskchat/) — Read the plugin documentation! - [Spigot](https://www.spigotmc.org/resources/huskchat.94496/) — View the Spigot resource page (Also: [Polymart](https://polymart.org/resource/huskchat.1217), [Modrinth](https://modrinth.com/plugin/huskchat)) - [Issues](https://github.com/WiIIiam278/HuskChat/issues) — File a bug report or feature request - [Discord](https://discord.gg/tVYhJfyDWG) — Get help, ask questions - [bStats](https://bstats.org/plugin/bungeecord/HuskChat/11882) — View plugin metrics (Also: [Velocity](https://bstats.org/plugin/velocity/HuskChat%20-%20Velocity/14187)) --- © [William278](https://william278.net/), 2024. Licensed under the Apache-2.0 License.

_Footer