OneBot

一个强大的 Minecraft 服务器插件,它将 OneBot 协议实现与您的游戏服务器连接起来。

资源图片
# OneBot
![OneBot](https://img.shields.io/badge/OneBot-v11%2Fv12-blue) ![TabooLib](https://img.shields.io/badge/TabooLib-6.2.3+-green) ![Minecraft](https://img.shields.io/badge/Minecraft-1.8--1.21+-orange) ![Java](https://img.shields.io/badge/Java-8+-red) ![Build Status](https://img.shields.io/github/actions/workflow/status/BingZi-233/OneBot/build.yml) ![License](https://img.shields.io/github/license/BingZi-233/OneBot) ![Downloads](https://img.shields.io/github/downloads/BingZi-233/OneBot/total) 一个允许玩家控制生物生成的Spigot插件。 [Wiki](https://github.com/BingZi-233/OneBot/wiki) | [Issues](https://github.com/BingZi-233/OneBot/issues)
## ✨ 特性 - 🔌 **协议支持** - 完全支持 OneBot v11/v12 协议 - 🎮 **广泛兼容性** - 与 Minecraft 1.8-1.21+ 服务器兼容 - 🚀 **高性能** - 基于 TabooLib 框架以实现最佳性能 - 🔧 **易于配置** - 流行 OneBot 实现的预配置模板 - 📊 **指标集成** - 内置 bStats 指标用于使用分析 - 🌍 **国际化** - 多语言支持,支持 i18n - 🔄 **实时同步** - 游戏和聊天平台之间双向消息转发 - 🎨 **富文本支持** - 完全支持 Minecraft 聊天组件和格式 ## 📋 要求 - **Java**: 8 或更高版本 - **服务器**: Bukkit/Spigot/Paper 1.8-1.21+ - **内存**: 建议至少 2GB - **OneBot 实现**: 任何 OneBot v11/v12 兼容的服务器 (例如, go-cqhttp, Lagrange.OneBot) ## 🚀 快速开始 ### 安装 1. **下载插件** - 从 [Releases](https://github.com/BingZi-233/OneBot/releases) 获取最新版本 - 选择文件: `OneBot-x.x.x.jar` 2. **安装到服务器** ```bash # 将 JAR 文件放置到服务器的 plugins 目录下 cp OneBot-*.jar /path/to/server/plugins/ ``` 3. **启动/重启服务器** ```bash # 重新启动你的 Minecraft 服务器 /reload # 或 /stop && ./start.sh ``` ### 配置 1. **列出可用的预设** ```bash /onebot preset list ``` 2. **应用预设配置** ```bash # 对于 go-cqhttp /onebot preset apply go-cqhttp # 对于 Lagrange.OneBot /onebot preset apply lagrange ``` 3. **连接到 OneBot 服务器** ```bash /onebot connect ``` 4. **检查连接状态** ```bash /onebot status ``` ## 📁 项目结构 ``` OneBot/ ├── src/ │ └── main/ │ ├── kotlin/ # Kotlin 源代码 │ └── resources/ # 资源文件 │ ├── config.yml # 主配置文件 │ └── lang/ # 语言文件 ├── build.gradle.kts # 构建配置文件 └── settings.gradle.kts # 项目设置 ``` ## 🔧 开发 ### 从源代码构建 ```bash # 克隆仓库 git clone https://github.com/BingZi-233/OneBot.git cd OneBot # 构建插件 ./gradlew build # 输出 JAR 将在 build/libs/ 目录下 ``` ### 开发设置 对于想要将 OneBot 作为依赖项使用的开发者: ```bash # 构建 API JAR (不包含实现) ./gradlew taboolibBuildApi -PDeleteCode ``` ### Maven 依赖 ```xml online.bingzi onebot VERSION ``` ### Gradle 依赖 ```kotlin dependencies { implementation("online.bingzi:onebot:VERSION") } ``` ## 🌐 支持的 OneBot 实现 | 实现 | 协议版本 | 状态 | |----------------|------------------|--------| | go-cqhttp | v11 | ✅ 完全支持 | | Lagrange.OneBot | v11 | ✅ 完全支持 | | Shamrock | v11 | ✅ 完全支持 | | NapCat | v11 | ✅ 完全支持 | | OneBot v12 | v12 | 🚧 开发中 | ## 📖 命令 | 命令 | 权限 | 描述 | |---------|------------|-------------| | `/onebot help` | `onebot.use` | 显示帮助信息 | | `/onebot status` | `onebot.use` | 检查连接状态 | | `/onebot connect` | `onebot.admin` | 连接到 OneBot 服务器 | | `/onebot disconnect` | `onebot.admin` | 断开与 OneBot 服务器的连接 | | `/onebot reload` | `onebot.admin` | 重新加载配置 | | `/onebot preset list` | `onebot.admin` | 列出可用的预设 | | `/onebot preset apply ` | `onebot.admin` | 应用预设配置 | ## 🔗 配置指南 ### 基本配置 ```yaml # config.yml onebot: # 连接设置 connection: type: websocket host: localhost port: 8080 path: /onebot/v11/ws # 认证 auth: enabled: false token: your-token-here # 消息转发 forward: game-to-bot: true bot-to-game: true # 格式设置 format: game-message: "[MC] <{player}> {message}" bot-message: "[QQ] <{sender}> {message}" ``` ### 高级设置 请参阅 [Configuration Wiki](https://github.com/BingZi-233/OneBot/wiki/Configuration) 以获取详细的配置选项。 ## 🤝 贡献 我们欢迎贡献!请参阅我们的 [Contributing Guidelines](CONTRIBUTING.md) 以获取详细信息。 1. Fork 仓库 2. 创建你的功能分支 (`git checkout -b feature/AmazingFeature`) 3. 提交你的更改 (`git commit -m 'Add some AmazingFeature'`) 4. 推送到分支 (`git push origin feature/AmazingFeature`) 5. 打开一个拉取请求 ## 📊 指标 此插件使用 bStats 收集匿名使用数据。您可以在 bStats 配置文件中选择退出。 查看我们的指标:[bStats Page](https://bstats.org/plugin/bukkit/OneBot) ## 🐛 错误报告和功能请求 - **错误报告**: [创建问题](https://github.com/BingZi-233/OneBot/issues/new?labels=bug) - **功能请求**: [请求功能](https://github.com/BingZi-233/OneBot/issues/new?labels=enhancement) - **讨论**: [加入讨论](https://github.com/BingZi-233/OneBot/discussions) ## 📜 许可证 本项目的许可证为 MIT 许可证,请参阅 [LICENSE](LICENSE) 文件以获取详细信息。 ## 🙏 致谢 - [cnlimiter/onebot-client](https://github.com/cnlimiter/onebot-client) - 本项目基于该项目进行重设计和重构 - [TabooLib](https://github.com/TabooLib/taboolib) - 本插件构建在强大的框架之上 - [OneBot](https://onebot.dev/) - 聊天协议标准 - 所有为本插件做出贡献和使用本插件的用户 ## 💖 支持 如果您觉得本插件有帮助,请考虑: - ⭐ 星标仓库 - 🐛 报告错误并提出功能建议 - 🤝 为代码库做出贡献 - 📢 分享给其他人 ---
**Made with ❤️ by [BingZi-233](https://github.com/BingZi-233)** [报告 Bug](https://github.com/BingZi-233/OneBot/issues/new?labels=bug) · [请求 功能](https://github.com/BingZi-233/OneBot/issues/new?labels=enhancement) · [加入 讨论](https://github.com/BingZi-233/OneBot/discussions)