# musicfox

**Repository Path**: danlanhai/musicfox

## Basic Information

- **Project Name**: musicfox
- **Description**: Dart编写的命令行网易云音乐。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2020-08-05
- **Last Updated**: 2023-07-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


### 为了解决一些体验问题，该项目已使用go进行重写——[go-musicfox](https://github.com/anhoder/go-musicfox)，该仓库停止维护...


# musicfox

```
// TODO 优化
// 1. 电台-我的订阅 登录校验
// 2. 心动模式从当前歌曲开始
// 3. 随机播放保存历史播放列表
```

**给个star✨吧**

musicfox是一款使用Dart编写的网易云音乐命令行程序。

![GitHub repo size](https://img.shields.io/github/repo-size/anhoder/musicfox) ![GitHub](https://img.shields.io/github/license/anhoder/musicfox) ![Last Tag](https://badgen.net/github/tag/anhoder/musicfox) ![GitHub last commit](https://badgen.net/github/last-commit/anhoder/musicfox)![GitHub All Releases](https://img.shields.io/github/downloads/anhoder/musicfox/total)

![GitHub stars](https://img.shields.io/github/stars/anhoder/musicfox?style=social) ![GitHub forks](https://img.shields.io/github/forks/anhoder/musicfox?style=social)

## 感谢

感谢以下项目及其贡献者们（不限于）：

* [musicbox](https://github.com/darknessomi/musicbox)
* [NeteaseCloudMusicApi](https://github.com/Binaryify/NeteaseCloudMusicApi)
* [console.dart](https://github.com/DirectMyFile/console.dart)

## 预览

![欢迎界面](./preview/preview0.png)
![主界面1](./preview/preview1.png)
![主界面2](./preview/preview2.png)

## 更新

* Mac: `brew update musicfox`
* Linux或Windows: 下载最新的可运行文件

## 安装

**必须先安装mpg123**

### Mac

提供两种方式安装：

1. 使用brew安装: `brew tap anhoder/musicfox && brew install musicfox` 
2. 直接下载[Mac可执行文件](./bin/musicfox.mac)，在iTerm或Terminal中打开

Mac下默认使用AppleScript发送通知。如下：

![AppleScript](./preview/AppleScript.png)


如果想要更好的通知体验，可以安装`terminal-notifier`:

```sh
brew install terminal-notifier
```

效果如下：

![terminal-notifier](./preview/terminal-notifier.png)

### Linux
- Arch Linux

从[AUR](https://aur.archlinux.org/packages/musicfox/)安装 musicfox 

```sh
# 使用 AUR helper 
# yay
yay -S musicfox
# pikaur
pikaur -S musicfox

# 手动安装
git clone https://aur.archlinux.org/musicfox.git
cd musicfox
makepkg -si
```

- 直接下载[Linux可执行文件](./bin/musicfox.ubuntu)，在终端中执行。

> 本人没有Linux系统，该执行文件是在WSL2(Ubuntu 2004)下打包的，不保证其他Linux系统也能正常使用

Linux可以安装`libnotify-bin`来使用通知功能（未经测试）

### Windows

**Windows下存在几个已知问题，暂时没有解决方法：**
1. 暂停时会延迟几秒，播放时不会延迟
2. 登录或搜索输入时，会吞掉第一个字符
3. 上、下、左、右及ESC键无法监听，只能使用字母代替这些操作
4. 命令行窗口大小发生变化后，UI会变乱（因为Windows不支持resize事件）

*推荐在WSL下使用，WSL的声音转发可以参考我的另一个[项目](https://github.com/anhoder/wsl-audio-musicbox)*


下载[Windows可执行文件](./bin/musicfox.exe)，在命令行中运行即可。

> 推荐使用Windows Terminal

Windows下可以安装`notifu`实现通知，体验不太好（没找到其他更好的通知工具）

## 使用

```sh
$ musicfox
```

| 按键 | 作用 | 备注 |
| --- | --- | --- |
| h/H/LEFT | 左 | Windows只能使用`h`  |
| l/L/RIGHT | 右 | Windows只能使用`l` |
| k/K/UP | 上 | Windows只能使用`k` |
| j/J/DOWN | 下 | Windows只能使用`j` |
| q/Q | 退出 | Windows只能使用`q` |
| space | 暂停/播放 | |
| [ | 上一曲 | |
| ] | 下一曲 | |
| - | 减小音量 | |
| = | 加大音量 | |
| n/N/ENTER | 进入选中的菜单 | Windows只能使用`n` |
| b/B/ESC | 返回上级菜单 | Windows只能使用`b` |
| w/W | 退出并退出登录 | Windows只能使用`w` |
| p | 切换播放方式 | |
| P | 心动模式(仅在歌单中时有效) | Windows下使用`o` |
| , | 喜欢当前播放歌曲 | |
| < | 喜欢当前选中歌曲 | Windows下使用`;` |
| . | 当前播放歌曲移除出喜欢 | |
| > | 当前选中歌曲移除出喜欢 | Windows下使用`'` |
| / | 标记当前播放歌曲为不喜欢 | |
| ? | 标记当前选中歌曲为不喜欢 | Windows下使用`\` |

## TODO

* [x] 我的歌单
* [x] 每日推荐歌曲
* [x] 每日推荐歌单
* [x] 私人FM
* [x] 歌词显示
* [x] 欢迎界面
* [x] 搜索
    * [x] 按歌曲
    * [x] 按歌手
    * [x] 按歌词
    * [x] 按歌单
    * [x] 按专辑
    * [x] 按用户
* [x] 排行榜
* [x] 精选歌单
* [x] 最新专辑
* [x] 热门歌手
* [x] 云盘
* [x] 播放方式切换
* [x] 喜欢/取消喜欢
* [x] 心动模式/智能模式
* [x] 音乐电台 
* [ ] 将部分设置转化为文件可配置
    * [ ] 欢迎界面的欢迎语
    * [ ] 欢迎界面时长
    * [ ] 主题色
    * [ ] 歌词显示行数
    * [ ] ...

## 伴生项目

在该项目的开发过程中，我将一些通用的功能模块单独抽离出来，做成了几个伴生项目：

* [mp3_player](https://github.com/anhoder/mp3_player): dart命令行调用mpg123播放音乐
* [colorful_cmd](https://github.com/anhoder/colorful_cmd): 使用dart实现的一些命令行UI组件，如：WindowUI命令行窗口应用UI、RainbowProgress彩虹进度条、NotifierProxy三大平台通知代理、ColorText颜色文本...
* [netease_music_request](https://github.com/anhoder/netease_music_request): Dart实现的网易云音乐接口库，使用Dio发起请求，CookieJar管理Cookie信息


## 项目起因

在开始这个项目的之前，其实是已经有一个基于命令行的网易云音乐项目——[musicbox](https://github.com/darknessomi/musicbox)。

我也使用它听了很长一段时间的歌了，其中还贡献过一些代码，修复几个小问题。那为什么还要重新造一个轮子呢？

> 原因：
> 1. musicbox有一些我特别想要的功能是没有的
> 2. musicbox是使用python进行编写的，而我对python又并不是很熟悉，所以修改或者新增功能时比较麻烦

基于以上，我重新开启了这个项目。