Compatibility
Minecraft: Java Edition
1.21
1.20.4
1.20.1
1.19.2
1.18.2
1.16.5
1.13
1.12.2
Platforms
Fabric
Supported environments
75% of ad revenue goes to creators
Support creators and Modrinth ad-free with Modrinth+Creators
Details
Licensed MIT
Published 2 months ago
Updated last month
QueQiao
✨ A bridge for connecting to the Minecraft server ✨
📖Docs · 📃Chinese · 🐛Submit Suggestion/Bug
Introduction
- A server
plugin/mod
that distributes player events fromMinecraft
server inJson
format viaWebsocket
.- Implemented
events
Player Chat
Player Commands
Player Death
(Velocity
not yet available)Player Join
Player Logout
- Implemented
- Receives
Json
messages viaWebsocket
and forwards them to the game players.- Implemented interfaces
Quick Start
- Install the corresponding
plugin/mod
for the server. - Configure
websocket_server
inconfig.yml
enable: true
# Enablehost: "127.0.0.1"
# WebSocket Server addressport: 8080
# WebSocket Server port
- Start the server and wait for the
Websocket Server
to start. - Use
ApiFox
or other API testing tools, or connect to integration projects.- Configure global
Request Header
{ "x-self-name": "TestServer", // Required // Server name, must match 'server_name' in config.yml "Authorization": "Bearer 123", // Optional // Authorization, must match 'access_token' in config.yml, if 'access_token' in config.yml is empty, this item can be omitted "x-client-origin": "apifox" // Required // Client origin, if the origin is 'minecraft', it indicates that the request is from a Minecraft Websocket Client and will be rejected by the Minecraft server's Websocket Server }
- Configure global
- Start the game and join the server.
Integration
@17TheWord/nonebot-adapter-minecraft
:NoneBot2
adapter, connects to this mod@17TheWord/nonebot-plugin-mcqq
:NoneBot2
plugin, enables chat communication withMinecraft
@CikeyQi/mc-plugin
: Cloud plugin, enables chat communication withMinecraft
Compatibility
@kitUIN/ChatImage
: Display images in theMinecraft
chat window