docs: merge usage.zh to readme; remove English readme
This commit is contained in:
parent
deaf349d15
commit
12ce7cfeea
1
Jenkinsfile
vendored
1
Jenkinsfile
vendored
@ -22,7 +22,6 @@ pipeline {
|
||||
cmake --preset vs -DCMAKE_BUILD_TYPE=Release
|
||||
cmake --build --preset vs-release --config Release
|
||||
copy /y README.MD .\\build\\vs2022\\Release\\
|
||||
copy /y Usage*.txt .\\build\\vs2022\\Release\\
|
||||
copy /y LICENSE .\\build\\vs2022\\Release\\
|
||||
'''
|
||||
}
|
||||
|
59
README.MD
59
README.MD
@ -1,32 +1,47 @@
|
||||
# kgg-dec
|
||||
|
||||
Kugou `kgg` decryption tool.
|
||||
酷狗 `kgg` 文件解密工具。
|
||||
|
||||
## Build
|
||||
## 使用方法 (快捷)
|
||||
|
||||
Build in Windows with CMake + Visual Studio 2022
|
||||
1. 将 `kgg-dec.exe` 与酷狗安装目录下的 `infra.dll` 拷贝到 `kgg` 文件所在目录。
|
||||
2. 双击 `kgg-dec.exe` 开始解密当前目录。
|
||||
|
||||
## 使用方法 (命令行)
|
||||
|
||||
1. 从酷狗安装目录拷贝 `infra.dll` 文件到 `kgg-dec.exe` 的目录。
|
||||
2. 启动 `kgg-dec.exe`,其中第一个参数为含有 `kgg` 文件的目录。
|
||||
3. 你也可以使用 `--` 来将参数后的 `-` 开头的参数视为输入文件或目录。
|
||||
4. 你可以指定多项输入文件或目录。
|
||||
|
||||
### 其它参数
|
||||
|
||||
* `--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:\KGG\1.kgg"`: 解密 `D:\Music` 目录下的所有 `*.kgg` 文件,以及 `1.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`。
|
||||
|
||||
## 构建
|
||||
|
||||
在 Windows 下使用 CMake + Visual Studio 2022 构建。
|
||||
|
||||
```cmd
|
||||
cmake --preset vs -DCMAKE_BUILD_TYPE=Release
|
||||
cmake --build --preset vs-release --config Release
|
||||
copy /y README.MD .\\build\\vs2022\\
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
1. Copy `infra.dll` from KuGou installation directory to where `kgg-dec.exe` is located.
|
||||
2. Invoke exe with path to the directory containing kgg file.
|
||||
|
||||
```shell
|
||||
kgg-dec.exe .
|
||||
```
|
||||
|
||||
### CLI Options
|
||||
|
||||
* `--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.
|
||||
|
38
Usage.zh.txt
38
Usage.zh.txt
@ -1,38 +0,0 @@
|
||||
# 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. 你可以指定多项输入文件或目录。
|
||||
|
||||
或者:
|
||||
|
||||
1. 将 `kgg-dec.exe` 与 `infra.dll` 拷贝到 KGG 所在目录。
|
||||
2. 双击 `kgg-dec.exe`,开始解密当前目录。
|
||||
|
||||
其它参数:
|
||||
|
||||
* `--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`(大多数情况下能正常工作)。
|
Loading…
Reference in New Issue
Block a user