https://github.com/elaina-moe/chatcolors
A lightweight Minecraft plugin that allows players to use color codes (&) in chat messages. Supports configurable colors and multi-language messages.
https://github.com/elaina-moe/chatcolors
chat minecraft minecraft-plugin paper spigot spigot-plugins
Last synced: about 1 month ago
JSON representation
A lightweight Minecraft plugin that allows players to use color codes (&) in chat messages. Supports configurable colors and multi-language messages.
- Host: GitHub
- URL: https://github.com/elaina-moe/chatcolors
- Owner: Elaina-Moe
- License: mit
- Created: 2025-08-05T07:35:59.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-12-19T19:34:05.000Z (6 months ago)
- Last Synced: 2025-12-22T08:38:54.302Z (6 months ago)
- Topics: chat, minecraft, minecraft-plugin, paper, spigot, spigot-plugins
- Language: Java
- Homepage:
- Size: 23.4 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ChatColors
[中文版本（简体）](./README_zh.md)
ChatColors is a lightweight Minecraft plugin that allows players to use color codes (e.g., `&a`, `&b`) in chat messages and set a default color. It supports enabling/disabling features, reloading configs, and multilingual support.
---
## 📦 Features
- Chat supports color codes (e.g., `&aHello`)
- Set a default chat color
- Enable/disable color via config
- Multi-language support (English / Simplified Chinese)
- Hot-reload config and language files
---
## 🛠 Supported Versions
- Minecraft versions: 1.18 ~ 1.21+
- Spigot API versions: 1.18 ~ 1.21+
- Java versions: Java 17 or higher
---
## ⚙️ Configuration (`config.yml`)
```yaml
enable-color: true
default-color: "&f"
language: "zh"
```
- `enable-color`: Enable or disable colored chat
- `default-color`: Default color code for chat
- `language`: Language file to use (`zh` or `en`), default is `zh`
---
## 🌐 Language Files
```
resources/
├── messages_zh.yml # Simplified Chinese
└── messages_en.yml # English
```
---
## 🧪 Commands
| Command | Description | Permission |
|---------------------------|--------------------------------|------------------|
| `/chatcolor reload` | Reload config and lang files | `chatcolor.admin` |
| `/chatcolor set ` | Set default chat color | `chatcolor.use` |
| `/chatcolor gui` | Open color picker GUI | `chatcolor.use` |
---
## 🔐 Permissions
```yaml
chatcolor.use:
description: Allows use of chatcolor commands
default: true
chatcolor.admin:
description: Allows admin to use the reload command to reload configuration.
default: op
```
Note: runtime defaults are defined by `plugin.yml` and bundled `config.yml`.
---
## 📁 Project Structure
Project Structure (click to expand)
```
ChatColor/
├── LICENSE
├── README.md
├── README_zh.md
├── pom.xml
└── src/
└── main/
├── java/
│ └── com/
│ └── zFlqw/
│ └── chatcolors/
│ ├── ChatColors.java
│ └── Messages.java
└── resources/
├── plugin.yml
├── config.yml
├── messages_en.yml
└── messages_zh.yml
```
---
## 🏗️ How to Build
1. Install Java 17 and Maven
2. Open terminal and navigate to the project directory
3. Run:
```bash
mvn clean package
```
The final plugin `.jar` will be located at:
```
target/ChatColors-version.jar
```
Copy it into your server's `plugins/` folder to use.
---