Links
Tags
Creators
Details
Licensed MIT
Published last month
Updated 2 months ago
All versions
1.0.0
Release
WebChatAPI 1.0.03 months ago 10
Compatibility
Minecraft: Java Edition
26.2
26.1.x
1.21.x
Platforms
Paper
Purpur
Spigot
Changes
WebChatAPI 1.0.0
Initial release of WebChatAPI.
Features
- Expose Minecraft server chat through a HTTP JSON API
- Real-time chat updates using long polling
- Chat history support
- Online player list API
- Read-only mode enabled by default
- Optional web-to-Minecraft messaging
- Secret token authentication for web-to-game messages
- Configurable CORS
- Configurable chat history size
- Configurable message length
- Lightweight Paper plugin
- Designed for custom website integration
API Endpoints
GET /api/messages- Retrieve chat historyGET /api/poll- Receive new messages in real timeGET /api/players- Get online playersPOST /api/send- Send messages from web to Minecraft
Requirements
- Paper 1.21+
- Java 17+
Security
Web-to-Minecraft messaging is disabled by default. Enable it only when needed and keep the secret token on your backend.
Projects on Modrinth are automatically available through a Maven repository for use with JVM build tools such as Gradle. To learn more about the Modrinth Maven API, click here.
Note: When available, you should use the creator's maven repo instead as it will have transitive dependency information that the Modrinth Maven API does not. You may also end up with duplicate dependencies if you use a mix of Modrinth and non-Modrinth Maven repositories for your dependencies, because the group identifier will be different when served through the Modrinth Maven API.
Maven coordinates:
Version ID:
build.gradle:
repositories {
exclusiveContent {
forRepository {
maven {
name = "Modrinth"
url = "https://api.modrinth.com/maven"
}
}
// forRepositories(fg.repository) // Uncomment when using ForgeGradle
filter {
includeGroup "maven.modrinth"
}
}
}
// Standard Gradle dependency
dependencies {
implementation "maven.modrinth:Vs2R1iMr:pZwqIKXC"
}
// Legacy Loom dependency
dependencies {
modImplementation "maven.modrinth:Vs2R1iMr:pZwqIKXC"
}

