diff --git a/docs/.vuepress/navbar/en.ts b/docs/.vuepress/navbar/en.ts index 8b8d4e1a6..41a3de196 100644 --- a/docs/.vuepress/navbar/en.ts +++ b/docs/.vuepress/navbar/en.ts @@ -6,7 +6,7 @@ export const enNavbar = navbar([ { text: "Download", icon: "iconfont icon-install", - link: "https://api.snapgenshin.com/patch/hutao/download", + link: "/en/quick-start.html", }, { text: "Community", @@ -14,18 +14,44 @@ export const enNavbar = navbar([ link: "/en/community", }, { - text: "Service Availability", + text: "Help & Support", icon: "iconfont icon-define", children: [ { - text: "UptimeRobot", - icon: "/images/202312/uptimerobot-logo.svg", - link: "https://status.hut.ao/", + text: "Update Log", + icon: "iconfont icon-update", + link: "/en/statements/update-log.html" }, { - text: "Uptime Kuma", - icon: "/images/202312/uptime-kuma.svg", - link: "https://status.snapgenshin.cn/status", + text: "Service Availability", + children: [ + { + text: "UptimeRobot", + icon: "/images/202312/uptimerobot-logo.svg", + link: "https://status.hut.ao/", + }, + { + text: "Uptime Kuma", + icon: "/images/202312/uptime-kuma.svg", + link: "https://status.snapgenshin.cn/status", + } + ] + }, + { + text: "Question & Feedback", + children:[ + { + text: "FAQ", + icon: "iconfont icon-ask", + link: "/en/advanced/FAQ.html" + }, + { + text: "Report Bug", + icon: "iconfont icon-debug", + link: "/en/statements/bug-report.html" + }, + + ] } ] }, diff --git a/docs/en/README.md b/docs/en/README.md index 5290ed4cc..bb5e45803 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -13,11 +13,9 @@ head: - name: twitter:image:src content: https://repository-images.githubusercontent.com/482734649/eb0f81d6-29a8-4d3c-8012-d85475cd89ee actions: - - text: Download - link: https://apps.microsoft.com/store/detail/snap-hutao/9PH4NXJ2JN52 - type: primary - text: Quick Start link: quick-start.html + type: primary - text: Document link: menu.html - text: Project diff --git a/docs/en/community.md b/docs/en/community.md index d4765c287..0114bbb38 100644 --- a/docs/en/community.md +++ b/docs/en/community.md @@ -10,19 +10,33 @@ order: 8 As open-source software, community power is an important part of the ecology of Snap Hutao, and you can join our user community by following ways. - - -## GitHub Discussion - -[Snap.Hutao Discussion](https://github.com/DGP-Studio/Snap.Hutao/discussions) - -## QQ Group (CN) - -- [Snap Hutao](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=DmW_LDX35YEr1CQZwjZ6x4JYP03soai2&authKey=z3PzXsuYlaPTm%2FW7TyE0o9KNz7H6LA%2BTEZ4mK2BE9%2Fcz0HhH3s1qgbydciAmrGeg&noverify=0&group_code=910780153) -- [_Snap Developer Open Discussion Group_](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=XJPjE6ffuYPkZmXvujdP1ZDY2BqL8RDg&authKey=YHBYvW4KmPUpPjGwYwGduG7ZELhFIkd9QxLHuwBFmm4UvQH1ThWiv%2FKPgeckiqt4&noverify=0&group_code=982424236) - - General tech talk, not Snap Hutao Project development group - - The Dev group requires some basic tech knowledge - -## Discord - -Invite link：[https://discord.gg/Yb8bykUKp](https://discord.gg/Yb8bykaUKp) +
+ + + + +
diff --git a/docs/en/development/contribute.md b/docs/en/development/contribute.md index fc6519726..6a83f2391 100644 --- a/docs/en/development/contribute.md +++ b/docs/en/development/contribute.md @@ -2,7 +2,7 @@ category: [open source, development] tag: ["development", "GitHub"] icon: iconfont icon-code -order: 2 +order: 3 --- # Contribute Your Code @@ -36,8 +36,6 @@ You can find all [unsolved opened issues](https://github.com/DGP-Studio/Snap.Hut ## 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, a GitHub actions script will build the latest code to `Snap Hutao Alpha` package. You can find all build records in alpha actions pipeline. -You need to install [Snap.Hutao.CI.cer](https://github.com/DGP-Studio/Snap.Hutao/releases/download/2023.10.3.1/Snap.Hutao.CI.cer) certificate to your local machine, and then install the msix package in the release. - -\*If the latest release does not contain attached file, that means package is still in uploading process. +You need to install [Snap Hutao CA certificate](https://github.com/DGP-Automation/Hutao-Auto-Release/releases/download/certificate-ca/DGP_Studio_CA.crt) as `Trusted Root Certification Authorities` to allow Alpha versions be installed. diff --git a/docs/en/development/join.md b/docs/en/development/join.md new file mode 100644 index 000000000..566bc8847 --- /dev/null +++ b/docs/en/development/join.md @@ -0,0 +1,78 @@ +--- +category: [open source, development] +tag: ["develop", "collaborate", "community"] +icon: iconfont icon-group +order: 1 +--- + +# Join the Develop Team + +If you have one of the following experiences and are interested in joining the Snap Hutao development team to improve this project and get in touch with more Genshin Impact open source projects, welcome to join us! + + + + + + + + diff --git a/docs/en/development/platform.md b/docs/en/development/platform.md index 6823928b3..3a91f52b7 100644 --- a/docs/en/development/platform.md +++ b/docs/en/development/platform.md @@ -2,7 +2,7 @@ category: [open source, development] tag: [open source, Hutao Database, Spiral Abyss Database, Enka, UIGF, Open data] icon: iconfont icon-vscode -order: 1 +order: 2 --- # Hutao Open Platform diff --git a/docs/en/project.md b/docs/en/project.md index 01931b2c2..10daa11f0 100644 --- a/docs/en/project.md +++ b/docs/en/project.md @@ -13,13 +13,26 @@ the gaming experience for desktop players. By combining existing official resour development team, it provides a complete and useful set of tools without the need to rely on mobile devices. Snap Hutao does not take any destructive modification to the game client to ensure the security of the toolkit. +## Genshin Impact's Desktop Issues Snap Hutao Solved + +| Feature | Mobile | Desktop | Snap Hutao Solution | +| :--------------------------: | -------------------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------ | +| **High Framerate Limit** | iOS/iPadOS supports 120FPS by official | Only up to 60FPS | [Advanced Game Launcher - Framerate unlocker](features/game-launcher.md) | +| **Game Account Switch** | All signed in account will be kept | Will not be recorded after sign out | [Advanced Game Launcher - Account switch](features/game-launcher.md) | +| **Daily Checkin** | MiHoYo BBS client | Web check-in only available for oversea servers | [Account Panel - check-in](features/mhy-account-switch.md) | +| **Realtime Notes** | MiHoYo BBS client | N/A | [Realtime Notes](features/real-time-notes.md) | +| **Expedition Notifications** | Pushed by game client | N/A | [Realtime Notes Notification](features/real-time-notes.md) | +| **Spiral Abyss data lookup** | MiHoYo BBS client | Web lookup only available for oversea servers | [Spiral Abyuss](features/hutao-API.md) | +| **Develop Plan** | MiHoYo BBS client | Only available for oversea servers | [Develop Plan](features/develop-plan.md) | +| **Discord Activity** | N/A | Only available for oversea servers | [Advanced Game Launcher - Discord Activity](features/game-launcher.md) | + ## Project Resource - [GitHub code repository](https://github.com/DGP-Studio/Snap.Hutao) - [Crowdin localization translation](https://translate.hut.ao/) - [Snap Hutao Community](community.md) -## Feature Overview +## Full Feature Overview - [In-game announcement & event countdown](features/dashboard.md) - [MiHoYo BBS multi account login](features/mhy-account-switch.md) diff --git a/docs/en/quick-start.md b/docs/en/quick-start.md index d54b1d712..c81ed5add 100644 --- a/docs/en/quick-start.md +++ b/docs/en/quick-start.md @@ -24,7 +24,7 @@ Follow this document's instruction, you can set up your Snap Hutao quickly. **Unsupported OS Versions**： -1. LTSC and LTSB versions does not include Microsoft Store, so they are not supported +1. LTSC and LTSB versions are using legacy version of MSIX Core, so they are not supported 2. Windows 10 Build 19041 supports installation, but some feature may have unexpected errors due to Windows kernel issues, so Snap Hutao cannot solve them 3. Issues happens in Windows Insider preview versions will not be solved @@ -33,70 +33,58 @@ Follow this document's instruction, you can set up your Snap Hutao quickly. ### New Installation -**Whatever installation method you used, package source and registration are always handled by Microsoft Store.** +You can use MSIX package to install Snap Hutao, you can find pakcage from the following source. -::: tabs -@tab Microsoft Store - - +
+ + + + +
-Microsoft Store Link：[Snap Hutao](https://apps.microsoft.com/store/detail/snap-hutao/9PH4NXJ2JN52) +--- -On Windows 10 and Windows 11 you can click the button above to download Snap Hutao. +If you are interested in making the Snap Hutao project better through your own efforts, consider [join us](development/join.md)! -@tab winget +### Upgrade to the Latest Version from MS Store Versions -- Launch PowerShell -- Execute command `winget install "Snap Hutao"` -- Follow the prompt to allow the installation - - If failed install, receive error of missing dependency or stuck at framework installation stage, please refer to - [Install Dependency Manually](advanced/dependency.md) document +If you installed a Microsoft Store version of Snap Hutao (version 1.4.11 to 1.8.4), you need to uninstall it before the new installation -@tab GitHub +> For details of this change, please refer to [Explanation of Breaking Changes in Version 1.9.0](blog/version-1-9-0-breaking-changes.md) -- Visit the [latest release page](https://github.com/DGP-Studio/Snap.Hutao/releases/latest/) of Snap Hutao -- Download MSIX Package -- Run the MSIX package directly to perform installation - - If failed install, receive error of missing dependency or stuck at framework installation stage, please refer to - [Install Dependency Manually](advanced/dependency.md) document - -::: - -### Upgrade to MS Store Version from Side-load Versions - -If you installed a side-load version of Snap Hutao (version 1.4.10 and older), you need to uninstall it before the new installation - -- Uninstall the side-load version with our [uninstallation instruction document](advanced/uninstall.html) +- Uninstall the Microsoft Store version with our [uninstallation instruction document](advanced/uninstall.html) - Your data will not lose as long as you don't delete data directory manually - Follow the method above to install the Microsoft Store version application ### Update Snap Hutao -**You can use any of the update methods, whatever method you used when you installed Snap Hutao. They don't need to be consistent, as Microsoft Store is the only source of packages.** -::: tabs -@tab Microsoft +If no special instruction is given, you can download and install latest MSIX package to update your Snap Hutao. -- Launch Microsoft Store -- Click on Library in the bottom left to see all apps you have installed -- Click `Get updates` on the top right and your application will be updated - -If you still don't receive the update, you may enter the Snap Hutao [detail page](<(https://apps.microsoft.com/store/detail/snap-hutao/9PH4NXJ2JN52)>) in Microsoft Store, to allow the store to fetch the latest metadata. - -@tab winget - -- Launch PowerShell -- Execute command `winget upgrade "Snap Hutao"` -- Follow the prompt to allow the upgrade - -@tab GitHub - -- Visit the [latest release page](https://github.com/DGP-Studio/Snap.Hutao/releases/latest/) of Snap Hutao -- Download MSIX Package -- Run the MSIX package directly to perform upgrade - -::: +Starting from 1.9.0 version, Snap Hutao has embedded update module to notify the updates. ## Install Optional Components diff --git a/docs/zh/community.md b/docs/zh/community.md index 23e6c9e7d..5b6e76423 100644 --- a/docs/zh/community.md +++ b/docs/zh/community.md @@ -35,7 +35,7 @@ order: 8 /> 从微软商店版升级至最新版 +> 对于这项改变，你可以阅读 [1.9.0 版本重大改变详解](blog/version-1-9-0-breaking-changes.md) 来获得详细信息 + 如果你已经安装了 Snap Hutao 微软商店版（版本号介于1.4.11和1.8.5之间）则需要先卸载旧版本再进行全新安装 - 按照文档提供的[卸载方法](advanced/uninstall.html)卸载侧载版应用