Skip to content

Commit 4bd3718

Browse files
committed
docs: Update readme (#5)
1 parent 24417bc commit 4bd3718

2 files changed

Lines changed: 117 additions & 81 deletions

File tree

README.md

Lines changed: 21 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,36 @@
11
# VNGod
22

3-
English | [中文](https://vngod.samhou.moe)
3+
[在线中文文档](https://vngod.samhou.moe) | [English](./README_EN.md)
44

5-
A visual novel manager, but simple and effective.
5+
简洁高效的视觉小说管理器。
66

77
![MainWindow](docs/img/design.png)
88

9-
![GitHub License](https://img.shields.io/github/license/SamHou0/VNGod) [![.NET](https://github.com/SamHou0/VNGod/actions/workflows/dotnet-desktop.yml/badge.svg)](https://github.com/SamHou0/VNGod/actions/workflows/dotnet-desktop.yml) ![GitHub Release](https://img.shields.io/github/v/release/SamHou0/VNGod)
9+
![GitHub License](https://img.shields.io/github/license/SamHou0/VNGod) [![.NET](https://github.com/SamHou0/VNGod/actions/workflows/dotnet-desktop.yml/badge.svg)](https://github.com/SamHou0/VNGod/actions/workflows/dotnet-desktop.yml) ![GitHub Release](https://img.shields.io/github/v/release/SamHou0/VNGod) [![Telegram Chat](https://img.shields.io/badge/Telegram%20Chat-VNGod%20%E4%BA%A4%E6%B5%81-blue?style=social&logo=telegram&link=https%3A%2F%2Ft.me%2F%2Bs38gO1NIdw0zNTI1)](https://t.me/+s38gO1NIdw0zNTI1)
1010

1111
> [!WARNING]
12-
> This app is currently in development. Data loss during WebDAV sync may happen. Always backup your save from time to time if you choose to test it. Thanks for your participation!
12+
> 这个应用正在开发测试中,WebDAV 同步时,可能产生数据丢失。在你确认它的存档云同步能够正常工作之前,请先时不时备份你的存档。感谢您参与本程序的测试!如果发现了任何问题,请[提出 Issue](https://github.com/SamHou0/VNGod/issues/new/choose)
1313
14-
> [!NOTE]
15-
> This app is designed for Chinese users. So the default game display name is Chinese.
14+
## 功能
1615

17-
## Features
16+
- 统一管理你的视觉小说
17+
- 基于 .NET WPF 构建,UI 流畅高效
18+
- 自动匹配在线的条目,支持:
19+
- [Bangumi](https://bgm.tv)
20+
- [Vndb](https://vndb.org)
21+
- 快速打开文件夹、游戏和上述条目页面
22+
- 支持提取应用图标显示
23+
- 记录你的游玩时间
24+
- 通过 WebDAV,同步扫描到的数据和游戏存档
25+
- 一键将本地游戏备份到 WebDAV 云端存储(需要调用外部 7-zip 分卷压缩来归档)
26+
- 提供文件管理,可隐藏可删除本地文件夹
1827

19-
- [x] Organize your novels
20-
- [x] Automatically match entries in:
21-
- [x] [Bangumi](https://bgm.tv)
22-
- [x] [vndb](https://vndb.org)
23-
- [x] Open folder, game and entry page quickly
24-
- [x] Record your playing time
25-
- [x] Sync your saves and scanned files to WebDAV
28+
## 快速开始使用
2629

27-
## Quick Start Guide
30+
请前往文档网站查看[快速开始指南](https://vngod.samhou.moe/quick-start/start.html)
2831

29-
1. Download the app zip from [Releases](https://github.com/SamHou0/VNGod/releases)
30-
2. Extract to an empty that you like, then run `VNGod.exe`
31-
3. Prepare your game folder like this:
32+
## 讨论和参与
3233

33-
```text
34-
./gal (The name of the base folder does not matter)
35-
├── 9-nine-九次九日九重色
36-
├── 9-nine-天色天歌天籁音
37-
├── 9-nine-春色春恋春熙风 Ver1.1
38-
├── 9-nine-雪色雪花雪余痕
39-
├── Air
40-
├── Alpus and Dangerous Forest Ver.1.1
41-
├── HappySistersLife
42-
├── Koikatsu_Party
43-
├── NUKITASHI
44-
├── Rewrite_PLUS
45-
├── SPRB
46-
├── Sanoba Witch
47-
├── StellarCode
48-
├── Summer Pockets Ver2.1最终版
49-
├── WHITE ALBUM
50-
├── narcissu
51-
├── nine_newEP
52-
├── ましろ色シンフォニー -Love is pure white- Remake for FHD
53-
├── オトメ世界の歩き方
54-
├── 君与彼女与彼女之恋/你与彼女和彼女之恋(君と彼女と彼女の恋)
55-
├── 圣女不死心
56-
├── 恋爱猪脚饭
57-
└── 神様ちゅ~ず!
58-
```
34+
欢迎加入我们的 [Telegram 讨论群](https://t.me/+s38gO1NIdw0zNTI1),无论是反馈问题,还是关于视觉小说的聊天吹水,或是单纯接收更新通知,都非常欢迎。
5935

60-
> [!IMPORTANT]
61-
> Each sub folder should only contain one game. Do not place multiple games within one folder.
62-
63-
> [!Tip]
64-
> The sub folder's name should match the game that's inside it. This helps VNGod to identify it's translation name. (The language of the folder name does not matter.)
65-
66-
4. Choose the base folder by clicking `Open Repo` (in English)
67-
68-
![Choose open repo](docs/img/OpenRepo.png)
69-
70-
5. (Optional) Configure your WebDAV and Bangumi Token in setting.
71-
72-
> [!TIP]
73-
> Grab your Bangumi token at [https://next.bgm.tv/demo/access-token/create](https://next.bgm.tv/demo/access-token/create), and VNDB token at [vndb.org](https://vndb.org) > `My Profile` > `Applications` > `Create new token`.
74-
75-
> [!IMPORTANT]
76-
> If no token configured or your Bangumi account does not fulfill the requirement to see nsfw contents, your R18 games may have wrong display name.
77-
78-
6. Click `Get missing Info` to scan games. If WebDAV configured, it will sync automatically.
79-
7. Click `Edit Info` to edit games' info if it's wrong or missing. You can set a Bangumi ID and click `Get Info` to get the game's name automatically.
80-
81-
![Edit game](docs/img/EditGame.png)
82-
> [!NOTE]
83-
> To use cloud save sync, find and set a save path. Make sure the path match on your different computers.
84-
85-
> [!CAUTION]
86-
> NEVER start `VNGod` on MULTIPLE COMPUTERS to avoid data loss. To sync, close VNGod on one computer, then start another.
87-
88-
> [!WARNING]
89-
> Considering how GalGames read files, we always recommend syncing saves before you run the game when playing on a new computer.
90-
91-
8. Click `Play` to start the game. Choose the game's executable. VNGod will hide when it starts, and shows when the game ends.
92-
93-
> [!IMPORTANT]
94-
> If it hides and then shows at no time (when game does not exit), please use `taskmgr` to find the process name and configure it in `GameEditWindow`.
95-
96-
9. When the game exits, time played will be calculated.
36+
请通过讨论群或 GitHub Issues 报告错误。尽管程序会自动上传崩溃时的错误堆栈和运行时信息,我们有时候很难搞清楚什么情况下会发生错误。在提交时,请详细描述错误的复现步骤并带上日志。感谢您的参与!

README_EN.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# VNGod
2+
3+
English | [在线中文文档](https://vngod.samhou.moe)
4+
5+
A visual novel manager, but simple and effective.
6+
7+
![MainWindow](docs/img/design.png)
8+
9+
![GitHub License](https://img.shields.io/github/license/SamHou0/VNGod) [![.NET](https://github.com/SamHou0/VNGod/actions/workflows/dotnet-desktop.yml/badge.svg)](https://github.com/SamHou0/VNGod/actions/workflows/dotnet-desktop.yml) ![GitHub Release](https://img.shields.io/github/v/release/SamHou0/VNGod)
10+
11+
> [!WARNING]
12+
> This app is currently in development. Data loss during WebDAV sync may happen. Always backup your save from time to time if you choose to test it. Thanks for your participation!
13+
14+
> [!NOTE]
15+
> This app is designed for Chinese users and use Chinese data source like *Bangumi*, but there **IS** an English UI. However, translating docs to English require a lot of effort, so English docs is **NOT** available now. If you're interested in translating the docs website to English, please submit a Pull Request.
16+
17+
## Features
18+
19+
- Organize your novels
20+
- Automatically match entries in:
21+
- [Bangumi](https://bgm.tv)
22+
- [vndb](https://vndb.org)
23+
- Open folder, game and entry page quickly
24+
- Record your playing time
25+
- Sync your saves and scanned files to WebDAV
26+
27+
## Quick Start Guide
28+
29+
1. Download the app zip from [Releases](https://github.com/SamHou0/VNGod/releases)
30+
2. Extract to an empty that you like, then run `VNGod.exe`
31+
3. Prepare your game folder like this:
32+
33+
```text
34+
./gal (The name of the base folder does not matter)
35+
├── 9-nine-九次九日九重色
36+
├── 9-nine-天色天歌天籁音
37+
├── 9-nine-春色春恋春熙风 Ver1.1
38+
├── 9-nine-雪色雪花雪余痕
39+
├── Air
40+
├── Alpus and Dangerous Forest Ver.1.1
41+
├── HappySistersLife
42+
├── Koikatsu_Party
43+
├── NUKITASHI
44+
├── Rewrite_PLUS
45+
├── SPRB
46+
├── Sanoba Witch
47+
├── StellarCode
48+
├── Summer Pockets Ver2.1最终版
49+
├── WHITE ALBUM
50+
├── narcissu
51+
├── nine_newEP
52+
├── ましろ色シンフォニー -Love is pure white- Remake for FHD
53+
├── オトメ世界の歩き方
54+
├── 君与彼女与彼女之恋/你与彼女和彼女之恋(君と彼女と彼女の恋)
55+
├── 圣女不死心
56+
├── 恋爱猪脚饭
57+
└── 神様ちゅ~ず!
58+
```
59+
60+
> [!IMPORTANT]
61+
> Each sub folder should only contain one game. Do not place multiple games within one folder.
62+
63+
> [!Tip]
64+
> The sub folder's name should match the game that's inside it. This helps VNGod to identify it's translation name. (The language of the folder name does not matter.)
65+
66+
4. Choose the base folder by clicking `Open Repo` (in English)
67+
68+
![Choose open repo](docs/img/OpenRepo.png)
69+
70+
5. (Optional) Configure your WebDAV and Bangumi Token in setting.
71+
72+
> [!TIP]
73+
> Grab your Bangumi token at [https://next.bgm.tv/demo/access-token/create](https://next.bgm.tv/demo/access-token/create), and VNDB token at [vndb.org](https://vndb.org) > `My Profile` > `Applications` > `Create new token`.
74+
75+
> [!IMPORTANT]
76+
> If no token configured or your Bangumi account does not fulfill the requirement to see nsfw contents, your R18 games may have wrong display name.
77+
78+
6. Click `Get missing Info` to scan games. If WebDAV configured, it will sync automatically.
79+
7. Click `Edit Info` to edit games' info if it's wrong or missing. You can set a Bangumi ID and click `Get Info` to get the game's name automatically.
80+
81+
![Edit game](docs/img/EditGame.png)
82+
> [!NOTE]
83+
> To use cloud save sync, find and set a save path. Make sure the path match on your different computers.
84+
85+
> [!CAUTION]
86+
> NEVER start `VNGod` on MULTIPLE COMPUTERS to avoid data loss. To sync, close VNGod on one computer, then start another.
87+
88+
> [!WARNING]
89+
> Considering how GalGames read files, we always recommend syncing saves before you run the game when playing on a new computer.
90+
91+
8. Click `Play` to start the game. Choose the game's executable. VNGod will hide when it starts, and shows when the game ends.
92+
93+
> [!IMPORTANT]
94+
> If it hides and then shows at no time (when game does not exit), please use `taskmgr` to find the process name and configure it in `GameEditWindow`.
95+
96+
9. When the game exits, time played will be calculated.

0 commit comments

Comments
 (0)