5 Star 79 Fork 45

ssssssss-team / qq-robot

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

qq-robot

介绍

软件架构

  1. 采用插件式处理消息,可无限扩展插件,需要jdk1.8以上,maven3,暂时没有添加数据库相关操作,qq登录采用调用接口的方式,由于没有页面,所以直接采用knife4j的界面去调接口。
    用户和群隔离开,每个群单独一个启动的配置,所有用户私聊一个启动配置。
  2. 系统管理相关命令都在【系统管理插件】里,部分命令必须配置了root管理员才能使用,对应配置:project.qq-robot.root-manage-qq(例如开关群管理权限)
  3. 扩展插件需要继承RobotPlugin才能被系统扫描到,并且搭配注解@HookNotice@HookMethod使用
  4. 命令开始字符可以通过配置修改:project.qq-robot.cmd-char,默认为#,可以自定义成其它字符,也可以是中文字咯~

接口和注解

/**
 * 机器人插件接口
 */
public interface RobotPlugin {
    /**
     * 在目标方法被调用之前做增强处理
     *
     * @param content 插件上下文
     */
    public default void before(RobotPluginContent content) {
    }

    /**
     * 在目标方法完成之后做增强,无论目标方法时候成功完成
     *
     * @param content 插件上下文
     */
    public default void after(RobotPluginContent content) {
    }
}
/**
 * 消息通知钩子
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @interface HookNotice {
    /**
     * 名称
     */
    String name();

    /**
     * 描述
     */
    String[] desc() default {};

    /**
     * 默认是否启用
     */
    boolean start() default false;

    /**
     * 排序,数字越大越靠后,默认为10000
     */
    int order() default RobotPluginInfo.DEFAULT_ORDER;
}
/**
 * 执行命令的方法注解
 *
 * @author 超级小富翁
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface HookMethod {

   /**
    * 是否全局命令,不进行隔离限制
    */
   boolean globalCmd() default false;

   /**
    * 以字符开始的命令
    */
   String[] start() default {};

   /**
    * 完全匹配的命令
    */
   String[] equal() default {};

   /**
    * 普通管理员权限
    */
   boolean normalManager() default false;

   /**
    * root管理员权限
    */
   boolean rootManager() default false;

   /**
    * 适用的事件,不填默认只生效消息类型的事件,{@link RobotEventEnum#robotMessageEventEnums}
    */
   RobotEventEnum[] event() default {};

   /**
    * 描述
    */
   String desc() default "";
}

安装教程

  1. 下载源码,更新maven包
  2. 启动类:com.billdowney.qq.robot.StartUpApplication
  3. 默认文档地址:http://127.0.0.1:8282/qq-robot/doc.html
  4. 由于其中用到了别人的api服务,需要修改application.yml中的配置:project.qq-robot.alapi-tokenproject.qq-robot.kate-api-token

使用说明

  1. 文档地址:机器人接口->启动机器人,输入登录的qq号和密码登录账号
  2. 文档地址:机器人接口->机器人状态,可查看当前所有登录qq的状态,输入qq号查看指定的qq号状态
  3. 文档地址:机器人接口->停止机器人,可直接退出所有的qq号,输入qq号退出指定的qq
  4. 命令:#插件详情 系统管理插件,可查看当前所有管理员才能执行的命令,用于管理系统
  5. 所有内置插件在com.billdowney.qq.robot.plugins.provide包里
  6. 命令:#插件列表,可查看当前所有内置插件状态
  7. 命令:#插件详情 {插件名称},可查看对应插件简介以及使用方式
  8. 命令:#刷新配置,可以直接加载/cache/config.json的配置文件,可以先修改文件内容,然后刷新到内存中

工作空间目录说明

对应配置project.qq-robot.workspace的子目录结构说明

  1. group_manage,群管理插件文件夹
    1. leave_group,离群人员名单存放文件夹
      1. {机器人qq}/{群qq}
    2. welcome_img,欢迎图文件夹
  2. media,媒体插件文件夹
    1. img,看图
    2. short_video,短视频
    3. sticker,斗图
  3. qq,mirai登录qq缓存文件夹
    1. ${机器人qq}
  4. config.json,第一次启动后的初始化的配置文件

已知问题

  1. 常见问题
  2. 假如出现能发送好友消息,发送不了群消息,可以尝试删除cache/qq/[登录的qq号]文件夹,怀疑是缓存的服务器列表发送不了
  3. 软件第一次启动后会把所有的application.ymlproject.qq.robot配置全部写入到config.json工作空间目录说明 ,所以当配置不生效就需要修改该文件,并且使用命令刷新配置重新载入
  4. 尝试删除缓存目录下的deviceInfo-[qq].json,然后重新登录,或者前往https://blog.ryoii.cn/mirai-devicejs-generator/自动生成设备信息
  5. 无法登录的临时处理方案

参与贡献

  1. Fork 本仓库
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

qq机器人 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/ssssssss-team/qq-robot.git
git@gitee.com:ssssssss-team/qq-robot.git
ssssssss-team
qq-robot
qq-robot
master

搜索帮助

14c37bed 8189591 565d56ea 8189591