From f3ed4f969d4690e5829747ddaba289aa2cea17b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=B2=81=E6=A0=91=E4=BA=BA?= Date: Tue, 26 Nov 2024 06:26:33 +0900 Subject: [PATCH] docs: update readme --- README.MD | 10 ++++++---- Usage.zh.txt | 20 ++++++++++++++++---- 2 files changed, 22 insertions(+), 8 deletions(-) diff --git a/README.MD b/README.MD index f93e87c..6fde879 100644 --- a/README.MD +++ b/README.MD @@ -23,8 +23,10 @@ copy /y README.MD .\\build\\vs2022\\ ### CLI Options -* `[--infra-dll ]`: Specify the path to `infra.dll`, defaults to `infra.dll`. -* `[--scan-all-file-ext <0|1>]`: Whether to scan all file extensions, defaults to `0` to scan only `kgg` files. -* `[--db ]`: Specify the path to `KGMusicV3.db`, defaults to `%AppData%/Kugou8/KGMusicV3.db`. +* `--infra-dll` (Optional): Specify the path to `infra.dll`. Defaults to `infra.dll`. +* `--scan-all-file-ext` (Optional, `0` or `1`): Whether to scan all file extensions. Defaults to `0` to scan only `kgg` + files. +* `--db`: Specify the path to `KGMusicV3.db`, defaults to `%AppData%/Kugou8/KGMusicV3.db`. +* `--suffix`: Specify the suffix of the output file, defaults to `_kgg-dec`. -After specifying the parameters, you can specify any number of files or directories. \ No newline at end of file +After specifying the parameters, you can specify any number of files or directories. diff --git a/Usage.zh.txt b/Usage.zh.txt index fc1365c..e6e8e0d 100644 --- a/Usage.zh.txt +++ b/Usage.zh.txt @@ -1,11 +1,15 @@ # KGG 解密工具 by LSR 项目地址：https://git.unlock-music.dev/um/kgg-dec +项目协议：MIT License +注意事项：分发时请附上 `LICENSE` 开源协议文档。 使用方法 (命令行)： 1. 从酷狗安装目录拷贝 `infra.dll` 文件到 `kgg-dec.exe` 的目录。 2. 启动 `kgg-dec.exe`，其中第一个参数为含有 `*.kgg` 文件的目录。 +3. 你也可以使用 `--` 来将参数后的 `-` 开头的参数视为输入文件或目录。 +4. 你可以指定多项输入文件或目录。 或者： @@ -14,13 +18,21 @@ 其它参数： -* `[--infra-dll ]`: 指定 `infra.dll` 的路径，默认为 `infra.dll`。 -* `[--scan-all-file-ext <0|1>]`: 是否扫描所有文件后缀名，默认为 `0` 只扫描 `kgg` 文件。 -* `[--db ]`: 指定 `KGMusicV3.db` 的路径，默认为 `%AppData%/Kugou8/KGMusicV3.db`。 +* `--infra-dll` (可选): 指定 `infra.dll` 的路径，默认为 `infra.dll`。 +* `--scan-all-file-ext` (可选，`0` 或 `1`): 是否扫描所有文件后缀名。默认为 `0`，只扫描 `kgg` 文件。 +* `--db` (可选): 指定 `KGMusicV3.db` 的路径。默认为 `%AppData%/Kugou8/KGMusicV3.db`。 +* `--suffix` (可选): 指定解密后文件的后缀。默认为 `_kgg-dec`。 + +示例： + +* `kgg-dec.exe "D:\Music"`: 解密 `D:\Music` 目录下的所有 `*.kgg` 文件。 +* `kgg-dec.exe "D:\Music" "D:\Music\1.kgg" "D:\Music\2.kgg"`: 解密 `D:\Music` 目录下的所有 `*.kgg` 文件，以及 `1.kgg` 和 `2.kgg`。 +* `kgg-dec.exe "D:\Music" --scan-all-file-ext 1`: 尝试将 `D:\Music` 目录下的所有文件视为 `kgg` 文件来解密。 +* `kgg-dec.exe "D:\Music" --suffix ""`: 解密后不添加额外的后缀。 指定完参数后可以指定任意数量的文件或目录。 错误排查： 1. 需要至少播放一次 KGG 文件，并确保酷狗能正常播放。 -2. 文件后缀名嗅探代码只支持：`ogg` / `flac`，其他格式默认回退到 `mp3`。 +2. 文件后缀名嗅探代码只支持：`ogg` / `flac`。其他格式会被识别为 `mp3`（大多数情况下能正常工作）。