MineChat

MineChat Server

MineChat lets players chat on a Minecraft server without needing to join the server from Minecraft.

This plugin provides the server-side component of the MineChat platform, connecting in-game chat with external MineChat clients.

> Note: This project is currently being updated to follow the official MineChat protocol specification, which improves safety and convenience. > > The current version still works with older clients but will receive breaking changes in the future.

Features

* Automatic cleanup: MineChat clients authenticate once using a temporary link code. * Automatic cleanup: Messages sent in Minecraft chat are broadcast to connected MineChat clients and vice versa. * Automatic cleanup: Link codes and client information are saved on disk, persisting across server restarts. * Automatic cleanup: Expired link codes are removed automatically every minute.

How to Use

Linking your account

1. Generate a link code in-game: `/link` You will receive a temporary code valid for 5 minutes.

2. Authenticate from the CLI client (a GUI client is in the works):

```bash minechat-client --server <host:port> --link <code> ```

This links your MineChat client to your Minecraft account without using Minecraft credentials.

Advanced: How it Works

* Persistent storage: Listens for connections from MineChat clients on port `25575` by default. * Persistent storage: Validates clients using link codes or stored UUIDs and broadcasts join/leave messages. * Persistent storage: Sends in-game chat to connected clients and relays client messages to Minecraft chat. * Persistent storage: Stores client data in JSON files under `plugins/MineChat/` (`link_codes.json` and `clients.json`).

Contributing

Contributions are welcome! Please submit issues or pull requests.