update documents

hinaloe · Aug 8, 2023 · 209a538 · 209a538
1 parent 0ff410e
commit 209a538
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@ English | [简体中文](./docs/README.zh-CN.md) | [Tiếng Việt](./docs/READM
 
 # What is Starward?
 
-**Starward** comes from the slogan of Star Rail: May This Journey Lead Us **Starward**, witch is very suitable to be used as an app name. Starward is a game launcher that supports all desktop games of miHoYo. The goal of this project is to replace the official launcher completely, and then add some extended features.
+**Starward** comes from the slogan of Star Rail: May This Journey Lead Us **Starward**, which is very suitable to be used as an app name. Starward is a game launcher that supports all desktop games of miHoYo. The goal of this project is to replace the official launcher completely, and then add some extended features.
 
 In addition to the download and installation of the game, the following features are included:
 
@@ -24,6 +24,7 @@ First, your device needs to meet the following requirements:
 - [Visual C++ Runtime](https://learn.microsoft.com/cpp/windows/latest-supported-vc-redist) installed
 - [WebView2 Runtime](https://developer.microsoft.com/microsoft-edge/webview2) installed
 - Windows 10 users are advised to install the font [Segoe Fluent Icons](https://aka.ms/SegoeFluentIcons)
+- For better experience, please enable **Transparency effects** and **Animation effects** in the system settings
 
 Download the package for your CPU architecture from [GitHub Release](https://github.com/Scighost/Starward/releases). Extract it, then run `Starward.exe` and follow the prompts.
 
@@ -68,6 +69,7 @@ And the third-party libraries used in this project include:
 -  [Dapper](https://github.com/DapperLib/Dapper)
 -  [GitHub Markdown CSS](https://github.com/sindresorhus/github-markdown-css)
 -  [HDiffPatch](https://github.com/sisong/HDiffPatch)
+-  [H.NotifyIcon](https://github.com/HavenDV/H.NotifyIcon)
 -  [MiniExcel](https://github.com/mini-software/MiniExcel)
 -  [ScottPlot](https://github.com/ScottPlot/ScottPlot)
 -  [Serilog](https://github.com/serilog/serilog)

diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -21,9 +21,13 @@ Don't worry, files downloaded from GitHub Release will definitely satisfy this c
 The `config.ini` file contains only two setting items:
 
 ```ini
-# Whether to enable console output logging, True/False
+# Whether to enable console output logging, True/False.
 EnableConsole=False
-# The location of the user folder
+# The application window size, 0 - standard, 1 - smaller.
+WindowSizeMode=1
+# The language of the application interface, such as `zh-CN` `en-US`, which follows the system setting if empty.
+Language=
+# The location of the user folder.
 UserDataFolder=.
 ```
 
@@ -76,8 +80,6 @@ The data type `Type` in the following table uses the expression in C#, and `-` r
 
 | Key                             | Type    | Default Value | Comment                                                                                                                                                          |
 | ------------------------------- | ------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Language                        | string? | -             | The language of the application interface, such as `zh-CN` `en-US`, which follows the system setting if empty.                                                   |
-| WindowSizeMode                  | int     | -             | The application window size, 0 - standard, 1 - smaller                                                                                                           |
 | ApiCDNIndex                     | int     | -             | Api CDN options, 0 - CloudFlare, 1 - GitHub, 2 - jsDelivr                                                                                                        |
 | EnablePreviewRelease            | bool    | -             | Whether to join the preview release channel.                                                                                                                     |
 | IgnoreVersion                   | string? | -             | Ignore the version of the update alert, newer versions will continue to be alerted only if they are greater than this value.                                     |
@@ -93,6 +95,8 @@ The data type `Type` in the following table uses the expression in C#, and `-` r
 | UseOneBg                        | bool    | -             | Use the same background for all game regions, usually enabled when using video background.                                                                       |
 | AcceptHoyolabToolboxAgreement   | bool    | -             | Accept the disclaimer of the HoYoLAB toolbox page.                                                                                                               |
 | HoyolabToolboxPaneOpen          | bool    | true          | Is the navigation sidebar on the HoYoLAB Toolbox page open.                                                                                                      |
+| EnableSystemTrayIcon            | bool    | true          | Enabled to turn on the singleton mode, and app will be minimized to the system tray when click the close button of window.                                       |
+| ExitWhenClosing                 | bool    | true          | Whether to exit the process after clicking the close button of window                                                                                            |
 
 ## Dynamic Settings
 

diff --git a/docs/Configuration.zh-CN.md b/docs/Configuration.zh-CN.md
@@ -23,6 +23,10 @@
 ```ini
 # 是否启用控制台输出日志，True/False
 EnableConsole=False
+# 应用窗口大小，0 - 标准，1 - 较小
+WindowSizeMode=1
+# 应用界面语言，如 `zh-CN` `en-US`，为空时代表跟随系统设置
+Language=
 # 用户数据文件夹的位置
 UserDataFolder=.
 ```
@@ -76,8 +80,6 @@ Starward 使用 `enum GameBiz` 定义了不同的游戏区域，其中游戏全
 
 | Key                             | Type    | Default Value | Comment                                                                      |
 | ------------------------------- | ------- | ------------- | ---------------------------------------------------------------------------- |
-| Language                        | string? | -             | 应用界面语言，如 `zh-CN` `en-US`，为空时代表跟随系统设置                     |
-| WindowSizeMode                  | int     | -             | 应用窗口大小，0 - 标准，1 - 较小                                             |
 | ApiCDNIndex                     | int     | -             | Api CDN 选项，0 - CloudFlare，1 - GitHub，2 - jsDelivr                       |
 | EnablePreviewRelease            | bool    | -             | 是否加入预览版更新渠道                                                       |
 | IgnoreVersion                   | string? | -             | 忽略更新提醒的版本，新版本大于此值才会继续提醒                               |
@@ -93,6 +95,8 @@ Starward 使用 `enum GameBiz` 定义了不同的游戏区域，其中游戏全
 | UseOneBg                        | bool    | -             | 所有游戏区域使用同一个背景，一般在使用视频背景时启用                         |
 | AcceptHoyolabToolboxAgreement   | bool    | -             | 接受米游社工具箱页面的免责声明                                               |
 | HoyolabToolboxPaneOpen          | bool    | true          | 米游社工具箱页面的导航侧栏是否打开                                             |
+| EnableSystemTrayIcon            | bool    | true          | 启用后开启应用单例模式，点击关闭窗口按键时应用将最小化到系统托盘                 |
+| ExitWhenClosing                 | bool    | true          | 点击关闭窗口按键时直接退出进程                                            |
 
 ## 动态设置项
 

diff --git a/docs/Privacy.zh-CN.md b/docs/Privacy.zh-CN.md
@@ -1,4 +1,4 @@
-[English](./Privacy.md) | 简体中文./Privacy.zh-CN.md | [Tiếng Việt](./Privacy.vi-VN.md) | [ภาษาไทย](./Privacy.th-TH.md)
+[English](./Privacy.md) | 简体中文 | [Tiếng Việt](./Privacy.vi-VN.md) | [ภาษาไทย](./Privacy.th-TH.md)
 
 # 隐私策略
 

diff --git a/docs/README.zh-CN.md b/docs/README.zh-CN.md
@@ -24,6 +24,7 @@
 - 已安装 [Visual C++ Runtime](https://learn.microsoft.com/cpp/windows/latest-supported-vc-redist)
 - 已安装 [WebView2 Runtime](https://developer.microsoft.com/microsoft-edge/webview2)
 - Windows 10 用户建议安装字体 [Segoe Fluent Icons](https://aka.ms/SegoeFluentIcons)
+- 为了更好的使用体验，请在系统设置中开启**透明效果**和**动画效果**
 
 请在 [GitHub Release](https://github.com/Scighost/Starward/releases) 下载对应 CPU 架构的压缩包，解压后运行 `Starward.exe` 并按提示操作。
 
@@ -67,6 +68,7 @@ Starward 使用 [Crowdin](https://crowdin.com/project/starward) 进行本地化
 -  [Dapper](https://github.com/DapperLib/Dapper)
 -  [GitHub Markdown CSS](https://github.com/sindresorhus/github-markdown-css)
 -  [HDiffPatch](https://github.com/sisong/HDiffPatch)
+-  [H.NotifyIcon](https://github.com/HavenDV/H.NotifyIcon)
 -  [MiniExcel](https://github.com/mini-software/MiniExcel)
 -  [ScottPlot](https://github.com/ScottPlot/ScottPlot)
 -  [Serilog](https://github.com/serilog/serilog)