Skip to content

Commit dda5774

Browse files
committed
docs: Update docs about features
* Close #5
1 parent 4bd3718 commit dda5774

9 files changed

Lines changed: 71 additions & 11 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ export default defineConfig({
1818
nav: [
1919
{ text: '主页', link: '/' },
2020
{ text: '文档', link: '/quick-start/description' },
21-
{ text: '下载', link: '/download' }
21+
{ text: '下载', link: '/download' },
22+
{ text: '讨论群',link: 'https://t.me/+s38gO1NIdw0zNTI1'}
2223
],
2324
logo: 'favicon.ico',
2425
sidebar: [
@@ -34,6 +35,9 @@ export default defineConfig({
3435
items: [
3536
{text: '修改游戏信息',link:'/feature/game-edit'},
3637
{text: '图标搜刮',link:'/feature/icon'},
38+
{text: '游戏管理',link:'/feature/game-store'},
39+
{text: '隐藏游戏',link:'/feature/game-hide'},
40+
{text: '调试',link:'/feature/debug'},
3741
]
3842
},
3943
{
@@ -46,7 +50,7 @@ export default defineConfig({
4650
],
4751
socialLinks: [
4852
{ icon: 'github', link: 'https://github.com/SamHou0/VNGod' },
49-
{ icon: 'bilibili', link: 'https://space.bilibili.com/456964528' },
53+
{ icon: 'telegram', link: 'https://t.me/PatriciaBySamHou' },
5054
{ icon: 'rss', link: 'https://blog.samhou.top' }
5155
]
5256
}

docs/download.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# 下载
22

3+
下载之前,我们强烈推荐您先看看[快速开始](./quick-start/start.md)。如果遇到问题了,也可以点击右上角加入我们的讨论群。
4+
35
## 正式版
46

57
前往 [GitHub Release](https://github.com/SamHou0/VNGod/releases),下载最新版本的 zip 文件。

docs/feature/debug.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 调试
2+
3+
在设置界面中,我们提供了多种调试功能,帮助你进行故障排除。
4+
5+
- 打开日志文件夹。点击这个按钮,就可以打开 VNGod 的日志。默认情况下,只有 Info 以及以上的级别才会写入日志,防止你的硬盘被塞满。当你发现出现问题的时候,可以到 VNGod 的主程序文件夹中,查找 log4net.config,然后把 Info 改成 Debug,这样的日志更加详细。反馈问题时,带上 Debug 级别的日志更加有助于问题的解决。
6+
- 抛出测试异常。这个功能只是为了测试程序崩溃时能否自动提交问题报告,并选择重启。通常情况下,对于用户没用什么用处。
7+
- 运行认证测试。点击此处,可以确定你填入的 Bangumi API Token 是否有效。如果令牌无效或过期,它会报错。此时你应该再去[生成一个](https://next.bgm.tv/demo/access-token/create)。如果没有填入令牌(令牌为空),那么这项检查可以通过,只是你无法访问 NSFW 内容(这是 Bangumi 的规定,只有账号登录且账号达到一定注册时长才能够访问 NSFW 内容)。

docs/feature/game-hide.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 隐藏游戏
2+
3+
你可以隐藏一些游戏,他们不会在游戏列表和游戏管理页面显示。换句话说,VNGod 会完全忽略它们。你可以用这个功能,让 VNGod 忽略一些非视觉小说的游戏,也可以让已游玩的游戏藏起来(尽管我不推荐这么做,更好的方式是用[游戏管理](./game-store),上传到远程然后删除本地游戏)
4+
5+
在主界面游戏列表上右键一个游戏,然后选择**隐藏游戏**。这样,游戏将被 VNGod **永久忽略**。要想取消忽略,可以到对应游戏的文件夹中,删除 `.vngodignore` 文件(这个文件只有扩展名,没有文件名)。

docs/feature/game-store.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# 游戏存储管理
2+
3+
VNGod 提供本地和远程**游戏本体**存储管理。在配置 WebDAV 和 7-zip 之后,你可以将本地游戏上传到远程,也可以将远程游戏下载回本地。
4+
5+
VNGod 不希望把游戏的存储和它本身强绑定,因此我们选择了调用外部 7-zip,进行分卷压缩的方式(为避免网络波动导致反复重传,每个分卷调节为了 100M)对游戏本体进行备份。为了确保调用成功,请先安装 7-zip 并配置路径。
6+
7+
7-zip 作为和 VNGod 类似的开源软件,非常可靠轻量,因此我们选择使用它对你的游戏进行归档。如果你不再想要使用 VNGod,或者 VNGod 消失、停止维护了,你也可以用任意解压软件,自己对分卷压缩的压缩包进行解压。
8+
9+
> [!TIP]
10+
> 如果你不需要远程游戏备份,可以不配置。此时,游戏管理仅会显示删除游戏,你可以在这里删除你不需要的视觉小说。
11+
12+
## 安装配置
13+
14+
转到 [7-zip 官方网站](https://www.7-zip.org/),下载 Windows 版本的 7-zip,然后运行安装程序。在安装过程中,会要求您选择一个安装路径——请记下这个路径。安装完毕后,在文件资源管理器中打开这个路径(默认的是 `C:\Program Files\7-Zip`)。
15+
16+
检查该路径,在这个文件夹中,通常能够找到一个 `7z.exe`。右键点击`复制文件地址`,去除双引号,将它填入 VNGod 设置窗口的 7-zip 路径中(在默认情况下,这将是 `C:\Program Files\7-Zip\7z.exe`)。然后,配置 WebDAV。
17+
18+
关闭设置。如果没有提示`找不到 7-zip`,说明路径已配置成功。如果此时提示 WebDAV 配置有效,说明你已经准备好开始使用 WebDAV 功能了。满足以上条件之后,远程游戏管理才能正常工作。
19+
20+
## 上传、下载游戏本体
21+
22+
打开`游戏管理`,在左侧列表中**选中**你想要上传/删除的本地游戏,然后点击对应按钮即可执行操作。在右侧列表中选中你想要下载/删除的远程游戏,然后点击对应按钮即可执行操作。
23+
24+
别担心,`.vngod` 的元数据文件不仅不会被备份,还会保持同步,因此你的游戏数据(理论上)不会丢失。你的游戏存档在开始和结束游戏时也会自动(独立地)根据修改时间进行同步,因此不会由于备份而丢失。
25+
26+
但是,当你的游戏同时存在于本地和远程时,下载游戏会覆盖本地文件(是的,如果你的存档**在游戏文件夹内**,那么它也会被覆盖)。尽管 7-zip 和 VNGod 会尽力保持文件的修改日期不发生改变,而开始游戏时,存档云同步会以最新的版本覆盖刚刚下载的版本,但谁也不能保证这个复杂过程的可靠性。因此,最好在开始游戏前上传不带存档文件夹的游戏本体,或在下载前先备份你的存档(VNGod 在下载前会向你提示这一点,允许你备份存档后再继续)。

docs/feature/icon.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
你可以让 VNGod 获取一个游戏的图标。
44

5-
设置好可执行文件路径,即可获取图标。默认会在启动时获取,你也可以点击主页面上的按钮,手动获取图标
5+
设置好可执行文件路径,即可获取图标。默认会自动获取,你也可以右键点击任意游戏,手动刷新所有图标
66

77
![icon](../img/icon.png)

docs/img/setting.png

24.7 KB
Loading

docs/quick-start/description.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,28 @@
1212
简洁有用的视觉小说管理器。
1313

1414
> [!WARNING]
15-
> 这个应用正在开发测试中,WebDAV 同步时,可能产生数据丢失。在你尝试它的存档云同步之前,先备份你的存档。感谢您参与本程序的测试!如果发现了任何问题,请[提出 Issue(用英语中文都可以)](https://github.com/SamHou0/VNGod/issues/new/choose)
15+
> 这个应用正在开发测试中,WebDAV 同步时,可能产生数据丢失。在你确认它的存档云同步能够正常工作之前,请先时不时备份你的存档。感谢您参与本程序的测试!如果发现了任何问题,请[提出 Issue](https://github.com/SamHou0/VNGod/issues/new/choose)
1616
1717
## 功能
1818

1919
- 统一管理你的视觉小说
20+
- 基于 .NET WPF 构建,UI 流畅高效
2021
- 自动匹配在线的条目,支持:
2122
- [Bangumi](https://bgm.tv)
2223
- [Vndb](https://vndb.org)
2324
- 快速打开文件夹、游戏和上述条目页面
25+
- 支持提取应用图标显示
2426
- 记录你的游玩时间
2527
- 通过 WebDAV,同步扫描到的数据和游戏存档
28+
- 一键将本地游戏备份到 WebDAV 云端存储(需要调用外部 7-zip 分卷压缩来归档)
29+
- 提供文件管理,可隐藏可删除本地文件夹
30+
31+
## 快速开始使用
32+
33+
请前往文档网站查看[快速开始指南](https://vngod.samhou.moe/quick-start/start.html)
34+
35+
## 讨论和参与
36+
37+
欢迎加入我们的 [Telegram 讨论群](https://t.me/+s38gO1NIdw0zNTI1),无论是反馈问题,还是关于视觉小说的聊天吹水,或是单纯接收更新通知,都非常欢迎。
38+
39+
请通过讨论群或 GitHub Issues 报告错误。尽管程序会自动上传崩溃时的错误堆栈和运行时信息,我们有时候很难搞清楚什么情况下会发生错误。在提交时,请详细描述错误的复现步骤并带上日志。感谢您的参与!

docs/quick-start/start.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,20 +37,22 @@
3737
> [!Tip]
3838
> 子文件夹的名称应该与其包含的游戏匹配。这能够帮助 VNGod 查询、识别其对应的条目(可以使用原名,或者规范的翻译名称)。
3939
40-
4. 选择根文件夹,点击 `打开存储库`
40+
1. 选择根文件夹,点击 `打开存储库`
4141

4242
![打开存储库](../img/repo.png)
4343

44-
5. (非必要)在设置中,配置你的 WebDAV 和 Bangumi Token。
44+
1. (非必要)在设置中,配置你的 WebDAV,Bangumi Token,并指定 7-zip 的 `7z.exe` 可执行文件的路径(请参阅[游戏存储](../feature/game-store),了解更多信息)。如果配置无效,关闭设置界面后会提示错误,此时请根据错误提示来修改设置。如果不改正,那么相应的功能会无法使用。下面是一个示例配置:
45+
46+
![Setting](../img/setting.png)
4547

4648
> [!TIP]
47-
> 获取 Bangumi token,请转到 [https://next.bgm.tv/demo/access-token/create](https://next.bgm.tv/demo/access-token/create)获取 VNDB token 请转到 [https://vndb.org/u/tokens](https://vndb.org/u/tokens) (Vndb > `My Profile` > `Applications` > `Create new token`)。
49+
> 获取 Bangumi token,请转到 [https://next.bgm.tv/demo/access-token/create](https://next.bgm.tv/demo/access-token/create)
4850
4951
> [!IMPORTANT]
5052
> 如果你没有配置,或者你的 Bangumi 账号不满足查看 NSFW 条目的条件,那么你的相应游戏会识别错误或异常。
5153
52-
6. 点击 `获取未知信息` 来识别游戏。如果你已经配置了 WebDAV,那么扫描到的数据会同步。
53-
7. 点击 `修改游戏信息` 来编辑识别错误或失败的游戏的信息。你可以设置 Bangumi ID 或者 VNDB ID,然后点击相应的按钮,自动获得游戏的中文翻译名称。
54+
1. 点击 `获取未知信息` 来识别游戏。如果你已经配置了 WebDAV,那么扫描到的数据会同步。
55+
2. 点击 `修改游戏信息` 来编辑识别错误或失败的游戏的信息。你可以设置 Bangumi ID 或者 VNDB ID,然后点击相应的按钮,自动获得游戏的中文翻译名称。
5456

5557
> [!NOTE]
5658
> 要使用存档云同步,先寻找存档路径,并填入。确保多台电脑上的路径一致。
@@ -61,9 +63,9 @@
6163
> [!WARNING]
6264
> 考虑到视觉小说读取文件和创建存档的方式,我们强烈建议您,在新电脑上游玩同一游戏时,先同步存档,再运行游戏,防止新的存档覆盖您的旧存档。
6365
64-
8. 点击 ``,启动游戏。选择游戏的可执行文件。VNGod 在游戏启动时会自动隐藏,在游戏结束时,会自动显示。
66+
1. 点击 ``,启动游戏。选择游戏的可执行文件。VNGod 在游戏启动时会自动隐藏,在游戏结束时,会自动显示。
6567

6668
> [!IMPORTANT]
6769
> 如果 VNGod 隐藏后,马上显示(此时游戏未退出),那么请在任务管理器里,寻找游戏的进程名称,然后填入修改游戏信息的窗口。(已知某些游戏链式启动较慢,即使这样配置仍然不行,请先检查游戏是否在第一次运行破解或激活的脚本。通常执行一次后,就能正常启动)
6870
69-
9. 当游戏退出后,游戏时间会自动计算。存档和数据也将同步。
71+
1. 当游戏退出后,游戏时间会自动计算。存档和数据也将同步。

0 commit comments

Comments
 (0)