diff options
| author | Petr Mrázek <peterix@gmail.com> | 2021-10-21 01:11:08 +0200 |
|---|---|---|
| committer | Petr Mrázek <peterix@gmail.com> | 2021-10-21 01:11:08 +0200 |
| commit | 264d3017aac89eaf4ea2a1e06bd8631259fcbe10 (patch) | |
| tree | 35f0d47a987e3b9fee2517b1f0b7f4141fb671ff /notsecrets | |
| parent | d9b46289a1b9eec5bda19bd168750afba23a9ca4 (diff) | |
| download | PrismLauncher-264d3017aac89eaf4ea2a1e06bd8631259fcbe10.tar.gz PrismLauncher-264d3017aac89eaf4ea2a1e06bd8631259fcbe10.tar.bz2 PrismLauncher-264d3017aac89eaf4ea2a1e06bd8631259fcbe10.zip | |
NOISSUE update notsecrets README.md
Diffstat (limited to 'notsecrets')
| -rw-r--r-- | notsecrets/README.md | 29 |
1 files changed, 22 insertions, 7 deletions
diff --git a/notsecrets/README.md b/notsecrets/README.md index 14d27e7a..4664fa89 100644 --- a/notsecrets/README.md +++ b/notsecrets/README.md @@ -1,10 +1,25 @@ -# (Not) Secrets +# DevLauncher (Not) Secrets -This is a dummy implementation of MultiMC's _Secrets_ library, used to store private information needed for certain functions of MMC in a secure manner -(obfuscated or encrypted). - -Currently, this library contains: -- Your Microsoft Authentication app's client ID. **This is required to use Microsoft accounts to play!** +This is a dummy implementation of MultiMC's _Secrets_ library, used to store private information needed for: +- Application name and logo (and branding in general) +- Various URLs and API endpoints +- Your Microsoft Identity Platform client ID. **This is required to use Microsoft accounts to play!** - If omitted, adding Microsoft accounts will be completely disabled. -Forks of this project should provide their own implementation of this library to enable these functions properly. +## MultiMC development + +In its current state, the `notsecrets` library is suitable for MultiMC code contributions (the code builds as `DevLauncher`). + +All you have to do is add the Microsoft client ID. See `Secrets.cpp` for details. + +## Forking + +Forks of this project that intend to distribute binaries to users should use their own implementation of this library that does not impersonate MultiMC in any way (see the Apache 2.0 license, common sense and trademark law). + +A fork is a serious business, especially if you intend to distribute binaries to users. This is because you need to agree to the Microsoft identity platform Terms of Use: + +https://docs.microsoft.com/en-us/legal/microsoft-identity-platform/terms-of-use + +If you truly want to accept such an agreement, a starting point is to copy `notsecrets` to `secrets`, enable the `Launcher_EMBED_SECRETS` CMake option and customize the files. + +We do not want confused users asking for help with your fork in MultiMC Discord or similar locations. |