Fun/Snap.Hutao.Docs
1
0
Fork 0
mirror of https://jihulab.com/DGP-Studio/Snap.Hutao.Docs.git synced 2025-11-19 21:16:31 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update development documents

Browse Source
This commit is contained in:
Masterain
2023-10-12 00:23:38 -07:00
parent 564617cc1c
commit e765113d07
8 changed files with 101 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/en/development/README.md
View File

@@ -3,8 +3,10 @@ headerDepth: 0
comment: false
index: false
dir:
text: Development
text: Open Source Development
order: 3
---
# Development
# Open Source Development
<AutoCatalog />

36
docs/en/development/contribute.md Normal file
View File

@@ -0,0 +1,36 @@
---
category: [open source, development]
tag: ["development", "GitHub"]
icon: iconfont icon-code
order: 2
---
# Contribute Your Code
Snap Hutao is using C# and .NET Framework to develop both client and server. If you are willing to contribute your code
to the project, please read the following guidelines.
You can find all [unsolved opened issues](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aissue+is%3Aopen+-label%3A%E5%B7%B2%E4%BF%AE%E5%A4%8D+) on GitHub
## Setup Snap.Hutao Project
1. Download and install [Visual Studio 2022 Community](https://visualstudio.microsoft.com/downloads/)
2. Open Visual Studio Installer to complete Visual Studio installation
- You need to install `.NET desktop development`, `Desktop development with C++` and `Universal Windows Platform development` components
3. Install `Single-project MSIX Packaging Tools for VS 2022` provided by Microsoft in Visual Studio marketplace
4. Use git to clone the project `https://github.com/DGP-Studio/Snap.Hutao.git` to your local device
5. Switch git branch to `develop`
6. Open project solution with your Visual Studio and then you are ready to go
## Start Pull Request
- All code-related changes from authors' own branches are only allowed be merged to `develop` branch
- Please use [keywords](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests) to link your PR or commits with issues, so issues can be automatically closed once commits are merged into `main` branch.
## 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.
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.

9
docs/en/development/platform.md
View File

@@ -1,5 +1,6 @@
---
category: [open source, development]
tag: [open source, Hutao Database, Spiral Abyss Database, Enka, UIGF, Open data]
icon: iconfont icon-vscode
order: 1
---
@@ -23,8 +24,8 @@ Open-source software authors can use the Hutao API to retrieve data from the Hut
Developers who gain access to the Hutao API also receive full privileges to the Hutao Cloud feature
within the Snap Hutao as a benefit.
Developers can apply for access by submitting their information through the Hutao API Open Platform at
[https://homa.snapgenshin.com/](https://homa.snapgenshin.com/)
Developers can apply for access by submitting their information through the Hutao API Open Platform
at [homa.snapgenshin.com](https://homa.snapgenshin.com/)
## Enka API with China Acceleration
@@ -35,9 +36,7 @@ the stability of Enka Network's functionality in the region is compromised.
To ensure a smooth user experience for Snap Hutao users in China, the development team has utilized Enka Network's data
for the development of the [My Characters](../features/character-data.md) feature and established a proxy server.
If you are a developer of open-source Genshin Impact tools and require this functionality, you can fill out the
[form](https://docs.google.com/forms/d/e/1FAIpQLSefnrYz41NZ2hSG0xC6OoBsIiM_mDdVLS7lsUg9thHmA1h8qw/viewform?usp=sf_link)
to apply for the usage of our maintained proxy service.
Developers can ask for access in Snap Hutao development group chat or discord group from administrator.
## UIGF Interchangeable Game Data Format