
# ATRI——一个厨力项目
アトリは、高性能ですから!
[](https://wakatime.com/badge/github/Kyomotoi/ATRI)
[](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)
## 关于(About)
本项目名称、灵感均来自 [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/)查看相关内容
为QQ群中复现一个优秀的功能性机器人是本项目的目标
## 声明(Attaction)
**一切开发旨在学习,请勿用于非法用途**
## 实现(Work)
本项目可以在**任何平台**下运行,只要你具备基本的 `Python >= 3.8` 环境和一根接入互联网的网线
实现方式为 `go-cqhttp 或其它遵守Onebot标准的协议` + `NoneBot2`
因项目的特殊性,会不定时进行更新。更新日志:请关注commit
再一个:由于学业原因,在 `2022年6月` 前不会有太大的更新,当然,欢迎提交 `Pull Request`
## 功能概览(Preview)
> 此页面只展示主要功能,详细请在示例群内 **@机器人** 并发送`菜单`以获取帮助
> 如碰到示例机器人未响应,大概率是寄了
- 涩批:
- 文爱
- 涩图
- 涩图嗅探
- 涩批翻译机
- 实用:
- 在线运行代码
- 伪造转发内容
- 以图搜图
- 以图搜番
- ATRI语(加密、解密,改自[`rcnb`](https://github.com/rcnbapp/RCNB.js))
- 简单骰子
- 娱乐:
- 看不懂的笑话
- 今天吃什么
- 老婆!
- 其他:
- B站小程序解析
- 状态查看
**TODO**:
- [ ] 网页控制台
- [ ] RSS订阅
- [ ] B站动态订阅
- [ ] 冷重启
- [ ] 进裙验证(问题可自定义)
- [ ] 好感度系统(目前优先在[`go-ATRI`](https://github.com/Kyomotoi/go-ATRI)上实现)
- [ ] 模拟韭菜
## 使用 Docker 部署
> 注意,本条目仅为使用docker的部署方法,如果您不知道何为docker,请参考文档中的传统部署方法
**在开始部署前**:
请确保您拉取了最新的仓库并请确认您的 CPU 架构 ( uname -a )
### 首先请编辑 docker-compose.yml
>默认的 docker-compose.yml 为这样,请按需修改
version: "3"
services:
nonebot:
build: .
container_name: nonebot # 容器名称
ports:
- "20000:20000" # 映射端口到宿主机 宿主机端口:容器端口
network_mode: bridge
restart: unless-stopped
volumes:
- ~/.ATRI/data:/app/data # 这几条为挂载ATRI的工作数据目录与配置文件
- ~/.ATRI/accounts:/app/accounts # 挂载格式为 宿主机路径:容器路径
- ~/.ATRI/config.yml:/app/config.yml # 默认的工作路径为 ~/.ATRI 注意,该目录为隐藏目录
### 接下来请编辑 config.yml 并将其复制到工作目录下
> 默认的工作目录为 ~/.ATRI 如不存在,请 mkdir
### 请按您的处理器架构执行下列步骤
- X86 OR AMD64
> sudo docker-compose up
- ARM64 Or AARCH64
> cp ./Dockerfile ./Dockerfile_x86 && cp -f ./Dockerfile_aarch64 ./Dockerfile
> sudo docker-compose up
**首次部署时因为涉及到扫码登陆,请不要添加 -d 这一离屏参数,登陆成功后可以自行添加**
> 就算您使用 protainer 等容器管理器也应如此,二维码在 protainer 中不会正确显示
部署成功后,账号数据与 go-cqhttp 默认会保存在 ~/.ATRI/accounts 中
日志等数据默认保存在 ~/.ATRI/data 中
## 特别感谢(Thanks)
[Bot Universe](https://github.com/botuniverse): [Onebot标准](https://onebot.dev/)
[Mrs4s](https://github.com/Mrs4s): [go-cqhttp](https://github.com/Mrs4s/go-cqhttp)
[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
[JetBrains](https://www.jetbrains.com/?from=ATRI): 为本项目提供 [PyCharm](https://www.jetbrains.com/pycharm/?from=ATRI) 等 IDE 的授权
[
](https://www.jetbrains.com/?from=ATRI)
以及以下朋友们:
*/ω\*(
*排名不分现后*
· 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
· 梓哟P 23.33 CNY
· Ohdmire 20.00 CNY
· TerRALi 23.45 CNY
· 虾仁 10.00 CNY
· Tianli 11.00 CNY
## 支持(Support)
本项目已启用爱发电,你的支持就是对开发者的最大鼓励!
并会将你的ID写在项目**特别感谢**一栏。
-> https://afdian.net/@Kyomotoi
## 贡献(Contribute)
如果你在运行本项目中发现任何问题,你可以:
- [提交 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/)
## 协议(License)
本项目使用 [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) 协议
意味着你可以运行本项目,并向你的用户提供服务,但出现对本项目源码进行修改,则需要将你修改后的版本对你的用户`开源`
在运行本项目期间,行为违反当地法律法规的而被处理的,本项目概不承担任何责任