Archived
1
0
Fork 0
This repository has been archived on 2024-04-26. You can view files and clone it, but cannot push or open issues or pull requests.
akari-bot/README.md

69 lines
2.4 KiB
Markdown
Raw Normal View History

2022-09-22 10:07:01 +00:00
<div align="center">
<img width="256" src="./assets/character_marked.png" alt="logo">
2020-06-13 13:58:28 +00:00
2022-09-22 10:07:01 +00:00
# 小可 · AkariBot v4
2023-01-27 12:37:08 +00:00
2022-09-22 10:07:01 +00:00
</div>
2022-09-22 10:07:50 +00:00
2023-03-02 12:02:56 +00:00
![GitHub issues](https://img.shields.io/github/issues/Teahouse-Studios/bot) ![GitHub pull requests](https://img.shields.io/github/issues-pr/Teahouse-Studios/bot) ![License](https://img.shields.io/github/license/Teahouse-Studios/bot) ![GitHub Repo stars](https://img.shields.io/github/stars/Teahouse-Studios/bot?style=social) ![GitHub tag](https://img.shields.io/github/v/tag/Teahouse-Studios/bot?include_prereleases) [![Crowdin](https://badges.crowdin.net/akari-bot/localized.svg)](https://crowdin.com/project/akari-bot)
2021-11-06 14:58:02 +00:00
## 介绍
2022-01-20 12:13:03 +00:00
2023-08-14 13:53:28 +00:00
**小可**是基于多个框架开发的可扩展、多平台机器人。图标由 [Rin 十一](https://mihuashi.com/profiles/75826?role=painter)绘制。
2021-11-06 14:58:02 +00:00
目前小可还正在持续开发中。
## 平台
2022-01-20 12:13:03 +00:00
2021-11-06 14:58:02 +00:00
小可目前支持以下平台:
2022-01-20 12:13:03 +00:00
2023-01-27 12:37:08 +00:00
- QQ
- Discord
- Telegram
2023-06-30 07:59:11 +00:00
- Kook
feat: partial matrix support (#680) * build(deps): add matrix-nio * build(deps): update requirements.txt for matrix-nio * feat: add example config for matrix * feat: init matrix support * feat: do init sync to avoid receiving old messages * feat: store next sync batch with file * feat: parse matrix message * feat: check moderator permission * feat: redacting message * feat: toMessageChain for m.text and m.image * feat: drop m.notice messages * feat: sending messages * fix: power level fetching * fix: rich reply fallback stripping * style: less log * feat: guess image content type * fix: image upload * feat: sending audio * chore: add todo * chore: add todo * fix: use FinS.result to store room id As the spec, room_id is an opaque identifier, and at least all valid ASCII characters except '/' and ':' can be included in room_id. This means in some servers, '|' may be included in room_id. * fix: print RoomSendError * fix: public rooms with two user are regarded as DM * feat: resolving pm * fix: nio.ErrorResponse * feat: add post test * feat: pm post test * Revert "feat: pm post test" This reverts commit 3688213c802562b7f27ecf8fe88269d911036d60. * Revert "feat: add post test" This reverts commit 259fcf54ca92a6d20ada99ddcda7fcc8ded63675. * feat: create TPM room * feat: send typing notifications * feat: leave empty room * feat: rich reply formatted fallback support * fix: import * fix: include body in formatted rich reply fallbacks * fix: escape line breaks in html * fix: <br/> tag * feat: improve matrix direct messaging * feat: parse m.emote as m.text * fix: command run blockingly * fix: message send error handle * fix: keep DM room * fix: reuse of DM rooms * feat: add error log * docs: add deploy guide for matrix * docs: add matrix to readme * docs: add more warning * style: remove explictly type declartion (poljar/matrix-nio#417) * feat: receive audio message * feat: standard rich-reply fallback for m.emote * chore: add matrix to bug report issues template
2023-07-30 09:41:01 +00:00
- Matrix
2021-11-06 14:58:02 +00:00
## 运行
2022-01-20 12:13:03 +00:00
2021-11-06 14:58:02 +00:00
### 公共实例
2022-01-20 12:13:03 +00:00
2021-11-06 14:58:02 +00:00
茶馆工作室和问谛居共同提供小可的公共实例。
#### Telegram
2022-01-20 12:13:03 +00:00
2021-11-06 14:58:02 +00:00
链接:<https://t.me/oasisakaribot>,支持私聊和群聊。
#### Discord
2022-01-20 12:13:03 +00:00
2021-11-20 01:35:38 +00:00
邀请链接:<https://discord.com/oauth2/authorize?client_id=879379218209861712&scope=bot&permissions=259846044864>
2021-11-06 14:58:02 +00:00
#### QQ
2022-01-20 12:13:03 +00:00
2023-08-14 13:53:28 +00:00
目前 QQ 上稳定运行的小可实例为小可三号机。由于腾讯风控问题,请[在此提交](https://github.com/Teahouse-Studios/bot/issues/new?assignees=OasisAkari&labels=New&template=add_new_group.yaml&title=%5BNEW%5D%3A+)入群申请。
2021-11-06 14:58:02 +00:00
2023-05-19 07:17:23 +00:00
此外,你也可以加入我们的测试 QQ 群来测试命令738829671
2023-05-15 13:45:55 +00:00
2023-01-27 12:37:08 +00:00
QQ 频道的测试版支持也请在上方链接申请。我们正在进行 QQ 频道官方机器人入驻,未来可能会成为官方认证的机器人。
2021-11-20 01:35:38 +00:00
2023-06-30 07:59:11 +00:00
#### Kook
2023-06-30 08:11:43 +00:00
邀请链接:<https://www.kookapp.cn/app/oauth2/authorize?id=19512&permissions=949248&client_id=xiDWoVygvPsP6bov&redirect_uri=&scope=bot>
2023-06-30 07:59:11 +00:00
2021-11-06 14:58:02 +00:00
### 自搭建
2022-01-20 12:13:03 +00:00
2023-08-14 13:53:28 +00:00
你可以[参考这里](./DEPLOY.md)来进行尝试搭建。
2022-06-15 00:31:31 +00:00
2023-05-19 07:17:23 +00:00
若遇到问题,可以通过 [Issue](https://github.com/Teahouse-Studios/bot/issues/new) 或其他方式咨询开发者。
2021-11-06 14:58:02 +00:00
2023-03-02 03:58:40 +00:00
### 多语言
2023-08-14 13:53:28 +00:00
关于小可的多语言问题,可前往 [Crowdin](https://crowdin.com/project/akari-bot) 参与改进。
2023-03-02 03:58:40 +00:00
### 贡献
2022-01-20 12:13:03 +00:00
2023-08-14 13:53:28 +00:00
如您想为我们编写新的模块,可以看看[这里](https://bot.teahouse.team/wiki/%E6%96%B0%E5%BB%BA%E6%A8%A1%E5%9D%97%E6%8C%87%E5%8D%97)。
2021-11-06 14:58:02 +00:00
## 许可
2022-01-20 12:13:03 +00:00
2022-05-03 15:32:05 +00:00
小可使用 AGPL-3.0 协议授权。详见 [./LICENSE](./LICENSE)。