Skip to content

开发你的第一个澜音插件

插件为澜音增加功能。例如,你可以接入自己的音乐服务,让用户直接在澜音里搜索歌曲。

这套教程面向会基本 JavaScript、第一次写澜音插件的人。你需要能看懂变量、函数、数组和对象;不需要先学 Electron 或 Vue。

适用的软件

澜音 2.0 开始使用 v2 插件。1.14.1 仍使用 v1,对应的开发资料在 v1 文档。本教程的安装步骤需要支持 v2 的澜音 2.0 开发构建或正式版本。

这次要做出什么?

我们会在同一个 my-plugin 工程里,完成一个小插件:

  • 输入“晨光”,搜索到自己写在代码里的歌曲。
  • 点击“问候一次”,显示提示并记住点击次数。
  • 关闭再打开软件,仍能读到之前保存的次数。

歌曲是本地演示数据,没有音频地址,不能播放。这样可以先学会插件怎么接入澜音,再去处理音乐接口、认证和网络请求。

按顺序完成五节

章节你会完成的操作
1. 运行插件创建工程,在开发工作台搜索模板中的歌曲
2. 写一个命令写出最小插件,接通命令声明与执行函数
3. 添加搜索接收关键词,返回澜音能显示的歌曲数据
4. 保存数据保存问候次数,并为桌面提供一个按钮
5. 安装到澜音构建单文件,安装后检查搜索和计数

每节会写明要改哪个文件、代码替换范围,以及运行后应该看到什么。先从运行插件开始,不必提前读完 API 参考。

插件代码在哪里运行?

开发时,工作台负责加载插件、调用命令和展示返回结果。完成后,构建工具把工程打包成 dist/plugin.js,由用户安装到澜音桌面软件中。

两者运行的是同一个插件,但界面入口不同:工作台有直接测试动作的按钮,桌面需要插件自己声明用户入口。第四节会补上这个入口,第五节再安装验证。

入门之后

你的目标继续阅读
接入 HTTP 音乐服务HTTP 音源项目
使用 Vue 做登录页并连接 NavidromeNavidrome 项目
添加账号菜单和原生歌单页账号与原生音乐库项目
查询某个参数左侧按功能分类的 API 参考

工具源码:CLI 与 SDK。示例源码:插件模板

Released under the Apache License 2.0 License.