Skip to content

Features

Konicai edited this page Jun 7, 2021 · 21 revisions

What is the Global Api?

The Global Api is an API that is available for every server. It currently includes: Global Linking, 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 and the source code of the Global Linking server is available here.

What is Global Linking?

Instructions and information about how to link can also be found here: https://link.geysermc.org/

Before we introduced Global Linking, you always had to link your Java and Bedrock account on every individual server you visited (that has Floodgate). Global Linking is here to fix that problem. Link once, join everywhere.
Global Linking is part of the Global Api and uses the GlobalLinkServer to link your account. To be able to link your account you have to do the following:

  1. Join the GlobalLinkServer with both your Java and Bedrock account
    (IP: link.geysermc.org, Java port: 25565, Bedrock port: 19132)
  2. Start the linking process by typing /linkaccount on your Java or Bedrock account
  3. You'll get a message with a random number that you have to enter on the account that you did not start the linking process on.
  4. Enter the random number on the other account by typing /linkaccount <code>
  5. You should get kicked from the server on both your Bedrock and Java account with the message that it had successfully linked your accounts.

Global Linking should be enabled by default on every server running Floodgate 2.0, but in the case that you disabled it, you can enable it again by opening your Floodgate config and make sure that the player-link section looks similar to this:

# Configuration for player linking
player-link:
  # Whether to enable the linking system. Turning this off will prevent
  # players from using the linking feature even if they are already linked.
  enabled: true
  # Whether to use global linking. Global linking uses a central server to request link
  # accounts, allowing people to link once, join everywhere (on servers with global linking).
  use-global-linking: true

(see the default config)

Once you saved the config and restarted your server you should be using Global Linking.

Local Linking

You can also set up local linking on your server, in combination with Global Linking. If you don't want to use Global Linking, you can disable enable-global-linking in the Floodgate config. Link entries in your local database will override entries in the Global Linking Server.

If using a proxy like BungeeCord or Velocity, only follow these steps on the proxy.

  1. Download one of the linking databases here or get your linking database from Floodgate 1.0
  2. Copy the linking database into the plugin folder of floodgate 2.0
  3. Uncomment and enable enable-own-linking in the player-link section of Floodgate.
  4. Set type in the player-link section to your database type (currently either mysql or sqlite). The type of the old floodgate 1.0 database is mysql.
  5. Restart your server

What is skin uploading?

Skin uploading is also a part of the Global Api. It is responsible for converting Bedrock skins to Java skins and uploading them to make them show up on Java Edition.

Example skin upload