Shard

An AI-powered, free and open-source anti-cheat for Minecraft servers.

English · Русский

What Shard is

Shard is an open-source anti-cheat plugin for Minecraft servers.

Important before you install

Shard's AI check uses the official Shard API. Access is arranged in the Discord server.

To connect a server to the API, run /shard connect and authorize it in the Shard panel.

If API access is not available yet, disable the AI check for now.

Requirements

• Java 17 or newer to run the plugin
• JDK 21 or newer if you want to build from source
• A Paper or Folia-based server
• A configured AI inference API if the AI check is enabled

Installation

1. Download the latest release from GitHub Releases.
2. Place the main Shard-<version>.jar in the server plugins/ directory.
3. Start the server once so Shard can generate its configuration files.
4. Run /shard connect and authorize the server in the panel.
5. If needed, configure storage:
   • SQLite is the default
   • MySQL and MariaDB are also supported
6. If WorldGuard is installed, specific regions can be excluded from the AI check.
7. Restart the server or reload the Shard configuration.

Configuration files

• config.yml: AI, database, Redis and cross-server alerts, alerts, duplicate packet handling
• monitor.yml: formatting for /shard monitor and /shard view
• punishments.yml: punishment rules
• messages/messages_en.yml: English messages
• messages/messages_ru.yml: Russian messages

Main commands

Command	Purpose
/shard connect	Link this server to the panel
/shard connect status	Show the panel connection status
/shard disconnect	Unlink this server from the panel
/shard alerts	Toggle violation alerts
/shard suspicious <list|top|flagged>	Review suspicious or previously flagged online players
/shard profile <player>	Open a player's live profile
/shard monitor <player>	Watch AI data for one player in real time
/shard view	Toggle observation mode for nearby players
/shard logs [page]	View recent violations
/shard history <player> [page]	View a player's stored violation history
/shard stats	View server-side anti-cheat stats
/shard dc <start|stop|cancel|status>	Manage labeled data collection sessions
/shard reload	Reload Shard configuration

For the full command list, use /shard help in game.

Building from source

git clone https://github.com/KaelusAI/Shard.git
cd Shard
./gradlew shadowJar

The main plugin jar will be written to:

build/libs/Shard-<version>.jar

Help, bugs, and discussion

• Bug reports: GitHub Issues
• Community / support: Discord

Issue reports should include:

• server version
• Java version
• plugin version
• relevant config values
• logs, stack traces, and steps to reproduce

That makes problems easier to reproduce and fix.

Credits

Shard has its own, independently developed codebase. That said, some parts of its code are adapted from the open-source GrimAC project, and Shard builds on ideas developed by GrimAC, DefineOutside, and other GrimAC contributors - full credit and thanks to them for their work.

License

Shard is distributed under the terms of the GNU General Public License v3.0.