docs: update README.md
This commit is contained in:
y1ndan
parent
ce2e4588e2
commit
782be7d72c
83
README.md
83
README.md
@ -3,7 +3,7 @@
|
||||
Genshin Impact Helper
|
||||
</h1>
|
||||
|
||||
|
||||
<img src="https://i.loli.net/2020/11/18/3zogEraBFtOm5nI.jpg" alt="Genshin Impact Helper" width="625" height="500" />
|
||||
[](https://github.com/y1ndan/genshin-impact-helper/stargazers)
|
||||
[](https://github.com/y1ndan/genshin-impact-helper/network)
|
||||
[](https://github.com/y1ndan/genshin-impact-helper/issues)
|
||||
@ -12,7 +12,7 @@ Genshin Impact Helper
|
||||
|
||||
</div>
|
||||
|
||||
## 📎前言
|
||||
## 💭前言
|
||||
|
||||
原神是我见过的唯一一个游戏本体和签到福利分离的游戏，玩家为了签到还要额外下载米游社 App。
|
||||
|
||||
@ -20,14 +20,28 @@ Genshin Impact Helper
|
||||
|
||||
我承认是馋了这 **6W+** 摩拉和紫色经验书的奖励，于是撸了这个项目，实现自动每日签到。
|
||||
|
||||
**如果觉得本项目对你有帮助，顺手点个 `Star` 吧QAQ❤**
|
||||
**如果觉得本项目对你有帮助，请顺手点个`Star`吧QAQ ♥**
|
||||
|
||||
## 🌀简介
|
||||
|
||||
Genshin Impact Helper 可以自动化为你获取原神每日福利。
|
||||
|
||||
## 💡特性
|
||||
|
||||
- [x] **自动签到** 程序会在每天早上自动执行签到流程，也可以随时通过部署教程的`步骤4`手动触发，具体时间参照[此处](.github/workflows/main.yml)
|
||||
- [x] **自动同步** 自动从上游源仓库拉取代码至复刻仓库
|
||||
- [x] **支持多服务器** 支持绑定单个官服或 Bilibili 服的米游社账号，目前不支持同时绑定多个服务器的账号
|
||||
- [x] **支持多账号** 不同`Cookie`值之间用`#`分开即可，如：`<Cookie1>#<Cookie2>`
|
||||
|
||||
## 📐部署
|
||||
|
||||
<details>
|
||||
<summary>查看教程</summary>
|
||||
|
||||
### 1. Fork 仓库
|
||||
|
||||
* 项目地址：[github/genshin-impact-helper](https://github.com/y1ndan/genshin-impact-helper)
|
||||
* 点击右上角`Fork`到自己的账号下
|
||||
- 项目地址：[github/genshin-impact-helper](https://github.com/y1ndan/genshin-impact-helper)
|
||||
- 点击右上角`Fork`到自己的账号下
|
||||
|
||||
> 
|
||||
|
||||
@ -37,14 +51,15 @@ Genshin Impact Helper
|
||||
|
||||
#### 2.1 方法一
|
||||
|
||||
* 按`F12`，打开`开发者工具`，找到`Network`并点击
|
||||
* 按`F5`刷新页面，按下图复制`Cookie`
|
||||
- 按`F12`，打开`开发者工具`，找到`Network`并点击
|
||||
- 按`F5`刷新页面，按下图复制`Cookie`
|
||||
|
||||
> 
|
||||
|
||||
#### 2.2 方法二
|
||||
|
||||
* 复制以下代码
|
||||
- 复制以下代码
|
||||
|
||||
```
|
||||
var cookie = document.cookie;
|
||||
var ask = confirm('Cookie:' + cookie + '\n\n是否复制内容到剪切板？');
|
||||
@ -55,17 +70,18 @@ if (ask == true) {
|
||||
msg = 'Cancel';
|
||||
}
|
||||
```
|
||||
* 按`F12`，打开`开发者工具`，找到`Console`并点击
|
||||
* 命令行粘贴代码并运行，获得类似`Cookie:xxxxxx`的输出信息
|
||||
* `xxxxxx`部分即为所需复制的`Cookie`，点击确定复制
|
||||
|
||||
- 按`F12`，打开`开发者工具`，找到`Console`并点击
|
||||
- 命令行粘贴代码并运行，获得类似`Cookie:xxxxxx`的输出信息
|
||||
- `xxxxxx`部分即为所需复制的`Cookie`，点击确定复制
|
||||
|
||||
### 3. 添加 Cookie 至 Secrets
|
||||
|
||||
* 回到项目页面，依次点击`Settings`-->`Secrets`-->`New secret`
|
||||
- 回到项目页面，依次点击`Settings`-->`Secrets`-->`New secret`
|
||||
|
||||
> 
|
||||
|
||||
* 建立名为`COOKIE`的 secret，值为`步骤2`中复制的`Cookie`内容，最后点击`Add secret`
|
||||
- 建立名为`COOKIE`的 secret，值为`步骤2`中复制的`Cookie`内容，最后点击`Add secret`
|
||||
|
||||
> 
|
||||
|
||||
@ -77,19 +93,24 @@ if (ask == true) {
|
||||
|
||||
> 
|
||||
|
||||
</details>
|
||||
|
||||
至此，部署完毕。
|
||||
|
||||
## 🔍结果
|
||||
|
||||
当你完成上述流程，可以在`Actions`页面点击`Genshin Impact Helper`-->`build`-->`Run sign`查看结果。
|
||||
|
||||
<details>
|
||||
<summary>查看结果</summary>
|
||||
|
||||
### 签到成功
|
||||
|
||||
如果成功，会输出类似`"result": "Success"`的信息：
|
||||
|
||||
```
|
||||
2020-11-18T22:11:45 INFO Sleep for 100 seconds ...
|
||||
2020-11-18T22:13:26 INFO UID is 102***054
|
||||
2020-11-18T22:13:26 INFO UID is 100***000
|
||||
2020-11-18T22:13:27 INFO {
|
||||
"result": "Success",
|
||||
"message": "{\"retcode\": 0, \"message\": \"OK\", \"data\": {\"code\": \"ok\"}}"
|
||||
@ -102,7 +123,7 @@ if (ask == true) {
|
||||
|
||||
```
|
||||
2020-11-17T22:11:33 INFO Sleep for 54 seconds ...
|
||||
2020-11-17T22:12:28 INFO UID is 102***054
|
||||
2020-11-17T22:12:28 INFO UID is 100***000
|
||||
2020-11-17T22:12:29 INFO {
|
||||
"result": "Failed",
|
||||
"message": "{\"data\": null, \"message\": \"请求异常\", \"retcode\": -401}"
|
||||
@ -112,30 +133,26 @@ Error: Process completed with exit code 255.
|
||||
|
||||
同时你会收到一封来自GitHub、标题为`Run failed: Genshin Impact Helper - master`的邮件。
|
||||
|
||||
## 更新
|
||||
</details>
|
||||
|
||||
因为请求上可能发生一些变化，所以上游源代码需要作出更改来适配这些变化，如果你没有更新项目源代码，会导致签到失败。更新的步骤如下。
|
||||
## 🔄更新
|
||||
|
||||
```
|
||||
git clone https://github.com/<Your GitHub ID>/genshin-impact-helper.git
|
||||
cd ./genshin-impact-helper
|
||||
git pull https://github.com/y1ndan/genshin-impact-helper.git master
|
||||
git push origin master
|
||||
```
|
||||
因为接口请求上可能发生一些变化，所以上游源代码需要作出更改来适配这些变化，如果你没有及时更新项目源代码，可能会导致签到失败。
|
||||
|
||||
以上步骤可以在任意[Linux](https://zh.wikipedia.org/wiki/Linux)中执行，或者在[Windows](https://zh.wikipedia.org/wiki/Microsoft_Windows)中通过安装[Git](https://zh.wikipedia.org/wiki/Git)，之后在`Git Bash`软件中完成。
|
||||
为解决此问题，项目开启了自动同步上游源代码的工作流程。该功能生效于 2020 年 12 月 04 日之后复刻的项目。
|
||||
|
||||
> 1. Git可以在[此处](https://git-scm.com/downloads)下载，更多信息可以查阅[此处](https://git-scm.com/book/)。
|
||||
> 2. 更新完毕后，不需要重新部署Actions。
|
||||
若在此时间之前复刻，可按照以下步骤更新：
|
||||
|
||||
## 说明
|
||||
- 下载[sync.yml](https://raw.githubusercontent.com/y1ndan/genshin-impact-helper/master/.github/workflows/sync.yml)文件
|
||||
- 自行上传`sync.yml`文件至**你的 Fork 仓库**的`.github/workflows`目录下
|
||||
- 到`Actions`页面手动触发一次名为`Auto Sync Fork`的工作流程
|
||||
|
||||
此代码通过模拟浏览器使用Cookies登录米游社网页，点击页面完成签到来实现功能。签到功能通过官方公开的API实现，非游戏外挂。
|
||||
## ❗️协议
|
||||
|
||||
## ❗️注意
|
||||
此代码通过模拟浏览器使用 Cookies 登录米游社网页，点击页面完成签到来实现签到。功能通过官方公开的 API 实现，并非游戏外挂。
|
||||
|
||||
1. 程序会在每天早上自动执行签到流程，也可以随时通过上述`步骤4`手动触发，具体时间参照[此处](.github/workflows/main.yml)
|
||||
2. 登录失效时，尝试重新更换`Cookie`
|
||||
3. 支持多账号，不同`Cookie`之间用`#`分开即可
|
||||
4. 支持官服和 B 服
|
||||
使用 Genshin Impact Helper 即表明，您知情并同意：
|
||||
|
||||
- 用户之 Cookie 被储存于 Github 服务器，只供本项目使用。若 Github 服务器被攻破，则您的 Cookie 有遭到泄露的风险。除此之外，开发者无权获取您的 Cookie；即使是用户，一旦创建完成`Secrets`，也无法再次从中查看 Cookie
|
||||
|
||||
- Genshin Impact Helper 不会对您的任何损失负责，包括但不限于奖励回收、账号异常、刻晴被削、矿产被挖、核弹爆炸、第三次世界大战等
|
||||
|
||||
Loading…
Reference in New Issue
Block a user