A powerful Minecraft server plugin that bridges OneBot protocol implementations with your game server.
A powerful Minecraft server plugin that bridges OneBot protocol implementations with your game server.
Download the Plugin
OneBot-x.x.x.jarInstall on Server
# Place the JAR file in your server's plugins directory
cp OneBot-*.jar /path/to/server/plugins/
Start/Restart Server
# Restart your Minecraft server
/reload
# or
/stop && ./start.sh
List Available Presets
/onebot preset list
Apply a Preset Configuration
# For go-cqhttp
/onebot preset apply go-cqhttp
# For Lagrange.OneBot
/onebot preset apply lagrange
Connect to OneBot Server
/onebot connect
Check Connection Status
/onebot status
OneBot/
├── src/
│ └── main/
│ ├── kotlin/ # Kotlin source code
│ └── resources/ # Resource files
│ ├── config.yml # Main configuration
│ └── lang/ # Language files
├── build.gradle.kts # Build configuration
└── settings.gradle.kts # Project settings
# Clone the repository
git clone https://github.com/BingZi-233/OneBot.git
cd OneBot
# Build the plugin
./gradlew build
# The output JAR will be in build/libs/
For developers who want to use OneBot as a dependency:
# Build API JAR (without implementation)
./gradlew taboolibBuildApi -PDeleteCode
<dependency>
<groupId>online.bingzi</groupId>
<artifactId>onebot</artifactId>
<version>VERSION</version>
</dependency>
dependencies {
implementation("online.bingzi:onebot:VERSION")
}
| Implementation | Protocol Version | Status |
|---|---|---|
| go-cqhttp | v11 | ✅ Fully Supported |
| Lagrange.OneBot | v11 | ✅ Fully Supported |
| Shamrock | v11 | ✅ Fully Supported |
| NapCat | v11 | ✅ Fully Supported |
| OneBot v12 | v12 | 🚧 In Development |
| Command | Permission | Description |
|---|---|---|
/onebot help |
onebot.use |
Show help information |
/onebot status |
onebot.use |
Check connection status |
/onebot connect |
onebot.admin |
Connect to OneBot server |
/onebot disconnect |
onebot.admin |
Disconnect from OneBot server |
/onebot reload |
onebot.admin |
Reload configuration |
/onebot preset list |
onebot.admin |
List available presets |
/onebot preset apply <name> |
onebot.admin |
Apply a preset configuration |
# config.yml
onebot:
# Connection settings
connection:
type: websocket
host: localhost
port: 8080
path: /onebot/v11/ws
# Authentication
auth:
enabled: false
token: your-token-here
# Message forwarding
forward:
game-to-bot: true
bot-to-game: true
# Format settings
format:
game-message: "[MC] <{player}> {message}"
bot-message: "[QQ] <{sender}> {message}"
See Configuration Wiki for detailed configuration options.
We welcome contributions! Please see our Contributing Guidelines for details.
git checkout -b feature/AmazingFeature)git commit -m 'Add some AmazingFeature')git push origin feature/AmazingFeature)This plugin uses bStats to collect anonymous usage data. You can opt-out in the bStats config file.
View our metrics: bStats Page
This project is licensed under the MIT License - see the LICENSE file for details.
If you find this plugin helpful, please consider:
Made with ❤️ by BingZi-233