# 怎么使用
>[danger] 当前文档为 `1.x` 版本的文档。simple-robot 1.x 版本已经被认定为过时且停止维护,请前往 `2.x` 版本文档:https://www.yuque.com/simpler-robot/simpler-robot-doc
确实,整个文档放眼望去..woc,这都是些什么跟什么?真吓人走了走了
经常会有人出现这样的情况,所以我在这里单独写一个章节,说一下我推荐使用什么方式去使用本框架。
## **首先,你要知道你要用什么。**
目前已有的、可用来进行对接的组件有:
* **[酷Q平台下的CQ HTTP API插件的组件(推荐使用)](组件-酷Q-CoolQHTTPAPI.md)**
* **[酷Q平台下的HTTP TO CQ插件的组件](组件-酷Q-HTTPAPI.md)**
* **[酷Q平台下的LEMOC插件的组件](组件-酷Q-LEMOC.md)**
* **[酷Q平台下的JCQ插件的组件](组件-酷QQQ-JCQ.md)**
当你决定想要用哪个插件或者应用的时候,点击对应的链接,或者从文档左边菜单栏中的最下面找到对应的**组件章节**并点进去,看一看其中的**快速开始**以快速上手一个demo项目。
## **难以解决的问题**
如果你出现了各种由于**框架方面**出现的各种问题,或者跟着**快速开始**却没有成功的,你有很多解决这些问题的方案。
* 2、参考[常见问题汇总](./常见问题汇总.md)。
此处会是不是的更新一些很常见的问题与其解决方案。如果这些不能解决你的问题,参考第一条:进入QQ群聊。
* 3、通过邮箱`ForteScarlet@163.com`反馈问题。
最然我认为如果是提问题而不是反馈BUG的话,邮箱是效率最低的一种。而且我并不经常看邮箱,所以如果想快速解决问题,参考前两条。
* 4、通过[核心的GITHUB](核心.md)的`Issue`进行反馈。
如果不是为了反馈BUG,我觉得issue的效率也并不是很高。如果想快速解决问题,参考1、2条。
## **demo成功后**
在一个demo项目运行成功后,你的下一步就是完成你心目中的项目。而至于有些功能该怎么实现,此时你的思考逻辑与行动顺序应该是这样的:
**①、** 我有个功能想实现(例如群号过滤、CQ码提取、整合Springboot项目、连接数据库、自定义xxxx....)
**②、** 找找文档,有没有相关说明。
**③、** 再仔细找找,或者去github提问/反馈。
**⑤、** **可能性Ⅰ**:有这个功能,直接使用。**可能性Ⅱ**:没有这个功能,这时候再自己努力想办法实现。
为什么要有这么一个顺序呢?要知道我文档这么多东西不是全都是废话的,整个框架内所拥有功能是十分丰富的,所以如果框架能够让你的功能实现起来更便捷,何乐而不为?
- 前言
- 简单介绍
- 我该如何阅读文档
- 视频教程
- 安装与使用
- 开源协议
- 免责&捐助
- 注意事项
- 版本命名规则简介
- 主要功能版本历史
- 功能指引
- 通用API与功能
- 国际化语言
- 异常
- 消息监听
- @Listen
- @OnListen模板
- @Filter
- 消息参数截取
- @Spare
- @Constr
- @Ignore
- @ListenBreak
- @ListenBreakPlugin
- @ListenBody
- 监听响应
- 成功判定与返回值
- 监听上下文
- 动态参数
- 监听消息API
- 异步监听 @Async
- 限流监听 @Limit
- 自定义Http送信器
- 枚举与类型
- 送信器
- SENDER
- SETTER
- GETTER
- 返回值
- 其他位置
- 日志与日志拦截
- 异常处理
- 依赖注入
- 自定义依赖获取
- 批量依赖载入
- 注意事项
- 常量
- 定时任务
- 自定义过滤
- 拦截器
- 拦截器总定义
- 上下文对象总定义
- 监听消息拦截
- 送信器拦截
- 监听函数拦截
- CAT码
- CQ码
- CQCode
- CQ码工具类
- CQ扩展工具类
- AppendList拼接链
- 高级内容
- 阻断机制
- 截断机制
- 自定义枚举类型
- 枚举工厂
- byName注解
- 自定义注解
- 配置
- 文件配置
- 注解配置
- 参数配置
- 多配置
- 多账号
- 自定义账号管理器
- 小心!
- 核心版本与组件如何升级核心
- 核心版本迭代指南
- 核心
- 更新日志
- jar包与依赖
- 监听消息类结构图
- 快速启动
- 模组与扩展
- 模组开发
- 现有模组
- 通用模组-延时任务
- 通用模组-CQ码工具
- 转义器
- CQ码操作工具类
- CQ码模板-CodeTemplate
- CQ码载体-KQCode
- CQ码构建器
- MQ码工具类
- 通用模组-redis-bot管理器
- 通用模组-Debugger
- Debugger-common模块
- Debugger-server模块
- Debugger-client模块
- 通用模组-钉钉机器人
- 组件-Mirai(JVM)
- 快速开始(1.13+)
- springboot-starter
- 注意事项
- 配置
- 额外的内容
- 快速回复
- 额外监听
- CQ码解析
- 组件-酷Q(QQ)-CQ HTTP API(基本失效)
- 快速开始(推荐)
- 快速开始(1.7.x以下,不推荐)
- 快速开始(Springboot启动器)
- 启动器、启动接口与配置类
- 配置
- 文件配置
- 注意事项
- 更新日志
- 额外的内容
- 自定义额外监听
- CQ送信器
- 元事件
- 监听消息类结构图
- 组件-酷Q(QQ)-JCQ(失效)
- 快速开始
- 更新日志
- 额外的内容
- JCQ日志
- 配置
- 注意事项
- 监听消息类结构图
- 组件-酷Q(QQ)-HTTP TO CQ(失效)
- 快速开始(核心1.7.x及以下)
- 启动器、启动接口与配置类
- 配置
- 文件配置
- 注意事项
- 更新日志
- 监听消息类结构图
- 组件-酷Q(QQ)-LEMOC (失效)
- 快速开始(核心1.7.x及以下)
- 配置
- 注意事项
- 更新日志
- 监听消息类结构图
- Springboot快速启动器
- 常见问题汇总
- BUG反馈
- 更新计划总览