nonebot-plugin-multincm

NoneBot-Plugin-MultiNCM

✨ 网易云多选点歌 ✨

📖 介绍

一个网易云多选点歌插件（也可以设置成单选，看下面），可以翻页，可以登录网易云账号点 vip 歌曲听（插件发送的是自定义音乐卡片），没了

插件获取的是音乐播放链接，不会消耗会员每月下载次数

效果图

歌曲列表效果图（点击展开）

歌词效果图（点击展开）

💿 安装

以下提到的方法 任选其一 即可

[推荐] 使用 nb-cli 安装

在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装

nb plugin install nonebot-plugin-multincm

使用包管理器安装

在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

pip

pip install nonebot-plugin-multincm

pdm

pdm add nonebot-plugin-multincm

poetry

poetry add nonebot-plugin-multincm

conda

conda install nonebot-plugin-multincm

打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分的 plugins 项里追加写入

[tool.nonebot]
plugins = [
    # ...
    "nonebot_plugin_multincm"
]

⚙️ 配置

如果你安装了 nonebot-plugin-ncm 或者其他使用到 pyncm 的插件并且全局 Session 已登录，本插件会与它们共用全局 Session，就可以不用填下面的账号密码了

下面配置中，手机号登录 和 邮箱登录、明文密码 和 MD5 密码哈希 各选其一填写即可

在 nonebot2 项目的 .env 文件中添加下表中的必填配置

配置项	必填	默认值	说明
登录相关
NCM_CTCODE	否	86	手机号登录用，登录手机区号
NCM_PHONE	否	无	手机号登录用，登录手机号
NCM_EMAIL	否	无	邮箱登录用，登录邮箱
NCM_PASSWORD	否	无	帐号明文密码，邮箱登录时为邮箱密码
NCM_PASSWORD_HASH	否	无	帐号密码 MD5 哈希，邮箱登录时为邮箱密码
UI 相关
NCM_LIST_LIMIT	否	20	歌曲列表每页的最大数量
NCM_LIST_FONT	否	无	渲染歌曲列表使用的字体
NCM_LRC_EMPTY_LINE	否	-	填充歌词空行的字符
行为相关
NCM_AUTO_RESOLVE	否	False	当用户发送音乐链接时，是否自动解析并发送音乐卡片
NCM_RESOLVE_COOL_DOWN	否	30	自动解析同一链接的冷却时间（单位秒）
NCM_RESOLVE_PLAYABLE_CARD	否	False	开启自动解析时，是否解析可播放的卡片
NCM_ILLEGAL_CMD_FINISH	否	False	当用户在点歌时输入了非法指令，是否直接退出点歌
NCM_ILLEGAL_CMD_LIMIT	否	3	当未启用 NCM_ILLEGAL_CMD_FINISH 时，用户在点歌时输入了多少次非法指令后直接退出点歌，填 0 以禁用此功能
NCM_DELETE_MSG	否	True	是否在退出点歌模式后自动撤回歌曲列表与操作提示信息
NCM_DELETE_MSG_DELAY	否	[0.5, 2.0]	自动撤回消息间隔时间（单位秒）
NCM_SEND_MEDIA	否	True	是否发送歌曲，如关闭将始终提示使用命令获取播放链接
NCM_SEND_AS_CARD	否	True	在支持的平台下，发送歌曲卡片（目前支持 OneBot V11 与 Kritor）
NCM_SEND_AS_FILE	否	False	当无法发送卡片或卡片发送失败时，会回退到使用语音发送，启用此配置项将会换成回退到发送歌曲文件
其他配置
NCM_MSG_CACHE_TIME	否	43200	缓存 用户最近一次操作 的时长（秒）
NCM_MSG_CACHE_SIZE	否	1024	缓存所有 用户最近一次操作 的总计数量
NCM_RESOLVE_COOL_DOWN_CACHE_SIZE	否	1024	缓存 歌曲解析的冷却时间 的总计数量
NCM_CARD_SIGN_URL	否	None	音卡签名地址（与 LLOneBot 或 NapCat 共用），填写此 URL 后将会把音卡的签名工作交给本插件
NCM_CARD_SIGN_TIMEOUT	否	5	请求音卡签名地址的超时时间
NCM_OB_V11_LOCAL_MODE	否	False	在 OneBot V11 适配器下，是否下载歌曲后使用本地文件路径上传歌曲
NCM_FFMPEG_EXECUTABLE	否	ffmpeg	FFmpeg 可执行文件路径，已经加进环境变量可以不用配置，在 OneBot V11 适配器下发送语音需要使用

🎉 使用

指令

搜索指令

• 点歌 [歌曲名 / 音乐 ID]
  • 介绍：搜索歌曲。当输入音乐 ID 时会直接发送对应音乐
  • 别名：网易云、wyy、网易点歌、wydg、wysong
• 网易声音 [声音名 / 节目 ID]
  • 介绍：搜索声音。当输入声音 ID 时会直接发送对应声音
  • 别名：wysy、wyprog
• 网易电台 [电台名 / 电台 ID]
  • 介绍：搜索电台。当输入电台 ID 时会直接发送对应电台
  • 别名：wydt、wydj
• 网易歌单 [歌单名 / 歌单 ID]
  • 介绍：搜索歌单。当输入歌单 ID 时会直接发送对应歌单
  • 别名：wygd、wypli
• 网易专辑 [专辑名 / 专辑 ID]
  • 介绍：搜索专辑。当输入专辑 ID 时会直接发送对应专辑
  • 别名：wyzj、wyal

操作指令

• 解析 [回复 音乐卡片 / 链接]
  • 介绍：获取该音乐信息并发送，也可以解析歌单等
  • 别名：resolve、parse、get
• 直链 [回复 音乐卡片 / 链接]
  • 介绍：获取该音乐的下载链接
  • 别名：direct
• 上传 [回复 音乐卡片 / 链接]
  • 介绍：下载该音乐并上传到群文件
  • 别名：upload
• 歌词 [回复 音乐卡片 / 链接]
  • 介绍：获取该音乐的歌词，以图片形式发送
  • 别名：lrc、lyric、lyrics

Tip

• 当启用 NCM_AUTO_RESOLVE 时，Bot 会自动解析你发送的网易云歌曲或电台节目链接
• 点击 Bot 发送的音乐卡片会跳转到官网歌曲页
• 使用需要回复音乐卡片的指令时，如果没有回复，会自动使用你触发发送的最近一个音乐卡片的信息

🤔 Q & A

Q: 我可以把插件变成单选点歌吗？

A: 可以，把配置项 NCM_LIST_LIMIT 设置为 1 即可。因为插件在检测到搜索结果仅有一个时，会将它直接发送出来。我们在这里利用了这个特性。

📞 联系

QQ：3076823485
Telegram：@lgc2333
吹水群：1105946125
邮箱：[e-mail]

💡 鸣谢

mos9527/pyncm

项目使用的网易云 API 调用库

Binaryify/NeteaseCloudMusicApi

项目一些相关 API 来源

💰 赞助

赞助我

感谢大家的赞助！你们的赞助将是我继续创作的动力！

📝 更新日志

1.1.4

• 修复一个歌词合并的小问题

1.1.3

• 修复过长歌词多行不居中的问题

1.1.2

• 修复 OneBot V11 的音乐卡片无法发送的问题

1.1.1

• 修复图文消息 cover 发不出的问题

1.1.0

• 换用 alconna 构建卡片消息
• 修复手动使用指令解析也有冷却的问题

1.0.0

项目重构

• 支持多平台
  目前多平台发歌逻辑还不是很完善，如果有建议欢迎提出
• UI 大改
• 支持电台与专辑的搜索与解析
• 自动解析对同一歌曲有冷却了，防多 Bot 刷屏
• 配置项变动
  • 增加配置项 NCM_RESOLVE_COOL_DOWN、NCM_RESOLVE_COOL_DOWN_CACHE_SIZE
    按需更改，可防止多 Bot 刷屏
  • 增加配置项 NCM_SEND_MEDIA、NCM_SEND_AS_CARD、NCM_SEND_AS_FILE
    控制插件发送音乐的方式，现在不止支持卡片了
  • 增加配置项 NCM_CARD_SIGN_URL、NCM_CARD_SIGN_TIMEOUT
    可以把音卡的签名工作交给插件而不是协议端，自行寻找音卡签名服务填写于此
  • 增加配置项 NCM_FFMPEG_EXECUTABLE
    发送语音时可以将 silk 的编码工作交给插件而不是协议端
  • 重命名配置项 NCM_DOWNLOAD_LOCALLY -> NCM_OB_V11_LOCAL_MODE
  • 移除配置项 NCM_MAX_NAME_LEN、NCM_MAX_ARTIST_LEN、NCM_USE_PLAYWRIGHT
    现始终使用 playwright 进行图片渲染

点击展开 / 收起 v0 版本更新日志

0.5.0

• 适配 Pydantic V1 & V2
• 支持歌单的解析
• 点歌指令可以回复一条文本消息作为搜索内容了
• resolve #14
• 弃用 Pillow
• 重构部分代码

0.4.4

• 添加配置项 NCM_ILLEGAL_CMD_LIMIT

0.4.3

• 可以退出搜索模式了

0.4.2

• resolve #13

0.4.1

• 支持了 163cn.tv 短链（Thanks to @XieXiLin2）
• 修复当 NCM_RESOLVE_PLAYABLE_CARD 为 False 时，Bot 依然会回复的问题
• 部分代码优化

0.4.0

• 项目部分重构
• 删除 链接 指令，新增 直链、上传 指令
• 将卡片点击后跳转的地址改为官网歌曲页，代替 链接 指令，同时删除了发送过音乐卡片的缓存机制
• 添加配置项 NCM_RESOLVE_PLAYABLE_CARD、NCM_UPLOAD_FOLDER_NAME

0.3.9

• 让 htmlrender 成为真正的可选依赖
• 把配置项 NCM_MSG_CACHE_TIME 的默认值改为 43200（12 小时）

0.3.8

• 修改及统一表格背景色

0.3.7

• 添加配置项 NCM_DELETE_LIST_MSG 和 NCM_DELETE_LIST_MSG_DELAY（#5）

0.3.6

• 支持使用 nonebot-plugin-htmlrender (playwright) 渲染歌曲列表与歌词图片（默认不启用，如要启用需要自行安装 nonebot-plugin-multincm[playwright]）
• 添加配置项 NCM_USE_PLAYWRIGHT 与 NCM_LRC_EMPTY_LINE

0.3.5

• 🎉 NoneBot 2.0 🚀

0.3.4

• 修复分割线下会显示歌词翻译的问题

0.3.3

• 新增配置项 NCM_ILLEGAL_CMD_FINISH
• 在未启用 NCM_ILLEGAL_CMD_FINISH 时输入错误指令将会提示用户退出点歌

0.3.2

• 新增配置项 NCM_MSG_CACHE_TIME、NCM_AUTO_RESOLVE
• 调整登录流程到 driver.on_startup 中

0.3.1

• 修复电台相关 bug

0.3.0

• 支持电台节目的解析与点播

0.2.5

• 解析、歌词、链接 指令可以直接根据 Bot 发送的上个音乐卡片作出回应了
• 歌词解析会合并多行空行和去掉首尾空行了
• 现在插件会定时清理自身内存中的缓存了

0.2.4

• 修复一个歌词解析 bug

0.2.3

• 微调歌曲列表排版
• 微调插件帮助文本

0.2.2

• 修复搜歌 KeyError

0.2.1

• 删除歌词尾部的空行与多余分割线

0.2.0

• 新增了三个指令 解析、歌词、链接
• 点歌指令支持直接输入音乐 ID