https://github.com/WiIIiam278/HuskChat
A simple & customizable no-frills Minecraft chat system
https://github.com/WiIIiam278/HuskChat
bungeecord chat spigot velocity
Last synced: 4 days ago
JSON representation
A simple & customizable no-frills Minecraft chat system
- Host: GitHub
- URL: https://github.com/WiIIiam278/HuskChat
- Owner: WiIIiam278
- License: apache-2.0
- Archived: true
- Created: 2021-07-01T12:36:45.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-12T13:45:58.000Z (almost 2 years ago)
- Last Synced: 2025-04-07T11:32:46.838Z (over 1 year ago)
- Topics: bungeecord, chat, spigot, velocity
- Language: Java
- Homepage: https://william278.net/project/huskchat
- Size: 1.34 MB
- Stars: 80
- Watchers: 2
- Forks: 38
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Funding: .github/funding.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-minecraft - HuskChat - server chat plugin. (Plugins / Chat Tab Scoreboard and Discord)
README
> 🚨 **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.