nonebot-adapter-villa 0.1.0

NoneBot2米游社大别野Bot适配器。MiHoYo Villa Bot adapter for nonebot2.

NoneBot-Adapter-Villa

✨ 大别野 协议适配 ✨

安装

• 在NoneBot2项目目录下使用脚手架安装：nb adapter install nonebot-adapter-villa

或：

• 在NoneBot2项目环境下使用pip安装后手动注册：pip install nonebot-adapter-villa

配置

修改 NoneBot 配置文件 .env 或者 .env.*。

Driver

本适配器同时需要ReverseDriver和ForwardDriver，参考 driver 配置项。

例如：

DRIVER=~fastapi+~httpx

VILLA_BOTS

配置机器人帐号列表，每个bot有3个必填配置，在大别野机器人开发者社区申请时获得，

• bot_id: 机器人id，以bot_开头
• bot_secret: 机器人密钥
• callback_url: http回调地址，例如申请bot时给的回调地址是http://域名/your/callback/url，那么配置里的callback_url填写/your/callback/url 例如：

VILLA_BOTS='
[
  {
    "bot_id": "bot_123456789",
    "bot_secret": "abc123def456",
    "callback_url": "/your/callback/url"
  }
]
'

使用

注册适配器

如使用nb脚手架来安装的，则不用手动注册

在bot.py文件中(如果没有，使用nb generate来生成)注册本适配器，参考adapter，例如：

import nonebot
from nonebot.adapters.villa import Adapter as VillaAdapter  # 导入adapter

nonebot.init()

driver = nonebot.get_driver()
driver.register_adapter(VillaAdapter) # 注册adapter

nonebot.load_from_toml("pyproject.toml")

if __name__ == "__main__":
    nonebot.run()

消息段展示

以下是一个简单的插件示例，展示各种消息段：

from nonebot import on_command
from nonebot.params import CommandArg

from nonebot.adapters.villa import Bot, SendMessageEvent, Message, MessageSegment

matcher = on_command('发送')

@matcher.handle()
async def matcher_handler(bot: Bot, event: SendMessageEvent, cmd_arg: Message = CommandArg()):
    msg = Message()
    args = cmd_arg.extract_plain_text().strip().split(' ')
    for arg in args:
        if arg == "艾特我":
            msg += MessageSegment.mention_user(event.villa_id, event.from_user_id)
        elif arg == "艾特bot":
            msg += MessageSegment.mention_robot()
            # 目前只能艾特机器人自己
        elif arg == "文字":
            msg += MessageSegment.text("文字")
            # 表情也是用text来发送，以[表情名]格式，例如MessageSegment.text("[爱心]")
        elif arg == "房间":
            msg += MessageSegment.villa_room_link(event.villa_id, event.room_id)
        elif arg == "链接":
            msg += MessageSegment.link("https://www.miyoushe.com/ys/article/39670307", "这是链接")
            # 使用link的话链接能够点击进行跳转，使用text的话不能点击
        elif arg == "图片":
            msg += MessageSegment.image("https://www.miyoushe.com/_nuxt/img/miHoYo_Game.2457753.png")
            # 暂时只支持url图片
    await matcher.finish(msg)

使用命令@bot /发送 艾特我 艾特bot 文字 房间 链接 图片时，bot会回复@你的名字 @bot的名字 文字 #房间名 这是链接 图片内容

反馈

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

相关项目

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

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

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