Skip to content

Commit

Permalink
many many things
Browse files Browse the repository at this point in the history
1. Separate build instruction with contrib guidelines
2. Fixes alt/title
3. Add UI Overview tag
4. Add art annotation
5. Add Code signing policy
6. try to fix favicon for idk how many times already
7. Fix coloring style in hero page
8. Update privacy and TPN
  • Loading branch information
bagusnl committed Dec 24, 2024
1 parent 7205699 commit c77fd89
Show file tree
Hide file tree
Showing 17 changed files with 287 additions and 127 deletions.
6 changes: 5 additions & 1 deletion home/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ export default defineConfig({
['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/apple-touch-icon.png' }],
['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: '/favicon-32x32.png' }],
['link', { rel: 'icon', type: 'image/png', sizes: '16x16', href: '/favicon-16x16.png' }],
['link', { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico'}],
['link', { rel: 'manifest', href: '/site.webmanifest' }],
['meta', { name: 'description', content: 'An advanced launcher for HoYoverse Games. Built with C#/.NET with WinUI and open sourced. Supports all PC games published by miHoYo/HoYoverse with many advanced features like game repair, delta patch, game settings, etc.' }],
['meta', { name: 'keywords', content: 'HoYoverse, miHoYo, Games, Launcher, Collapse Launcher, C#, .NET, WinUI, WinUI3, Genshin Impact, Honkai: Impact 3rd, HI3, Honkai: Star Rail, HSR, Zenless Zone Zero, ZZZ' }],
Expand Down Expand Up @@ -73,14 +74,17 @@ export default defineConfig({
{
text: 'For Developers',
items: [
{text: 'Building', link: 'docs/building'},
{text: 'Contribution guidelines', link: 'docs/contrib'}
]
},
{
text: 'Legals',
items: [
{text: 'Privacy policy', link: 'docs/privacy'},
{text: 'License', link: 'docs/license'},
{text: 'Third party notices', link: 'docs/third_party_notices'}
{text: 'Third party notices', link: 'docs/third_party_notices'},
{text: 'Code signing policy', link: 'docs/code-signing-policy'}
]
}
],
Expand Down
4 changes: 2 additions & 2 deletions home/.vitepress/theme/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
}

/* Light mode - no worky pls help*/
@media (prefers-color-scheme: light) {
/*@media (prefers-color-scheme: light) {
:root {
--vp-home-hero-name-background: -webkit-linear-gradient(
45deg,
Expand All @@ -123,7 +123,7 @@
#fda085 50%
);
}
}
}*/

@media (min-width: 640px) {
:root {
Expand Down
31 changes: 31 additions & 0 deletions home/docs/building.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Building in your Local Environment | Collapse Launcher
---

# Building Collapse Launcher

## Tools Needed

Below is a list of tools needed to contribute to this project:

1. **Visual Studio 2022 (Any Edition - 17.12 or later)**
- Select .NET desktop development component
2. **Windows SDK (10.0.22621.0 ONLY)** via Visual Studio Installer
3. .NET 9 SDK: [**(9.0.0 or later)**](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)

::: info
Starting from September 29<sup>th</sup> 2024, you <b>must</b> have Visual Studio 2022 version 17.12+ installed on your computer due to the updated minimum system requirement of `.NET 9`.

Using a lower Visual Studio version (like VS2019) is not possible due to requirement from WindowsAppSDK used in this project.
:::

## Cloning Repository

- Unless otherwise stated in this project's README, please make sure to clone the source code from the `main` branch using `--recurse-submodules` parameter to pull all the submodules Collapse needs to compile.

```git clone https://github.com/CollapseLauncher/Collapse --recurse-submodules```

- Make sure you use the supported IDE & SDKs listed.
- Make sure to read the "Restriction for New Feature(s)" section in 'Contribution Guidelines'.
- When submitting a Pull Request (PR), make sure that it is done to the same branch from which you first pulled, unless otherwise stated in the project's README, or if specifically instructed by maintainers of this project.
- We don't require a fully descriptive PR, but please be clear on what is added/removed and what the code does.
18 changes: 18 additions & 0 deletions home/docs/code-signing-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Code Signing Policy | Collapse Launcher
---


# Code Signing Policy

:::info
Free code signing provided by [SignPath.io], certificate by [SignPath Foundation]
:::

- This program will only transfer user data to user configured database server. Exception data will be sent to [Sentry.io] for error tracking purposes (user are able to disable the behavior in App Settings).
- Read our full [**Privacy Policy**](/docs/privacy)
- Also read our [**Third Party Notices**](/docs/third_party_notices) for license used by third party libraries that we use.

[SignPath Foundation]:https://signpath.org
[SignPath.io]:https://signpath.io
[Sentry.io]:https://sentry.io
34 changes: 15 additions & 19 deletions home/docs/contrib.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,59 +3,55 @@ title: Contribution Guidelines | Collapse Launcher
---

# Contribution Guidelines

## Before you Start

- Unless otherwise stated in this project's README, please make sure to clone the source code from the `main` branch using `--recurse` parameter to pull all the submodules Collapse needs to compile.

```git clone https://github.com/CollapseLauncher/Collapse --recurse```

- Make sure you use the supported IDE & SDKs listed below.
- Make sure to read the "Restriction for New Feature(s)" section below.
- When submitting a Pull Request (PR), make sure that it is done to the same branch from which you first pulled, unless otherwise stated in the project's README, or if specifically instructed by maintainers of this project.
- We don't require a fully descriptive PR, but please be clear on what is added/removed and what the code does.

## Localization Contribution(s)
You can help us add or proofread localization changes for [Collapse on Transifex!](https://explore.transifex.com/collapse-launcher/collapse-mainapp/)
If you wish to add new language that isn't yet listed in the Crowdin project, please create an issue either in GitHub or create a discussion through Crowdin itself. We'll do our best to get back to you in a timely manner.

## Tools Needed
Below is a list of tools needed to contribute to this project:
1. **Visual Studio 2022 (Any Edition - 17.12 or later)**
- Select .NET desktop development component
2. **Windows SDK (10.0.22621.0 ONLY)** via Visual Studio Installer
3. .NET 9 SDK: [**(9.0.0 or later)**](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)

::: info
Starting from September 29<sup>th</sup> 2024, you <b>must</b> have Visual Studio 2022 version 17.12+ installed on your computer due to the updated minimum system requirement of `.NET 9`.

Using a lower Visual Studio version (like VS2019) is not possible due to requirement from WindowsAppSDK used in this project.
:::
You can help us add or proofread localization changes for [Collapse on Transifex!](https://explore.transifex.com/collapse-launcher/collapse-mainapp/)
If you wish to add new language that isn't yet listed in the Crowdin project, please create an issue either in GitHub or create a discussion through Crowdin itself. We'll do our best to get back to you in a timely manner.

## Restrictions for New Feature(s)

While this software is fully open source and not affiliated with HoYoverse, Cognosphere, or any of its related entities in any way, we are nonetheless bound to their Terms of Service and Code of Conduct when developing Collapse. This means that there are some features that we will **not** implement. We will close any issue or PRs that are made to add such functionality to Collapse. Such features include, but are not limited to:

- Anything that, in any way, interacts with the miHoYo SDK and/or API, including their Authentication and Payment Processing endpoints.
- Anything that directly injects into the game process (and/or any of its subprocesses) including DLL injections, memory reading/modification, etc.
- Anything that directly modifies game files and resources to provide an unfair advantage in-game for those using our launcher.

### Examples for features that we encourage others to submit PRs for:
### Examples for features that we encourage others to submit PRs for

- Community resources
- Officially-endorsed HoYoverse Tools
- Etc.

### Examples of features that we will probably never implement:
### Examples of features that we will probably never implement

- Account switcher(s)
- FPS Unlocker (that violates any of the rules included above)
- Any type of cheats or exploits.
- Etc.


## Further reads

- [Genshin Impact Terms of Service](https://genshin.hoyoverse.com/en/company/terms)
- [Honkai Impact 3rd Terms of Service](https://honkaiimpact3.hoyoverse.com/global/en-us/terms)
- [Honkai: Star Rail Terms of Service](https://hsr.hoyoverse.com/en-us/company/terms)
- [HoYoLAB Forum Terms of Service](https://www.hoyolab.com/agreement)

---
&nbsp;

# A Humble Thank You

As contributors, we always feel grateful for all your contributions to the project, whether it be through helping with localizing the app, coming up with new features, reporting bugs, and even using this launcher. Through everyone's effort, we can keep this project alive by bringing even more features and quality-of-life (QoL) upgrades over the existing launchers (including official) that are out there.
Thank you ❤️
Thank you ❤️
78 changes: 78 additions & 0 deletions home/docs/privacy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
title: Privacy Policy | Collapse Launcher
---

# Privacy Policy for Collapse Launcher

_Last Updated: November 19th, 2024_

Thank you for using Collapse Launcher! This Privacy Policy outlines the information practices of Collapse Launcher and how any third-party services utilized may collect, use, and disclose data.

Please read this Privacy Policy carefully to understand how we may use and process your information.

## 1. Information We Do Not Collect

Collapse Launcher is committed to preserving your privacy and does not collect any personally identifiable information (PII). We do not track your usage, access, or any personal data related to your interaction with the program.
However, we do collect error data to aid in development. This data is stored on either self-hosted or SaaS, Sentry-compatible dashboard server, which is accessible only to our core development team. We try our best to strip any PII data from being collected. You can disable this anytime by going to the application settings.

## 2. Third-Party Services

While Collapse itself does not collect the information outlined above, we utilize certain third-party services, such as Cloudflare, to enhance the performance, security, and functionality of our project. These third-party services may collect information as described in their respective privacy policies.

### Service Provider: GitHub

- Purpose: Main Data Provider
- Information collected: IP address, device information, session information, date and time of request, cookies, geolocation information.
- Privacy policies:
<https://docs.github.com/en/site-policy/privacy-policies>
- Opt-out: You can change the CDN provider by going to the application settings.

### Service Provider: Cloudflare, Inc.

- Purpose: Main Content Delivery Network (CDN) Provider
- Information collected: IP address, country, city, and internet service provider (ISP) used to access the service.
- Privacy policies:
<https://www.cloudflare.com/privacypolicy/>; <https://www.cloudflare.com/trust-hub/gdpr/>;

### Service Provider: CODING; Tencent Cloud Computing (Beijing) Co., Ltd.

- Purpose: Content Delivery Network (CDN) Provider
- Information collected: Monitoring Log (URL access path, IP address, user agent of the browser (OS type and version, CPU type, browser type and version, browser rendering engine, browser language and plug-in))
- Privacy policies:
<https://www.tencentcloud.com/document/product/1133/45791>
- Opt-out: You can change the CDN provider by going to the application settings.

### Service Provider: Sentry (Functional Software, Inc.)

- Purpose: Error Tracking and Monitoring
- Information collected: Error data, Collapse log file, session information, environment information (device information, OS version, application version, etc.)
- Privacy policies:
<https://sentry.io/privacy/>
- Opt-out: You can disable this feature by going to the application settings or setting system environment variable "DISABLE_SENTRY" to true.

#### Service Provider: Turso

- Purpose: Storing User Synchronization Data in user provided database account.
- Information collected: IP address, Geo-location data.
- Privacy policies:
<https://turso.tech/privacy-policy>
- Opt-out: Disabled by default, you can enable this feature by making an account in the website and providing your own database account to the app. Collapse developer has no access to the data stored in the database.


## 3. Cookies

We do not collect or store any web cookies. All cookies used in Collapse Launcher's internal browser are locally stored. While that is the case, we have no control over websites collecting cookies when accessed.

## 4. Security

Collapse Launcher employs reasonable security measures to protect against unauthorized access, alteration, disclosure, or destruction of data. However, no method of transmission over the internet or electronic storage is completely secure, and we cannot guarantee absolute security.

## 5. Changes to Privacy Policy

Collapse Launcher reserves the right to update or modify this Privacy Policy at any time. We will notify users by posting the updated policy on our website and/or any available platform(s) with the effective date of the changes.

## 6. Contact

Should you have any questions, concerns, or requests regarding this Privacy Policy, please contact us at <[email protected]>.

By using Collapse Launcher, you agree to the terms outlined in this Privacy Policy.
Loading

0 comments on commit c77fd89

Please sign in to comment.