From 72f880ac4f22c9b1c70f30c0e696663706a481fa Mon Sep 17 00:00:00 2001 From: Masterain Date: Wed, 28 Sep 2022 19:37:43 -0700 Subject: [PATCH] re-structure --- docs/.vuepress/navbar/en.ts | 2 +- docs/.vuepress/navbar/zh.ts | 2 +- docs/.vuepress/sidebar/en.ts | 30 ++++++---- docs/.vuepress/sidebar/zh.ts | 6 +- .../FAQ/Gacha-system-and-export-principal.md | 0 docs/FAQ/README.md | 1 + .../FAQ/most-frequent-questions.md | 0 docs/README.md | 2 +- docs/documents/README.md | 0 .../FAQ/Gacha-system-and-export-principal.md | 60 +++++++++++++++++++ docs/en/FAQ/README.md | 1 + docs/en/FAQ/most-frequent-questions.md | 9 +++ docs/en/README.md | 4 +- docs/en/documents/README.md | 0 docs/en/documents/features/wish-export.md | 13 ---- docs/en/features/README.md | 1 + .../features/achievements.md | 0 .../{documents => en}/features/wish-export.md | 0 docs/en/statements/README.md | 1 + .../statements/bug-report.md | 0 docs/features/README.md | 1 + .../documents => }/features/achievements.md | 2 +- docs/features/wish-export.md | 33 ++++++++++ docs/statements/README.md | 1 + .../documents => }/statements/bug-report.md | 0 25 files changed, 137 insertions(+), 32 deletions(-) rename docs/{documents => }/FAQ/Gacha-system-and-export-principal.md (100%) create mode 100644 docs/FAQ/README.md rename docs/{documents => }/FAQ/most-frequent-questions.md (100%) delete mode 100644 docs/documents/README.md create mode 100644 docs/en/FAQ/Gacha-system-and-export-principal.md create mode 100644 docs/en/FAQ/README.md create mode 100644 docs/en/FAQ/most-frequent-questions.md delete mode 100644 docs/en/documents/README.md delete mode 100644 docs/en/documents/features/wish-export.md create mode 100644 docs/en/features/README.md rename docs/{documents => en}/features/achievements.md (100%) rename docs/{documents => en}/features/wish-export.md (100%) create mode 100644 docs/en/statements/README.md rename docs/{documents => en}/statements/bug-report.md (100%) create mode 100644 docs/features/README.md rename docs/{en/documents => }/features/achievements.md (96%) create mode 100644 docs/features/wish-export.md create mode 100644 docs/statements/README.md rename docs/{en/documents => }/statements/bug-report.md (100%) diff --git a/docs/.vuepress/navbar/en.ts b/docs/.vuepress/navbar/en.ts index 90a50bf09..c2a13f430 100644 --- a/docs/.vuepress/navbar/en.ts +++ b/docs/.vuepress/navbar/en.ts @@ -6,7 +6,7 @@ export const enNavbar = navbar([ { text: "文档", icon: "documents", - link: "/documents/" + link: "/features/README.md" }, { text: "GitHub", diff --git a/docs/.vuepress/navbar/zh.ts b/docs/.vuepress/navbar/zh.ts index 45fa59824..1871e554f 100644 --- a/docs/.vuepress/navbar/zh.ts +++ b/docs/.vuepress/navbar/zh.ts @@ -2,7 +2,7 @@ import { navbar } from "vuepress-theme-hope"; export const zhNavbar = navbar([ "/", - { text: "文档", icon: "article", link: "/documents/" }, + { text: "文档", icon: "article", link: "/features/README.md" }, { text: "下载", icon: "install", diff --git a/docs/.vuepress/sidebar/en.ts b/docs/.vuepress/sidebar/en.ts index 84dd468da..cf0d7b698 100644 --- a/docs/.vuepress/sidebar/en.ts +++ b/docs/.vuepress/sidebar/en.ts @@ -4,18 +4,28 @@ export const enSidebar = sidebar({ "/en/": [ "", { - icon: "discover", - text: "Demo", - prefix: "demo/", - link: "demo/", - children: "structure", + icon: "play", + text: "快速开始", + link: "quick-start.md" }, { - text: "Docs", - icon: "note", - prefix: "guide/", - children: "structure", + icon: "read", + text: "功能指南", + prefix: "/features/README.md", + children: "structure" }, - "slides", + { + icon: "ask", + text: "常见问题", + prefix: "/FAQ/README.md", + children: ["most-frequent-questions.md", "Gacha-system-and-export-principal.md"] + //children: "structure" + }, + { + icon: "article", + text: "声明和公告", + prefix: "/statements/README.md", + children: "structure" + } ], }); diff --git a/docs/.vuepress/sidebar/zh.ts b/docs/.vuepress/sidebar/zh.ts index f5a20affc..d669b08ac 100644 --- a/docs/.vuepress/sidebar/zh.ts +++ b/docs/.vuepress/sidebar/zh.ts @@ -11,20 +11,20 @@ export const zhSidebar = sidebar({ { icon: "read", text: "功能指南", - prefix: "documents/features/", + prefix: "/features/", children: "structure" }, { icon: "ask", text: "常见问题", - prefix: "documents/FAQ/", + prefix: "/FAQ/", //children: ["most-frequent-questions.md", "Gacha-system-and-export-principal.md"] children: "structure" }, { icon: "article", text: "声明和公告", - prefix: "documents/statements/", + prefix: "/statements/", children: "structure" } ], diff --git a/docs/documents/FAQ/Gacha-system-and-export-principal.md b/docs/FAQ/Gacha-system-and-export-principal.md similarity index 100% rename from docs/documents/FAQ/Gacha-system-and-export-principal.md rename to docs/FAQ/Gacha-system-and-export-principal.md diff --git a/docs/FAQ/README.md b/docs/FAQ/README.md new file mode 100644 index 000000000..80aa9567d --- /dev/null +++ b/docs/FAQ/README.md @@ -0,0 +1 @@ +[[toc]] \ No newline at end of file diff --git a/docs/documents/FAQ/most-frequent-questions.md b/docs/FAQ/most-frequent-questions.md similarity index 100% rename from docs/documents/FAQ/most-frequent-questions.md rename to docs/FAQ/most-frequent-questions.md diff --git a/docs/README.md b/docs/README.md index b967f2215..14d164112 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,7 +13,7 @@ actions: - text: 快速开始 link: /quick-start.md - text: 文档 - link: /documents/ + link: /features/ - text: 项目进度 link: project.md diff --git a/docs/documents/README.md b/docs/documents/README.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/en/FAQ/Gacha-system-and-export-principal.md b/docs/en/FAQ/Gacha-system-and-export-principal.md new file mode 100644 index 000000000..c22903089 --- /dev/null +++ b/docs/en/FAQ/Gacha-system-and-export-principal.md @@ -0,0 +1,60 @@ +--- +headerDepth: 0 +--- + +# 祈愿系统与导出原理 +> Gacha System and Principal + + +胡桃的祈愿系统相较 Snap Genshin 进行了整体架构上的重新设计。 + +本文将解释原神的祈愿记录机制和胡桃工具箱中祈愿导出功能的技术原理。 + +## 祈愿的获取 + +获取祈愿记录需要请求米哈游的API + +关于此API, 有下列几个注意点 +* 通过米哈游服务器的API，只能查询到过去6个月内的祈愿记录 + * 这也是原神客户端中祈愿记录的来源 +* API存在请求速率限制，过快的请求会导致后续的请求失败，无法正常获取数据 + +为了请求此API，我们需要四个关键参数 + +- 目前有下列几种方法可以获取这些参数 + * 遍历 Unity 的日志文件，查找用户打开的祈愿记录URL + * 代理本机流量，筛选祈愿记录URL + * 查找 CefBrowser 的浏览器缓存，找到祈愿记录URL + * 对于包含了Stoken的Cookie，调用genAuthKey API,获取参数 + * 高级用户手动输入相关URL + +在请求API后可以获取到零散的祈愿记录，在对其进行拼接后即可获得一份完整的祈愿记录列表 + +## 祈愿的存储 + +获得完整的祈愿记录列表后即可将其简单的序列化入本地数据库内，在需要时可从数据库中反序列化出来呈现给用户。 + +后续的对服务器的请求只需要对比数据库中的数据请求新增的部分即可。 + +这样，用户即可长期地保存帐号的完整祈愿记录 + +## UIGF格式 +> 统一可交换祈愿记录标准 +> +> Uniformed Interchangeable GachaLog Format standard + +UIGF 是由我们联合其他祈愿记录应用倡导、推出并**持久维护**的一个统一的祈愿记录数据交换标准 + +标准化的数据格式将允许用户将祈愿记录在不同的转移数据，以使用到不同原神工具中各自的特色功能 + +### 祈愿的导入 + +在使用 UIGF 数据格式的前提下，可以导入曾在其他应用中储存的数据 + +胡桃在处理导入时，会对比本地储存中存在的最早的索引（ID）并仅导入较老的数据 + +（因为始终可以从米哈游的服务器获取较新的数据，这种原始数据有更高的精确度） + +### 祈愿的导出 + +尚未实现，正在设计 \ No newline at end of file diff --git a/docs/en/FAQ/README.md b/docs/en/FAQ/README.md new file mode 100644 index 000000000..80aa9567d --- /dev/null +++ b/docs/en/FAQ/README.md @@ -0,0 +1 @@ +[[toc]] \ No newline at end of file diff --git a/docs/en/FAQ/most-frequent-questions.md b/docs/en/FAQ/most-frequent-questions.md new file mode 100644 index 000000000..ffa82dd06 --- /dev/null +++ b/docs/en/FAQ/most-frequent-questions.md @@ -0,0 +1,9 @@ +--- +headerDepth: 2 +--- + +# 快速解答 + +## Windows 10 下程序乱码 +当用户在 Windows 10 下使用胡桃且发现有乱码情况时，可以下载 `Segoe Fluent Icons`字体，并为系统所有用户安装，即可解决问题 + diff --git a/docs/en/README.md b/docs/en/README.md index 970571781..14d164112 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -7,13 +7,13 @@ heroText: 胡桃工具箱 tagline: 一个实用的多功能原神工具箱 actions: - text: 下载 - link: https://go.hut.ao/archive + link: https://go.hut.ao/down type: primary - text: 快速开始 link: /quick-start.md - text: 文档 - link: /documents/ + link: /features/ - text: 项目进度 link: project.md diff --git a/docs/en/documents/README.md b/docs/en/documents/README.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/en/documents/features/wish-export.md b/docs/en/documents/features/wish-export.md deleted file mode 100644 index f9abbb365..000000000 --- a/docs/en/documents/features/wish-export.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -headerDepth: 0 ---- - -# 原神祈愿记录导出 - -- 打开原神游戏本体，进入祈愿界面，点击 `历史记录` -- 启动 Snap Genshin，从左侧菜单栏进入 `祈愿记录` -- 点击右上角的 `代理模式刷新` 按钮 - - 第一次使用该功能时，Snap Genshin 需要添加证书至系统，你需要根据系统提示，允许 Snap Genshin 添加证书以保证祈愿记录导出功能正常 -- 根据提示，进入游戏祈愿功能并点击历史记录，等待祈愿记录获取完成 - -![wish-export-sample](https://image.snapgenshin.com/imgs/2022/09/22/4b43c28556b2abf7.png) diff --git a/docs/en/features/README.md b/docs/en/features/README.md new file mode 100644 index 000000000..80aa9567d --- /dev/null +++ b/docs/en/features/README.md @@ -0,0 +1 @@ +[[toc]] \ No newline at end of file diff --git a/docs/documents/features/achievements.md b/docs/en/features/achievements.md similarity index 100% rename from docs/documents/features/achievements.md rename to docs/en/features/achievements.md diff --git a/docs/documents/features/wish-export.md b/docs/en/features/wish-export.md similarity index 100% rename from docs/documents/features/wish-export.md rename to docs/en/features/wish-export.md diff --git a/docs/en/statements/README.md b/docs/en/statements/README.md new file mode 100644 index 000000000..80aa9567d --- /dev/null +++ b/docs/en/statements/README.md @@ -0,0 +1 @@ +[[toc]] \ No newline at end of file diff --git a/docs/documents/statements/bug-report.md b/docs/en/statements/bug-report.md similarity index 100% rename from docs/documents/statements/bug-report.md rename to docs/en/statements/bug-report.md diff --git a/docs/features/README.md b/docs/features/README.md new file mode 100644 index 000000000..80aa9567d --- /dev/null +++ b/docs/features/README.md @@ -0,0 +1 @@ +[[toc]] \ No newline at end of file diff --git a/docs/en/documents/features/achievements.md b/docs/features/achievements.md similarity index 96% rename from docs/en/documents/features/achievements.md rename to docs/features/achievements.md index 7e3c3e7bf..180a18cea 100644 --- a/docs/en/documents/features/achievements.md +++ b/docs/features/achievements.md @@ -2,7 +2,7 @@ headerDepth: 0 --- -# 成就管理 +# 成就管理 ![](https://image.snapgenshin.com/imgs/2022/05/02/21047ff544f318fa.png) diff --git a/docs/features/wish-export.md b/docs/features/wish-export.md new file mode 100644 index 000000000..53b065c00 --- /dev/null +++ b/docs/features/wish-export.md @@ -0,0 +1,33 @@ +--- +headerDepth: 0 +--- + +# 原神祈愿记录导出 + +![wish-export-sample](/images/202209/wish-export.png) +有关原神祈愿记录导出的技术原理，你可以参阅我们的[**祈愿系统与导出原理**](/documents/FAQ/Gacha-system-and-export-principal.md)一文 + +## 从原神服务器获取最新的祈愿记录 +- 打开原神游戏本体，进入祈愿界面，点击 `历史记录` +- 启动胡桃工具箱，从左侧菜单栏进入 `祈愿记录` +- 点击右上角的 `刷新` 按钮 + - 在大多数情况下，点击`从缓存刷新`后胡桃工具箱即可开始获取你的祈愿记录 + - 点击`Stoken刷新`，胡桃工具箱会通过当前登录的米游社帐号推算出帐号的祈愿记录Url并自动获取祈愿记录 + - 如果你通过其它工具获取到了你祈愿历史记录的Url，可以选择`手动输入Url`并根据提示操作 +- 等待祈愿记录获取完成 + +在默认情况下，胡桃工具箱会在匹配到本地已有记录的祈愿ID后停止导入。 +但如果你希望完整地获取原神服务器中所有的历史记录（即使它已经存在于你的本地祈愿记录中），你可以勾选`全量更新`。 + +**不勾选`全量更新`不会使你丢失祈愿数据，勾选`全量更新`也不会让你的本地记录错误地额外记录一次相同的祈愿数据。** + +## 从其它祈愿导出程序导入祈愿数据 + +胡桃工具箱支持导入 `UIGF数据格式` 的祈愿记录数据。 + +如果你希望导入这一类数据，可以： +- 启动胡桃工具箱，从左侧菜单栏进入`祈愿记录` +- 点击右上角的`导入` + - 选择`从 UIGF Json 文件导入` + - 选择你的 UIGF 数据文件 + - 根据界面确认导入数据 \ No newline at end of file diff --git a/docs/statements/README.md b/docs/statements/README.md new file mode 100644 index 000000000..80aa9567d --- /dev/null +++ b/docs/statements/README.md @@ -0,0 +1 @@ +[[toc]] \ No newline at end of file diff --git a/docs/en/documents/statements/bug-report.md b/docs/statements/bug-report.md similarity index 100% rename from docs/en/documents/statements/bug-report.md rename to docs/statements/bug-report.md