diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml index b71be85..b3ac7f3 100644 --- a/.github/workflows/dotnet.yml +++ b/.github/workflows/dotnet.yml @@ -3,8 +3,8 @@ name: .NET on: push: branches: [ dev ] - # paths: - # - "versions/**" + paths: + - "versions/**" pull_request: branches: [ dev ] diff --git a/README.md b/README.md index f5b486b..1a5fc19 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,8 @@ macOS 和 Linux 用户请打开终端,切换到软件目录,一样执行命 程序的所有的配置信息,都在 `config.yaml` 进行更改,下面标注了各个配置的说明。 +其中是否开启的可选项为 `true` 或者 `false`,等同于中文的是和否。 + ```yaml globalOption: # 允许扫描的歌曲文件后缀名。 @@ -95,18 +97,27 @@ globalOption: plugin: - name: NetEase # 基于网易云音乐的歌词下载器。 priority: 1 # 优先级,升序排列,改为 -1 时禁用。 + depth: 30 # 搜索深度,值越大搜索结果越多,但搜索时间越长。 - name: QQ # 基于 QQ 音乐的歌词下载器。 priority: 2 + # depth: 10 # 暂时不支持。 - name: KuGou # 基于酷狗音乐的歌词下载器。 priority: 3 + depth: 10 # 歌词下载的一些共有配置参数。 config: - isOneLine: true # 双语歌词是否合并为一行展示。 - lineBreak: "\n" # 换行符的类型,记得使用双引号指定。 - isEnableTranslation: true # 是否启用翻译歌词。 - isSkipExistLyricFiles: false # 如果歌词文件已经存在,是否跳过这些文件。 + isOneLine: true # 双语歌词是否合并为一行展示。 + lineBreak: "\n" # 换行符的类型,记得使用双引号指定。 + isEnableTranslation: true # 是否启用翻译歌词。 + isOnlyOutputTranslation: false # 是否只输出翻译歌词。 + isSkipExistLyricFiles: false # 如果歌词文件已经存在,是否跳过这些文件。 + fileEncoding: 'utf-8' # 歌词文件的编码格式。 ``` +#### 支持的编码格式 + +详细信息请参考: [MSDN Encoding 列表](https://learn.microsoft.com/en-us/dotnet/api/System.Text.Encoding.GetEncodings?view=net-6.0#examples),使用 `identifier and name` 作为参数值填入 `config.yaml` 文件当中的 `fileEncoding`。 + ### 屏蔽字典 屏蔽字典适用于网易云音乐歌词下载,针对某些单词,网易云音乐使用了 * 号进行屏蔽,这个时候可以使用屏蔽字典,设置歌曲名的关键词替换。例如有一首歌曲叫做 *Fucking ABC* ,这个时候网易云实际的名字是 *Fu****ing* ,用户只需要在屏蔽字典加入替换逻辑即可,例如: @@ -123,6 +134,10 @@ globalOption: +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=real-zony/ZonyLrcToolsX&type=Timeline)](https://star-history.com/#real-zony/ZonyLrcToolsX&Timeline) + ## 路线图 - [x] 支持跨平台的 CLI 工具。 diff --git a/src/ZonyLrcTools.Cli/config.yaml b/src/ZonyLrcTools.Cli/config.yaml index af1f20f..a39beee 100644 --- a/src/ZonyLrcTools.Cli/config.yaml +++ b/src/ZonyLrcTools.Cli/config.yaml @@ -9,6 +9,7 @@ globalOption: isEnable: false # 是否启用代理。 ip: 127.0.0.1 # 代理服务 IP 地址。 port: 4780 # 代理服务端口号。 + updateUrl: https://api.zony.me/lrc-tools/update # 更新检查地址。 # 下载器的相关参数配置。 provider: