# OneBot<\/p>\n
\n
\n
\n
\n
\n
\n<\/p>\n
A powerful Minecraft server plugin that bridges OneBot protocol implementations with your game server.<\/p>\n
Wiki | Issues<\/p>\n<\/div>\n
## \u2728 Features<\/p>\n
– \ud83d\udd0c **Protocol Support** – Full support for OneBot v11\/v12 protocols
\n– \ud83c\udfae **Wide Compatibility** – Works with Minecraft 1.8-1.21+ servers
\n– \ud83d\ude80 **High Performance** – Built on TabooLib framework for optimal performance
\n– \ud83d\udd27 **Easy Configuration** – Pre-configured templates for popular OneBot implementations
\n– \ud83d\udcca **Metrics Integration** – Built-in bStats metrics for usage analytics
\n– \ud83c\udf0d **Internationalization** – Multi-language support with i18n
\n– \ud83d\udd04 **Real-time Sync** – Bidirectional message forwarding between game and chat platforms
\n– \ud83c\udfa8 **Rich Text Support** – Full Minecraft chat component support with formatting<\/p>\n
## \ud83d\udccb Requirements<\/p>\n
– **Java**: 8 or higher
\n– **Server**: Bukkit\/Spigot\/Paper 1.8-1.21+
\n– **Memory**: Minimum 2GB recommended
\n– **OneBot Implementation**: Any OneBot v11\/v12 compatible server (e.g., go-cqhttp, Lagrange.OneBot)<\/p>\n
## \ud83d\ude80 Quick Start<\/p>\n
### Installation<\/p>\n
1. **Download the Plugin**
\n – Get the latest release from Releases
\n – Choose the file: `OneBot-x.x.x.jar`<\/p>\n
2. **Install on Server**
\n “`bash
\n # Place the JAR file in your server’s plugins directory
\n cp OneBot-*.jar \/path\/to\/server\/plugins\/
\n “`<\/p>\n
3. **Start\/Restart Server**
\n “`bash
\n # Restart your Minecraft server
\n \/reload
\n # or
\n \/stop && .\/start.sh
\n “`<\/p>\n
### Configuration<\/p>\n
1. **List Available Presets**
\n “`bash
\n \/onebot preset list
\n “`<\/p>\n
2. **Apply a Preset Configuration**
\n “`bash
\n # For go-cqhttp
\n \/onebot preset apply go-cqhttp<\/p>\n
# For Lagrange.OneBot
\n \/onebot preset apply lagrange
\n “`<\/p>\n
3. **Connect to OneBot Server**
\n “`bash
\n \/onebot connect
\n “`<\/p>\n
4. **Check Connection Status**
\n “`bash
\n \/onebot status
\n “`<\/p>\n
## \ud83d\udcc1 Project Structure<\/p>\n
“`
\nOneBot\/
\n\u251c\u2500\u2500 src\/
\n\u2502 \u2514\u2500\u2500 main\/
\n\u2502 \u251c\u2500\u2500 kotlin\/ # Kotlin source code
\n\u2502 \u2514\u2500\u2500 resources\/ # Resource files
\n\u2502 \u251c\u2500\u2500 config.yml # Main configuration
\n\u2502 \u2514\u2500\u2500 lang\/ # Language files
\n\u251c\u2500\u2500 build.gradle.kts # Build configuration
\n\u2514\u2500\u2500 settings.gradle.kts # Project settings
\n“`<\/p>\n
## \ud83d\udd27 Development<\/p>\n
### Building from Source<\/p>\n
“`bash
\n# Clone the repository
\ngit clone https:\/\/github.com\/BingZi-233\/OneBot.git
\ncd OneBot<\/p>\n
# Build the plugin
\n.\/gradlew build<\/p>\n
# The output JAR will be in build\/libs\/
\n“`<\/p>\n
### Development Setup<\/p>\n
For developers who want to use OneBot as a dependency:<\/p>\n
“`bash
\n# Build API JAR (without implementation)
\n.\/gradlew taboolibBuildApi -PDeleteCode
\n“`<\/p>\n
### Maven Dependency<\/p>\n
“`xml ### Gradle Dependency<\/p>\n “`kotlin ## \ud83c\udf10 Supported OneBot Implementations<\/p>\n | Implementation | Protocol Version | Status | ## \ud83d\udcd6 Commands<\/p>\n | Command | Permission | Description | ## \ud83d\udd17 Configuration Guide<\/p>\n ### Basic Configuration<\/p>\n “`yaml # Authentication # Message forwarding # Format settings ### Advanced Settings<\/p>\n See Configuration Wiki for detailed configuration options.<\/p>\n ## \ud83e\udd1d Contributing<\/p>\n We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.<\/p>\n 1. Fork the repository ## \ud83d\udcca Metrics<\/p>\n This plugin uses bStats to collect anonymous usage data. You can opt-out in the bStats config file.<\/p>\n View our metrics: bStats Page<\/p>\n ## \ud83d\udc1b Bug Reports & Feature Requests<\/p>\n – **Bug Reports**: Create an Issue ## \ud83d\udcdc License<\/p>\n This project is licensed under the MIT License – see the [LICENSE](LICENSE) file for details.<\/p>\n ## \ud83d\ude4f Acknowledgments<\/p>\n – cnlimiter\/onebot-client – This project is redesigned and reimplemented based on this project ## \ud83d\udc96 Support<\/p>\n If you find this plugin helpful, please consider: —<\/p>\n **Made with \u2764\ufe0f by BingZi-233**<\/p>\n Report Bug \u00b7 Request Feature \u00b7 Join Discussion<\/p>\n<\/div>\n","protected":false},"excerpt":{"rendered":" A powerful Minecraft server plugin that bridges OneBot protocol implementations with your game server.<\/p>\n","protected":false},"featured_media":115991,"template":"","meta":{"_minecraft_slug":"onebot","_minecraft_project_id":"ay8Rdsj0","_minecraft_author":"BingZi-233","_minecraft_license":"AGPL-3.0-only","_minecraft_downloads":141,"_minecraft_follows":2,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"onebot.zip","_minecraft_size_bytes":10278038,"_minecraft_version_count":3,"_minecraft_updated_at":"2026-05-15T18:50:50.665957Z","_minecraft_date_created":"2025-08-12T02:41:45.770248Z","_minecraft_date_modified":"2025-08-14T13:23:26.611982Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/onebot","_minecraft_icon_attachment_id":115991,"_minecraft_imported_at":"2026-06-06T19:53:53+00:00","_minecraft_import_hash":"7cfbb822f63347d1c95a3b4aa400baf7","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,125,873,126,127,128,129],"mod_loader":[130,131,132,133,134],"minecraft_version":[360,379,382,385,438,446,449,110,111,112,113,114,115,116,117,118,119,120,46,47,48,49,50,51,52,53,54,55,56,57,58,59,36,60,93,94,101,102,62,37,73,74,38,78,79,80,81],"class_list":["post-115990","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-folia","mod_category-library","mod_category-management","mod_category-paper","mod_category-purpur","mod_category-spigot","mod_loader-bukkit","mod_loader-folia","mod_loader-paper","mod_loader-purpur","mod_loader-spigot","minecraft_version-1-11-2","minecraft_version-1-12","minecraft_version-1-12-1","minecraft_version-1-12-2","minecraft_version-1-13","minecraft_version-1-13-1","minecraft_version-1-13-2","minecraft_version-1-14","minecraft_version-1-14-1","minecraft_version-1-14-2","minecraft_version-1-14-3","minecraft_version-1-14-4","minecraft_version-1-15","minecraft_version-1-15-1","minecraft_version-1-15-2","minecraft_version-1-16","minecraft_version-1-16-1","minecraft_version-1-16-2","minecraft_version-1-16-3","minecraft_version-1-16-4","minecraft_version-1-16-5","minecraft_version-1-17","minecraft_version-1-17-1","minecraft_version-1-18","minecraft_version-1-18-1","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8"],"yoast_head":"\n
\n
\n
\n
\n
\n<\/dependency>
\n“`<\/p>\n
\ndependencies {
\n implementation(“online.bingzi:onebot:VERSION”)
\n}
\n“`<\/p>\n
\n|—————-|——————|——–|
\n| go-cqhttp | v11 | \u2705 Fully Supported |
\n| Lagrange.OneBot | v11 | \u2705 Fully Supported |
\n| Shamrock | v11 | \u2705 Fully Supported |
\n| NapCat | v11 | \u2705 Fully Supported |
\n| OneBot v12 | v12 | \ud83d\udea7 In Development |<\/p>\n
\n|———|————|————-|
\n| `\/onebot help` | `onebot.use` | Show help information |
\n| `\/onebot status` | `onebot.use` | Check connection status |
\n| `\/onebot connect` | `onebot.admin` | Connect to OneBot server |
\n| `\/onebot disconnect` | `onebot.admin` | Disconnect from OneBot server |
\n| `\/onebot reload` | `onebot.admin` | Reload configuration |
\n| `\/onebot preset list` | `onebot.admin` | List available presets |
\n| `\/onebot preset apply
\n# config.yml
\nonebot:
\n # Connection settings
\n connection:
\n type: websocket
\n host: localhost
\n port: 8080
\n path: \/onebot\/v11\/ws<\/p>\n
\n auth:
\n enabled: false
\n token: your-token-here<\/p>\n
\n forward:
\n game-to-bot: true
\n bot-to-game: true<\/p>\n
\n format:
\n game-message: “[MC] <{player}> {message}”
\n bot-message: “[QQ] <{sender}> {message}”
\n“`<\/p>\n
\n2. Create your feature branch (`git checkout -b feature\/AmazingFeature`)
\n3. Commit your changes (`git commit -m ‘Add some AmazingFeature’`)
\n4. Push to the branch (`git push origin feature\/AmazingFeature`)
\n5. Open a Pull Request<\/p>\n
\n– **Feature Requests**: Request a Feature
\n– **Discussions**: Join Discussions<\/p>\n
\n– TabooLib – The powerful framework this plugin is built on
\n– OneBot – The chat protocol standard
\n– All contributors and users of this plugin<\/p>\n
\n– \u2b50 Starring the repository
\n– \ud83d\udc1b Reporting bugs and suggesting features
\n– \ud83e\udd1d Contributing to the codebase
\n– \ud83d\udce2 Sharing with others<\/p>\n