# Minechat<\/p>\n
Minechat brings modern, real\u2011time chat to your Minecraft server with a Minecraft\u2011themed web interface, REST API, and WebSocket gateway. Players can chat from the browser or in\u2011game, send offline DMs, manage friends and groups, and see ranks and online status\u2014everything stays in sync.<\/p>\n
## Note
\n – You can get the web interface from the minechat repository inside the \/web folder
\n – https:\/\/github.com\/HarshitKumar9030\/minechat\/web
\n## Features<\/p>\n
– Real\u2011time chat
\n – WebSocket live updates between web and in\u2011game
\n – Group chat with announcements and basic moderation
\n – Offline\u2011friendly DMs (web\u2194web and web\u2194MC; messages persist)
\n– Friends and groups
\n – Friend list, requests, and removal
\n – Create\/join\/leave groups, invite flow with membership checks
\n – Group roles (owner\/admin\/member) and member counts
\n– Ranks and presence
\n – Renders Minecraft “\u00a7” color\/style codes on web
\n – Online\/offline indicators and member lists
\n– Web API + WebSocket
\n – REST for authentication, lists, history
\n – WebSocket for live events and sending messages
\n – CORS enabled for development
\n– Production\u2011ready
\n – Error handling, session tokens, rate limiting basics
\n – Nginx reverse proxy examples and HTTPS guidance
\n – Works great alongside Vault\/LuckPerms\/PowerRanks (optional for rank data)<\/p>\n
## Quick Start<\/p>\n
1) Install
\n– Drop the plugin jar into your server\u2019s plugins folder.
\n– Start the server once to generate configs.<\/p>\n
2) Configure
\n– In `config.yml`:
\n“`yaml
\nweb:
\n enable-api: true
\n port: 8080 # HTTP REST API
\n websocket-port: 8081 # WebSocket (real-time)
\n“`<\/p>\n
3) Enable web access 4) Connect from the web ## Web API (highlights)<\/p>\n – POST `\/api\/auth` \u2014 authenticate with username + web password Example login request: ## WebSocket (highlights)<\/p>\n – Connect: `ws:\/\/localhost:8081\/ws` ## Commands (selection)<\/p>\n – Web access Note: Admin\/owner actions and settings are enforced server\u2011side.<\/p>\n ## Compatibility<\/p>\n – Server: Paper\/Spigot\/Purpur (Paper recommended) ## Security Notes<\/p>\n – Players control web access via an in\u2011game password. ## Links<\/p>\n – Source: https:\/\/github.com\/HarshitKumar9030\/minechat Minecraft chat plugin with ranks, friends, groups, MongoDB logging, and a real-time web interface (REST + WebSocket).<\/p>\n","protected":false},"featured_media":101532,"template":"","meta":{"_minecraft_slug":"minechatt","_minecraft_project_id":"qEayxfO8","_minecraft_author":"HarshitKumar9030","_minecraft_license":"MIT","_minecraft_downloads":63,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"minechatt.zip","_minecraft_size_bytes":5643867,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-15T20:43:07.380032Z","_minecraft_date_created":"2025-08-25T04:52:24.039446Z","_minecraft_date_modified":"2025-08-11T06:06:57.932268Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/minechatt","_minecraft_icon_attachment_id":101532,"_minecraft_imported_at":"2026-06-05T20:03:48+00:00","_minecraft_import_hash":"9619e59c9e72851ef77470452951c764","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,126,127,128,867,123,92],"mod_loader":[130,132,133],"minecraft_version":[81],"class_list":["post-101531","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-management","mod_category-paper","mod_category-purpur","mod_category-social","mod_category-technology","mod_category-utility","mod_loader-bukkit","mod_loader-paper","mod_loader-purpur","minecraft_version-1-21-8"],"yoast_head":"\n
\n– In-game, each player runs:
\n“`
\n\/friend webaccess enable
\n– REST API: http:\/\/localhost:8080\/api\/
\n– WebSocket: ws:\/\/localhost:8081\/ws<\/p>\n
\n– GET `\/api\/friends?playerUUID={uuid}`
\n– GET `\/api\/groups?playerUUID={uuid}`
\n– GET `\/api\/messages?groupId={uuid}&limit=50`
\n– GET `\/api\/users`, GET `\/api\/ranks`
\n– Group invites: GET `\/api\/group-invites`, POST accept\/reject<\/p>\n
\n“`json
\nPOST \/api\/auth
\n{ “username”: “Player”, “password”: “web_password” }
\n“`<\/p>\n
\n– Authenticate:
\n“`json
\n{ “type”: “auth”, “data”: { “username”: “Player”, “password”: “web_password” } }
\n“`
\n– Send:
\n – Friend: `type: “friend_message”`
\n – Group: `type: “group_message”`
\n– Receive:
\n – `friend_message`, `group_message`, `message_sent`, `error`, etc.<\/p>\n
\n – `\/friend webaccess enable
\n – `\/friend webaccess disable`
\n– Groups (examples)
\n – `\/group create
\n – `\/group join
\n – `\/group leave
\n – `\/group invite
\n – `\/group accept
\n – `\/group chat
\n– Java: 17+
\n– MC versions: 1.20.x\u20131.21.x (adjust as needed for your environment)
\n– Optional: Vault\/LuckPerms\/PowerRanks for richer rank display<\/p>\n
\n– Session tokens and basic rate limiting included.
\n– Supports reverse proxy + HTTPS (see Nginx examples).
\n– Input is sanitized on the web UI; still validate on integrations.<\/p>\n
\n– Issues: https:\/\/github.com\/HarshitKumar9030\/minechat\/issues
\n– License: MIT<\/p>\n","protected":false},"excerpt":{"rendered":"