ChatClear

A small Paper plugin by FMFL Devteam. Uses Adventure/MiniMessage; no legacy chat APIs.

License

Licensed under the MIT License. Copyright (c) 2026 FMFL Devteam.

Build and install

• Supported target: Paper 26.2, Java 25 or newer. API pinned to official stable build 129 (Paper Fill metadata); 26.3 was still beta when selected.
• Run ./gradlew build (Windows: gradlew.bat build). Gradle 9.8 supports the installed Java 27; the configured Java 25 toolchain is automatically provisioned by Foojay if missing. Initial build needs internet access.
• Copy build/libs/ChatClear-1.0.0.jar to the server's plugins/ directory and restart. Configuration is generated at plugins/ChatClear/config.yml.
• Unit tests: ./gradlew test; report: build/reports/tests/test/index.html.

Continuous integration

GitHub Actions (.github/workflows/build.yml) runs on branch pushes, pull requests, and tag pushes using Java 25 and Gradle dependency caching.

• build: runs build, including unit tests, Spotless, and Checkstyle. Uploads test/lint reports even on failure and the plugin JAR on success. Workflow artifacts are retained for seven days.
• release: after a successful tagged build, publishes a GitHub Release with generated release notes and the downloadable JAR under Assets. Release downloads do not expire after seven days. Only this job has repository write permission; authentication uses GitHub's built-in token, with no custom secret required.
• Release tags must use a version such as v1.0.0 or 1.0.0. The optional v prefix is removed for the JAR filename and plugin metadata. Tags with a prerelease suffix, such as v1.1.0-beta.1, create a prerelease. Rerunning a tag workflow replaces its existing JAR asset.

To publish a release, tag the desired commit and explicitly push the tag:

git tag v1.0.0
git push origin v1.0.0

Local builds default to version 1.0.0; override it with ./gradlew build -PreleaseVersion=1.1.0.

Code formatting

Java sources and tests use Spotless with a pinned Google Java Format version using AOSP style for consistent formatting (four-space indentation, no tabs), import cleanup, and whitespace normalization.

• Apply formatting: ./gradlew spotlessApply.
• Check formatting without changing files: ./gradlew spotlessCheck.
• ./gradlew check and ./gradlew build include formatting checks and fail on unformatted code; they do not automatically rewrite files.
• On Windows, use gradlew.bat instead of ./gradlew. Formatter dependencies are downloaded on first use.

Run spotlessApply before submitting changes. IDE formatting is optional; the Gradle formatter is the source of truth.

Checkstyle additionally requires curly braces for every if, else, for, while, and do body, including single-line statements and empty loops. Standard else if chains are allowed. This rule applies to main sources and tests and is configured in config/checkstyle/checkstyle.xml.

• Check braces: ./gradlew checkstyleMain checkstyleTest.
• check and build enforce both Spotless formatting and Checkstyle rules.
• Add missing braces manually; spotlessApply only formats code and does not insert them.
• Checkstyle HTML reports: build/reports/checkstyle/main.html and build/reports/checkstyle/test.html.

Commands and permissions

Aliases: /cc, /clearchat. All permissions default to op, with no implicit permission inheritance.

Command	Permission	Behavior
/chatclear	fmfl.chatclear.use	Clear online players' chat; announce to cleared players
/chatclear self	fmfl.chatclear.self	Online players only; clear own chat, regardless of bypass
/chatclear silent	fmfl.chatclear.use and fmfl.chatclear.silent	Global clear without a public announcement
/chatclear reload	fmfl.chatclear.reload	Reload configuration atomically

fmfl.chatclear.bypass excludes players from global clears and announcements when bypass-enabled is true. Since this defaults to op, operators are exempt by default. Set bypass-enabled: false to include everyone. Console can run global, silent and reload commands, and receives private success/error feedback. Every successful clear reports the number of eligible players, including zero. Completion is permission-filtered; console is never offered self.

Configuration

• clear-lines: integer 1–1000, default 100.
• bypass-enabled: boolean, default true.
• Every message, including usage, permission errors, console feedback and reload failures, is under messages in the bundled configuration. MiniMessage formatting is supported. <player> is the command sender's name, inserted as literal text (never parsed as markup); <count> is the number of cleared players. Empty messages suppress visible text. Keep MiniMessage tags properly closed.
• Missing/invalid values produce server-log warnings and use bundled defaults. Invalid message markup falls back individually. Malformed YAML or unreadable files cause reload to fail, preserve the entire previous configuration, and send the configured reload-failure message. On initial malformed configuration, bundled defaults remain active.

Clearing sends empty chat components on the server thread; it pushes messages out of the visible chat area, not out of client history/logs. Client mods or larger scrollback settings may retain older messages. This plugin targets Paper, not Folia.