Floodgate - rtm516/GeyserMC-wiki GitHub Wiki

Floodgate is a hybrid mode plugin which allows for Minecraft: Bedrock Accounts to join Minecraft: Java Edition servers without needing a Minecraft: Java Edition account. This is something you install in addition to Geyser. Unlike Geyser, Floodgate can only be installed as a plugin on Bukkit, Bungeecord, and Velocity, and can only be utilized on servers that have it installed.

Download

Setting Up

NOTE: Floodgate does not replace the Geyser jar. If you are running a plugin version of Geyser, you still MUST have Geyser installed.

Any reference to Spigot here also refers to compatible server softwares such as Paper.

Plugin Setup (You have Geyser and Floodgate on the same server)

For multi-server setups: you only are required to install Floodgate on the BungeeCord or Velocity instance unless you want to use the Floodgate API on the other servers - see below for the installation process.

If using Velocity: Set player-info-forwarding-mode to LEGACY in velocity.toml

  • Download the Floodgate plugin from here and add it to your plugins folder.
  • Change the auth-type in the Geyser config to floodgate.
  • Restart/start up the server.

Standalone Setup (Geyser and Floodgate are in separate places)

  • Download the Floodgate plugin from here and add it to your plugins folder.
  • Run the server with Floodgate.
  • Copy the public-key.pem file in the Floodgate config folder to the same directory as Geyser (standalone) or Geyser's config folder (plugin versions). DO NOT DISTRIBUTE THIS KEY TO ANYBODY! This key is what allows for Bedrock accounts to bypass the Java Edition authentication, and if anyone gets ahold of this, they can wreak havoc on your server.
  • Change the auth-type in the Geyser config to floodgate.

Running Floodgate on Spigot servers behind BungeeCord or Velocity

This is only needed when you want to use the Floodgate API on your Spigot server(s).

  • Download the Floodgate plugin from here and install it as a plugin on both BungeeCord/Velocity and the Spigot server(s).
  • Enable ip_forwarding in your BungeeCord config.yml if using BungeeCord
  • Set player-info-forwarding-mode to LEGACY in velocity.toml if using Velocity
  • Set bungeecord to true in your spigot.yml
  • Start the proxy server.
  • Edit the Floodgate config on your proxy server and set send-floodgate-data to true.
  • Copy both key files in the Floodgate config folder to Spigot Floodgate's config folder. DO NOT DISTRIBUTE THIS KEY TO ANYBODY! This key is what allows for Bedrock accounts to bypass the Java Edition authentication, and if anyone gets ahold of this, they can wreak havoc on your server.
  • Restart the Spigot servers and proxy server.

Known Issues/Caveats

Skins

Due to how Minecraft: Java Edition handles skins, all Bedrock players will appear as Steve or Alex to other Java players.

Access token can not be null or empty

This may be because you forgot to set the auth-type in the config to floodgate. If that isn't it, check to make sure your config contains the line floodgate-key-file: public-key.pem. If not, just copy that in directly.

Invalid packet id: 27

This usually means one of two things:

  • You did not follow the Floodgate instructions properly. However, in an unlikely scenario, this could also be an error related to uploading through FTP. Using ascii will not work here, and you need to make sure you're on binary when uploading.
  • You're trying to log in without an Xbox account. Floodgate requires an Xbox account to authenticate the Bedrock player.

Whitelist command not working

See this page.

Obtaining UUIDs for Floodgate players

Check the server log for their UUIDs, or use this method.

Using PlaceholderAPI

If you're using the Bukkit version of Floodgate, download the Placeholder plugin here. Using the placeholders shouldn't require additional setup other than having PlaceholderAPI installed. See the section above on installing Floodgate on backend servers if you wish to use this on BungeeCord.

Using Skript

If you're using the Bukkit version of Floodgate, there is an unofficial plugin that adds Skript support here.