📘 Simpler Coding Instructions

This commit is contained in:
bitcookies
2024-06-05 11:10:49 +08:00
parent 3867ec8740
commit 05346bda87
6 changed files with 2269 additions and 89 deletions
+45 -45
View File
@@ -41,24 +41,24 @@ WinRAR 不是免费软件。如果你想使用它,你应当向 [__RARLAB__](ht
有多种方法可供选择:
+ [使用 Github Actions](#6-使用-Github-Actions)
+ [使用 Github Actions with secrets](#7-使用-Github-Actions-with-secrets)
+ [通过 Visual Studio 编译使用](#8-通过-Visual-Studio-编译使用)
+ [使用 Github Actions](#4-使用-Github-Actions)
+ [使用 Github Actions with secrets](#5-使用-Github-Actions-with-secrets)
+ [通过 Visual Studio 编译使用](#6-通过-Visual-Studio-编译使用)
## 4. 编码说明
### 3.1 编码说明
WinRAR Keygen 支持 `ASCII``ANSI``UTF-8` 三种编码类型,以下是三种编码的简单说明
WinRAR Keygen 支持 `ASCII``ANSI``UTF-8` 三种编码类型,对应支持的字符如下表
> [!WARNING]
> 建议暂时不要用 ANSI 编码方式生成非 ASCII 字符的 license,因为在 Windows Server 2022 上中文、日语和韩语的 PowerShell 控制台字符会出现乱码问题,[该问题微软正在修复](https://learn.microsoft.com/en-us/troubleshoot/windows-server/system-management-components/powershell-console-characters-garbled-for-cjk-languages)
> [!NOTE]
> 默认使用 `utf8`,但是你也可以指定编码为 `ascii` 或 `ansi`
| 编码 | 说明 | 支持的字符 |
| -------------------------------------------- | ------------------------------------------------------------ | ----------------------------------------------------- |
| [ASCII](https://en.wikipedia.org/wiki/ASCII) | 单字节编码,只使用最下面的 7 位,没有重音符号等 | 仅支持 ASCII 字符 |
| ANSI | 没有一种固定的 ANSI 编码。通常说的 ANSI 是指 “系统默认的本地/代码页”,它通过 [Encoding.Default](http://msdn.microsoft.com/en-us/library/system.text.encoding.default.aspx) 获得,通常是 [Windows-1252](http://en.wikipedia.org/wiki/Windows-1252),但也可以是其他本地 | 仅支持 ASCII 字符和您操作系统所设国家或地区的语言编码 |
| [UTF8](https://en.wikipedia.org/wiki/UTF-8) | 可变长度编码,每个码位 1-4 个字节(ASCII 值用 1 个字节编码为 ASCII) | 支持 UTF-8 编码字符 |
| 编码 | 支持的字符 | 字符示例 |
| -------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| [ASCII](https://en.wikipedia.org/wiki/ASCII) | 仅支持 ASCII 编码字符 | <img width="300px" src="assets/ascii-characters-light.svg#gh-light-mode-only"><img width="300px" src="assets/ascii-characters-dark.svg#gh-dark-mode-only"> |
| ANSI | 没有一种固定的 ANSI 编码,通常是 [Windows-1252](http://en.wikipedia.org/wiki/Windows-1252),但也可以是其他本地 | <img width="300px" src="assets/windows-1252-characters-light.svg#gh-light-mode-only"><img width="300px" src="assets/windows-1252-characters-dark.svg#gh-dark-mode-only"> |
| [UTF8](https://en.wikipedia.org/wiki/UTF-8) | 支持 UTF-8 编码字符 | ASCII characters, English, 简体中文, 繁體中文, Deutsch, Français, 日本語, 한국어, et al. |
## 5. License 类型
### 3.2 License 类型
WinRAR license 有 `rarreg.key``rarkey.rar` 两种类型,它们仅在导入上有区别:
@@ -67,7 +67,7 @@ WinRAR license 有 `rarreg.key` 和 `rarkey.rar` 两种类型,它们仅在导
| <img width="100px" src="assets/file-icon.svg"> | <img width="100px" src="assets/winrar-icon.svg"> |
| 拖动导入或放于指定位置 | 双击运行自动导入 |
如果你无法执行拖动操作,你可以尝试把 `rarreg.key` 放置以下目录中:
如果你无法执行拖动操作,你可以尝试把 `rarreg.key` 放置以下目录中:
```shell
C:\Users\yourname\AppData\Roaming\WinRAR\rarreg.key
@@ -75,16 +75,16 @@ C:\Users\yourname\AppData\Roaming\WinRAR\rarreg.key
你也可以将 `rarreg.key` 压缩成 `rarkey.rar` 然后双击运行,授权导入将会自动进行。
## 6. 使用 Github Actions
## 4. 使用 Github Actions
<details>
<summary>点击展开</summary>
新的 workflow 能很方便的帮助你生成 license,你只需跟随以下步骤即可:
> 你的 `Username` 和 `License Name` 会出现在 actions 日志中,如果你不想泄露这些信息,请参考 [7. 使用 Github Actions with secrets](#7-使用-Github-Actions-with-secrets)。
> 你的 `Username` 和 `License Name` 会出现在 actions 日志中,如果你不想泄露这些信息,请参考 [5. 使用 Github Actions with secrets](#5-使用-Github-Actions-with-secrets)。
### 6.1 Fork
### 4.1 Fork
点击该项目右上角的 **Fork** 按钮,fork 一份代码到你的 Github
@@ -92,7 +92,7 @@ C:\Users\yourname\AppData\Roaming\WinRAR\rarreg.key
![Fork](assets/fork-dark.png#gh-dark-mode-only)
### 6.2 允许 Fork 仓库运行 Workflows
### 4.2 允许 fork 仓库运行 workflows
返回到你刚刚 fork 完成的 repo,然后点击 **Actions** 去允许 workflows 在你的 fork repo 中运行:
@@ -100,11 +100,11 @@ C:\Users\yourname\AppData\Roaming\WinRAR\rarreg.key
![Workflow](assets/enable-workflows-dark.png#gh-dark-mode-only)
### 6.3 运行 workflow
### 4.3 运行 workflow
允许 workflow 后,选择 **WinRAR Keygen > Run workflow** 并填入信息就可以开始生成了:
> License 编码的区别请参考 [4. 编码说明](#4-编码说明)。
> License 编码的区别请参考 [3.1 编码说明](#31-编码说明)。
![Secrets](assets/run-ketgen-light.png#gh-light-mode-only)
@@ -120,18 +120,18 @@ C:\Users\yourname\AppData\Roaming\WinRAR\rarreg.key
`rarreg_file.zip` 解压缩后会得到 `rarreg.key`,然后拖动导入 WinRAR 即可。你也可以将 `rarreg.key` 压缩成 `rarkey.rar`,然后双击运行,授权导入将会自动进行。
如果你得到的是 key 是无效的,请查看 [解决方法](#9-无效的-Key)。
如果你得到的是 key 是无效的,请查看[解决方法](#7-无效的-Key)。
</details>
## 7. 使用 Github Actions with secrets
## 5. 使用 Github Actions with secrets
<details>
<summary>点击展开</summary>
使用 [secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) 可以帮助你隐藏 license 信息。
### 7.1 Fork
### 5.1 Fork
点击该项目右上角的 **Fork** 按钮,fork 一份代码到你的 Github
@@ -139,7 +139,7 @@ C:\Users\yourname\AppData\Roaming\WinRAR\rarreg.key
![Fork](assets/fork-dark.png#gh-dark-mode-only)
### 7.2 允许 Fork 仓库运行 Workflows
### 5.2 允许 fork 仓库运行 workflows
返回到你刚刚 fork 完成的 repo,然后点击 **Actions** 去允许 workflows 在你的 fork repo 中运行:
@@ -147,15 +147,15 @@ C:\Users\yourname\AppData\Roaming\WinRAR\rarreg.key
![Workflow](assets/enable-workflows-dark.png#gh-dark-mode-only)
### 7.3 创建 Secrets
### 5.3 创建 secrets
允许 workflows 后,进入 **Settings > Secrets and variables > Actions > New repository secret** 来创建 Secrets
允许 workflows 后,进入 **Settings > Secrets and variables > Actions > New repository secret** 来创建 secrets
![Secrets](assets/secrets-light.png#gh-light-mode-only)
![Secrets](assets/secrets-dark.png#gh-dark-mode-only)
创建三个 Secrets,名称为 `TEXT1``TEXT2``PWD`,并填入相关值:
创建三个 secrets,名称为 `TEXT1``TEXT2``PWD`,并填入相关值:
> 填入的值应与你选择的编码类型保持一致。
@@ -175,11 +175,11 @@ C:\Users\yourname\AppData\Roaming\WinRAR\rarreg.key
![Secrets Repo](assets/secrets-repo-dark.png#gh-dark-mode-only)
### 7.4 运行 workflow
### 5.4 运行 workflow
进入 **Actions** 选择 **WinRAR Keygen with secrets > Run workflow** 并填入信息:
> License 编码的区别请参考 [4. 编码说明](#4-编码说明)。
> License 编码的区别请参考 [3.1 编码说明](#31-编码说明)。
![Run](assets/run-workflow-light.png#gh-light-mode-only)
@@ -195,11 +195,11 @@ C:\Users\yourname\AppData\Roaming\WinRAR\rarreg.key
`rarreg_file.zip` 解压缩后会得到 `rarreg.7z`,使用你设置的密码进行解压缩获得 `rarreg.key`,然后拖动导入 WinRAR 即可。你也可以将 `rarreg.key` 压缩成 `rarkey.rar`,然后双击运行,授权导入将会自动进行。
如果你得到的是 key 是无效的,请查看 [解决方法](#9-无效的-Key)。
如果你得到的是 key 是无效的,请查看[解决方法](#7-无效的-Key)。
</details>
## 8. 通过 Visual Studio 编译使用
## 6. 通过 Visual Studio 编译使用
<details>
<summary>点击展开</summary>
@@ -208,7 +208,7 @@ C:\Users\yourname\AppData\Roaming\WinRAR\rarreg.key
如果你不想自行编译,也可以到 [Release](https://github.com/bitcookies/winrar-keygen/releases/) 页面获取对应版本的 `winrar-keygen.exe`
### 8.1 前提条件
### 6.1 前提条件
1. 请确保你有 **Visual Studio 2022**,因为这是一个 VS2022 项目。如果你仍在使用 Visual Studio 2019,可以在 [vs2019](https://github.com/bitcookies/winrar-keygen/tree/vs2019) 分支中找到适合 VS2019 的项目,但是此分支将不再维护。
@@ -231,7 +231,7 @@ C:\Users\yourname\AppData\Roaming\WinRAR\rarreg.key
$ vcpkg integrate install
```
### 8.2 编译
### 6.2 编译
1. 在 __Visual Studio__ 中打开这个项目;
2. 选择 `Release` 配置;
@@ -239,7 +239,7 @@ C:\Users\yourname\AppData\Roaming\WinRAR\rarreg.key
你将在 `bin/` 目录下看到生成的文件。
### 8.3 如何使用?
### 6.3 如何使用?
直接在终端执行以下代码,配置两个参数即可生成 `rarreg.key`。
@@ -277,7 +277,7 @@ dd4ab952600ba16a99236d910bfa995d5f60651ec451f462511507
将生成的信息以 **ANSI 编码** 的文本格式保存为 `rarreg.key`。
### 8.4 多语言的支持
### 6.4 多语言的支持
使用 ANSI 编码时,你只能使用你操作系统所在国家或地区的字符。ANSI 编码从 Powershell 7.4 以后开始支持,你还需要[升级你的 Powershell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.4)。
@@ -297,7 +297,7 @@ winrar-keygen.exe "日本語" "license" | Out-File -Encoding ansi rarreg.key
winrar-keygen.exe "한국어" "license" | Out-File -Encoding ansi rarreg.key
```
使用 UTF-8 编码生成多语言的 license 时,你可能需要在 “控制面板 > 时钟和区域 > 区域 > 管理 > 更改系统区域设置 ” 中勾选使用 “[Beta版:使用Unicode UTF-8提供全球语言支持](https://stackoverflow.com/a/57134096/10242225)” 才能正确的处理数据。但是不建议你这么操作,这可能会导致很多软件无法正常运行,建议[使用 Github Actions](#6-使用-Github-Actions)。
使用 UTF-8 编码生成多语言的 license 时,你可能需要在 “控制面板 > 时钟和区域 > 区域 > 管理 > 更改系统区域设置” 中勾选使用 “[Beta版:使用Unicode UTF-8提供全球语言支持](https://stackoverflow.com/a/57134096/10242225)” 才能正确的处理数据。但是不建议你这么操作,这可能会导致很多软件无法正常运行,建议[使用 Github Actions](#4-使用-Github-Actions)。
用 UTF-8 编码生成多语言的 license
@@ -319,13 +319,13 @@ winrar-keygen.exe "utf8:한국어" "license" | Out-File -Encoding utf8 rarreg.ke
</details>
## 9. 无效的 Key
## 7. 无效的 Key
为什么我生成的 `rarreg.key` 是无效的?
### 9.1 字符编码不正确
### 7.1 字符编码不正确
参数 `TEXT1` 和 `TEXT2` 需要满足[对应的编码要求](#4-编码说明)
参数 `TEXT1` 和 `TEXT2` 需要满足[对应的编码要求](#31-编码说明)
```console
winrar-keygen.exe <TEXT1> <TEXT2>
@@ -333,7 +333,7 @@ winrar-keygen.exe <TEXT1> <TEXT2>
具体可参考原理文档:[授权文件"rarreg.key"的生成](https://github.com/bitcookies/winrar-keygen/blob/master/README.HOW_DOES_IT_WORK.zh-CN.md#7-%E6%8E%88%E6%9D%83%E6%96%87%E4%BB%B6rarregkey%E7%9A%84%E7%94%9F%E6%88%90)
### 9.2 文本储存编码不正确
### 7.2 文本储存编码不正确
如果你使用了如下命令:
@@ -353,7 +353,7 @@ winrar-keygen.exe "Github" "Github.com" | Out-File -Encoding ansi rarreg.key
winrar-keygen.exe "utf8:Github" "Github.com" | Out-File -Encoding utf8 rarreg.key
```
### 9.3 关于简体中文版
### 7.3 关于简体中文版
在 [__RARLAB__](https://www.rarlab.com/) 下载的简体中文版 WinRAR 将会自带广告组件,即使使用了 `rarreg.key` 授权,广告组件依旧会出现。这是由于简体中文代理商的一些意见,RARLAB 已将简体中文安装包的公开链接更换成了带有广告的简体中文安装包。
@@ -378,20 +378,20 @@ https://www.rarlab.com/rar/winrar-x64-611sc.exe
请注意区分上述连接地址,更多方法可以查看 [Issues #14](https://github.com/bitcookies/winrar-keygen/issues/14) 和 [Issues #19](https://github.com/bitcookies/winrar-keygen/issues/19)。
## 10. 贡献
## 8. 贡献
### 10.1 反馈和建议
### 8.1 反馈和建议
如果您遇到了一些问题,可在 [Issues](https://github.com/bitcookies/winrar-keygen/issues) 页面反馈,会有很多热心的开发者及 Github 用户帮助你。
该项目欢迎贡献和建议,您可以在 [Issues](https://github.com/bitcookies/winrar-keygen/issues) 提出建议,或者进行提交拉取请求 😄
### 10.2 感谢
### 8.2 感谢
非常感谢一些热心的开发者,在 [Issues](https://github.com/bitcookies/winrar-keygen/issues) 帮助解答一些问题。
🏆 特别感谢 [@Sonic-The-Hedgehog-LNK1123](https://github.com/Sonic-The-Hedgehog-LNK1123)
## 11. 许可
## 9. 许可
使用 [MIT License](https://github.com/bitcookies/winrar-keygen/blob/master/LICENSE)