diff options
author | Petr Mrázek <peterix@gmail.com> | 2021-07-22 20:15:20 +0200 |
---|---|---|
committer | Petr Mrázek <peterix@gmail.com> | 2021-07-25 19:50:44 +0200 |
commit | dd133680858351e3e07690e286882327a4f42ba5 (patch) | |
tree | 42ac11eb0d6cc58d3785c57f8571046cafe4b769 /libraries/katabasis/README.md | |
parent | 2568752af57258a33f27f4c2d0b8fc486fb3d100 (diff) | |
download | PrismLauncher-dd133680858351e3e07690e286882327a4f42ba5.tar.gz PrismLauncher-dd133680858351e3e07690e286882327a4f42ba5.tar.bz2 PrismLauncher-dd133680858351e3e07690e286882327a4f42ba5.zip |
NOISSUE bulk addition of code from Katabasis
Diffstat (limited to 'libraries/katabasis/README.md')
-rw-r--r-- | libraries/katabasis/README.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/libraries/katabasis/README.md b/libraries/katabasis/README.md new file mode 100644 index 00000000..a4dc0994 --- /dev/null +++ b/libraries/katabasis/README.md @@ -0,0 +1,36 @@ +# Katabasis - MS-flavoerd OAuth for Qt, derived from the O2 library + +This library's sole purpose is to make interacting with MSA and various MSA and XBox authenticated services less painful. + +It may be possible to backport some of the changes to O2 in the future, but for the sake of going fast, all compatibility concerns have been ignored. + +[You can find the original library's git repository here.](https://github.com/pipacs/o2) + +Notes to contributors: + + * Please follow the coding style of the existing source, where reasonable + * Code contributions are released under Simplified BSD License, as specified in LICENSE. Do not contribute if this license does not suit your code + * If you are interested in working on this, come to the MultiMC Discord server and talk first + +## Installation + +Clone the Github repository, integrate the it into your CMake build system. + +The library is static only, dynamic linking and system-wide installation are out of scope and undesirable. + +## Usage + +At this stage, don't, unless you want to help with the library itself. + +This is an experimental fork of the O2 library and is undergoing a big design/architecture shift in order to support different features: + +* Multiple accounts +* Multi-stage authentication/authorization schemes +* Tighter control over token chains and their storage +* Talking to complex APIs and individually authorized microservices +* Token lifetime management, 'offline mode' and resilience in face of network failures +* Token and claims/entitlements validation +* Caching of some API results +* XBox magic +* Mojang magic +* Generally, magic that you would spend weeks on researching while getting confused by contradictory/incomplete documentation (if any is available) |