README.md

YiriMirai

在新的维护者到来前，建议换用 Graia Ariadne 等活跃维护的项目，也请关注原开发者的下一代 QQ 无头客户端支持库 awr。

本项目现由 XYCode-Kerman 进行维护，新版本将于不久后发布

Caution

由于某公司一直以来都在加强某聊天软件的登录风控，导致现 Mirai 的用户群体大不如前，而 YiriMirai 是与 mirai-api-http 项目耦合的库，因此我们决定停止维护该库。

同时，我们建议换用 YiriMiraiOneBot，该库提供和 YiriMirai 风格相似的API，兼容 OneBot 11/12 标准。有关该库0.0.1版本的开发工作，将会在 2024/7/15 左右完成。

需要注意，YiriMiraiOneBot 只是延续了 YiriMirai 的项目名称和API风格，但其并不与 Mirai 项目或其的生态绑定，API 名称也与 YiriMirai 不同。

一个轻量级、低耦合度的基于 mirai-api-http 的 Python SDK。

本项目适用于 mirai-api-http 2.0 以上版本。

安装

从 PyPI 安装：

pip install yiri-mirai
# 或者使用 poetry
poetry add yiri-mirai

此外，你还可以克隆这个仓库到本地，然后使用 poetry 安装：

git clone [email protected]:Wybxc/YiriMirai.git
cd YiriMirai
poetry install

使用

from mirai import Mirai, FriendMessage, WebSocketAdapter

if __name__ == '__main__':
    bot = Mirai(12345678, adapter=WebSocketAdapter(
        verify_key='your_verify_key', host='localhost', port=6090
    ))

    @bot.on(FriendMessage)
    async def on_friend_message(event: FriendMessage):
        if str(event.message_chain) == '你好':
            await bot.send(event, 'Hello World!')

    bot.run()

更多信息参看文档或文档镜像。

社区

QQ 群：766952599（链接）

Github Discussion（链接）

Discord（链接）

开源协议

由于 mirai 及 mirai-api-http 均采用了 AGPL-3.0 开源协议，本项目同样采用 AGPL-3.0 协议。

请注意，AGPL-3.0 是传染性协议。如果你的项目引用了 YiriMirai，请在发布时公开源代码，并同样采用 AGPL-3.0 协议。