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

Introduction

• Distributes player events from the server in JSON format via WebSocket
  • Implemented Events:
    • Player Chat
    • Player Command
    • Player Death (Not available for Velocity)
    • Player Join
    • Player Quit
    • Player Advancement(Achievement)
• Receives JSON messages via WebSocket and forwards to in-game players
  • Implemented APIs:
    • Broadcast
    • PrivateMessage
    • Title & SubTitle
    • ActionBar
    • Rcon Command

Documentation

• Visit the ApiFox QueQiao for detailed documentation

Can't find a suitable Mod/Plugin version? Feel free to submit an Issue

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 or 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"
     }
     

5. Launch the game and join the server
6. Refer to the API Documentation to send messages or listen to player events.

Integration Projects

• @17TheWord/nonebot-adapter-minecraft: NoneBot2 adapter
• @17TheWord/nonebot-plugin-mcqq: NoneBot2 plugin
• @CikeyQi/mc-plugin: YunZai plugin
• @Twiyan0/koishi-plugin-minecraft-sync-msg: Koishi plugin
• @17TheWord/zerobot-plugin-mcqq: ZeroBot plugin
• @kterna/astrbot_plugin_mcqq: AstrBot plugin
• @KroMiose/nekro-agent: AI agent

Related Projects

• @kterna/queqiao_mcdr: MCDR implementation of QueQiao for message exchange

Compatibility

• @kitUIN/ChatImage: Displays images in Minecraft chat

Community

• Discord

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.