QueQiao
ModMinecraft Server Mod/Plugin for Real-time Player Events & API Broadcast Messaging.
Description
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
JSONformat viaWebSocket- Implemented
Events:Player ChatPlayer CommandPlayer Death(Not available for Velocity)Player JoinPlayer QuitPlayer Advancement(Achievement)
- Implemented
- Receives
JSONmessages viaWebSocketand forwards to in-game players- Implemented APIs:
Documentation
- Visit the
ApiFox QueQiaofor detailed documentation
Can't find a suitable Mod/Plugin version? Feel free to submit an
Issue
Quick Start
- Install the corresponding server
plugin/mod - Configure
websocket_serverinconfig.yml:enable: true# Enable WebSocket serverhost: "127.0.0.1"# WebSocket Server addressport: 8080# WebSocket Server port
- Start the server and wait for
WebSocket Serverto initialize - Use
ApiFoxor other API testing tools, or connect with Integration projects- Configure global
Request Header:{ // 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" }
- Configure global
- Launch the game and join the server
- Refer to the
API Documentationto send messages or listen to player events.
Integration Projects
@17TheWord/nonebot-adapter-minecraft:NoneBot2adapter@17TheWord/nonebot-plugin-mcqq:NoneBot2plugin@CikeyQi/mc-plugin:YunZaiplugin@Twiyan0/koishi-plugin-minecraft-sync-msg:Koishiplugin@17TheWord/zerobot-plugin-mcqq:ZeroBotplugin@kterna/astrbot_plugin_mcqq:AstrBotplugin@KroMiose/nekro-agent:AIagent
Related Projects
@kterna/queqiao_mcdr:MCDRimplementation ofQueQiaofor message exchange
Compatibility
@kitUIN/ChatImage: Displays images in Minecraft chat
Community
Special Thanks
@kitUIN: For code assistance and build tools@kitUIN/ModMultiVersion: IDEA multi-version MOD plugin@kitUIN/ModMultiVersionTool: Multi-version MOD build tool
Support & Contribution
- Star this project if you find it useful or support me on
Afdian - Submit suggestions/bugs via
Issues - Contribute via
Pull requests
License
This project is licensed under the MIT license.
Compatibility
Mod Loaders
Game Versions
Recommended Gear
AffiliateHardware and extras that pair well with this mod.
As an Amazon Associate I earn from qualifying purchases.
Screenshots
Similar Mods
SquidUtils (abandoned)
SquidUtils is a tweak mod that lets you set various properties of Vanilla objects.
Foggy Pale Garden (FPG)
A Minecraft mod that adds fog to the Pale Garden biome. But you can customize any kind of fog anywhere you like!
Onslaught [outdated/momentarily discontinued]
Inspired by Terraria, Onslaught is an extensive invasion mod with a visible progress bar, per-dimension invasions, and m...
Loot Integrations: The Lost Castle
Adds better loot to The Lost Castle chests including modded loot
Thaumcraft Aspect Creator
A Minecraft mod that allows modpack makers to define and add to Thaumcraft custom aspects
Solar Energy
Solar Energy adds solar energy generation and huge battery storage for minecraft