akari-bot/README.md

<div align="center">
  <img width="256" src="./assets/character_marked.png" alt="logo">

# 小可 · AkariBot v4

</div>

![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 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) ![GitHub Repo stars](https://img.shields.io/github/stars/Teahouse-Studios/bot?style=social)

## 介绍

**小可**是基于多个框架开发的可扩展、多平台机器人。图标由 [Rin 十一](https://mihuashi.com/profiles/75826?role=painter)绘制。

目前小可还正在持续开发中。

## 平台

小可目前支持以下平台：

-   QQ
-   Discord
-   Telegram
-   Kook
-   Matrix

## 运行

### 公共实例

茶馆工作室和问谛居共同提供小可的公共实例。

#### QQ

~~目前 QQ 上稳定运行的小可实例为小可三号机。由于腾讯风控问题，请[在此提交](https://github.com/Teahouse-Studios/akari-bot/issues/new?assignees=OasisAkari&labels=New&template=add_new_group.yaml&title=%5BNEW%5D%3A+)入群申请。~~

~~QQ 频道的测试版支持也请在上方链接申请。~~

你也可以加入我们的 QQ 公共实例测试群：[738829671](http://qm.qq.com/cgi-bin/qm/qr?k=nXkV2SUP_WWlCuSzzpnKJK_uYkG7n1im)

我们正在进行 QQ 频道官方机器人入驻，未来可能会成为官方认证的机器人。

#### Discord

邀请链接：<https://discord.com/oauth2/authorize?client_id=879379218209861712&scope=bot&permissions=259846044864>

#### Telegram

链接：<https://t.me/oasisakaribot>，支持私聊和群聊。

#### Kook

邀请链接：<https://www.kookapp.cn/app/oauth2/authorize?id=19512&permissions=949248&client_id=xiDWoVygvPsP6bov&redirect_uri=&scope=bot>

### 自搭建

你可以参考[此处](./docs/DEPLOY.md)来尝试搭建。

若遇到问题，可以通过 [Issue](https://github.com/Teahouse-Studios/akari-bot/issues/new) 或其他方式咨询开发者。

### 多语言

你可以前往 [Crowdin](https://crowdin.com/project/akari-bot) 参与改进小可的多语言支持。

关于多语言规范的详细说明，请见[此处](./docs/LOCALES.md)。

### 贡献

如你想为我们编写新的模块，可以看看[这里](https://bot.teahouse.team/wiki/%E6%96%B0%E5%BB%BA%E6%A8%A1%E5%9D%97%E6%8C%87%E5%8D%97)。

## 许可

小可使用 AGPL-3.0 协议授权。详见 [./LICENSE](./LICENSE)。
new character logo 2022-09-22 10:07:01 +00:00			`<div align="center">`
			`<img width="256" src="./assets/character_marked.png" alt="logo">`
Create README.md 2020-06-13 13:58:28 +00:00
new character logo 2022-09-22 10:07:01 +00:00			`# 小可 · AkariBot v4`
Update DEPLOY.md 2023-01-27 12:37:08 +00:00
new character logo 2022-09-22 10:07:01 +00:00			`</div>`
Update README.md 2022-09-22 10:07:50 +00:00
Update docs 2024-01-19 13:29:08 +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 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) ![GitHub Repo stars](https://img.shields.io/github/stars/Teahouse-Studios/bot?style=social)
Update README.md 内容正在大幅调整中，可能不适合用于追求稳定性的运维 2021-09-14 14:55:19 +00:00
Write some readme 2021-11-06 14:58:02 +00:00			`## 介绍`
autoformat 2022-01-20 12:13:03 +00:00
Update 2023-08-14 13:53:28 +00:00			`小可是基于多个框架开发的可扩展、多平台机器人。图标由 [Rin 十一](https://mihuashi.com/profiles/75826?role=painter)绘制。`
Write some readme 2021-11-06 14:58:02 +00:00
			`目前小可还正在持续开发中。`

			`## 平台`
autoformat 2022-01-20 12:13:03 +00:00
Write some readme 2021-11-06 14:58:02 +00:00			`小可目前支持以下平台：`
autoformat 2022-01-20 12:13:03 +00:00
Update DEPLOY.md 2023-01-27 12:37:08 +00:00			`- QQ`
			`- Discord`
			`- Telegram`
update 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`
Write some readme 2021-11-06 14:58:02 +00:00
			`## 运行`
autoformat 2022-01-20 12:13:03 +00:00
Write some readme 2021-11-06 14:58:02 +00:00			`### 公共实例`
autoformat 2022-01-20 12:13:03 +00:00
Write some readme 2021-11-06 14:58:02 +00:00			`茶馆工作室和问谛居共同提供小可的公共实例。`

Update docs 2024-01-19 13:29:08 +00:00			`#### QQ`
autoformat 2022-01-20 12:13:03 +00:00
Update docs 2024-01-19 13:29:08 +00:00			`~~目前 QQ 上稳定运行的小可实例为小可三号机。由于腾讯风控问题，请[在此提交](https://github.com/Teahouse-Studios/akari-bot/issues/new?assignees=OasisAkari&labels=New&template=add_new_group.yaml&title=%5BNEW%5D%3A+)入群申请。~~`

			`~~QQ 频道的测试版支持也请在上方链接申请。~~`

Update README.md 2024-01-25 03:15:00 +00:00			`你也可以加入我们的 QQ 公共实例测试群：[738829671](http://qm.qq.com/cgi-bin/qm/qr?k=nXkV2SUP_WWlCuSzzpnKJK_uYkG7n1im)`
Update README.md 2024-01-23 14:39:48 +00:00
Update docs 2024-01-19 13:29:08 +00:00			`我们正在进行 QQ 频道官方机器人入驻，未来可能会成为官方认证的机器人。`
Write some readme 2021-11-06 14:58:02 +00:00
			`#### Discord`
autoformat 2022-01-20 12:13:03 +00:00
Fix ~github search 2021-11-20 01:35:38 +00:00			`邀请链接：<https://discord.com/oauth2/authorize?client_id=879379218209861712&scope=bot&permissions=259846044864>`
Write some readme 2021-11-06 14:58:02 +00:00
Update docs 2024-01-19 13:29:08 +00:00			`#### Telegram`
Write some readme 2021-11-06 14:58:02 +00:00
Update docs 2024-01-19 13:29:08 +00:00			`链接：<https://t.me/oasisakaribot>，支持私聊和群聊。`
Fix ~github search 2021-11-20 01:35:38 +00:00
update 2023-06-30 07:59:11 +00:00			`#### Kook`

Update README.md 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>`
update 2023-06-30 07:59:11 +00:00
Write some readme 2021-11-06 14:58:02 +00:00			`### 自搭建`
autoformat 2022-01-20 12:13:03 +00:00
Update docs 2024-01-19 13:29:08 +00:00			`你可以参考[此处](./docs/DEPLOY.md)来尝试搭建。`
add DEPOLY.md 2022-06-15 00:31:31 +00:00
Add LOCALES.md (#1055) 2023-12-14 09:59:52 +00:00			`若遇到问题，可以通过 [Issue](https://github.com/Teahouse-Studios/akari-bot/issues/new) 或其他方式咨询开发者。`
Write some readme 2021-11-06 14:58:02 +00:00
Update README.md 2023-03-02 03:58:40 +00:00			`### 多语言`

Update docs 2024-01-19 13:29:08 +00:00			`你可以前往 [Crowdin](https://crowdin.com/project/akari-bot) 参与改进小可的多语言支持。`

update LOCALES.md 2024-01-19 14:13:26 +00:00			`关于多语言规范的详细说明，请见[此处](./docs/LOCALES.md)。`
Update README.md 2023-03-02 03:58:40 +00:00
add information about writing new module 2021-11-27 15:04:48 +00:00			`### 贡献`
autoformat 2022-01-20 12:13:03 +00:00
Update locales 2024-01-28 10:03:05 +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)。`
add information about writing new module 2021-11-27 15:04:48 +00:00
Write some readme 2021-11-06 14:58:02 +00:00			`## 许可`
autoformat 2022-01-20 12:13:03 +00:00
Update README.md 2022-05-03 15:32:05 +00:00			`小可使用 AGPL-3.0 协议授权。详见 [./LICENSE](./LICENSE)。`