mirror of
https://github.com/real-zony/ZonyLrcToolsX.git
synced 2025-07-02 05:10:42 +00:00
82 lines
3.9 KiB
Markdown
82 lines
3.9 KiB
Markdown
简体中文 | [English](./en_US.md)
|
||
|
||
## 简介
|
||
|
||
ZonyLrcToolX 4 是一个基于 CEF 的跨平台歌词下载工具。
|
||
|
||
🚧 当前版本正在开发当中。
|
||
🚧 如果你想查看可以工作的代码，请切换到 dev 分支。
|
||
|
||
## 用法
|
||
|
||
Windows 用户请在软件目录当中，按住 Shift + 右键呼出菜单，然后选择 PowerShell (部分用户可能显示的是 *命令提示符*)，根据下述说明执行命令即可。
|
||
|
||
macOS 和 Linux 用户请打开终端，切换到软件目录，一样执行命令即可。
|
||
|
||
### 命令
|
||
|
||
#### 歌曲下载
|
||
|
||
子命令为 `download`，可用于下载歌词数据和专辑图像，支持多个下载器进行下载。
|
||
|
||
```shell
|
||
./ZonyLrcTools.Cli.exe download -d|dir <WAIT_SCAN_DIRECTORY> [-l|--lyric] [-a|--album] [-n|--number]
|
||
|
||
./ZonyLrcTools.Cli.exe download -h|--help
|
||
```
|
||
|
||
**例子**
|
||
|
||
```shell
|
||
# 下载歌词
|
||
./ZonyLrcTools.Cli.exe download -d "C:\歌曲目录" -l -n 2
|
||
# 下载专辑封面
|
||
./ZonyLrcTools.Cli.exe download -d "C:\歌曲目录" -a -n 2
|
||
```
|
||
|
||
#### 加密格式转换
|
||
|
||
目前软件支持 NCM、QCM(开发中...🚧) 格式的音乐文件转换，命令如下。
|
||
|
||
```shell
|
||
./ZonyLrcTools.Cli.exe util -t=Ncm D:\CloudMusic
|
||
```
|
||
|
||
### 配置文件
|
||
|
||
程序的部分配置信息需要在 `appsettings.json` 进行更改，下面标注了各个配置的说明。
|
||
|
||
| 属性 | 说明 | 示例值 |
|
||
| ------------------------------------------------- | ------------------------------------------------------------ | ------------------------------- |
|
||
| ToolOption.SupportFileExtensions | 允许扫描的歌曲文件后缀名，以 `;` 号隔开多个后缀。 | `*.mp3;*.flac` |
|
||
| ToolOption.NetworkOptions.Enable | 是否启用 HTTP 网络代理服务，true 表示启用，false 表示禁用。 | false |
|
||
| ToolOption.NetworkOptions.ProxyIp | HTTP 网络代理服务的 IP，在 `Enable` 为 false 时会忽略该属性值。 | 127.0.0.1 |
|
||
| ToolOption.NetworkOptions.ProxyPort | HTTP 网络代理服务的 端口，在 `Enable` 为 false 时会忽略该属性值。 | 8080 |
|
||
| TagInfoProviderOptions.FileNameRegularExpressions | 文件名 Tag 标签信息读取器使用，使用正则表达式匹配歌曲名和歌手，请使用命名分组编写正则表达式。 | (?'artist'.+)\\s-\\s(?'name'.+) |
|
||
| LyricDownloader.[n].Name | 指定歌词下载器的配置项标识，对应具体的歌词下载器。 | NetEase 或 QQ |
|
||
| LyricDownloader.[n].Priority | 指定歌词下载器的优先级，按升序排列，如果值设置为 `-1` 则代表禁用。 | `1` |
|
||
| BlockWordOptions.IsEnable | 是否启用屏蔽词词典。 | false |
|
||
| BlockWordOptions.BlockWordDictionaryFile | 屏蔽词词典的位置。 | `./BlockWords.json` |
|
||
|
||
### 屏蔽字典
|
||
|
||
屏蔽字典适用于网易云音乐歌词下载，针对某些单词，网易云音乐使用了 * 号进行屏蔽，这个时候可以使用屏蔽字典，设置歌曲名的关键词替换。例如有一首歌曲叫做 *Fucking ABC* ，这个时候网易云实际的名字是 *Fu****ing* ，用户只需要在屏蔽字典加入替换逻辑即可，例如:
|
||
|
||
```json
|
||
{
|
||
"Fuckking": "Fu****ing"
|
||
}
|
||
```
|
||
|
||
屏蔽字典默认路径为程序所在目录的 *BlockWords.json* 文件，用户可以在 *appsettings.json* 文件中配置其他路径。
|
||
|
||
## 捐赠
|
||
|
||
暂无
|
||
|
||
## 路线图
|
||
|
||
- [x] 支持跨平台的 CLI 工具。
|
||
- [ ] 基于 Web GUI 的操作站点。
|
||
- [ ] 支持插件系统(Lua 引擎)。
|