{"id":27283779,"url":"https://github.com/windowssov8forus/nonebot-plugin-tsugu-bangdream-bot","last_synced_at":"2025-04-11T18:38:33.571Z","repository":{"id":240001541,"uuid":"801379202","full_name":"WindowsSov8forUs/nonebot-plugin-tsugu-bangdream-bot","owner":"WindowsSov8forUs","description":"Koishi-Plugin-Tsugu-BanGDream-Bot 的 NoneBot2 实现","archived":false,"fork":false,"pushed_at":"2025-04-04T16:36:11.000Z","size":117,"stargazers_count":11,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-04T17:31:47.384Z","etag":null,"topics":["bangdream","bot","nonebot","nonebot2","plugin","python","tsugu"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WindowsSov8forUs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-16T05:50:47.000Z","updated_at":"2025-04-04T16:35:13.000Z","dependencies_parsed_at":"2024-12-26T02:37:39.026Z","dependency_job_id":"f554a167-df93-416d-ab3c-8706b01ee3bc","html_url":"https://github.com/WindowsSov8forUs/nonebot-plugin-tsugu-bangdream-bot","commit_stats":null,"previous_names":["windowssov8forus/nonebot-plugin-tsugu-bangdream-bot"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindowsSov8forUs%2Fnonebot-plugin-tsugu-bangdream-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindowsSov8forUs%2Fnonebot-plugin-tsugu-bangdream-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindowsSov8forUs%2Fnonebot-plugin-tsugu-bangdream-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindowsSov8forUs%2Fnonebot-plugin-tsugu-bangdream-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WindowsSov8forUs","download_url":"https://codeload.github.com/WindowsSov8forUs/nonebot-plugin-tsugu-bangdream-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248459809,"owners_count":21107373,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bangdream","bot","nonebot","nonebot2","plugin","python","tsugu"],"created_at":"2025-04-11T18:38:32.880Z","updated_at":"2025-04-11T18:38:33.558Z","avatar_url":"https://github.com/WindowsSov8forUs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://v2.nonebot.dev/store\"\u003e\u003cimg src=\"https://github.com/A-kirami/nonebot-plugin-template/blob/resources/nbp_logo.png\" width=\"180\" height=\"180\" alt=\"NoneBotPluginLogo\"\u003e\u003c/a\u003e\n  \u003cbr\u003e\n  \u003cp\u003e\u003cimg src=\"https://github.com/A-kirami/nonebot-plugin-template/blob/resources/NoneBotPlugin.svg\" width=\"240\" alt=\"NoneBotPluginText\"\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n# NoneBot-Plugin-Tsugu-BanGDream-Bot\n\n_✨ [Koishi-Plugin-Tsugu-BanGDream-Bot](https://github.com/Yamamoto-2/tsugu-bangdream-bot) 的 NoneBot2 实现 ✨_\n\n\n\u003ca href=\"https://github.com/Yamamoto-2/tsugu-bangdream-bot\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/tsugu bangdream bot-api-FFEE88\" alt=\"license\"\u003e\n\u003c/a\u003e\n\u003ca href=\"./LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/WindowsSov8forUs/nonebot-plugin-tsugu-bangdream-bot.svg\" alt=\"license\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://pypi.python.org/pypi/nonebot-plugin-tsugu-bangdream-bot\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/v/nonebot-plugin-tsugu-bangdream-bot.svg\" alt=\"pypi\"\u003e\n\u003c/a\u003e\n\u003cimg src=\"https://img.shields.io/badge/python-3.8+-blue.svg\" alt=\"python\"\u003e\n\n\u003c/div\u003e\n\n[koishi-plugin-tsugu-bangdream-bot](https://github.com/Yamamoto-2/tsugu-bangdream-bot) 的 NoneBot2 实现，旨在于 NoneBot 上还原 Tsugu Bot 的使用。\n\n## 📖 介绍\n\n在 NoneBot2 上进行的对于 [koishi-plugin-tsugu-bangdream-bot](https://github.com/Yamamoto-2/tsugu-bangdream-bot) 的复刻，支持跨平台，支持自定义。\n\n\u003e 基于 [NoneBot-Plugin-Alconna](https://github.com/nonebot/plugin-alconna) 和 [nonebot-plugin-userinfo](https://github.com/noneplugin/nonebot-plugin-userinfo) 实现跨平台支持。\n\u003e\n\u003e 基于 [tsugu-api-python](https://github.com/WindowsSov8forUs/tsugu-api-python) 实现与 Tsugu 后端的连接。\n\n## 💿 安装\n\n\u003e\n\u003e ⚠ 使用警告 ⚠\n\u003e\n\u003e 若运行本插件时出现了如下异常信息：\n\u003e\n\u003e ```bash\n\u003e ImportError: Failed to import httpx and aiohttp, please install one of them to use this plugin.\n\u003e ```\n\u003e\n\u003e 表示你的 Nonebot 项目没有使用 HTTP 客户端驱动，也没有运行在安装了 `httpx` 库或 `aiohttp` 库的环境。\n\u003e\n\u003e 请确保使用了 HTTP 客户端驱动或安装了这两个库的其中一个。\n\u003e\n\n\u003cdetails open\u003e\n\u003csummary\u003e使用 nb-cli 安装\u003c/summary\u003e\n在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装\n\n    nb plugin install nonebot-plugin-tsugu-bangdream-bot\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e使用包管理器安装\u003c/summary\u003e\n在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令\n\n\u003cdetails\u003e\n\u003csummary\u003epip\u003c/summary\u003e\n\n    pip install nonebot-plugin-tsugu-bangdream-bot\n\u003c/details\u003e\n\u003cdetails\u003e\n\u003csummary\u003epdm\u003c/summary\u003e\n\n    pdm add nonebot-plugin-tsugu-bangdream-bot\n\u003c/details\u003e\n\u003cdetails\u003e\n\u003csummary\u003epoetry\u003c/summary\u003e\n\n    poetry add nonebot-plugin-tsugu-bangdream-bot\n\u003c/details\u003e\n\u003cdetails\u003e\n\u003csummary\u003econda\u003c/summary\u003e\n\n    conda install nonebot-plugin-tsugu-bangdream-bot\n\u003c/details\u003e\n\n打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入\n\n    plugins = [\"nonebot-plugin-tsugu-bangdream-bot\"]\n\n\u003c/details\u003e\n\n## ⚙️ 配置\n\n在 nonebot2 项目的`.env`文件中添加下表中的必填配置\n\n**nonebot-plugin-tsugu-bangdream-bot** 并无必填配置，但仍然建议对部分配置进行添加。\n\n| 配置项 | 必填 | 默认值 | 说明 |\n|:-----:|:----:|:----:|:----:|\n| TSUGU_USE_EASY_BG | 否 | `False` | 是否使用简易背景，启用这将大幅提高速度，关闭将使部分界面效果更美观 |\n| TSUGU_COMPRESS | 否 | `False` | 是否压缩图片，启用会使图片质量下降，但是体积会减小，从而减少图片传输时所需的时间 |\n| TSUGU_BANDORI_STATION_TOKEN | 否 | `None` | BandoriStationToken, 用于发送车牌，可以去 [BandoriStation](https://github.com/maborosh/BandoriStation/wiki/API%E6%8E%A5%E5%8F%A3) 申请。缺失情况下，视为Tsugu车牌 |\n| TSUGU_REPLY | 否 | `False` | 消息是否回复用户 |\n| TSUGU_AT | 否 | `False` | 消息是否@用户 |\n| TSUGU_NO_SPACE | 否 | `False` | 是否启用无需空格触发大部分指令，启用这将方便一些用户使用习惯，但会增加bot误判概率，仍然建议使用空格 |\n| TSUGU_RETRIES | 否 | `3` | 重试次数配置，配置 `\u003c= 0` 时代表关闭重试机制 |\n| TSUGU_BACKEND_URL | 否 | `\"http://tsugubot.com:8080\"` | 后端服务器地址，用于处理指令。如果有自建服务器，可以改成自建服务器地址。默认为Tsugu公共后端服务器。 |\n| TSUGU_DATA_BACKEND_URL | 否 | `\"http://tsugubot.com:8080\"` | 用户数据后端服务器地址，用于处理用户与车牌指令。如果有自建服务器，可以改成自建服务器地址。默认为Tsugu公共后端服务器。 |\n| TSUGU_PROXY | 否 | `\"\"` | 使用的代理服务器。在部分地区，网络环境可能无法连接后端服务器。通过此配置项配置代理服务器。 |\n| TSUGU_TIMEOUT | 否 | `10` | 后端服务器的响应超时时间（秒） |\n| TSUGU_BACKEND_PROXY | 否 | `False` | 是否通过代理服务器访问后端服务器 |\n| TSUGU_DATA_BACKEND_PROXY | 否 | `False` | 是否通过代理服务器访问用户数据后端服务器 |\n| TSUGU_OPEN_FORWARD_ALIASES | 否 | `()` | 开启车牌转发指令别名 |\n| TSUGU_CLOSE_FORWARD_ALIASES | 否 | `()` | 关闭车牌转发指令别名 |\n| TSUGU_BIND_PLAYER_ALIASES | 否 | `()` | 绑定玩家指令别名 |\n| TSUGU_UNBIND_PLAYER_ALIASES | 否 | `()` | 解除绑定指令别名 |\n| TSUGU_MAIN_SERVER_ALIASES | 否 | `()` | 切换服务器模式指令别名 |\n| TSUGU_DEFAULT_SERVERS_ALIASES | 否 | `()` | 切换显示服务器列表指令别名 |\n| TSUGU_PLAYER_STATUS_ALIASES | 否 | `()` | 用户玩家状态指令别名 |\n| TSUGU_PLAYER_LIST_ALIASES | 否 | `()` | 用户玩家状态列表指令别名 |\n| TSUGU_SWITCH_INDEX_ALIASES | 否 | `()` | 切换默认玩家 ID 指令别名 |\n| TSUGU_YCM_ALIASES | 否 | `()` | 查询车牌指令别名 |\n| TSUGU_SEARCH_PLAYER_ALIASES | 否 | `()` | 查询玩家指令别名 |\n| TSUGU_SEARCH_CARD_ALIASES | 否 | `()` | 查卡指令别名 |\n| TSUGU_CARD_ILLUSTRATION_ALIASES | 否 | `()` | 查卡面指令别名 |\n| TSUGU_SEARCH_CHARACTER_ALIASES | 否 | `()` | 查角色指令别名 |\n| TSUGU_SEARCH_EVENT_ALIASES | 否 | `()` | 查活动指令别名 |\n| TSUGU_SEARCH_SONG_ALIASES | 否 | `()` | 查曲指令别名 |\n| TSUGU_SONG_CHART_ALIASES | 否 | `()` | 查谱面指令别名 |\n| TSUGU_SONG_RANDOM_ALIASES | 否 | `()` | 随机曲目指令别名 |\n| TSUGU_SONG_META_ALIASES | 否 | `()` | 查歌曲分数表指令别名 |\n| TSUGU_EVENT_STAGE_ALIASES | 否 | `()` | 查试炼舞台指令别名 |\n| TSUGU_SEARCH_GACHA_ALIASES | 否 | `()` | 查卡池指令别名 |\n| TSUGU_YCX_ALIASES | 否 | `()` | 查询预测线指令别名 |\n| TSUGU_YCX_ALL_FORWARD_ALIASES | 否 | `()` | 查询全榜预测线指令别名 |\n| TSUGU_LSYCX_ALIASES | 否 | `()` | 查询历史预测线指令别名 |\n| TSUGU_GACHA_SIMULATE_ALIASES | 否 | `()` | 抽卡模拟指令别名 |\n\n## 🎉 使用\n\n参考 [关于 Tsugu V3.0](https://www.bilibili.com/read/cv18082802/)\n\n## 引用\n\n本插件使用或参考了以下插件/项目\n\n- [NoneBot-Plugin-Alconna](https://github.com/nonebot/plugin-alconna) 提供跨平台以及 Koishi-like 指令支持。\n- [nonebot-plugin-userinfo](https://github.com/noneplugin/nonebot-plugin-userinfo) 提供跨平台的用户信息获取支持。\n- [tsugu-api-python](https://github.com/WindowsSov8forUs/tsugu-api-python) 提供与 Tsugu 后端的连接支持。\n- [tsugu-bangdream-bot](https://github.com/Yamamoto-2/tsugu-bangdream-bot) Tsugu 本体。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwindowssov8forus%2Fnonebot-plugin-tsugu-bangdream-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwindowssov8forus%2Fnonebot-plugin-tsugu-bangdream-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwindowssov8forus%2Fnonebot-plugin-tsugu-bangdream-bot/lists"}