// Documentation
Mio Music 文档
Mio Music 是使用 Rust 与 GPUI 原生构建的跨平台桌面音乐播放器。这里收录安装与构建、日常使用、内部架构,以及面向插件开发者的完整参考。
开发阶段
项目仍在持续开发。macOS 已有开发包;Windows 与 Linux 的检查工作流已配置,但尚未完成实机验收。具体进度与已知缺口以仓库 README 为准。
快速开始
准备环境、克隆仓库(含插件子模块)、运行应用与生成 macOS 开发包。
使用指南
安装并配置插件、接入 Subsonic 等自托管服务器,以及播放、歌词、下载与备份。
架构概览
工作区里的各个 crate、数据流向,以及插件宿主与列表契约如何协作。
插件开发者文档
用 JavaScript 编写音乐列表插件与音源插件:契约、数据结构、运行时 API 与发布流程。
从哪里开始
- 想把应用跑起来:先读 快速开始,然后按 使用指南 安装第一个插件。在线来源完全由插件提供,没有插件就没有在线内容。
- 想写一个插件:从 开发概览 看清两类插件的区别,再跟着 快速上手 写出第一个可运行的插件。
- 想参与开发:读 架构概览,了解各 crate 的职责与检查命令。
关于这些文档
文档与官网一起放在仓库的 website/ 目录,是纯静态页面,不参与软件打包。内容以代码和仓库中的说明为准;如果发现与实际行为不一致,欢迎直接提交 Issue 或 Pull Request,每页底部都有「在 GitHub 上编辑此页」的入口。
当前文档仅提供中文版本。