---

为何会有这个项目📖

让我来给您描绘一下吧：

• 现在是凌晨 3 点
• 你的机器人不能播放音乐
• 你凝视虚空，虚空也凝视着你
• 果然你依赖的第三方 API 挂了，而你对此无能为力

这个仓库正是那场存在午夜危机的结果。基于 NeteaseCloudMusicApi 的自建部署方案，在本地里你能控制、维护并信任它（希望如此）。

免责声明 ❗

• 本项目的功能仅限于内部交流与小范围使用，请勿将 本项目 用于任何以盈利为目的的场景。
• 仅供交流学习使用。如有侵权，请联系我们，我们会立即删除相关内容。

特性✨

• 完全不依赖第三方 API 服务器
• 支持全部 NeteaseCloudMusicApi 接口
• 本地运行于 127.0.0.1:3030，安全且快速
• 随Yunzai托管，自动重启，开机自启

You can still survive after restarting,unlike your will to learn.

• 重启后依然能存活，不像你的学习意志

安装教程😊

1. 推荐使用 git 进行安装，以方便后续升级

cd /root/Yunzai

使用 GitHub:

git clone --depth=1 https://github.com/sarsxe/NCMApi-plugin.git ./plugins/NCMApi-plugin

2. 进入项目

cd /root/Yunzai/plugins/NCMApi-plugin

3. 安装依赖

pnpm install

启动方式

方式一：随 Yunzai 自动启动（推荐）

重启或启动 Yunzai，无需再为本插件单独配置 pm2 进程。 插件会在 Yunzai 启动时加载本地 NeteaseCloudMusicApi 服务。

方式二：独立启动（兼容模式）

如需单独调试，可执行：

cd /root/Yunzai/plugins/NCMApi-plugin

node start.js

服务默认运行在 http://127.0.0.1:3030

快速验证:

curl http://127.0.0.1:3030/search?keywords=hello

功能介绍

支持的 API 接口（点击展开）

接口	说明
/search?keywords=xxx	搜索歌曲
/cloudsearch?keywords=xxx	高级搜索
/song/url/v1?id=xxx	获取歌曲播放链接
/song/detail?ids=xxx	获取歌曲详情
/lyric?id=xxx	获取歌词
/playlist/detail?id=xxx	获取歌单详情
/artist/songs?id=xxx	获取歌手歌曲
/album?id=xxx	获取专辑内容
/comment/music?id=xxx	获取歌曲评论
/banner	首页轮播图
/personalized	推荐歌单
/toplist	排行榜
/login/status	检查登录状态
/user/cloud	云盘歌曲列表

完整接口文档请参考：NeteaseCloudMusicApi 文档

音质等级

等级	说明
standard	标准音质
higher	较高音质
exhigh	极高音质
lossless	无损音质（FLAC）
hires	Hi-Res 高解析度

更新与版本管理

插件内支持以下命令：

命令	说明
#NCM版本	查看插件版本信息
#NCM更新	更新插件并安装依赖
#NCM状态	NCMApi 运行状态查看
#NCM端口变更	本地api转发端口更改
#NCM强制更新	放弃本地修改后强制更新
#NCM更新/安装api***	NeteaseCloudMusicApi 依赖安装与更新

说明：

• 更新命令会执行 git pull --no-rebase 和 pnpm install
• 更新完成后，请重启 Yunzai，使插件代码与内置 NCM API 服务一起生效
• 不再依赖单独的 pm2 restart NeteaseCloudMusicApi

对接配置示例

如需在其他插件或配置中显式指定本地网易云 API 地址，可使用：

useLocalNeteaseAPI:

true

neteaseCloudAPIServer:

http://127.0.0.1:3030

项目结构

NCMApi-plugin/
|-- apps/                # NCMApi-plugin指令触发区域
|-- service.js           # 本地 NCM API 启动封装与单例保护
|-- index.js             # Yunzai 插件入口，随 Yunzai 自动启动服务
|-- start.js             # 兼容独立启动入口
|-- package.json         # 项目配置及依赖
|-- package-lock.json    # 依赖锁定文件
|-- README.md            # 项目文档

Tech Stack 技术线

技术	用途
Node.js	运行环境
Express	Web 框架
NeteaseCloudMusicApi v4.32.0	核心 API 模块
Your sanity	Troubleshooting at 3 AM

Acknowledgements 致谢

• NeteaseCloudMusicApi ——让这一切成为可能的起源项目
• Yunzai-Bot -- 让服务永远活下去

License 许可证

MIT -- Do whatever you want, just do not blame me.

麻省理工 -- 爱干什么就干什么吧,别来怪我。

---