简介
Ceru Music 是基于 Electron 和 Vue 开发的跨平台桌面音乐播放器工具，借鉴洛雪音乐插件思想，提供插件运行框架与播放功能，不直接存储、提供任何音乐源文件。用户需通过自行选择、安装合规插件获取音乐相关数据，项目旨在为开发者提供桌面应用技术实践与学习案例，为用户提供合规的音乐播放工具框架。
技术栈
- Electron：用于构建跨平台桌面应用
- Vue 3：前端框架，提供响应式 UI
- TypeScript：增强代码可维护性和类型安全
- Pinia：状态管理工具
- Vite：快速的前端构建工具
- CeruPlugins：音乐插件运行环境（仅提供框架，不包含默认插件）
主要功能
- 提供插件加载与管理功能，支持通过合规插件获取公开音乐信息
- 支持通过插件获取歌词、专辑封面等公开元数据
- 支持虚拟滚动列表，优化大量数据渲染性能
- 本地播放列表管理（仅存储用户手动创建的列表结构，不包含音乐文件）
- 本地数据仅保存在用户设备本地，未进行云端备份，用户需自行备份以防止数据丢失
- 精美的用户界面与动画效果
- 插件生态框架（插件需用户自行获取并确保合规性）
安装与使用
推荐开发环境
- IDE: VS Code 或 WebStorm
- Node.js 版本：22 及以上
- 包管理器：yarn
项目设置
安装依赖：
yarn install
启动开发服务器：
yarn dev
构建应用：
yarn build
平台构建指令
- Windows:
yarn build:win - macOS:
yarn build:mac - Linux:
yarn build:linux
提示：构建后的应用仅包含播放器框架，需用户自行配置合规插件方可获取音乐数据。
文档与资源
- 产品设计文档：涵盖项目架构、核心功能设计和开发规范（不含任何音乐数据源信息）。
- 插件开发文档：仅提供插件开发技术规范，明确要求插件开发者需遵守数据来源平台的用户协议与版权法，禁止开发、传播获取非公开数据的插件。
开源许可
本项目源代码遵循 GNU AGPL v3.0，仅授权用户对项目框架进行学习、修改与二次开发，不包含任何音乐数据相关授权。详情请参阅 LICENSE 文件，使用前请务必阅读许可条款。
第三方组件与致谢
歌词组件使用自 applemusic-like-lyrics 项目，感谢 Steve-xmh 及其贡献者的出色工作。该组件遵循其上游许可（AGPL-3.0），相关使用与分发需符合其许可要求。
