Setup

User Guide

Other

Bedrock clients will join through Geyser and it will handle all the packet translations. There are six different versions of Geyser: Geyser for Spigot (works on derivatives such as Paper), Geyser for BungeeCord (also works on Waterfall), Geyser for Velocity, Geyser for Sponge, Geyser for Fabric (does not support client required mods, and more info about that can be found here) and Geyser Standalone. The first five versions run as plugins/mods and can be installed directly onto the server. The standalone version can be used in a similar way, except you run it separately.

If you are running a server, it is highly recommended you use one of the plugin versions, and if you want to join a server that does not have Geyser installed, you can run the standalone version. If you use Pterodactyl Panel we have an egg for the standalone version, please see here for more information.

If you're still having problems with Geyser not working or giving you an "Unable to connect to world" error, see the Common Issues page.
For more information, take a look at the Understanding the Config page, and the FAQ page.
And if you still have questions, feel free to join the Discord if you haven't already.

Prerequisites

The server you are connecting to has to support the latest version of Minecraft Java Edition (at this time this is Minecraft 1.18.1) The server itself does not have to be the latest version but does have to allow connections. If you're running the server on an older version, you can use the plugin ViaVersion, but do note that only 1.12.2 and any version above is officially supported.
The device running Geyser must support Java 16 or later. If you need help installing or updating, please see https://paper.readthedocs.io/en/latest/java-update/index.html. If you're running a version of Paper that does not support Java 16 or later, you can add the flag -DPaper.ignoreJavaVersion=true to your startup Java arguments to allow Paper to run on Java 16. You can run Geyser standalone on another device if a server software cannot be updated to use Java 16.
If you are connecting to an online mode Java server, a paid Java account is required. If you are running the server, you can bypass this requirement for your server with Floodgate.
Your Bedrock client has to be a supported version - at this time that is Bedrock version 1.17.30 - 1.18.2.
If you are running the server, you need to have a UDP port opened. See below for more instructions.

Plugin Setup

Download a jar of Geyser from the build server depending on what platform your server runs on. See the FAQ if you're confused about which build to download.
Put the Geyser jar file in your plugins folder and start up the server.
If you are on a hosting provider, you will likely need to change your Bedrock port in config.yml. Information on your hosting provider might be available on the Supported Hosting Providers page.
Restart your server if you edited your config.
If not using a hosting provider you will need to use port forwarding to allow people out of your LAN to connect. You want to port forward 19132 UDP, instructions to do that for most routers can be found here.

If you are trying to join from the same LAN, the server should show up in the friends tab.

BungeeCord/Velocity Setup

If you are using a BungeeCord, Waterfall, or Velocity proxy, then you only need to install Geyser (and Floodgate, if you desire) on the proxy.

You can install Floodgate (but not Geyser) on the back-end servers to improve skin functionality and to let other plugins access the Floodgate API. If you do this, then you must make sure that the same key.pem file is used between all instances of Floodgate; otherwise, Bedrock clients will not be able to join. Full instructions can be found on the Floodgate Wiki.

The Bedrock clients, like Java clients, should connect to the proxy server, and should never directly connect to a back-end server. You don't need to (and shouldn't) port-forward anything for the back-end servers!

Standalone Setup

Please keep in mind, you need some sort of computer or host to run Geyser Standalone on. Applications such as Termux on Android are capable of running Geyser, but this largely depends on how powerful your Android device is. Please do so at your own risk. Instructions to run Geyser on Termux can be found here.

Download a jar of Geyser from the build server.
Create a new folder for Geyser, and drop the jar in there.

GUI Setup (Recommended)

Double-click the jar file and all the necessary files for Geyser will be created.
Configure options such as the server you want to join in the Geyser config. A description of all options of the config can be found on the Understanding the Config page.
Stop the current instance of Geyser and re-run it.

Console Setup

Create a new bat or startup script, similar to the one you'd use for a Spigot or Paper server, and take a look at this page for what to put into it.
Run the startup script/bat, and all the necessary files for Geyser will be created.
Configure options such as the server you want to join in the Geyser config. A description of all options of the config can be found on the Understanding the Config page.
Stop the current instance of Geyser and re-run it.

Once you're done, open up Minecraft: Bedrock Edition and in the Friends tab, Geyser should show up there. If it does not show up, just add the Java IPv4 address and Bedrock port.

Standalone Setup (Geyser and Floodgate are not on the same server)

If you want to offload Geyser's processing you can host Geyser (Standalone) somewhere else and make it redirect to your server. Warning: Do not forget to edit the remote section of your Geyser config. See the Floodgate wiki page for more details.

Port Forwarding

Unlike Minecraft Java Edition, Bedrock Edition runs on port 19132 on the UDP protocol. When port forwarding, make sure to allocate to 19132 UDP or another UDP port. For many server hosting providers, you will simply need to change your Bedrock listening port (see here for a list of supported providers).

Termux (Android)

Please read the disclaimer here before continuing.

Download and install Termux
Run pkg install openjdk-17
Run wget https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/lastSuccessfulBuild/artifact/bootstrap/standalone/target/Geyser.jar
Run java -jar Geyser.jar

OR

We have an automated setup script for clean Termux installs, which might not work for all users. If the manual guide above does not work, try this. Run this to start the download/install:

curl https://gist.githubusercontent.com/rtm516/e3e07d6595ee41e05a38b03c0f4d7a80/raw/install.sh | bash

NewTerm 2 (iOS)

Note: A jailbreak is required. You can find what jailbreak to use for your device here.

Install Filza File Manager.
Install NewTerm 2.
Download jre-16 for iOS and install it using Filza here.
Download my modified java commands, and install it using Filza here.
Open NewTerm 2 and run wget https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/lastSuccessfulBuild/artifact/bootstrap/standalone/target/Geyser.jar.
Run java -jar Geyser.jar.
You can find Geyser server running in MCPE!

Note: Due to iOS's environment, if your device has low specs, iOS might end up killing NewTerm 2 while you're playing, stopping the server. There is no fix for that because of how iOS works.

You may encounter some issues. If you do, run su then enter the root password (default is alpine) for root access. Then, run the server like you normally would, and it should work just fine.