🌍中文 / English

# QueQiao ✨ Minecraft Server Mod/Plugin for Real-time Player Events & API Broadcast Messaging ✨

📖 Documentation · ⬇️ Modrinth · ⬇️ CurseForge · 🐛 Report Issues

## Introduction - Distributes **player events** from the server in `JSON` format via `WebSocket` - Implemented [`Events`](https://queqiao.apifox.cn/68795505f0): - [`Player Chat`](https://queqiao.apifox.cn/7662378m0) - [`Player Command`](https://queqiao.apifox.cn/7662404m0) - [`Player Death`](https://queqiao.apifox.cn/7662407m0) (Not available for Velocity) - [`Player Join`](https://queqiao.apifox.cn/7662405m0) - [`Player Quit`](https://queqiao.apifox.cn/7662406m0) - [`Player Advancement(Achievement)`](https://queqiao.apifox.cn/7662410m0) - Receives `JSON` messages via `WebSocket` and forwards to in-game players - Implemented APIs: - [`Broadcast`](https://queqiao.apifox.cn/3690114w0) - [`PrivateMessage`](https://queqiao.apifox.cn/3690118w0) - [`Title & SubTitle`](https://queqiao.apifox.cn/3690115w0) - [`ActionBar`](https://queqiao.apifox.cn/3690116w0) - [`Rcon Command`](https://queqiao.apifox.cn/3690119w0) ## Documentation - Visit the [`ApiFox QueQiao`](https://queqiao.apifox.cn/) for detailed documentation > Can't find a suitable Mod/Plugin version? Feel free to submit an [`Issue`](https://github.com/17TheWord/QueQiao/issues/new?template=version_feature.yml) ## Quick Start 1. Install the corresponding server `plugin/mod` 2. Configure `websocket_server` in `config.yml`: - `enable: true` # Enable WebSocket server - `host: "127.0.0.1"` # WebSocket Server address - `port: 8080` # WebSocket Server port 3. Start the server and wait for `WebSocket Server` to initialize 4. Use [`ApiFox`](https://apifox.com/) or other API testing tools, or connect with [Integration](#integration-projects) projects - Configure global `Request Header`: ```json5 { // Required: server name, must match 'server_name' in config.yml "x-self-name": "TestServer", // Optional: auth token, must match 'access_token' in config.yml (omit if empty) "Authorization": "Bearer 123" } ``` 5. Launch the game and join the server 6. Refer to the [`API Documentation`](https://queqiao.apifox.cn/68642911f0) to send messages or listen to player events. ## Integration Projects - [`@17TheWord/nonebot-adapter-minecraft`](https://github.com/17TheWord/nonebot-adapter-minecraft): `NoneBot2` adapter - [`@17TheWord/nonebot-plugin-mcqq`](https://github.com/17TheWord/nonebot-plugin-mcqq): `NoneBot2` plugin - [`@CikeyQi/mc-plugin`](https://github.com/CikeyQi/mc-plugin): `YunZai` plugin - [`@Twiyan0/koishi-plugin-minecraft-sync-msg`](https://github.com/Twiyin0/koishi-plugin-minecraft-sync-msg): `Koishi` plugin - [`@17TheWord/zerobot-plugin-mcqq`](https://github.com/17TheWord/zerobot-plugin-mcqq): `ZeroBot` plugin - [`@kterna/astrbot_plugin_mcqq`](https://github.com/kterna/astrbot_plugin_mcqq): `AstrBot` plugin - [`@KroMiose/nekro-agent`](https://github.com/KroMiose/nekro-agent): `AI` agent ## Related Projects - [`@kterna/queqiao_mcdr`](https://github.com/kterna/queqiao_mcdr): `MCDR` implementation of `QueQiao` for message exchange ## Compatibility - [`@kitUIN/ChatImage`](https://github.com/kitUIN/ChatImage): Displays images in Minecraft chat ## Community - [`Discord`](https://discord.gg/SBUkMYsyf2) ## Special Thanks - [`@kitUIN`](https://github.com/kitUIN): For code assistance and build tools - [`@kitUIN/ModMultiVersion`](https://github.com/kitUIN/ModMultiVersion): IDEA multi-version MOD plugin - [`@kitUIN/ModMultiVersionTool`](https://github.com/kitUIN/ModMultiVersionTool): Multi-version MOD build tool ## Support & Contribution - Star this project if you find it useful or support me on [`Afdian`](https://afdian.com/a/17TheWord) - Submit suggestions/bugs via [`Issues`](https://github.com/17TheWord/QueQiao/issues) - Contribute via [`Pull requests`](https://github.com/17TheWord/QueQiao/pulls) ## License This project is licensed under the [`MIT`](https://github.com/17TheWord/QueQiao/blob/main/LICENSE) license.