CeruMusic/docs/index.md

---
# https://vitepress.dev/reference/default-theme-home-page
layout: home

hero:
  name: 'Ceru Music'
  text: '澜音 播放器'
  tagline: 澜音是一个跨平台的音乐播放器应用，支持基于合规插件获取公开音乐信息与播放功能。
  image:
    src: '/logo.svg'
  actions:
    - theme: brand
      text: 下载应用
      link: https://ceru.shiqianjiang.cn/#download
      target: _blank
    - theme: alt
      text: 使用文档
      link: /guide/

features:
  - title: 多平台支持
    icon: 🚀
    details: 支持网易云音乐、QQ音乐等多个平台，搜索
  - title: 跨平台支持
    icon: 🪟
    details: 原生桌面应用，支持 Windows、macOS、Linux 三大操作系统
  - title: 歌词显示
    icon: 🎼
    details: 实时歌词显示，支持专辑信息获取，让音乐体验更丰富
  - title: 优雅界面
    icon: 💻
    details: 现代化设计语言，流畅动画效果，为你带来愉悦的视觉体验
  - title: 代码开源
    details: 代码完全开源，供给大家使用开发
    icon: 👐
    link: https://github.com/timeshiftsauce/CeruMusic
---

<div style="margin-top:4rem"></div>

# Ceru Music（澜音）

一个跨平台的音乐播放器应用，支持基于合规插件获取公开音乐信息与播放功能。

## 项目简介

Ceru Music 是基于 Electron 和 Vue 开发的跨平台桌面音乐播放器工具，**仅提供插件运行框架与播放功能**，不直接存储、提供任何音乐源文件。用户需通过自行选择、安装合规插件获取音乐相关数据，项目旨在为开发者提供桌面应用技术实践与学习案例，为用户提供合规的音乐播放工具框架。

<div style="display: grid; grid-template-columns: repeat(auto-fit, minmax(280px, 1fr)); gap: 2rem">
  <img src="./assets/image-20251003173109619.png" alt="image-20251003173109619"/>
  <img src= "./assets/image-20251003173654569.png">
</div>

## 技术栈

- **Electron**：用于构建跨平台桌面应用
- **Vue 3**：前端框架，提供响应式 UI
- **TypeScript**：增强代码可维护性和类型安全
- **Pinia**：状态管理工具
- **Vite**：快速的前端构建工具
- **CeruPlugins**：音乐插件运行环境（仅提供框架，不包含默认插件）
- **AMLL**：音乐生态辅助模块

## 主要功能

- 提供插件加载与管理功能，支持通过合规插件获取公开音乐信息
- 支持通过插件获取歌词、专辑封面等公开元数据
- 支持虚拟滚动列表，优化大量数据渲染性能
- 本地播放列表管理（仅存储用户手动创建的列表结构，不包含音乐文件）
- **提示**：本地数据仅保存在用户设备本地，未进行云端备份，用户需自行备份以防止数据丢失
- 精美的用户界面与动画效果
- **插件生态框架**（插件需用户自行获取并确保合规性）

## 安装与使用

### 推荐开发环境

- **IDE**: VS Code 或 WebStorm
- **Node.js 版本**: 22 及以上
- **包管理器**: **yarn**

### 项目设置

1. 安装依赖：

   ```bash
   yarn install
   ```

2. 启动开发服务器：

   ```bash
   yarn dev
   ```

3. 构建应用：

   ```bash
   yarn build
   ```

### 平台构建指令

- Windows

  ```bash
  yarn build:win
  ```

- macOS

  ```bash
  yarn build:mac
  ```

- Linux

  ```bash
  yarn build:linux
  ```

> 提示：构建后的应用仅包含播放器框架，需用户自行配置合规插件方可获取音乐数据。

## 文档与资源

- [产品设计文档](#)：涵盖项目架构、核心功能设计和开发规范（不含任何音乐数据源信息）。
- [插件开发文档](./guide/CeruMusicPluginDev)：仅提供插件开发技术规范，**明确要求插件开发者需遵守数据来源平台的用户协议与版权法**，禁止开发、传播获取非公开数据的插件。

## 开源许可

本项目源代码遵循 **Apache License 2.0**，仅授权用户对项目框架进行学习、修改与二次开发，不包含任何音乐数据相关授权。详情请参阅 [LICENSE](https://github.com/timeshiftsauce/CeruMusic/blob/main/LICENSE) 文件，使用前请务必阅读许可条款。

## 贡献指南

欢迎开发者贡献代码与反馈建议，贡献内容需符合以下要求：

1. 仅涉及播放器框架功能优化、bug 修复、文档完善，不包含任何音乐数据源相关代码。
2. 遵循 [Git 提交规范](#) 并确保代码符合项目风格指南。
3. 贡献的代码需无第三方版权纠纷，且不违反开源许可协议。

## 联系方式

如有技术问题或合作意向（仅限技术交流），请通过 Gitee 私信联系项目维护者。

## 项目开发者

- **时迁酱**：产品总体设计与开发

  <img src="./assets/head.jpg" alt="head.jpg (940×940)" style="zoom:15%;" />

- **无聊的霜霜**：首页设计&Ai助手

  <img src="./assets/image-20250827181604432.png" alt="image-20250827181604432" style="zoom:25%;" />

- **Star**：**插件管理**相关功能&部分接口封装

  <img src="./assets/image-20250827181535681.png" alt="image-20250827181535681" style="zoom:25%;" />

**Tips**: 排名不分先后

# 法律声明与免责条款

**重要提示：使用本项目前，请务必仔细阅读本条款，使用本项目即视为你已充分理解并同意本条款全部内容。**

### 一、定义约定

- “Apache License 2.0”：指 Ceru Music（澜音）桌面播放器框架及源代码，不包含任何第三方插件或音乐数据。
- “**用户**”：指下载、安装、使用本项目的个人或组织。
- “**合规插件**”：指符合数据来源平台用户协议、不侵犯第三方版权、不获取非公开数据的插件。
- “**版权内容**”：指包括但不限于音乐文件、歌词、专辑封面、艺人信息等受著作权法保护的内容。

### 二、数据与内容责任

1. 本项目**不直接获取、存储、传输任何音乐数据或版权内容**，仅提供插件运行框架。用户通过插件获取的所有数据，其合法性、准确性由插件提供者及用户**自行负责**，本项目不承担任何责任。
2. 若用户使用的插件存在获取非公开数据、侵犯第三方版权等违规行为，相关法律责任由用户及插件提供者承担，与本项目无关。
3. 本项目使用的字体、图片等素材，均来自开源社区或已获得合法授权，若存在侵权请联系项目维护者立即移除，本项目将积极配合处理。

### 三、版权合规要求

1. 用户承诺：使用本项目时，仅通过合规插件获取音乐相关信息，且获取、使用版权内容的行为符合**《中华人民共和国著作权法》**及相关法律法规，不侵犯**任何第三方**合法权益。
2. 用户需知晓：任何未经授权下载、传播、使用受版权保护的音乐文件的行为，均可能构成侵权，需自行承担法律后果。
3. 本项目倡导 “尊重版权、支持正版”，提醒用户通过官方音乐平台获取授权音乐服务。

### 四、免责声明

1. 因用户使用非合规插件、违反法律法规或第三方协议导致的任何法律责任（包括但不限于侵权赔偿、行政处罚），均由用户自行承担，本项目不承担任何直接、间接、连带或衍生责任。
2. 因本项目框架本身的 **bug** 导致的用户设备故障、数据丢失，本项目仅承担在合理范围内的技术修复责任，不承担由此产生的间接损失（如商誉损失、业务中断损失等）。
3. 本项目为开源学习项目，不提供商业服务，对用户使用本项目的效果不做任何明示或暗示的保证。

### 五、使用限制

1. 本项目仅允许用于**非商业、纯技术学习目的**，禁止用于任何商业运营、盈利活动，禁止修改后用于侵犯第三方权益的场景。
2. 禁止在违反当地法律法规、本声明或第三方协议的前提下使用本项目，若用户所在地区禁止此类工具的使用，应立即停止使用。
3. 禁止将本项目源代码或构建后的应用，与违规插件捆绑传播，禁止利用本项目从事任何违法违规活动。

### 六、其他

1. 本声明的效力、解释及适用，均适用中华人民共和国法律（不含港澳台地区法律）。
2. 若用户与本项目维护者就本声明产生争议，应首先通过友好协商解决；协商不成的，任何一方均有权向本项目维护者所在地有管辖权的人民法院提起诉讼。

## 赞助

若您认可本项目的技术价值，欢迎通过以下方式支持开发者（仅用于项目技术维护与迭代）：
<img src="./assets/image-20250827175356006.png" alt="赞助方式1" style="zoom:33%;" /><img src="./assets/image-20250827175547444.png" alt="赞助方式2" style="zoom: 33%;" />

---