README_EN.md

🌍English / 中文

QueQiao

✨ A bridge for connecting to the Minecraft server ✨

📖Docs · ⬇️Modrinth · ⬇️CurseForge · 🐛Submit Suggestion/Bug

Introduction

• A server plugin/mod that distributes player events from Minecraft server in Json format via Websocket.
  • Implemented events
    • Player Chat
    • Player Commands
    • Player Death (Velocity not yet available)
    • Player Join
    • Player Logout
• Receives Json messages via Websocket and forwards them to the game players.
  • Implemented interfaces
    • Broadcast
    • PrivateMessage
    • Title & SubTitle
    • ActionBar

Quick Start

1. Install the corresponding plugin/mod for the server.
2. Configure websocket_server in config.yml
   • enable: true # Enable
   • host: "127.0.0.1" # WebSocket Server address
   • port: 8080 # WebSocket Server port
3. Start the server and wait for the Websocket Server to start.
4. Use ApiFox or other API testing tools, or connect to integration projects.
   • Configure global Request Header

     {
       "x-self-name": "TestServer",
       // Required
       // Server name, must match 'server_name' in config.yml
       "Authorization": "Bearer 123",
       // Optional
       // Authorization, must match 'access_token' in config.yml, if 'access_token' in config.yml is empty, this item can be omitted
       "x-client-origin": "apifox"
       // Required
       // Client origin, if the origin is 'minecraft', it indicates that the request is from a Minecraft Websocket Client and will be rejected by the Minecraft server's Websocket Server
     }

5. Start the game and join the server.

Help and Download

• Go Docs for help
• GO Modrinth for download
• Go CurseForge for download

Integration

• @17TheWord/nonebot-adapter-minecraft: NoneBot2 adapter, connects to this mod
• @17TheWord/nonebot-plugin-mcqq: NoneBot2 plugin, enables chat communication with Minecraft
• @CikeyQi/mc-plugin: Cloud plugin, enables chat communication with Minecraft

Compatibility

• @kitUIN/ChatImage: Display images in the Minecraft chat window

Special Thanks

• @kitUIN: Provided help with code and build tools
• @kitUIN/ModMultiVersion: IDEA multi-version MOD plugin
• @kitUIN/ModMultiVersionTool: Multi-version MOD build tool

Contribution and Support

• If you find it useful, please give this project a Star or support me on Afdian.

• Any feedback or suggestions are welcome, and you can submit Issues and Pull requests.

Open Source License

This project uses the MIT open-source license.