Skip to content

Latest commit

 

History

History
55 lines (45 loc) · 3.99 KB

CONTRIBUTING.md

File metadata and controls

55 lines (45 loc) · 3.99 KB
Raw

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/neon-nyan/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! 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.8 or later)
    • Select .NET desktop development component
  2. Windows SDK (10.0.22621.0 ONLY) via Visual Studio Installer
  3. .NET 8 SDK: (8.0.0 or later)
  4. WinUI 3: (WindowsAppSDK 1.4.0 Stable Runtime)

Note:

Starting from November 21st 2023, you must have Visual Studio 2022 version 17.8+ installed on your computer due to the updated minimum system requirement of WindowsAppSDK and .NET 8.

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

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
  • 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:

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