From f361a675af5036cc924b8b89100b32019f45ddfb Mon Sep 17 00:00:00 2001 From: crazywhalecc Date: Wed, 23 Dec 2020 10:21:48 +0800 Subject: [PATCH] update README.md --- README.md | 76 +++++++++++++++++++++++++------------------------------ 1 file changed, 35 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 2c608d05..144f8e50 100644 --- a/README.md +++ b/README.md @@ -7,32 +7,42 @@ [![zhamao License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/zhamao-robot/zhamao-framework/blob/master/LICENSE) [![Latest Stable Version](http://img.shields.io/packagist/v/zhamao/framework.svg)](https://packagist.org/packages/zhamao/framework) [![Banner](https://img.shields.io/badge/CQHTTP-v11-black)]() -[![dev-version](https://img.shields.io/badge/dev--version-v2.0.0--b3-green)]() [![stupid counter](https://img.shields.io/github/search/zhamao-robot/zhamao-framework/stupid.svg)](https://github.com/zhamao-robot/zhamao-framework/search?q=stupid) [![TODO counter](https://img.shields.io/github/search/zhamao-robot/zhamao-framework/TODO.svg)](https://github.com/zhamao-robot/zhamao-framework/search?q=TODO) - + ## 开发者注意 -**2.0 版本开发完毕后，会发布测试版和并入 master 分支，敬请关注。** - -[![dev-version2](https://img.shields.io/badge/process-95%25-green)]() - +**开发者 QQ 群：670821194** +**当前 v2 版本已正式发布，此 master 分支为 2.0 版本，如需查看 v1 版本，请移步 `v1-legacy` 分支！** +**2.0 版本如果有问题请第一时间加群反馈！** ## 简介 -zhamao-framework 是一个 PHP Swoole 的聊天机器人框架，兼容 OneBot 标准，它会对微信公众号等终端收到的消息进行解析处理，并以模块化的形式进行开发，来完成机器人的自然语言对话等功能。 +炸毛框架使用 PHP 编写，采用 Swoole 扩展为基础，主要面向 API 服务，聊天机器人（OneBot 兼容的 QQ 机器人对接），包含 Websocket、HTTP 等监听和请求库，用户代码采用模块化处理，使用注解可以方便地编写各类功能。 -除了起到解析消息的作用，炸毛框架 还提供了完整的 WebSocket + HTTP 服务器，你还能用此框架构建出高性能的 API 接口服务器。 +框架主要用途为 HTTP 服务器，机器人搭建框架。尤其对于 QQ 机器人消息处理较为方便和全面，提供了众多会话机制和内部调用机制，可以以各种方式设计你自己的模块。 + +```php +/** + * @CQCommand("你好") + */ +public function hello() { + ctx()->reply("你好，我是炸毛！"); // 简单的命令式回复 +} +/** + * @RequestMapping("/index") + */ +public function index() { + return "

hello!

"; // 快速的 HTTP 服务开发 +} +``` ## 开始 -先安装环境，环境安装见下方文档。 -1. `composer create-project zhamao/framework-starter` 从模板新建基础文档结构进行使用 -2. 你也可以直接到 **Release** 中下载最新的 phar 包，放入文件夹后 `php server.phar` 快速启动框架 -3. 还可以使用 Dockerfile 构建 Docker 容器 +框架首先需要部署环境，可以参考下方文档中部署环境和框架的方法进行。 -## 文档 +## 文档（v2 版本） 查看文档：[https://docs-v2.zhamao.xin/](https://docs-v2.zhamao.xin/) 备用链接：[http://docs-v2.zhamao.me/](http://docs-v2.zhamao.me/) @@ -41,42 +51,20 @@ zhamao-framework 是一个 PHP Swoole 的聊天机器人框架，兼容 OneBot ## 特点 - 支持多账号 +- 使用 Swoole 多工作进程机制和协程加持，尽可能简单的情况下提升了性能 - 灵活的注解事件绑定机制 - 支持下断点调试（Psysh） - 易用的上下文，模块内随处可用 -- 采用模块化编写，功能之间高内聚低耦合 +- 采用模块化编写，可单独拆装功能 - 常驻内存，全局缓存变量随处使用 -- 自带 MySQL 查询器、数据库连接池等数据库连接方案 +- 自带 MySQL、Refis 等数据库连接池等数据库连接方案 - 自带 HTTP 服务器、WebSocket 服务器可复用，可以构建属于自己的 HTTP API 接口 - 静态文件服务器 -- 支持 phar 一键打包 -## 炸毛特色模块 +## 从 v1 升级 +炸毛框架 v2 相对 v1 版本改动了不少内容，其中包括框架底层机制、注解事件分发、调试、命名空间等变化，详情可查看上方文档。 -| 模块名称 | 说明 | 模块地址 | -| ------------------ | -------------------------------- | ------------------------------------------------------------ | -| 通用模块 | 图片上传和下载模块 | [zhamao-general-tools](https://github.com/zhamao-robot/zhamao-general-tools) | - -## 计划开发内容 -- [X] WebSocket测试脚本（客户端） -- [X] Session 和中间层管理模块 -- [X] 常驻服务脚本 -- [X] 一些常用的通用 API 例如经济（用户积分、亲密度等）的模块 -- [ ] 图灵机器人/腾讯AI 聊天模块 -- [ ] 分词模块（可能会放弃计划，因为目前好用的分词都是其他语言的） -- [ ] HTTP 过滤器、Auth 模块、完整的 MVC 兼容（可能会放弃计划，因为框架主打机器人开发） -- [X] Redis 连接池或开箱即用的相应功能内置 -- [X] 1.3 版本使用上下文代替 -- [X] 更好的 Logger，稳定和漂亮的控制台输出 -- [ ] 日志服务 -- [X] 框架支持 Phar 打包（可能会比较靠后支持） -- [X] 完整的单元测试（如果有需求则尽快开发） -- [X] 静态文件服务器 - -## 从 cqbot-swoole 升级 -目前新的框架采用了全新的注解机制，所以旧版的框架上写的模块到新框架需要重新编写。当然为了减少工作量，新的框架也最大限度地保留了旧版框架编写的风格，一般情况下根据新版框架的文档仅需修改少量地方即可完成重写。 - -旧版框架并入了 `old` 分支，如果想继续使用旧版框架请移步分支。升级过程中如果遇到问题可以找作者。 +如果旧版框架使用过程中无问题且对新功能暂无需求，可以继续使用 v1 版本，后续也将维护安全类更新和修复致命 bug。 ## 贡献和捐赠 如果你在使用过程中发现任何问题，可以提交 Issue 或自行 Fork 后修改并提交 Pull Request。目前项目仅一人维护，耗费精力较大，所以非常欢迎对框架的贡献。 @@ -88,6 +76,8 @@ zhamao-framework 是一个 PHP Swoole 的聊天机器人框架，兼容 OneBot ### 支付宝 ![支付宝二维码](/resources/images/alipay_img.jpg) +如果你对我们的周边感兴趣，我们还有炸毛机器人定制 logo 的雨伞，详情咨询作者 QQ，我们会作为您捐助了本项目！ + ## 关于 框架和 SDK 是 炸毛机器人 项目的核心框架开源部分。炸毛机器人是作者写的一个高性能机器人，曾获全国计算机设计大赛一等奖。 @@ -96,3 +86,7 @@ zhamao-framework 是一个 PHP Swoole 的聊天机器人框架，兼容 OneBot 本项目在更新内容时，请及时关注 GitHub 动态，更新前请将自己的模块代码做好备份。 项目框架采用 Apache-2.0 协议开源，在分发或重写修改等操作时需遵守协议。项目模块部分(`Module` 文件夹) 在非借鉴框架内代码时可不遵守 Apache-2.0 协议进行分发和修改(声明版权)。 + +**注意**：在你使用 mirai 等 `AGPL-3.0` 协议的机器人软件与框架连接时，使用本框架需要将你编写或修改的部分使用 `AGPL-3.0` 协议重新分发。 + +![star](https://starchart.cc/zhamao-robot/zhamao-framework.svg) \ No newline at end of file