# 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)", "Plugin System" & "Plugin Restrictions" sections 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 Transifex project, please create an issue either in GitHub or create a discussion through Transifex 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 - latest version)** or **JetBrains Rider (Any Edition - latest version)**
   - Select .NET desktop development component
2. **Windows SDK (10.0.26100.0 ONLY)** via Visual Studio Installer
3. .NET 9 SDK: [**(9.0.4 or later)**](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)

> **Note**:
> Make sure to always use the latest version of Visual Studio or Rider in order to be able to open the project.

## Plugin System
> The plugin system was introduced in a recent version of Collapse, allowing for external games, not officially supported by the launcher, to be managed through the it. Any user can create & load their own plugins into Collapse, provided they follow a set of guidelines and standards.

The plugin system requires its own set of dependencies and packages, though the tools required to develop it are identical. For more information about developing your own plugin, take a look at the core plugin module's [documentation](https://github.com/CollapseLauncher/Hi3Helper.Plugin.Core). 

## Plugin Restrictions
Plugins are designed to interface with Collapse through COM Interops and marshalling. As such, you must follow the API contracts defined in the core library. That being said, there's nothing stopping you from writing your own interfaces and ways to interact with Collapse, provided that the current launcher code supports that functionality. Ultimately, **we, the Collapse core developer team, cannot stop users from distributing their own plugin libraries and implementing features that we never will** (see below), but it is our hope that our users and community will adhere to the rules we set.

All official plugins (plugins that are accessible through Collapse's download interface) must be validated by a member of the development team before being approved for publishing, to ensure the safety of our users and preserve launcher stability and integrity. The Collapse project and its members are not responsible for damage caused to the user should they install unofficial and unsupported plugins. Furthermore, no support will be provided for any unofficial plugin.

## 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:
- Community resources
- Officially-endorsed HoYoverse Tools
- Code that enhances plugin-related functionality
- Etc.
  
### 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)
- [Zenless Zone Zero Terms of Service](https://zenless.hoyoverse.com/en-us/company/terms)
- [HoYoLAB Forum Terms of Service](https://www.hoyolab.com/agreement)
- Any other Terms of Service & Privacy Policy links for games implemented through the plugin system

# 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 ❤️