Skip to content
This repository has been archived by the owner on Feb 20, 2024. It is now read-only.
/ villa-py Public archive

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

License

Notifications You must be signed in to change notification settings

CMHopeSunshine/villa-py

Repository files navigation

Villa

✨ 米游社大别野Bot Python SDK ✨

license version python pypi download wakatime ruff

重要通知

因作者时间和精力问题,本 SDK 将暂停更新,强烈建议使用 NoneBot2+ nonebot-adapter-villa 来开发大别野 Bot,NoneBot 有着丰富的功能和生态,以及完善的文档和众多插件供学习,对大别野的支持也是最新的,强烈建议各位开发者使用 NoneBot 替换本 SDK。

特性

  • 基于FastAPIPydantic,异步优先、快速、高性能!
  • 完整的类型注解支持,便于开发。
  • 便捷的消息构造和发送方法。
  • 完整的消息段和API支持。
  • Serverless云函数支持。
  • More 想不出来了

安装

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

快速开始

你需要一个米游社大别野的 Bot,可前往大别野「机器人开发者社区」(ID: OpenVilla)申请,取得bot_idbot_secretpub_key

from villa import Bot
from villa.event import SendMessageEvent

bot = Bot(
    bot_id="your_bot_id",
    bot_secret="your_bot_secret",
    pub_key="-----BEGIN PUBLIC KEY-----\nyour_pub_key\n-----END PUBLIC KEY-----\n",
    callback_url="your_callback_url_endpoint",
)
# 初始化Bot,填写你的bot_id、密钥、pub_key以及回调地址endpoint
# 举例:若申请时提供的回调地址为https://域名/callback,这里的callback_url就填`/callback`

@bot.on_startswith("hello")
async def handler(event: SendMessageEvent):
    await event.send("world!")
    # 一个简单的处理函数,向你的Bot发送包含`hello`关键词的消息,它将会回复你`world`!


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

示例

详见 example 文件夹:

交流、建议和反馈

注意:本SDK并非官方SDK

大别野 Bot 和本 SDK 均为开发测试中,如遇问题请提出 issue ,感谢支持!

也欢迎来我的大别野「尘世闲游」(ID: wgiJNaU)进行交流~

相关项目

About

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

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Languages