Skip to content

Brikster/Chatty

Repository files navigation

Chatty

Chatty (Bukkit plugin)

GitHub release (latest by date) GitHub All Releases GitHub code size in bytes JitPack Codacy Badge

Chatty v3 is a ground-up rewrite built on Kyori's Adventure library. It is approaching its first stable release (3.0.0); this branch holds its code.

  • Stable builds — the Releases page (once 3.0.0 is tagged).
  • Development builds — the latest artifact from the "Actions" tab (see the "Artifacts" section).

Chatty v2.* is deprecated and no longer maintained. Upgrading from v2? See MIGRATION.md — v3 migrates your old config automatically.

Chatty is the modern chat management system for Bukkit-compatible servers. It's based on-top of Kyori's Adventure library, that makes it so powerful and stable.

Key features:

  • Chat channels ("local" and "global" by default)
  • Private messaging
  • Moderation (CAPS, advertisements, swears)
  • Notifications (chat, action bar and title)
  • "Vanilla" messages configuring (join/quit/death)
  • MiniMessage both legacy (&) styling format

Building

Chatty uses Gradle to handle dependencies & building. You need JDK 11 or higher to compile Chatty.

Compiling from source

git clone https://github.com/Brikster/Chatty.git
cd Chatty/
./gradlew build

Output jar will be placed into /build/libs directory.

Testing

Run the unit tests:

./gradlew test

Run the end-to-end smoke test — it boots a real Paper server with the built plugin and verifies that it enables cleanly on a fresh install and correctly migrates a legacy v2 configuration:

./gradlew build
JAVA_HOME=/path/to/jdk-21 bash scripts/smoke-test.sh

Both run automatically on every push via GitHub Actions.