mirror of
https://github.com/xmqywx/mio-plugin-music.git
synced 2026-04-12 02:04:33 +00:00
docs: add README.md and README.zh-CN.md
This commit is contained in:
parent
d044a6f0c0
commit
93078fb2d9
76
README.md
Normal file
76
README.md
Normal file
@ -0,0 +1,76 @@
|
||||
# Music Player Plugin for MioIsland
|
||||
|
||||
A native plugin that brings real-time music playback information to your MioIsland Notch bar. See what's currently playing across any music app on your Mac without leaving your workflow.
|
||||
|
||||
## Features
|
||||
|
||||
- Displays the currently playing track, artist, and album from any macOS music app (Apple Music, Spotify, etc.)
|
||||
- Reads system NowPlaying metadata — no need to configure individual apps
|
||||
- Lightweight native `.bundle` plugin with minimal resource usage
|
||||
- Smooth animated UI that matches the MioIsland design language
|
||||
- Appears as a header icon button in the Notch bar
|
||||
|
||||
## Screenshots
|
||||
|
||||
*Coming soon*
|
||||
|
||||
## Installation
|
||||
|
||||
### From MioIsland Plugin Store
|
||||
|
||||
1. Visit [miomio.chat](https://miomio.chat)
|
||||
2. Find "Music Player" and click Install
|
||||
3. MioIsland will automatically download and activate the plugin
|
||||
|
||||
### Manual Installation
|
||||
|
||||
```bash
|
||||
cp -r music-player.bundle ~/.config/codeisland/plugins/
|
||||
```
|
||||
|
||||
Restart MioIsland to load the plugin.
|
||||
|
||||
## Building from Source
|
||||
|
||||
Requirements:
|
||||
- macOS 15.0+
|
||||
- Xcode Command Line Tools
|
||||
- Swift 5.9+
|
||||
|
||||
```bash
|
||||
git clone https://github.com/xmqywx/mio-plugin-music.git
|
||||
cd mio-plugin-music
|
||||
bash build.sh
|
||||
```
|
||||
|
||||
The build script outputs:
|
||||
- `build/music-player.bundle` — the plugin (copy to `~/.config/codeisland/plugins/`)
|
||||
- `build/music-player.zip` — compressed bundle for marketplace upload
|
||||
|
||||
## Plugin Architecture
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `MioPlugin.swift` | Plugin protocol definition |
|
||||
| `MusicPlugin.swift` | Main plugin entry point — activate, deactivate, makeView |
|
||||
| `MusicPlayerView.swift` | SwiftUI view displaying track info |
|
||||
| `MusicHeaderButton.swift` | Header icon button for the Notch bar |
|
||||
| `NowPlayingBridge.swift` | Bridges macOS NowPlaying system APIs |
|
||||
|
||||
## How It Works
|
||||
|
||||
The plugin uses macOS `MRMediaRemoteGetNowPlayingInfo` API to read the system-wide NowPlaying information. This works with any app that reports playback status to the system, including:
|
||||
|
||||
- Apple Music
|
||||
- Spotify
|
||||
- YouTube (in browser)
|
||||
- VLC
|
||||
- Any app using MPNowPlayingInfoCenter
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
## Author
|
||||
|
||||
[@xmqywx](https://github.com/xmqywx)
|
||||
76
README.zh-CN.md
Normal file
76
README.zh-CN.md
Normal file
@ -0,0 +1,76 @@
|
||||
# MioIsland 音乐播放器插件
|
||||
|
||||
一款原生插件,将实时音乐播放信息带到你的 MioIsland Notch 栏。无需离开工作流,即可查看 Mac 上正在播放的音乐。
|
||||
|
||||
## 功能特性
|
||||
|
||||
- 显示当前播放的曲目、艺术家和专辑,支持任何 macOS 音乐应用(Apple Music、Spotify 等)
|
||||
- 读取系统 NowPlaying 元数据,无需单独配置各个应用
|
||||
- 轻量级原生 `.bundle` 插件,资源占用极低
|
||||
- 流畅的动画界面,与 MioIsland 设计语言一致
|
||||
- 以头部图标按钮的形式显示在 Notch 栏中
|
||||
|
||||
## 截图
|
||||
|
||||
*即将添加*
|
||||
|
||||
## 安装方式
|
||||
|
||||
### 从 MioIsland 插件商店安装
|
||||
|
||||
1. 访问 [miomio.chat](https://miomio.chat)
|
||||
2. 找到「音乐播放器」并点击安装
|
||||
3. MioIsland 会自动下载并激活插件
|
||||
|
||||
### 手动安装
|
||||
|
||||
```bash
|
||||
cp -r music-player.bundle ~/.config/codeisland/plugins/
|
||||
```
|
||||
|
||||
重启 MioIsland 即可加载插件。
|
||||
|
||||
## 从源码编译
|
||||
|
||||
环境要求:
|
||||
- macOS 15.0+
|
||||
- Xcode 命令行工具
|
||||
- Swift 5.9+
|
||||
|
||||
```bash
|
||||
git clone https://github.com/xmqywx/mio-plugin-music.git
|
||||
cd mio-plugin-music
|
||||
bash build.sh
|
||||
```
|
||||
|
||||
编译脚本会输出:
|
||||
- `build/music-player.bundle` — 插件文件(复制到 `~/.config/codeisland/plugins/`)
|
||||
- `build/music-player.zip` — 压缩包,用于上传到插件商店
|
||||
|
||||
## 插件架构
|
||||
|
||||
| 文件 | 用途 |
|
||||
|------|------|
|
||||
| `MioPlugin.swift` | 插件协议定义 |
|
||||
| `MusicPlugin.swift` | 插件主入口 — 激活、停用、创建视图 |
|
||||
| `MusicPlayerView.swift` | SwiftUI 视图,显示曲目信息 |
|
||||
| `MusicHeaderButton.swift` | Notch 栏的头部图标按钮 |
|
||||
| `NowPlayingBridge.swift` | 桥接 macOS NowPlaying 系统 API |
|
||||
|
||||
## 工作原理
|
||||
|
||||
插件使用 macOS `MRMediaRemoteGetNowPlayingInfo` API 读取系统级的 NowPlaying 信息。这适用于任何向系统报告播放状态的应用,包括:
|
||||
|
||||
- Apple Music
|
||||
- Spotify
|
||||
- YouTube(浏览器中)
|
||||
- VLC
|
||||
- 任何使用 MPNowPlayingInfoCenter 的应用
|
||||
|
||||
## 许可证
|
||||
|
||||
MIT
|
||||
|
||||
## 作者
|
||||
|
||||
[@xmqywx](https://github.com/xmqywx)
|
||||
Loading…
Reference in New Issue
Block a user