快速入门

本指南将帮助你在 5 分钟内完成第一个 Such 插件。

前置条件

• 熟悉 JavaScript 或 TypeScript 基础语法
• 已安装 Such Music 桌面客户端

最小插件示例

创建一个 .ts 或 .js 文件，写入以下代码：

window.source = {
  id: 'MY_FIRST_PLUGIN',
  name: '我的第一个插件',
  version: '1.0.0',
  author: 'YourName',
  description: '一个简单的 Hello World 插件',

  initialization() {
    console.log('插件已启动！')
    window.notify('Hello Such!', 'success')
  }
}

关键点：

• window.source 是插件注册的唯一入口，不需要 module.exports
• id 必须全局唯一，格式为大写字母 + 下划线
• initialization() 在插件加载后自动调用一次

加载插件

1. 打开 Such Music，进入 插件管理 页面
2. 点击 加载插件，选择你编写的 .ts / .js 文件
3. 插件加载成功后，你将在插件列表中看到它
4. 状态变为「运行中」时，通知栏会弹出 "Hello Such!"

调试技巧

查看日志

插件中调用 console.log() / console.warn() / console.error() 的输出会显示在：

• Such 开发者控制台（在 Such 设置中开启）
• 插件详情页的日志面板

initialization() {
  console.log('初始化开始...')
  console.warn('这是一条警告')
  console.error('这是一条错误')
}

桌面通知

使用 window.notify() 向用户发送桌面通知，方便调试状态变化：

window.notify('操作成功', 'success')
window.notify('操作失败', 'error')
window.notify('请注意', 'warning')
window.notify('提示信息', 'info')

下一步

• 了解 window.source 元数据 的完整字段
• 学习 suchmusic 宿主 API 调用宿主能力
• 给你的插件添加 JSON UI Schema 界面