> For the complete documentation index, see [llms.txt](https://corelab.gitbook.io/corelab-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://corelab.gitbook.io/corelab-docs/overview.md).

# Overview

## Welcome to CoreChat

CoreChat is a lightweight, modular, and high-performance chat management plugin designed for modern Minecraft servers. It provides complete control over server communication through localized channels, anti-spam mechanisms, interactive hover and click tags, MiniMessage broadcast support, and flexible formatting.

#### Key Features

* **Multi-Channel Chat:** Dedicated channels for Local, Global, and Staff chat.
* **Interactive Chat Tags:** Built-in `[item]`, `[pos]`, and `[ping]` keywords with tooltips and click events.
* **Modern Formatting:** Native MiniMessage and Adventure formatting support for hex colors and gradients.
* **Automated Announcements:** Pixel-perfect centered auto-broadcasts with custom sound notifications.
* **Chat Moderation:** Cooldown timers, repetitive message filters, link blockers, caps filtering, and granular mute commands.

***

#### Requirements

* **Java Version:** Java 17 or higher.
* **Server Software:** Paper, Purpur, or Spigot (Paper recommended for async chat performance).
* **Supported Versions:** Minecraft 1.20 through modern releases.
* **Optional Dependencies:**
  * **LuckPerms:** Required for rank-based prefixes, suffixes, and group chat formatting.
  * **PlaceholderAPI:** Required for third-party placeholders inside chat messages and broadcasts.

***

#### Installation

1. Download the latest `CoreChat.jar` file from SpigotMC or Modrinth.
2. Place the jar file inside your server's `plugins/` directory.
3. Start or restart your server completely (do not use `/reload`).
4. Set up the required permission nodes for your staff and players using your permissions manager.
5. Open `plugins/CoreChat/config.yml` to adjust settings, chat channels, and messages.
6. Run `/corechat reload` in-game or via console to apply your configuration changes without restarting.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://corelab.gitbook.io/corelab-docs/overview.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
