QueQiao

<div align="right"> 🌍<a href="https://github.com/17TheWord/QueQiao/blob/main/README.md">中文</a> / English </div> <p align="center"> <img src="https://raw.githubusercontent.com/17TheWord/nonebot-adapter-minecraft/main/assets/logo.png" width="200" height="200" alt="QueQiao Logo"> </p> <div align="center"> # QueQiao ✨ Minecraft Server Mod/Plugin for Real-time Player Events & API Broadcast Messaging ✨ </div> <p align="center"> <a href="https://github.com/17TheWord/QueQiao/blob/main/LICENSE"> <img src="https://img.shields.io/badge/license-MIT-green" alt="license"> </a> <a href="https://github.com/17TheWord/QueQiao/releases"> <img src="https://img.shields.io/github/v/release/17TheWord/QueQiao" alt="release"> </a> </p> <p align="center"> <a href="https://www.spigotmc.org"> <img src="https://img.shields.io/badge/SpigotMC-1.12.2--latest-blue?logo=data:image/png;base64,..." alt="spigotmc"/> </a> <a href="https://docs.papermc.io/paper"> <img src="https://img.shields.io/badge/PaperMC-1.17.1--latest-blue?logo=data:image/png;base64,..." alt="velocity"> </a> <a href="https://docs.papermc.io/folia"> <img src="https://img.shields.io/badge/Folia-1.21.4--latest-blue?logo=data:image/png;base64,..." alt="velocity"> </a> <a href="https://papermc.io/software/velocity"> <img src="https://img.shields.io/badge/Velocity-3.3.0-blue?logo=data:image/png;base64,..." alt="velocity"> </a> </p> <p align="center"> <a href="https://files.minecraftforge.net"> <img src="https://img.shields.io/badge/Forge-1.7.10--1.21-blue?logo=data:image/png;base64,..." alt="forge"> </a> <a href="https://fabricmc.net"> <img src="https://img.shields.io/badge/Fabric-1.16.5--1.21.8-blue?logo=data:image/png;base64,..." alt="fabric"> </a> <a href="https://neoforged.net/"> <img src="https://img.shields.io/badge/NeoForge-1.21.1-blue?logo=data:image/png;base64,..." alt="fabric"> </a> </p> <p align="center"> <a href="https://queqiao.apifox.cn">📖 Documentation</a> · <a href="https://modrinth.com/plugin/queqiao">⬇️ Modrinth</a> · <a href="https://www.curseforge.com/minecraft/mc-mods/queqiao">⬇️ CurseForge</a> · <a href="https://github.com/17TheWord/QueQiao/issues">🐛 Report Issues</a> </p> ## Introduction - Distributes **player events** from the server in `JSON` format via `WebSocket` - Implemented (https://queqiao.apifox.cn/68795505f0): - (https://queqiao.apifox.cn/7662378m0) - (https://queqiao.apifox.cn/7662404m0) - (https://queqiao.apifox.cn/7662407m0) (Not available for Velocity) - (https://queqiao.apifox.cn/7662405m0) - (https://queqiao.apifox.cn/7662406m0) - (https://queqiao.apifox.cn/7662410m0) - Receives `JSON` messages via `WebSocket` and forwards to in-game players - Implemented APIs: - (https://queqiao.apifox.cn/3690114w0) - (https://queqiao.apifox.cn/3690118w0) - (https://queqiao.apifox.cn/3690115w0) - (https://queqiao.apifox.cn/3690116w0) - (https://queqiao.apifox.cn/3690119w0) ## Documentation - Visit the (https://queqiao.apifox.cn/) for detailed documentation > Can't find a suitable Mod/Plugin version? Feel free to submit an (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 (https://apifox.com/) or other API testing tools, or connect with (#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 (https://queqiao.apifox.cn/68642911f0) to send messages or listen to player events. ## Integration Projects - (https://github.com/17TheWord/nonebot-adapter-minecraft): `NoneBot2` adapter - (https://github.com/17TheWord/nonebot-plugin-mcqq): `NoneBot2` plugin - (https://github.com/CikeyQi/mc-plugin): `YunZai` plugin - (https://github.com/Twiyin0/koishi-plugin-minecraft-sync-msg): `Koishi` plugin - (https://github.com/17TheWord/zerobo