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

# Information

## :exclamation:Introduction

**SDChat** is a powerful Minecraft chat plugin that offers advanced chat customization, including interactive messages, chat games, and item hovers. It’s perfect for servers that want to provide a unique and engaging chat experience for their players.

## :star: Features

* ***You are in control! - Enable or Disable any feature of this plugin.***
* :wrench: **Interactive Chat Messages**: Add clickable and hoverable text in chat.
* :link: **Item/Inventory Linking**: Show off your inventory, enderchest, or items in chat!
* :video\_game: **Chat Games**: Keep your players entertained with various chat mini-games.
* :rotating\_light: **Advanced Moderation Tools**: Mute, clear, slow, and filter chat with ease.
* :rainbow: **Custom Chat Formatting**: Personalize the look and feel of your server chat.
* :bar\_chart: **Message Logging**: Keep records of all chat messages for review.
* :skull: **Custom Death Messages**: Edit and change all death messages to your liking.
* :bangbang: **Timed Announcements**: Create infinite announcement messages on a timer.
* :tools: **Staff Chat**: Take advantage of our fully customizable in-game staff chat!
* :grey\_exclamation: **Player Mentioning alerts**: Get notified if a player mentions your name!
* :closed\_lock\_with\_key: **Command & Word Blocker**: Block specific commands and words!
* :robot: **Anti-Spam & Anti-Bot:** Protect your chat with our anti-bot features!

## :inbox\_tray: Installation

### Prerequisites

* Minecraft server running Spigot version 1.21 or higher.
* LuckPerms must be installed
* PlaceholderAPI must be installed

### Steps

1. **Download the SDChat Plugin jar** from [BuiltByBit](https://builtbybit.com/resources/sdchat.50923/).
2. **Place the jar file** into your server's 'plugins' directory.
3. **Restart your server** to load the plugin.

## :man\_technologist: Configuration

After installation, you can customize SDChat through the `config.yml` file located in the `plugins/SDChat` directory.

### Key Configuration Options

* 'Chat-Format' : Customize the format of chat messages.
* 'Use-Logging' : 'true' or 'false' - Whether the plugin will log chat messages and DM's to a file.

For a full list of configuration options, visit the [Configuration](/sdchat/configuration.md) section.

## :wrench: Commands & Permissions

### Commands

<table data-full-width="false"><thead><tr><th width="176">Command</th><th width="348">Description</th><th width="209">Usage</th></tr></thead><tbody><tr><td>/sdchat</td><td>General Command</td><td>/sdchat</td></tr><tr><td>/mutechat</td><td>Mute or Unmute public chat</td><td>/mutechat</td></tr><tr><td>/clearchat</td><td>Clears the in-game chat</td><td>/clearchat</td></tr><tr><td>/slowchat</td><td><p>Limits how often players can talk in chat </p><p>(in seconds)</p></td><td>/slowchat &#x3C;seconds></td></tr><tr><td>/message<br>/msg</td><td>Private message other players</td><td>/message &#x3C;player> &#x3C;text></td></tr><tr><td>/reply<br>/r</td><td>Easily respond to a private message</td><td>/reply &#x3C;text></td></tr><tr><td>/nickname<br>/nick</td><td>Change your name in chat (Nickname)</td><td>/nick &#x3C;nickname><br>/nick reset</td></tr><tr><td>/block</td><td>Block a player from showing up in chat &#x26; messaging you (run again to unblock)</td><td>/block &#x3C;player></td></tr><tr><td>/staffchat</td><td>Chat privately amongst all online staff</td><td>/staffchat &#x3C;message><br>/staffchat - toggle</td></tr><tr><td>/messagespy<br>/spy</td><td>Spy on all private messages</td><td>/messagespy</td></tr><tr><td>/helpop</td><td>Send a message to all online staff members</td><td>/helpop &#x3C;message></td></tr><tr><td>/report</td><td>Send a report to all online staff members</td><td>/report &#x3C;message></td></tr><tr><td>/viewreports</td><td>View all past reports</td><td>/viewreports</td></tr><tr><td>/trash</td><td>Open a virtual trash bin to dispose of items</td><td>/trash</td></tr><tr><td>/playertime<br>/ptime</td><td>Change your individual time</td><td>/ptime &#x3C;ticks></td></tr><tr><td>/time</td><td>Change server-wide time</td><td>/time &#x3C;ticks></td></tr><tr><td>/playerweather<br>/pweather</td><td>Change your individual weather</td><td>/pweather &#x3C;clear/downfall></td></tr><tr><td>/weather</td><td>Change server-wide weather</td><td>/weather &#x3C;clear/downfall></td></tr><tr><td>/chatgames<br><br>/chatgames start</td><td>Shows if there is an active game or not<br><br>Starts a chatgame</td><td>/chatgames<br><br>/chatgames start</td></tr><tr><td>/broadcast</td><td>Sends an alert to all online players</td><td>/broadcast &#x3C;message></td></tr></tbody></table>

### Permissions

<table><thead><tr><th width="406">Permission</th><th>Description</th></tr></thead><tbody><tr><td>"sdchat.mutechat"</td><td>Allows muting / unmuting of public chat</td></tr><tr><td>"sdchat.mutechat.bypass"</td><td>Allows a player to bypass muted chat.</td></tr><tr><td>"sdchat.mutechat.notify"</td><td>Sends an alert when chat is muted / unmuted.</td></tr><tr><td>"sdchat.clearchat"</td><td>Allows a player to clear the chat for all players.</td></tr><tr><td>"sdchat.slowchat"</td><td>Allows a player to slow down chat by setting a delay between messages.</td></tr><tr><td>"sdchat.slowchat.bypass"</td><td>Allows a player to bypass the chat slow mode.</td></tr><tr><td>"sdchat.slowchat.notify"</td><td>Sends an alert when chat is slowed.</td></tr><tr><td>"sdchat.filter.bypass"</td><td>Allows a player to bypass chat filters, including duplicate messages, advertising, and anti-caps.</td></tr><tr><td>"sdchat.blocker.bypass"</td><td>Allows a player to bypass command blockers.</td></tr><tr><td>"sdchat.staffchat"</td><td>Allows staff to talk privately</td></tr><tr><td>"sdchat.message"</td><td>Allows a player to use private messaging commands such as <code>/msg</code> and <code>/r</code>.</td></tr><tr><td>"sdchat.message.toggle"</td><td>Allows a player to toggle receiving private messages. <code>/r</code> bypasses this toggle.</td></tr><tr><td>"sdchat.chat.color"</td><td>Allows a player to use color codes in chat.</td></tr><tr><td>"sdchat.nickname"</td><td>Allows a player to set or change their nickname.</td></tr><tr><td>"sdchat.nickname.color"</td><td>Allows a player to use color codes in their nickname.</td></tr><tr><td>"sdchat.block"</td><td>Allows a player to block messages from a specific player.</td></tr><tr><td>"sdchat.block.bypass"</td><td>Allows a player to bypass being blocked by others.</td></tr><tr><td>"sdchat.message.spy"</td><td>Allows a player to spy on private messages.</td></tr><tr><td>"sdchat.helpop"</td><td>Allows a player to send help messages to staff using <code>/helpop</code>.</td></tr><tr><td>"sdchat.helpop.receive"</td><td>Allows staff to receive helpop messages.</td></tr><tr><td>"sdchat.report"</td><td>Allows a player to send report messages to staff using <code>/report</code>.</td></tr><tr><td>"sdchat.report.receive"</td><td>Allows staff to receive report messages.</td></tr><tr><td>"sdchat.viewreports"</td><td>Allows staff to view all submitted reports</td></tr><tr><td>"sdchat.trash"</td><td>Allows a player to use the trash command to discard items.</td></tr><tr><td>"sdchat.ptime"</td><td>Allows a player to set their personal time using the <code>/ptime</code> command.</td></tr><tr><td>"sdchat.time"</td><td>Allows a player to change server-wide time using the <code>/time</code> command.</td></tr><tr><td>"sdchat.pweather"</td><td>Allows a player to set their personal weather using the <code>/pweather</code> command.</td></tr><tr><td>"sdchat.weather"</td><td>Allows a player to change server-wide weather using the <code>/weather</code> command.</td></tr><tr><td>"sdchat.chatgames.admin"</td><td>Allows access to chat game administration commands, such as starting games with <code>/chatgames start</code>.</td></tr><tr><td>"sdchat.broadcast"</td><td>Allows a player to use the broadcast command to send server-wide messages.</td></tr></tbody></table>