https://github.com/andcool-systems/mc-oauth-server
Simple tool for authenticate minecraft profiles for your project
https://github.com/andcool-systems/mc-oauth-server
api authorization-flow minecraft-server oauth yggdrasil-minecraft-login
Last synced: 6 months ago
JSON representation
Simple tool for authenticate minecraft profiles for your project
- Host: GitHub
- URL: https://github.com/andcool-systems/mc-oauth-server
- Owner: Andcool-Systems
- Created: 2024-06-03T21:44:40.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-11-21T04:51:40.000Z (6 months ago)
- Last Synced: 2024-11-21T05:26:31.781Z (6 months ago)
- Topics: api, authorization-flow, minecraft-server, oauth, yggdrasil-minecraft-login
- Language: Java
- Homepage: https://mc-oauth.andcool.ru
- Size: 99.6 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Minecraft OAuth server
## Preface
Implementation of the Minecraft authentication flow in Java. After developing the [mc-oauth plugin](https://github.com/Andcool-Systems/mc-oauth), I was very disappointed with the load on my VPS from the original Minecraft server, and even the PaperMC core did not significantly improve the situation. So, I decided to write a server from scratch that would only include the authentication system, without burdening the server with the game world.
All endpoints and response types remain the same as in the plugin.
>[!Note]
> This server does not contain game state implementation and cannot be used for full-fledged gameplay.
>
## Retrieving Data
`GET /code/<6-digit code>`
After the user receives the code, you should send a request to the API endpoint, which will return data about the Minecraft account.
The code is valid only once and for 5 minutes (by default) after it is received. After this time, the code is deleted.
**Example of a Successful Response:**
```json
{
"nickname": "AndcoolSystems",
"UUID": "1420c63c-b111-4453-993f-b3479ba1d4c6",
"status": "success"
}
```
## Detailed description
The main stages of establishing a connection with the server:
C–Client S–Server
1. **C -> S** Handshake
2. **C -> S** Login start
3. **S -> C** Encryption request
4. **Client auth**
5. **C -> S** Encryption response
6. **Server auth + generate code**
7. **S -> C** Code response
The server does not have an offline mode setting, as it would not make sense in this case, so it always tries to authenticate the player through Mojang.
TODO:
- [x] Add server icon support.
- [ ] Add the ability to choose the authentication server.
- [x] Add configuration.
- [ ] Add a proper logger (instead of the custom SillyLogger).
- [x] Add text formatter for MOTD.