jhqwqmc / huskchat Goto Github PK

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.

⭐ 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

⭐ 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!

⭐ Quick and easy to use — Super simple set of 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

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

HuskChat is licensed under the Apache 2.0 license.

• License

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
• English Locales

• Docs — Read the plugin documentation!
• Spigot — View the Spigot resource page (Also: Polymart, Modrinth)
• Issues — File a bug report or feature request
• Discord — Get help, ask questions
• bStats — View plugin metrics (Also: Velocity)

© William278, 2024. Licensed under the Apache-2.0 License.