mirror of
https://jihulab.com/DGP-Studio/Snap.Hutao.Docs.git
synced 2025-11-19 21:16:31 +08:00
Merge branch 'main' into next-patch
This commit is contained in:
@@ -10,9 +10,9 @@ Documents for [Snap Hutao project](https://github.com/DGP-Studio/Snap.Hutao). Yo
|
|||||||
|
|
||||||
- Install [NodeJS 18](https://nodejs.org/en/download/)
|
- Install [NodeJS 18](https://nodejs.org/en/download/)
|
||||||
- Use [GitHub Desktop](https://desktop.github.com/) or Git command to clone this repository (`git clone`)
|
- Use [GitHub Desktop](https://desktop.github.com/) or Git command to clone this repository (`git clone`)
|
||||||
- Run `npm install` in the root directory of the project
|
- Run `pnpm install` in the root directory of the project
|
||||||
|
|
||||||
### Local Test
|
### Local Test
|
||||||
|
|
||||||
- Run `npm run docs:dev` in the root directory of the project
|
- Run `pnpm run docs:dev` in the root directory of the project
|
||||||
- The document will run at `http://localhost:8080` by default
|
- The document will run at `http://localhost:8080` by default
|
||||||
|
|||||||
@@ -16,6 +16,6 @@ export const enNavbar = navbar([
|
|||||||
{
|
{
|
||||||
text: "Service Availability",
|
text: "Service Availability",
|
||||||
icon: "iconfont icon-define",
|
icon: "iconfont icon-define",
|
||||||
link: "https://status.hut.ao/"
|
link: "https://status.hut.ao/",
|
||||||
}
|
},
|
||||||
]);
|
]);
|
||||||
|
|||||||
@@ -16,6 +16,6 @@ export const zhNavbar = navbar([
|
|||||||
{
|
{
|
||||||
text: "服务可用性",
|
text: "服务可用性",
|
||||||
icon: "iconfont icon-define",
|
icon: "iconfont icon-define",
|
||||||
link: "https://status.hut.ao/"
|
link: "https://status.hut.ao/",
|
||||||
}
|
},
|
||||||
]);
|
]);
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ export const enSidebar = sidebar({
|
|||||||
icon: "iconfont icon-github",
|
icon: "iconfont icon-github",
|
||||||
text: "Open Source Development",
|
text: "Open Source Development",
|
||||||
prefix: "development/",
|
prefix: "development/",
|
||||||
children: "structure"
|
children: "structure",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: "iconfont icon-article",
|
icon: "iconfont icon-article",
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ export const zhSidebar = sidebar({
|
|||||||
icon: "iconfont icon-github",
|
icon: "iconfont icon-github",
|
||||||
text: "开源开发",
|
text: "开源开发",
|
||||||
prefix: "development/",
|
prefix: "development/",
|
||||||
children: "structure"
|
children: "structure",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: "iconfont icon-article",
|
icon: "iconfont icon-article",
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ export default hopeTheme({
|
|||||||
|
|
||||||
iconAssets: [
|
iconAssets: [
|
||||||
"iconfont",
|
"iconfont",
|
||||||
"https://at.alicdn.com/t/c/font_3861247_nm7gjy97qqd.css"
|
"https://at.alicdn.com/t/c/font_3861247_nm7gjy97qqd.css",
|
||||||
],
|
],
|
||||||
|
|
||||||
logo: "https://img.alicdn.com/imgextra/i4/1797064093/O1CN01vK3m2w1g6duwt8quS_!!1797064093.png",
|
logo: "https://img.alicdn.com/imgextra/i4/1797064093/O1CN01vK3m2w1g6duwt8quS_!!1797064093.png",
|
||||||
@@ -80,6 +80,18 @@ export default hopeTheme({
|
|||||||
|
|
||||||
components: {
|
components: {
|
||||||
components: ["Badge", "BiliBili"],
|
components: ["Badge", "BiliBili"],
|
||||||
|
rootComponents: {
|
||||||
|
notice: [
|
||||||
|
{
|
||||||
|
path: "/zh/",
|
||||||
|
title: "加入我们",
|
||||||
|
content:
|
||||||
|
"如果你有<b>软件开发</b>,<b>网页前端</b>,<b>文档管理</b>或<b>视频创作</b>的经验,并希望将其施展于胡桃工具箱项目中,欢迎<a href='http://hut.ao/zh/project.html#%E5%8A%A0%E5%85%A5%E6%88%91%E4%BB%AC'>加入开发团队</a>",
|
||||||
|
fullscreen: false,
|
||||||
|
showOnce: false,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
feed: {
|
feed: {
|
||||||
@@ -91,13 +103,12 @@ export default hopeTheme({
|
|||||||
},
|
},
|
||||||
|
|
||||||
mdEnhance: {
|
mdEnhance: {
|
||||||
gfm: false,
|
align: true,
|
||||||
|
footnote: true,
|
||||||
imgLazyload: true,
|
imgLazyload: true,
|
||||||
include: true,
|
include: true,
|
||||||
tabs: true,
|
tabs: true,
|
||||||
footnote: true,
|
tasklist: true,
|
||||||
align: true,
|
|
||||||
tasklist: true
|
|
||||||
},
|
},
|
||||||
|
|
||||||
pwa: {
|
pwa: {
|
||||||
|
|||||||
@@ -102,6 +102,40 @@ Run Snap Hutao as Administrator to edit your settings to solve this issue.
|
|||||||
running as Administrator
|
running as Administrator
|
||||||
- This issue comes from Windows kernel, and it's hard to locate, so we suggest you to update your OS to the latest version
|
- This issue comes from Windows kernel, and it's hard to locate, so we suggest you to update your OS to the latest version
|
||||||
|
|
||||||
|
## How to Recover `config.ini` Configuration File
|
||||||
|
|
||||||
|
In some particular conditions (such as wrong game folder permission), `config.ini` may lose after server conversion.
|
||||||
|
This will cause user not able to get into advanced launcher page and launch the game.
|
||||||
|
|
||||||
|
After identify the server version on your device, you can manually create and fill the configuration file with the right
|
||||||
|
content. The following are common configurations.
|
||||||
|
|
||||||
|
::: tabs#game_config_samples
|
||||||
|
|
||||||
|
@tab CN Server Official
|
||||||
|
|
||||||
|
```
|
||||||
|
[General]
|
||||||
|
channel=1
|
||||||
|
cps=mihoyo
|
||||||
|
game_version=4.1.0
|
||||||
|
sub_channel=1
|
||||||
|
plugin_7_version=1.0.0
|
||||||
|
```
|
||||||
|
|
||||||
|
@tab Global Server Official
|
||||||
|
|
||||||
|
```
|
||||||
|
[General]
|
||||||
|
channel=1
|
||||||
|
cps=mihoyo
|
||||||
|
game_version=4.1.0
|
||||||
|
sub_channel=0
|
||||||
|
plugin_7_version=1.0.0
|
||||||
|
```
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
## How to Fully Backup/Recover Client Data
|
## How to Fully Backup/Recover Client Data
|
||||||
|
|
||||||
::: warning Data Security Warning
|
::: warning Data Security Warning
|
||||||
|
|||||||
@@ -8,6 +8,11 @@ order: 3
|
|||||||
|
|
||||||
# Known Issue
|
# Known Issue
|
||||||
|
|
||||||
This document records known issues that **need to be fixed**.
|
You can view all issues on [GitHub Issue page](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aissue)
|
||||||
|
|
||||||
You can view latest version of opened BUG report on [https://github.com/DGP-Studio/Snap.Hutao/issues](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aissue+label%3ABUG+)
|
| Category | Flag |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
|
||||||
|
| [All Opened BUG Issues](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aissue+label%3ABUG+is%3Aopen) | Labeled with `BUG` |
|
||||||
|
| [All Opened Feature Request Issues](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aopen+is%3Aissue+label%3A%E5%8A%9F%E8%83%BD) | Labeled with `功能` (Feature) |
|
||||||
|
| [Fixed and Resolved Issues](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aissue+label%3A%E5%B7%B2%E4%BF%AE%E5%A4%8D) | Labeled with `已修复` (Fixed) |
|
||||||
|
| [Issues will be Fixed in Next Version](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aissue+label%3A%E7%AD%89%E5%BE%85%E5%8F%91%E5%B8%83) | Labeled with `等待发布` (Ready for Publish) |
|
||||||
|
|||||||
@@ -22,19 +22,19 @@ You can find all [unsolved opened issues](https://github.com/DGP-Studio/Snap.Hut
|
|||||||
5. Switch git branch to `develop`
|
5. Switch git branch to `develop`
|
||||||
6. Open project solution with your Visual Studio and then you are ready to go
|
6. Open project solution with your Visual Studio and then you are ready to go
|
||||||
|
|
||||||
## Enable Debug
|
## <HopeIcon icon="iconfont icon-debug" size="1.5rem" color="rgb(73,156,84)" /> Enable Debug
|
||||||
|
|
||||||
1. Download and install `Sysinternals Suite` from [Microsoft Store](https://www.microsoft.com/store/productid/9P7KNL5RWT25) or [Microsoft website](https://learn.microsoft.com/en-us/sysinternals/downloads/sysinternals-suite)
|
1. Download and install `Sysinternals Suite` from [Microsoft Store](https://www.microsoft.com/store/productid/9P7KNL5RWT25) or [Microsoft website](https://learn.microsoft.com/en-us/sysinternals/downloads/sysinternals-suite)
|
||||||
2. Locate and run `DebugView` program in the installed app list or unzipped folder
|
2. Locate and run `DebugView` program in the installed app list or unzipped folder
|
||||||
3. Run Snap Hutao client
|
3. Run Snap Hutao client
|
||||||
4. Check DebugView output
|
4. Check DebugView output
|
||||||
|
|
||||||
## <HopeIcon icon="iconfont icon-pull-request" size="1.5rem" /> Start Pull Request
|
## <HopeIcon icon="iconfont icon-pull-request" size="1.5rem" color="rgb(130,80,223)"/> Start Pull Request
|
||||||
|
|
||||||
- All code-related changes from authors' own branches are only allowed be merged to `develop` branch
|
- All code-related changes from authors' own branches are only allowed be merged to `develop` branch
|
||||||
- Please use [keywords](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests) to link your PR or commits with issues, so issues can be automatically closed once commits are merged into `main` branch.
|
- Please use [keywords](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests) to link your PR or commits with issues, so issues can be automatically closed once commits are merged into `main` branch.
|
||||||
|
|
||||||
## <HopeIcon icon="iconfont icon-build-package" size="1.5rem" /> Test Binary Package
|
## <HopeIcon icon="iconfont icon-build-package" size="1.5rem" color="rgb(254,189,105)" /> Test Binary Package
|
||||||
|
|
||||||
Once the code in updated in `develop` and `main` branches, an Azure Pipeline CI script will build the latest code to `Snap Hutao Alpha` package. Once the package is built, it will be released on [GitHub Release page](https://github.com/DGP-Studio/Snap.Hutao/releases) as a pre-released package.
|
Once the code in updated in `develop` and `main` branches, an Azure Pipeline CI script will build the latest code to `Snap Hutao Alpha` package. Once the package is built, it will be released on [GitHub Release page](https://github.com/DGP-Studio/Snap.Hutao/releases) as a pre-released package.
|
||||||
|
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ comment: false
|
|||||||
- Redesigned advanced game launcher page UI
|
- Redesigned advanced game launcher page UI
|
||||||
- User now can view and select launcher parameters in advanced game launcher
|
- User now can view and select launcher parameters in advanced game launcher
|
||||||
|
|
||||||
## 1.7.11
|
## 1.7.11 <Badge text="hotfix" type="tip" />
|
||||||
|
|
||||||
- Fixed the game launching arguments error (hotfix)
|
- Fixed the game launching arguments error (hotfix)
|
||||||
|
|
||||||
|
|||||||
@@ -134,6 +134,38 @@ comment: false
|
|||||||
6. 重新进入胡桃客户端的 `游戏启动器` 界面,`游戏路径不正确` 错误应不再出现,且`服务器`设置一栏为空。此时,你可以选择原本的服务器版本(国际服)
|
6. 重新进入胡桃客户端的 `游戏启动器` 界面,`游戏路径不正确` 错误应不再出现,且`服务器`设置一栏为空。此时,你可以选择原本的服务器版本(国际服)
|
||||||
并立刻启动游戏,或选择新的服务器目标(国服)并转换客户端版本。
|
并立刻启动游戏,或选择新的服务器目标(国服)并转换客户端版本。
|
||||||
|
|
||||||
|
## 如何恢复 `config.ini` 配置文件
|
||||||
|
|
||||||
|
在某些特定条件下(如游戏目录权限错误),`config.ini` 文件会在转服后丢失。这会造成无法进入胡桃工具箱高级启动器界面和游戏无法正常启动。
|
||||||
|
|
||||||
|
在判断你当前的游戏版本后,你可以在游戏目录下手动创建并填入对应的配置文件,下面是常见的配置文件内容。
|
||||||
|
|
||||||
|
::: tabs#game_config_samples
|
||||||
|
|
||||||
|
@tab 国服 Official
|
||||||
|
|
||||||
|
```
|
||||||
|
[General]
|
||||||
|
channel=1
|
||||||
|
cps=mihoyo
|
||||||
|
game_version=4.1.0
|
||||||
|
sub_channel=1
|
||||||
|
plugin_7_version=1.0.0
|
||||||
|
```
|
||||||
|
|
||||||
|
@tab 国际服 Official
|
||||||
|
|
||||||
|
```
|
||||||
|
[General]
|
||||||
|
channel=1
|
||||||
|
cps=mihoyo
|
||||||
|
game_version=4.1.0
|
||||||
|
sub_channel=0
|
||||||
|
plugin_7_version=1.0.0
|
||||||
|
```
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
## 如何完整地备份/恢复客户端数据
|
## 如何完整地备份/恢复客户端数据
|
||||||
|
|
||||||
::: warning 数据安全提示
|
::: warning 数据安全提示
|
||||||
|
|||||||
@@ -8,6 +8,11 @@ redirectFrom: /advanced/known-issue.html
|
|||||||
|
|
||||||
# 已知问题
|
# 已知问题
|
||||||
|
|
||||||
该文档包含由所有已知问题和修复计划
|
你可以在 [GitHub Issue 页面](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aissue) 查看全部的议题
|
||||||
|
|
||||||
你可以在 [https://github.com/DGP-Studio/Snap.Hutao/issues](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aissue+label%3ABUG+) 查看最新的来自社区的 BUG 报告
|
| 类别 | 特征 |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
|
||||||
|
| [全部未关闭的 BUG 议题](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aissue+label%3ABUG+is%3Aopen) | 包含标签 `BUG` |
|
||||||
|
| [全部未关闭的功能提案](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aopen+is%3Aissue+label%3A%E5%8A%9F%E8%83%BD) | 包含标签 `功能` |
|
||||||
|
| [已修复或已实现的功能](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aissue+label%3A%E5%B7%B2%E4%BF%AE%E5%A4%8D) | 包含标签 `已修复` |
|
||||||
|
| [将在下一版本修复的问题](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aissue+label%3A%E7%AD%89%E5%BE%85%E5%8F%91%E5%B8%83) | 包含标签 `等待发布` |
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
category: [open source, development]
|
category: [开源, 开发]
|
||||||
tag: ["开发", "GitHub"]
|
tag: ["开发", "GitHub"]
|
||||||
icon: iconfont icon-code
|
icon: iconfont icon-code
|
||||||
order: 2
|
order: 2
|
||||||
@@ -21,20 +21,20 @@ order: 2
|
|||||||
5. 将分支切换为 `develop`
|
5. 将分支切换为 `develop`
|
||||||
6. 使用你的 Visual Studio 打开项目 solution,接下来你就可以开始编辑代码了
|
6. 使用你的 Visual Studio 打开项目 solution,接下来你就可以开始编辑代码了
|
||||||
|
|
||||||
## 开启 Debug
|
## <HopeIcon icon="iconfont icon-debug" size="1.5rem" color="rgb(73,156,84)" /> 开启 Debug
|
||||||
|
|
||||||
1. 从[微软商店](https://www.microsoft.com/store/productid/9P7KNL5RWT25)或[微软官网](https://learn.microsoft.com/zh-cn/sysinternals/downloads/sysinternals-suite)下载并安装 `Sysinternals Suite`
|
1. 从[微软商店](https://www.microsoft.com/store/productid/9P7KNL5RWT25)或[微软官网](https://learn.microsoft.com/zh-cn/sysinternals/downloads/sysinternals-suite)下载并安装 `Sysinternals Suite`
|
||||||
2. 从开始菜单或解压后的文件中找到 `DebugView` 并启动
|
2. 从开始菜单或解压后的文件中找到 `DebugView` 并启动
|
||||||
3. 启动 Snap Hutao 主程序
|
3. 启动 Snap Hutao 主程序
|
||||||
4. 观察 DebugView 的输出
|
4. 观察 DebugView 的输出
|
||||||
|
|
||||||
## <HopeIcon icon="iconfont icon-pull-request" size="1.5rem" /> 发起 Pull Request
|
## <HopeIcon icon="iconfont icon-pull-request" size="1.5rem" color="rgb(130,80,223)"/> 发起 Pull Request
|
||||||
|
|
||||||
- 所有不是从项目其它分支发起的 Pull Request 都只被允许合并进 `develop` 分支
|
- 所有不是从项目其它分支发起的 Pull Request 都只被允许合并进 `develop` 分支
|
||||||
- 如果你提交的代码与已有的 issue 相关,请使用请使用[关键词](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests)
|
- 如果你提交的代码与已有的 issue 相关,请使用请使用[关键词](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests)
|
||||||
将你的 PR 与相关的 issue 关联起来。这样当你的 PR 最终被合并进 `main` 主分支时,这些 issue 将被自动关闭。
|
将你的 PR 与相关的 issue 关联起来。这样当你的 PR 最终被合并进 `main` 主分支时,这些 issue 将被自动关闭。
|
||||||
|
|
||||||
## <HopeIcon icon="iconfont icon-build-package" size="1.5rem" /> 测试打包程序
|
## <HopeIcon icon="iconfont icon-build-package" size="1.5rem" color="rgb(254,189,105)" /> 测试打包程序
|
||||||
|
|
||||||
一旦你的代码被合并进 `develop` 和 `main` 分支,一个 Azure Pipeline CI 流水线脚本将运行起来以构建所在分支的最新代码,并以 `Snap Hutao Alpha` 命名。
|
一旦你的代码被合并进 `develop` 和 `main` 分支,一个 Azure Pipeline CI 流水线脚本将运行起来以构建所在分支的最新代码,并以 `Snap Hutao Alpha` 命名。
|
||||||
当该测试包打包完成后,它将被以 `pre-release` 的形式发布在 [GitHub 发布页面](https://github.com/DGP-Studio/Snap.Hutao/releases)上。
|
当该测试包打包完成后,它将被以 `pre-release` 的形式发布在 [GitHub 发布页面](https://github.com/DGP-Studio/Snap.Hutao/releases)上。
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ comment: false
|
|||||||
- 重新设计了启动游戏页面的 UI
|
- 重新设计了启动游戏页面的 UI
|
||||||
- 用户现在可以在高级启动器中选择游戏启动参数
|
- 用户现在可以在高级启动器中选择游戏启动参数
|
||||||
|
|
||||||
## 1.7.11
|
## 1.7.11 <Badge text="hotfix" type="tip" />
|
||||||
|
|
||||||
- 修复了游戏启动器中窗口设置的错误 (hotfix)
|
- 修复了游戏启动器中窗口设置的错误 (hotfix)
|
||||||
|
|
||||||
|
|||||||
21
package.json
21
package.json
@@ -18,28 +18,19 @@
|
|||||||
"@vuepress/plugin-google-analytics": "2.0.0-beta.67",
|
"@vuepress/plugin-google-analytics": "2.0.0-beta.67",
|
||||||
"husky": "8.0.3",
|
"husky": "8.0.3",
|
||||||
"nano-staged": "0.8.0",
|
"nano-staged": "0.8.0",
|
||||||
"prettier": "2.8.8",
|
"prettier": "3.0.3",
|
||||||
"vue": "^3.3.4",
|
"vue": "^3.3.7",
|
||||||
"vuepress": "2.0.0-beta.67",
|
"vuepress": "2.0.0-beta.67",
|
||||||
"vuepress-plugin-redirect": "2.0.0-beta.237",
|
"vuepress-plugin-redirect": "2.0.0-beta.240",
|
||||||
"vuepress-theme-hope": "2.0.0-beta.237"
|
"vuepress-theme-hope": "2.0.0-beta.240"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=16.0.0"
|
"node": ">=18.12.0"
|
||||||
},
|
},
|
||||||
"nano-staged": {
|
"nano-staged": {
|
||||||
"*.md": [
|
"*.md": [
|
||||||
"prettier --write"
|
"prettier --write"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"packageManager": "pnpm@8.3.1",
|
"packageManager": "pnpm@8.9.2"
|
||||||
"pnpm": {
|
|
||||||
"peerDependencyRules": {
|
|
||||||
"ignoreMissing": [
|
|
||||||
"@algolia/client-search",
|
|
||||||
"react",
|
|
||||||
"react-dom"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
2845
pnpm-lock.yaml
generated
2845
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user