villa 0.3.0

米游社大别野Bot Python SDK。MiHoYo Villa Bot Python SDK.

Villa

✨ 米游社大别野Bot Python SDK ✨

特性

• 基于FastAPI和Pydantic，异步、快速、高性能！
• 完整的类型注解支持
• 便捷的消息构造和发送方法
• 丰富的消息段和完整的API支持
• 想不出来了

安装

• 使用pip: pip install villa
• 使用poetry: poetry add villa
• 使用pdm: pdm add villa

快速开始

首先你需要一个米游社大别野的Bot，如果没有请先到机器人开发者社区(别野ID: OpenVilla)申请，取得bot_id、bot_secret

from villa import Bot
from villa.event import SendMessageEvent

bot = Bot(bot_id="your_bot_id", bot_secret="your_bot_secret", callback_url="your_callback_url")
# 初始化Bot，填写你的bot_id、密钥以及回调地址

@bot.on_startswith("hello")
async def handler(event: SendMessageEvent):
    await event.send("world!")
    # 一个简单的处理函数，向你的Bot发送`@Bot hello`，它将会回复你`world`！


if __name__ == "__main__":
    bot.run(host="127.0.0.1", port=13350)
    # 启动bot，注意，port端口号要和你的回调地址对上

使用说明

详见example文件夹：

• single_bot.py: 单Bot运行
• multiple_bots.py: 多Bot运行
• handle_func.py: 各种处理器介绍
• send_message.py: 各种消息发送方法介绍

反馈

目前无论是大别野Bot还是本SDK都在测试开发中，如遇问题请提出issue，感谢支持！

也欢迎来我的大别野【尘世闲游】进行交流~

• 大别野ID: wgiJNaU
• Web端链接

相关项目

• NoneBot2 非常好用的Python跨平台机器人框架！
• nonebot-adapter-villa NoneBot2的大别野Bot适配器。

推荐有成熟Python开发经验但对NoneBot2不熟悉的小伙伴选择本SDK，

对NoneBot2熟悉或希望接触更成熟的生态的小伙伴选择NoneBot2+Villa适配器进行开发。