QueQiao

✨ A bridge for connecting to the Minecraft server ✨

📖Docs · 📃Chinese · 🐛Submit Suggestion/Bug

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
• Receives JSON messages via WebSocket and forwards to in-game players
  • Implemented APIs:
    • Broadcast
    • PrivateMessage
    • Title & SubTitle
    • ActionBar

Documentation

• Visit the Wiki for detailed documentation

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:

     {
       "x-self-name": "TestServer",
       // Required
       // Server name, must match 'server_name' in config.yml
       "Authorization": "Bearer 123",
       // Optional
       // Authentication, must match 'access_token' in config.yml (can be omitted if 'auth_token' is empty)
     }
     

5. Launch the game and join the server

Integration Projects

• @17TheWord/nonebot-adapter-minecraft: NoneBot2 adapter supporting message exchange and Rcon commands
• @17TheWord/nonebot-plugin-mcqq: NoneBot2 plugin for chat integration between OneBot/QQ and Minecraft
• @CikeyQi/mc-plugin: Yunzai plugin for OneBot protocol integration
• @Twiyan0/koishi-plugin-minecraft-sync-msg: Koishi plugin for chat integration
• @17TheWord/zerobot-plugin-mcqq: ZeroBot plugin for OneBot-Minecraft integration

Compatibility

• @kitUIN/ChatImage: Displays images in Minecraft chat

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.