Skip to content

Commit

Permalink
Add Education documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bundabrg committed Aug 21, 2020
1 parent 5384baa commit 1c7bb82
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
33 changes: 33 additions & 0 deletions docs/education.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,5 @@ where your Geyser.jar file is located.
[11:08:37 DEBUG] {GeyserReversion} Registered Translator: Translator_v390ee_to_v408be
```


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
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,5 @@ plugins:
nav:
- Introduction: index.md
- Configuration: config.md
- Education: education.md
- Contributing: contributing.md

0 comments on commit 1c7bb82

Please sign in to comment.