A Guess song plugin for Nonebot2
Project description
📖 介绍
一个音游猜歌插件(主要为舞萌DX maimaiDX提供资源),有开字母、猜曲绘、听歌猜曲、谱面猜歌、线索猜歌等游戏
💿 安装
使用 nb-cli 安装
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装nb plugin install nonebot-plugin-guess-song
使用包管理器安装
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令pip
pip install nonebot-plugin-guess-song
pdm
pdm add nonebot-plugin-guess-song
poetry
poetry add nonebot-plugin-guess-song
conda
conda install nonebot-plugin-guess-song
打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分追加写入
plugins = ["nonebot_plugin_guess_song"]
⚙️ 配置
⚠️⚠️⚠️请务必注意,若需要使用听歌猜曲以及谱面猜歌,必须先下载并配置ffmpeg⚠️⚠️⚠️
⚠️⚠️⚠️若需要使用谱面猜歌,请安装moviepy==1.0.3(最新版本无法使用)⚠️⚠️⚠️
在 nonebot2 项目的.env文件中添加下表中的必填配置
| 配置项 | 必填 | 默认值 | 说明 |
|---|---|---|---|
| guess_static_resources_path | 是 | 无 | 歌曲信息、曲绘、别名等静态资源路径 |
| guess_resources_path | 是 | 无 | 音乐文件、谱面文件、猜歌排名记录信息等动态资源路径 |
比如:在.env.dev文件中添加以下两行:
GUESS_STATIC_RESOURCES_PATH="E:\\Bot\\CainithmBot\\static"
GUESS_RESOURCES_PATH="E:\\Bot\\CainithmBot\\resources"
资源需求
🟩static文件:Yuri-YuzuChaN个人云盘、百度云盘 内部包括music_data.json、music_alias.json文件,以及mai/cover,是歌曲的信息与别名,以及歌曲的曲绘。 推荐联合使用其它maimai插件来动态更新歌曲信息与别名信息。
🟩动态资源文件(针对听歌猜曲和谱面猜歌,可按需下载):
- 听歌猜曲文件(共6.55GB,已切分为五个压缩包,可部分下载):百度云盘
- 谱面猜歌文件(共22.37GB,已划分为按版本聚类,可下载部分版本使用):百度云盘 在动态资源路径guess_static_resources_path下,建立music_guo文件夹,将听歌猜曲文件放入内;建立chart_resources文件夹,将谱面猜歌资源文件放入内(保持每个版本一个文件夹)。
💡资源需求说明: 最低配置:music_data.json、music_alias.json 开字母:无需添加其它资源(可以按需添加“这么难他都会”的图片资源到/resources/maimai/so_hard.jpg) 猜曲绘:需要添加mai/cover 线索猜歌:需要添加mai/cover(如果添加了音乐资源,还会增加歌曲长度作为线索) 听歌猜曲:需要添加music_guo——在动态资源路径guess_static_resources_path下,建立music_guo文件夹,将听歌猜曲文件放入内; 谱面猜歌:需要添加chart_resources——在动态资源路径guess_static_resources_path下,建立chart_resources文件夹,将谱面猜歌资源文件放入内(保持每个版本一个文件夹)。
⚠️可以不下载动态资源, 也可以只下载部分资源(部分歌曲或部分版本),插件也能正常运行,只不过曲库会略微少一些。⚠️
🎉 使用
指令表
详细指令表及其高级用法(比如过滤某个版本、某些等级的歌曲)也可以通过“/猜歌帮助”来查看
| 指令 | 权限 | 需要@ | 范围 | 说明 |
|---|---|---|---|---|
| /开字母 | 群员 | 否 | 群聊 | 开始开字母游戏 |
| /(连续)听歌猜曲 | 群员 | 否 | 群聊 | 开始(连续)听歌猜曲游戏 |
| /(连续)谱面猜歌 | 群员 | 否 | 群聊 | 开始(连续)谱面猜歌游戏 |
| /(连续)猜曲绘 | 群员 | 否 | 群聊 | 开始(连续)猜曲绘游戏 |
| /(连续)线索猜歌 | 群员 | 否 | 群聊 | 开始(连续)线索猜歌游戏 |
| 猜歌 xxx | 群员 | 否 | 群聊 | 根据已知信息猜测歌曲 |
| 不玩了 | 群员 | 否 | 群聊 | 揭晓当前猜歌的答案 |
| 停止 | 群员 | 否 | 群聊 | 停止连续猜歌 |
| /开启/关闭猜歌 xxx | 管理员/主人 | 否 | 群聊 | 开启或禁用某类或全部猜歌游戏 |
| /猜曲绘配置 xxx | 管理员/主人 | 否 | 群聊 | 进行猜曲绘配置(高斯模糊程度、打乱程度、裁切程度等) |
| /检查歌曲文件完整性 | 主人 | 否 | 群聊 | 检查听歌猜曲的音乐资源 |
| /检查谱面完整性 | 主人 | 否 | 群聊 | 检查谱面猜歌的文件资源 |
📝 项目特点
- ✅ 游戏新颖、有趣
- ✅ 资源配置要求较低,可按需部分下载
- ✅ 性能较高,使用preload技术加快谱面加载速度
- ✅ 框架通用,可扩展性强
- ✅ 使用简单、可使用别名猜歌,用户猜歌方便
- ✅ 贡献了谱面猜歌数据集,可以用于制作猜歌视频
效果图
🙏 鸣谢
- maimai插件 - maimai插件、static资源下载
- MajdataEdit - maimai谱面编辑器
- MajdataEdit_BatchOutput_Tool - 用于批量导出maimai谱面视频资源
- NoneBot2 - 跨平台 Python 异步机器人框架
📞 联系
| 猜你字母Bot游戏群(欢迎加群游玩) | QQ群:925120177 |
|---|
发现任何问题或有任何建议,欢迎发Issue,也可以加群联系开发团队,感谢!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nonebot_plugin_guess_song-1.0.0.tar.gz.
File metadata
- Download URL: nonebot_plugin_guess_song-1.0.0.tar.gz
- Upload date:
- Size: 34.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.22.3 CPython/3.9.21 Windows/10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
782cbec85c4511a30da36b3df058b61617fe48dc7821a63f599704cec7e09343
|
|
| MD5 |
50867a45754c556fbb649806c892b035
|
|
| BLAKE2b-256 |
bdf0657ae5bd5367d3fc07b8e773cab037be8c15af3bb11c88e4649e0f32de50
|
File details
Details for the file nonebot_plugin_guess_song-1.0.0-py3-none-any.whl.
File metadata
- Download URL: nonebot_plugin_guess_song-1.0.0-py3-none-any.whl
- Upload date:
- Size: 41.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.22.3 CPython/3.9.21 Windows/10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
27071f3f17de2594e2cb90cdee67a552f27c5bda6c3978956578005b609257a8
|
|
| MD5 |
009088d4a0a0a946f2a1ddd7857470b8
|
|
| BLAKE2b-256 |
bffb538df673c88f3788c415fcb763e359238d56d4ba74be682525058dd515fe
|