simple-robot-core

Introduction: 这是基于 java 的 QQ 机器人开发框架,是一种注解开发风格、可扩展的、可与 SpringBoot 应用相互结合的开发框架,对接各种提供接口的 QQ 机器人应用来实现以一种统一标准编写 QQ 机器人。未来也可能会对接一些其他的机器人应用。
More: Author   ReportBugs   
Tags:

img

项目对应 GITHUB 地址: https://github.com/ForteScarlet/simple-robot-core

项目对应 GITEE 地址: https://gitee.com/ForteScarlet/simple-robot-core

首先,点击项目右上角的star以开启隐藏链接。

核心版本:img


文档请见文档地址: http://simple-robot-doc.forte.lovehttps://www.kancloud.cn/forte-scarlet/simple-coolq-doc

在线 javadoc 文档(由码云平台生成): https://apidoc.gitee.com/ForteScarlet/simple-robot-core

由于目前核心部分与组件部分相互分离,所以核心与组件的 github 地址也相互分离了。 所有组件均依赖于此核心框架,支持 maven 坐标,具体坐标请见文档下文入群咨询

点击star后即可申请加入 QQ 群聊,QQ 群号:782930037



这是什么?

这是一个基于网络通讯接口的通讯机器人开发框架,可以对接例如酷 Q 机器人等一系列通讯机器人应用。 此框架分有两个部分:核心框架与组件框架,当前仓库为核心框架。

核心框架?

核心框架提供主要的功能与接口,用于为组件框架提供实现接口,并借此可以实现不同平台、不同插件的简易切换。 核心框架提供标准化接口、功能,但是不能够直接使用。

组件框架?

组件框架依赖于核心框架,其存在的主要目的就是为了针对某一个特定的插件(例如酷 Q 的 CQ HTTP API 插件)进行对接。

为何要分离?

举个例子。假如你想要使用此框架对接 A 应用 ,那么你就要使用 组件框架 A 来开发,然后过了两个月,你发现B 应用也挺好的,想要切换到B 应用,这时候分离的作用就出现了,你只需要将依赖的组件框架 A切换为组件框架 B,然后简单修改一下启动类和配置信息,而不需要修改任何功能性的代码(例如消息监听器、定时任务等等)。因为绝大部分功能性的东西都是核心框架所提供的,而你切换组件是不会变更核心的,这样就可以做到能够很好的去支持更多的应用,且切换起来也不会太繁琐。

简单来讲,核心框架就是一块儿主板,组件框架就是一块儿显卡,而最终开机后,电脑里的各种各样的应用程序,就是你最终所书写的功能性代码。
只要这块儿主板不变,每次更换显卡只需要重新安装一下显卡驱动,而不需要删除所有的应用。

也得益于核心组件分离,使其能够有更大的拓展空间,而不是仅局限于酷 Q 应用,也不一定局限于腾讯 QQ 的业务范围。毕竟有着“私信、群聊”等等一系列信息内容的应用可不仅限于腾讯 QQ


有何优点?

  • 有着极高的扩展性。任何人都可以根据核心框架,并针对某一个应用或者接口来开发组件框架,并投入使用。
  • 核心提供了极其丰富的功能,例如
    • 注解开发风格
    • 丰富的过滤规则
    • 集成 quartz 定时任务框架
    • 依赖注入
    • 部分拦截器
    • 支持与 Spring(boot(+MyBatis))等其他框架的整合
    • 目前针对 Springboot,提供了快速启动器(starter)
  • 持续更新的代码
  • 好说话的作者(欢迎入群与群主交流催更😏
  • 高度接口化,可扩展性强
  • 有虽然没有完全写完但是已经很全面了的中文文档
  • 已上传 Maven 中央仓库,支持 Maven、gradle 等项目架构方式

现在已经存在的应用?

已经存在的组件框架

平台 依赖 项目地址
酷 Q(停止) LEMOC 插件 https://github.com/ForteScarlet/simple-robot-component-lemoc
酷 Q(停止) HTTP TO CQ 插件 https://github.com/ForteScarlet/simple-robot-component-httpapi
酷 Q(停止) CQ HTTP API 插件 https://github.com/ForteScarlet/simple-robot-component-coolHttpApi
酷 Q(停止) JCQ 插件 https://github.com/ForteScarlet/simple-robot-component-JCQ
JVM Mirai(停止维护) https://github.com/ForteScarlet/simple-robot-component-mirai

酷 Q 已停止服务。R.I.P.

Mirai 已停止维护。

已经存在的模组

名称 描述 项目地址
cqcodeutils 模组 提供高效的 cq 码操作工具。可独立依赖、使用。 https://github.com/ForteScarlet/simple-robot-module-cqcodeutils
delay-task 模组 提供基于携程的异步延时任务功能。可独立依赖、使用。 https://github.com/ForteScarlet/simple-robot-module-delay-task
redis-bot-manager 模组 提供使用 redis 统一管理 bot 账号的功能。 暂无仓库,文档:http://simple-robot-doc.forte.love/1672448
debugger 模组 提供一系列便于本地、远程 debug 的功能的模组。 https://github.com/ForteScarlet/simple-robot-module-debuger-common

已经存在的Springboot-starter

名称 描述 项目地址
core-starter starter 项目的父项目,提供一些基础配置 https://github.com/ForteScarlet/simple-robot-core-springboot-starter
cqhttp-starter cqhttp 组件的 starter https://github.com/ForteScarlet/simple-robot-component-cqhttp-springboot-starter
mirai-starter mirai 组件的 starter https://github.com/ForteScarlet/simple-robot-component-mirai-springboot-starter

公开 Demo

如果你想要尝试一下,不妨在阅读过文档的快速开始的情况下,去公开 Demo 项目(gitee)看一看。

如果你根据核心开发了组件框架,可以告知我,我会更新在此处与下文处。

如果你只是想开发一个 QQ 机器人,而不在乎使用什么平台,请参考文档开头提到的组件框架。

安装

此处仅对如何搭建 Java 项目进行说明,如果你想开发 QQ 机器人, 请移步至 文档 查看。

首先你需要知道,此项目(即核心) 无法直接使用,如果你想要开发酷 Q 平台的 QQ 机器人,请移步至 文档 查看。

其次,以下列举的部署方式中,版本号请自行修改为最新版。

你可以选择使用以下方法进行自动部署:

版本参考:img

Maven

<dependency>
    <groupId>io.github.ForteScarlet</groupId>
    <artifactId>simple-robot-core</artifactId>
    <version>${version}</version>
</dependency>

Gradle

// https://mvnrepository.com/artifact/io.github.ForteScarlet/simple-robot-core
compile group: 'io.github.ForteScarlet', name: 'simple-robot-core', version: '>${version}'

如果你不选择使用自动部署的方式,你可以直接前往 Maven 下载 Jar 包或者碰碰运气,看看releases有没有最新的 Jar 包。

注意,当你选择下载 jar 包的时候,请同时下载项目中lib文件夹下的依赖包。

看的有点蒙,但是想试试

可以考虑:

  • 加入 QQ 群:782930037, 如果对水群没有兴趣,可以直接去找群主。
  • 邮箱:ForteScarlet@163.com (邮箱信息查看周期较长)
  • GITEE 或者 GITHUB 留言

首先建议进群交流,毕竟其他两个我并不经常看(●ˇ∀ˇ●)

建议、意见、bug 反馈

  • 你可以使用issue向我反馈 bug 或者提出建议意见。
  • 你可以加入 QQ 群聊782930037向我反馈 bug 或者提出建议意见。
  • 你可以通过联系邮箱ForteScarlet@163.com向我反馈 bug 或者提出建议意见(可能会处理不及时)。

更新计划

对于未来的更新计划可以从 github 的 projects 中或者更新计划中看到。一般想到什么的话会优先更新更新计划.md

赞助一下?

那真的真的太感谢了,你可以参考 文档/捐助 或者去 爱发电 逛逛~

大家的成果

项目名称 作者 项目简介 项目链接

崩坏学园 2 小助手 - 萌萌新

瑶光天枢 崩坏学园 2 的在线群聊,查询装备,模拟扭蛋,查询 up 记录,来份色图的机器人 https://github.com/LiChen233/simple-robot

群管机器人

会跑的仓鼠 基于 simple 开发的群机器人 https://gitee.com/yaozhenyong/cqrobotjar2

游戏查询机器人

基于 simple 开发的娱乐性机器人 https://gitee.com/yaozhenyong/cqrobotIndependent

云端控制面板

主要做上面两个版本机器人的控制面板(web 端) https://gitee.com/yaozhenyong/Qqrobotwar

Robot-Spring

千年老妖(1571650839)

基于酷 Q 的,使用 Java 语言开发的,面向 COC 的骰子机器人组件, 使用架构为 SpringBoot-Mybatis-CoolHttpApI。主要功能:COC 跑团基础功能+斗图,聊天,群管等乱七八糟的功能

https://github.com/17336324331/Robot-Spring

coolqhttpapisimpleyiluoeandxishirobot

以罗伊 就是用 simple-robot 框架写的一个小机器人啦,windows linux 上都能正确运行(目前) https://github.com/YiluoE/coolqhttpapisimpleyiluoeandxishirobot
Apps
About Me
GitHub: Trinea
Facebook: Dev Tools