> 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/configuration.md).

# Configuration

## Configuration Guide

All general settings, chat channels, anti-spam protections, and automated tasks are configured in `plugins/CoreChat/config.yml`.

***

#### Full `config.yml` Reference

```yaml
# ==============================================================
#                      CoreChat Configuration
#                Developed by UnCut Labs (DiegoteUnCut)
# ==============================================================

# Default plugin language file
locale: "en_US"

# --------------------------------------------------------------
# Chat Formatting & Ranks (Supports MiniMessage & LuckPerms)
# --------------------------------------------------------------
chat-format:
  default-format: "<gray>{player}:</gray> <white>{message}</white>"
  # Custom format based on LuckPerms primary group or permission
  group-formats:
    admin: "<dark_red>[Admin]</dark_red> <red>{player}</red><dark_gray>:</dark_gray> <white>{message}</white>"
    vip: "<gold>[VIP]</gold> <yellow>{player}</yellow><dark_gray>:</dark_gray> <white>{message}</white>"

# --------------------------------------------------------------
# Chat Channels (Local, Global, Staff)
# --------------------------------------------------------------
channels:
  local:
    enabled: true
    radius: 100.0
    format: "<gray>[Local]</gray> {player}: <white>{message}</white>"
    no-players-nearby-message: "<red>Nobody nearby can hear you.</red>"
  global:
    enabled: true
    symbol: "!"
    format: "<gold>[Global]</gold> {player}: <white>{message}</white>"
  staff:
    enabled: true
    symbol: "#"
    permission: "corechat.channel.staff"
    format: "<dark_aqua>[Staff]</dark_aqua> <aqua>{player}: {message}</aqua>"

# --------------------------------------------------------------
# Moderation & Anti-Spam
# --------------------------------------------------------------
anti-spam:
  cooldown:
    enabled: true
    delay-seconds: 2.0
    message: "<red>Please wait {time}s before sending another message.</red>"
  repetitive-filter:
    enabled: true
    repetitive-time-seconds: 15
    similarity-percentage: 80
    message: "<red>Do not repeat similar messages!</red>"
  anti-caps:
    enabled: true
    min-length: 6
    max-caps-percentage: 60
  anti-link:
    enabled: true
    whitelist:
      - "discord.gg"
      - "youtube.com"
    blocked-message: "<red>Posting external links is not allowed.</red>"

# --------------------------------------------------------------
# Interactive Chat Tags
# --------------------------------------------------------------
interactive-tags:
  item:
    enabled: true
    empty-hand-message: "<red>You are not holding any item.</red>"
  pos:
    enabled: true
    format: "<gray>[<yellow>{world}</yellow> {x}, {y}, {z}]</gray>"
  ping:
    enabled: true
    format: "<gray>[Ping: {color}{ping}ms<gray>]</gray>"

# --------------------------------------------------------------
# Automated Announcements (Centered & MiniMessage)
# --------------------------------------------------------------
auto-broadcast:
  enabled: true
  interval-seconds: 180
  centered: true
  sound:
    enabled: true
    name: "BLOCK_NOTE_BLOCK_PLING"
    volume: 1.0
    pitch: 1.5
  messages:
    - - "<gradient:#00D2FF:#3A7BD5>========================================</gradient>"
      - "<yellow>Need help or have questions?</yellow>"
      - "<click:open_url:'[https://discord.gg/yourserver](https://discord.gg/yourserver)'><underlined><aqua>Click here to join our Discord!</aqua></underlined></click>"
      - "<gradient:#00D2FF:#3A7BD5>========================================</gradient>"

# --------------------------------------------------------------
# Join & Quit Events
# --------------------------------------------------------------
join-quit:
  join-message: "<green>+ <white>{player} joined the game.</green>"
  quit-message: "<red>- <white>{player} left the game.</red>"
  fireworks:
    enabled: true
    first-join-only: false
    power: 1
```

#### Reloading Changes

To apply configuration changes without restarting the server:

```bash
/corechat reload
```

*(Requires permission `corechat.reload`)*


---

# 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/configuration.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.