* providers.json cleanup, yeet all non-minecraft hosts advanced-setup.md start, include ovh/oci, or docker/ptero instructions there * more little fixes * portforwarding examples * portforwarding page done? minor other changes * fix OVH link, break up long lines, srv records * online/offline mode mismatch still exists * portforwarding title instead of advanced setup * spelling * macOS instructions * Rework providers.json * yeet <br> in favor of bulletpoints * yeet "\n", remove ni-host as supported * Apply suggestions from code review Co-authored-by: rtm516 <rtm516@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: rtm516 <rtm516@users.noreply.github.com> * change \" to ', or `` depending on context * mooooore `` * Address review by @rtm516 --------- Co-authored-by: rtm516 <rtm516@users.noreply.github.com>
24 lines
2.0 KiB
Markdown
24 lines
2.0 KiB
Markdown
---
|
|
title: Global API
|
|
---
|
|
|
|
### Geyser Global API
|
|
The Global API is available for every server. It currently includes: [Global Linking](/floodgate/linking/#what-is-global-linking), [skin uploading](/floodgate/features/#what-is-skin-uploading), getting a xuid by gamertag, and getting a gamertag by xuid.
|
|
We don't store anything else than you can access by the Global API, except for some non-identifiable metrics. The source code of the Global API is available [here](https://github.com/GeyserMC/global_api) and the source code of the Global Linking server is available [here](https://github.com/GeyserMC/GlobalLinkServer).
|
|
|
|
As a user of the API, you can get various info about Geyser (or specifically, Floodgate players) that joined any Geyser + Floodgate server before. This includes:
|
|
- Conversion methods from a Bedrock gamertag to Bedrock xuid, and vice-versa. Only provides info for players who are in Geyser's cache. <br>
|
|
If you need them for all players, you can use a third-party API, e.g. https://mcprofile.io/endpoints, which also provides info from the Geyser Global API.
|
|
- Skin info: Whenever a Bedrock player joins via Floodgate, their skin gets converted & uploaded to mineskin. If you want to grab that converted skin, use the xuid of the Bedrock player in this endpoint to get a texture id, or a base64 encoded "value", which you could use directly in e.g. player heads.
|
|
|
|
See the [Global API docs](https://api.geysermc.org/docs) for more info, and detailed usage.
|
|
|
|
### Examples
|
|
Here are a few examples of how you could use the Global API. <br>
|
|
|
|
[GeyserDiscordBot](https://github.com/GeyserMC/GeyserDiscordBot/blob/master/src/main/java/org/geysermc/discordbot/commands/FloodgateUuidCommand.java)
|
|
- GeyserMC's discord bot has a /uuid command to get a floodgate uuid from a bedrock username. <br>
|
|
|
|
[CustomPlayerHeads](https://github.com/onebeastchris/customplayerheads/blob/master/src/main/java/net/onebeastofchris/customplayerheads/utils/PlayerUtils.java#L54-L72)
|
|
- A fabric mod that uses the Global API to get a Bedrock player's skin, and then uses that to create a player head.
|