diff --git a/docs/education.md b/docs/education.md new file mode 100644 index 0000000..5a46abb --- /dev/null +++ b/docs/education.md @@ -0,0 +1,33 @@ +## Overview + +Minecraft Education has a different method of allowing users on. By default a Minecraft Educational Client +can only connect to another Minecraft Education Client who is part of the same Microsoft Tenancy. + +The server has to have a token for each tenancy that it will allow logins for. It can support multiple tenancies +at the same time. + +## Generating a Token + +To generate a token you will need to enter the following geyser command: + +``` +/geyser education new +``` + +This will provide a URL that a user in the tenancy must open in their browser (any user in the tenancy is fine). This will allow them to log into +Microsoft as usual. They will end up with a white screen and a long address in their address bar. This address needs +to be copied. Then enter the following geyser command: + +``` +/geyser education confirm {copied address} +``` + +This will generate the appropriate token. This token only allows the server access to the minecraft part of the account +and if the user ever changes their Microsoft password the token will no longer be valid. Now any user in that same +tenancy will be able to connect. + +## Notes + +Minecraft Education uses the Tenancy username as the player username. This can cause collisions, so you may +wish to additionally use [GeyserLogin](https://github.com/bundabrg/GeyserLogin/releases) to provide a login screen +for them to select a username. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 9116cb4..a2ff8fe 100644 --- a/docs/index.md +++ b/docs/index.md @@ -31,4 +31,5 @@ where your Geyser.jar file is located. [11:08:37 DEBUG] {GeyserReversion} Registered Translator: Translator_v390ee_to_v408be ``` - \ No newline at end of file +4. If using `education` you will need to generate a token for each tenancy that you support otherwise you'll get a +"School not allowed" error. See [education docs](education.md) for more info diff --git a/mkdocs.yml b/mkdocs.yml index 0d04dcc..8b0f80d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -76,4 +76,5 @@ plugins: nav: - Introduction: index.md - Configuration: config.md + - Education: education.md - Contributing: contributing.md \ No newline at end of file