diff options
| -rw-r--r-- | README.md | 190 |
1 files changed, 94 insertions, 96 deletions
@@ -1,82 +1,94 @@  -# ATRI——一个厨力项目 -アトリは、高性能ですから！ +### 👋 Here is ATRI - 一个厨力项目 [](https://wakatime.com/badge/github/Kyomotoi/ATRI) +[](https://www.gnu.org/licenses/gpl-3.0.html) -[](https://www.gnu.org/licenses/gpl-3.0.html) -[](https://jq.qq.com/?_wv=1027&k=a89kfKQE) +アトリは、高性能ですから！ -- 文档: - - [传送门 1](https://atri.kyomotoi.moe) - - [传送门 2](https://project-atri-docs.vercel.app) +为🐧即时聊天工具中复现一只优秀的**功能性**机器人是本项目的目标. -- [更新日志](changelog.md) +## 📌 声明 | Declarations -## 关于（About） +**一切开发旨在学习，请勿用于非法用途** -本项目名称、灵感均来自 [ANIPLEX](https://aniplex-exe.com/) 发行的 [ATRI-My Dear Moments-](https://atri-mdm.com/) +本项目名称、灵感均来自 [ANIPLEX](https://aniplex-exe.com/) 发行的 [ATRI-My Dear Moments-](https://atri-mdm.com/). -本项目中所使用的任何有关 ATRI 的图标、LOGO，解释权、著作权均归 [ANIPLEX](https://aniplex-exe.com/)。你可以[在此](https://aniplex-exe.com/guidelines/)查看相关内容 +本项目中所使用的任何有关 [ATRI](https://atri-mdm.com/) 的图标、LOGO，解释权、著作权均归 [ANIPLEX](https://aniplex-exe.com/). 你可以[在此](https://aniplex-exe.com/guidelines/)查看相关内容. -为QQ群中复现一个优秀的功能性机器人是本项目的目标 +## ✨ 特性概览 | Features -## 声明（Warning） +- 使用 [NoneBot 2](https://v2.nonebot.dev/) 进行项目底层构建. +- 使用 [go-cqhttp](https://go-cqhttp.org/) 作为默认协议端. +- 遵循 [OneBot v11](https://onebot.dev/) 规范. +- 易于上手的 [可视化界面](https://github.com/Kyomotoi/Project-ATRI-Console). +- Comming soon... -**一切开发旨在学习，请勿用于非法用途** +## 📱 功能概览 | Service Overview + +<details markdown='1'><summary>涩涩</summary> + +- 文爱 +- 涩图 +- 涩图嗅探 +- 涩批翻译机 +</details> + +<details markdown='1'><summary>实用</summary> + +- 在线运行代码 +- 伪造转发内容 +- 以图搜图 +- 以图搜番 +- ATRI语（加密、解密，改自[`rcnb`](https://github.com/rcnbapp/RCNB.js)） +- 简单骰子 +- b站动态订阅 +</details> -## 实现（Work） +<details markdown='1'><summary>娱乐</summary> -本项目可以在**任何平台**下运行，只要你具备基本的 `Python >= 3.8` 环境和一根接入互联网的网线 +- 看不懂的笑话 +- 今天吃什么 +- 老婆！ +</details> -实现方式为 `go-cqhttp 或其它遵守Onebot标准的协议` + `NoneBot2` +<details markdown='1'><summary>其它</summary> -因项目的特殊性，会不定时进行更新。更新日志：请关注commit +- B站小程序解析 +- 状态查看 +</details> -再一个：由于学业原因，在 `2022年6月` 前不会有太大的更新，当然，欢迎提交 `Pull Request` +<details markdown='1'><summary>TODO</summary> -## 功能概览（Preview） +> 被勾上的即已大致完成，但仍需优化 +- [x] 网页控制台 +- [ ] RSS订阅 +- [x] B站动态订阅 +- [ ] 冷重启 +- [ ] 进裙验证（问题可自定义） +- [ ] 好感度系统 +- [ ] 模拟韭菜 +</details> -> 此页面只展示主要功能，详细请在示例群内 **@机器人** 并发送`菜单`以获取帮助 +## 🚀 开始部署 | Getting Started -> 如碰到示例机器人未响应，大概率是寄了 +请参考文档: [部署项目](https://atri.kyomotoi.moe/install/installation/) -- 涩批: - - 文爱 - - 涩图 - - 涩图嗅探 - - 涩批翻译机 +## 📖 文档 | Documentation +所有公开的信息都可在 [atri.kyomotoi.moe](https://atri.kyomotoi.moe) 获取. 使用 [MkDocs](https://github.com/mkdocs/mkdocs/) 构建. -- 实用: - - 在线运行代码 - - 伪造转发内容 - - 以图搜图 - - 以图搜番 - - ATRI语（加密、解密，改自[`rcnb`](https://github.com/rcnbapp/RCNB.js)） - - 简单骰子 - - b站动态订阅 +对于 Mainland 用户**无法**访问: [文档](https://project-atri-docs.vercel.app/). -- 娱乐: - - 看不懂的笑话 - - 今天吃什么 - - 老婆！ +[文档仓库](https://github.com/Kyomotoi/Project-ATRI-Docs) -- 其他: - - B站小程序解析 - - 状态查看 +## ⚡️ 性能表现 | Performance -**TODO**: +得益于强大的 [NoneBot 2](https://v2.nonebot.dev/) 和 [go-cqhttp](https://go-cqhttp.org/)，真正意义上实现：全平台运行、运行时资源占用极少. - - [ ] 网页控制台 - - [ ] RSS订阅 - - [x] B站动态订阅 - - [ ] 冷重启 - - [ ] 进裙验证（问题可自定义） - - [ ] 好感度系统（目前优先在[`go-ATRI`](https://github.com/Kyomotoi/go-ATRI)上实现） - - [ ] 模拟韭菜 +## 🔊 更新日志 | Changelog -## 特别感谢（Thanks） +## ❤️ 特别感谢 | Acknowledgments [Bot Universe](https://github.com/botuniverse): [Onebot标准](https://onebot.dev/) @@ -84,60 +96,46 @@ [NoneBot](https://github.com/nonebot): [NoneBot2](https://github.com/nonebot/nonebot2) -[Richard Chien](https://github.com/richardchien), [Mnixry](https://github.com/mnixry) and GoCQHTTP Dev Group +[Richard Chien](https://github.com/richardchien), [Mnixry](https://github.com/mnixry) and go-cqhttp Developers. [JetBrains](https://www.jetbrains.com/?from=ATRI): 为本项目提供 [PyCharm](https://www.jetbrains.com/pycharm/?from=ATRI) 等 IDE 的授权<br> -[<img src="https://cdn.jsdelivr.net/gh/Kyomotoi/CDN@master/noting/jetbrains-variant-3.png" width="200"/>](https://www.jetbrains.com/?from=ATRI) - -以及以下朋友们： -<details markdown='1'><summary>*/ω＼*(</summary> - *排名不分现后*<br> - · 50861735 11.00 CNY<br> - · 1072324725 17.00 CNY<br> - · AfdianUser_quGy 5.00 CNY<br> - · 1752179928 56.14 CNY<br> - · Mikasa 66.00 CNY<br> - · SkipM4 32.00 CNY<br> - · Chunk7 33.00 CNY<br> - · Wwwwwwalnut 10.00 CNY<br> - · 演变 5.00 CNY<br> - · 梓哟P 23.33 CNY<br> - · Ohdmire 20.00 CNY<br> - · TerRALi 23.45 CNY<br> - · 虾仁 10.00 CNY<br> - · Tianli 11.00 CNY +[<img src="https://cdn.jsdelivr.net/gh/Kyomotoi/CDN@master/noting/jetbrains-variant-3.png" width="150"/>](https://www.jetbrains.com/?from=ATRI) + +<details markdown='1'><summary>以及以下朋友们！</summary> + +>排名不分现后 +- 50861735 11.00 CNY +- 1072324725 17.00 CNY +- AfdianUser_quGy 5.00 CNY +- 1752179928 56.14 CNY +- Mikasa 66.00 CNY +- SkipM4 32.00 CNY +- Chunk7 33.00 CNY +- Wwwwwwalnut 10.00 CNY +- 演变 5.00 CNY +- YuimeC 23.33 CNY +- Ohdmire 20.00 CNY +- TerRALi 23.45 CNY +- 虾仁 21.00 CNY +- Tianli 11.00 CNY +- linx 33.00 CNY +- 屁东 5.00 CNY +> Total: 343.92 CNY. 16 supporters. </details> -## 支持（Support） - -本项目已启用爱发电，你的支持就是对开发者的最大鼓励！ - -并会将你的ID写在项目**特别感谢**一栏。 +## 👥 贡献 | Contribution --> https://afdian.net/@Kyomotoi - -## 贡献（Contribute） - -如果你在运行本项目中发现任何问题，你可以： +如果你喜欢本项目，可以请我[喝杯红茶](https://afdian.net/@Kyomotoi). +如果你有想法，有能力，欢迎: - [提交 Issue](https://github.com/Kyomotoi/ATRI/issues) - [提交 Pull request](https://github.com/Kyomotoi/ATRI/pulls) -- [在反馈群内进行反馈](https://jq.qq.com/?_wv=1027&k=WoAAYXbJ) - - -- 提交 `Pull request` 时，请注意： - - - 所提交的代码尽量与原仓库代码风格保持一致 - - 遵守 [`PEP-8`](https://www.python.org/dev/peps/pep-0008/) 标准 - - 变量名清晰明了 - - 包含单元测试（对插件的修改/添加） - - 如果你是初次提交 `Pull request`，请先阅读[这篇文章](https://atri.kyomotoi.moe/developer/overview/) +- [在交流群内进行反馈](https://jq.qq.com/?_wv=1027&k=WoAAYXbJ) -## 协议（License） +在提交 Issue、Pull request 前，请先阅读[此内容](https://atri.kyomotoi.moe/developer/overview/). -本项目使用 [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) 协议 +## 📄 许可 | License -意味着你可以运行本项目，并向你的用户提供服务，但出现对本项目源码进行修改，则需要将你修改后的版本对你的用户`开源` +本项目使用 [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html). -在运行本项目期间，行为违反当地法律法规的而被处理的，本项目概不承担任何责任 +意味着你可以运行本项目，并向你的用户提供服务，如后续有对本项目源码的修改，你需要向用户公开修改后的此项目的源码. |