Skip to content

Features

Tim203 edited this page Aug 16, 2021 · 21 revisions

Whitelist command

Floodgate 2.0 has a whitelist command, fwhitelist, that should be used for adding or removing Floodgate players to whitelist.json. The username prefix doesn't need to be included. fwhitelist add Tim203 fwhitelist remove Tim203

The permission node is floodgate.command.whitelist.

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.

If you don't want to use Global Linking, you can disable enable-global-linking in the Floodgate config.

Local Linking

You can also set up a local linking database on your server. Local linking can work with Global Linking at the same time. Link entries in your local database will override entries in the Global Linking Server.

Note that you only have to follow these steps on your proxy (BungeeCord or Velocity), if you have one.

  1. Download one of the linking databases extensions here. (If you need help picking one of them: if you already have a database or want to have a multi-proxy setup: choose mysql, otherwise choose sqlite)
  2. Copy the linking database extension jar file you just downloaded into the floodgate 2.0 plugin folder (e.g. /plugins/floodgate/).
  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). (If you used Floodgate 1.0 and had linking enabled back then; the database type was sqlite).
  5. Restart your server
  6. Use the same commands that Global Linking lists above

What is skin uploading?

Skins of Bedrock player should be visible to Java players on servers with Floodgate 2.0 installed.
If they aren't, it's most likely that the skin uploading queue has grown too large and can take a while to upload your skin.

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

We're using MineSkin internally. MineSkin is running on accounts donated by the community. So if you want to support MineSkin and make the upload times faster, feel free to look at this page for more info.

Example skin upload