Skip to content
This repository was archived by the owner on Jul 21, 2024. It is now read-only.

wiki setup changes #86

Merged
merged 26 commits into from
Oct 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
39dca49
the setup guide is more complete now
onebeastchris Sep 23, 2022
70adfa8
split standalone instructions for cleaner look
onebeastchris Sep 23, 2022
71cbb25
mention floodgate
onebeastchris Sep 23, 2022
b535986
pterodactyl port forward
onebeastchris Sep 23, 2022
0c60de6
fix typo
onebeastchris Sep 23, 2022
2845d1b
remove unnecessary if statement
onebeastchris Sep 26, 2022
e9a32e8
removed and from list
onebeastchris Sep 26, 2022
34f795e
removed and from list
onebeastchris Sep 26, 2022
f4c37bb
fix update links/names for standalone
onebeastchris Sep 26, 2022
2ffbb08
fixes after review
onebeastchris Sep 26, 2022
f680400
add chat signing info
onebeastchris Sep 26, 2022
3a4ff57
let auto stay auto
onebeastchris Sep 26, 2022
f2d50ab
fix further capitalisation
onebeastchris Sep 26, 2022
15667a8
add warning to disabling the chat signing requirement
onebeastchris Sep 27, 2022
2822e55
Add more info link
onebeastchris Sep 30, 2022
8117eef
1.13 as the lowest supported version
onebeastchris Sep 30, 2022
9ba41a2
1.12.2 -> 1.13.2
onebeastchris Sep 30, 2022
bd7504c
Merge branch 'GeyserMC:master' into master
onebeastchris Oct 3, 2022
7096703
standalone permalink fix
onebeastchris Oct 3, 2022
9067ef6
Merge pull request #1 from onebeastchris/onebeastchris-patch-1
onebeastchris Oct 3, 2022
050f24b
Update _docs/geyser/setup.md
onebeastchris Oct 3, 2022
6c4902b
Update _docs/geyser/setup.md
onebeastchris Oct 3, 2022
32023ff
Update _docs/geyser/setup.md
onebeastchris Oct 3, 2022
d57f4d1
Apply suggestions from code review
onebeastchris Oct 4, 2022
831d4e0
Remove recommendation to run Geyser as root on iOS
jackson-57 Oct 4, 2022
4c4f990
Changed toc.yml to (hopefully) include the new "standalone" page, and…
onebeastchris Oct 4, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions _data/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@
children:
- title: Plugin Setup
url: "geyser/setup/#plugin-setup"
- title: Standalone Setup
url: "geyser/setup/#standalone-setup"
- title: Videos
url: "geyser/setup/#setup-videos"
- title: "Standalone"
url: "geyser/standalone/"
children:
- title: Termux (Android)
url: "geyser/setup/#termux-android"
- title: NewTerm 2 (iOS)
url: "geyser/setup/#newterm-2-ios"
- title: Videos
url: "geyser/setup/#setup-videos"
- title: FAQ
url: "geyser/faq/"
- title: Common Issues
Expand Down
2 changes: 1 addition & 1 deletion _docs/geyser/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ This is a Bedrock client issue caused by Bedrock being 32-bit and Java being 64-
No, this is a translation tool to allow Bedrock players to connect to Java servers. It does not work the opposite way.

## Can I use Geyser with Pterodactyl Panel?
Yes, you can use Geyser as a plugin or a mod for your Minecraft server software running on Pterodactyl. There is also an official egg for the standalone version. It supports auto-updating and has all config options easily editable. You can find it [here](https://github.com/GeyserMC/pterodactyl-stuff), download the JSON egg, and import it into your panel.
Yes, you can use Geyser as a plugin or a mod for your Minecraft server software running on Pterodactyl. There is also an official egg for the standalone version. It supports auto-updating and has all config options easily editable. You can find it [here](https://github.com/GeyserMC/pterodactyl-stuff), download the JSON egg, and import it into your panel. Make sure the Geyser port (using UDP) is exported out to the host & allocated the port to the server.

## Can I use Geyser with Ngrok?
Unfortunately, Ngrok is TCP-only, so you will not be able to use Geyser with Ngrok. As an alternative, you can use [playit.gg](https://playit.gg), which supports both TCP and UDP.
Expand Down
114 changes: 51 additions & 63 deletions _docs/geyser/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,52 @@ permalink: /geyser/setup/

# Setup

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](/other/geyser-fabric/)) 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.
## Overview

Bedrock clients will join through Geyser, and it will handle all the packet translations. There are six different versions of Geyser:
1. Geyser for Spigot (works on derivatives such as Paper),
2. Geyser for BungeeCord (also works on Waterfall),
3. Geyser for Velocity,
4. Geyser for Sponge,
5. Geyser for Fabric (does not support client required mods, and more info about that can be found [here](/other/geyser-fabric/)),
6. Geyser Standalone (Standalone Setup instructions are [here](/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](/geyser/faq/#can-i-use-geyser-with-pterodactyl-panel) 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](/geyser/common-issues/) page.\
For more information, take a look at the [Understanding the Config](/geyser/understanding-the-config/) page, and the [FAQ](/geyser/faq/) page.\
And if you still have questions, feel free to join the [Discord](https://discord.geysermc.org) 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 {{ site.data.versions.java }})
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](https://www.spigotmc.org/resources/19254/), but do note that only **1.12.2 and any version above is officially supported**.
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](https://www.spigotmc.org/resources/19254/), but do note that only **1.13.2 and any version above is officially supported**. For older versions, use Geyser Standalone, or Geyser on a proxy like Velocity or BungeeCord.
- The device running Geyser must support Java 16 or later. If you need help installing or updating, please see [PaperMC's Java update page](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](/floodgate/).
- Your Bedrock client has to be a supported version - at this time that is Bedrock version(s) {{ site.data.versions.bedrock }}.
- If you are running the server, you need to have a UDP port opened. See below for more instructions.
- Currently, Geyser does not support key signing. To disable it (on servers running version 1.19 and higher), follow these instructions: Spigot, Paper, & all forks: Set `enfore-secure-profile: false` in the `server.properties` file. On BungeeCord: Set `enforce_secure_profile: false` in your `config.yml`. Using Velocity: set `force-key-authentication = false` in your `velocity.toml`. This will disable chat signing, which Geyser currently does not support. Be careful though: This will allow Java players who bypass chat signing with mods such as NoChatReports to join the server, and make them unreportable. For more info on chat reporting, see this [article](https://gist.github.com/kennytv/ed783dd244ca0321bbd882c347892874).

## Plugin Setup
1. Download a jar of Geyser from the [build server](https://ci.opencollab.dev/job/Geyser/job/master/) depending on what platform your server runs on. See the [FAQ](/geyser/faq/#which-plugin-version-of-geyser-do-i-need) if you're confused about which build to download.
2. Put the Geyser jar file in your plugins folder and start up the server.
3. 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](/geyser/supported-hosting-providers/) page.
4. Restart your server if you edited your config.
5. 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](https://www.lifewire.com/how-to-port-forward-4163829).
1. Read the Prerequisites above, especially if you are setting up Geyser for an older Minecraft Java Edition version!
2. To make sure you are using the easiest way to set up Geyser, please check whether your hosting provider features [built-in Geyser](/supported-hosting-providers/#built-in-geyser). If you are not using a hosting provider, or your hosting provider is not featured on said list, continue with the steps below.
3. If 2. does not apply: download a jar of Geyser from the [build server](https://ci.opencollab.dev/job/Geyser/job/master/) depending on what platform your server runs on. See the [FAQ](/geyser/faq/#which-plugin-version-of-geyser-do-i-need) if you're confused about which build to download. Keep in mind: Geyser-Spigot.jar is for Spigot and its forks, such as PaperMC or Purpur.
4. Put the Geyser jar file in your plugins folder and start up the server.
5. Port-forwarding:
- If you are using 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](/geyser/supported-hosting-providers/) page. If there is no information on your hosting provider and you are unable to assign/open ports yourself, try enabling `clone-remote-port` in Geyser's `config.yml`file and connecting with the same IP/port as you would with Java Edition.
- If not using a hosting provider, you will need to use port forwarding to allow people outside your LAN to connect. You want to port forward 19132 UDP, instructions to do that for most routers can be found [here](https://www.lifewire.com/how-to-port-forward-4163829). If you are trying to join from the same LAN, the server should show up in the friends tab.
- To check whether it is working correctly, you can use the `geyser connectiontest [yourIP]:[yourPort]` command in your server console to check if the server is reachable from the outside.
- _Restart your server if you edited your config! Simply reloading will not work._
6. Besides the `port` entry in the _Bedrock Section_ of Geyser's `config.yml`, you rarely need to change anything. A few examples:
- `address: 0.0.0.0` The IP address that will listen for connections. There is no reason to change this unless you want to limit what IPs can connect to your server or if your hosting provider instructs you to do so.
- `port: 19132` The port Bedrock players will use to connect. If the option `clone-remote-port` is set to true, this port is ignored, and you'll have to use the same port on bedrock as you would on Java to connect.
7. The _remote_ section in the `config.yml` determines, which Java server the Bedrock players join.
- `address: auto` This means, that Geyser configures the server's IP, port and auth-type of the java server by itself, leave this at auto.
- `port: 25565` This should be the port of the Java server. By default, it is set to 25565 - your hosting provider may have assigned a different port to your Java server, set that here.
8. If you wish to remove the Java account requirement, set up the [Floodgate](/floodgate/setup/) plugin. This will allow Bedrock players to play on your server, without you having to use offline mode.
9. For further Geyser config changes, like allowing Bedrock players to build on the nether roof, refer to [the config help article](/geyser/understanding-the-config/).

If you are trying to join from the same LAN, the server should show up in the friends tab.
If you're still having problems with Geyser not working or giving you an "Unable to connect to world" error, see the [Common Issues](/geyser/common-issues/) page.\
For more information, take a look at the [Understanding the Config](/geyser/understanding-the-config/) page, and the [FAQ](/geyser/faq/) page.\
And if you still have questions, feel free to join the [Discord](https://discord.geysermc.org) if you haven't already.

### 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.
Expand All @@ -39,64 +60,31 @@ You can install Floodgate (but not Geyser) on the back-end servers to improve sk

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](/geyser/setup/#termux-android).

1. Download a jar of Geyser from the [build server](https://ci.opencollab.dev/job/Geyser/job/master/).
2. Create a new folder for Geyser, and drop the jar in there.

### GUI Setup (Recommended)
3. Double-click the jar file and all the necessary files for Geyser will be created.
4. 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](/geyser/understanding-the-config/) page.
5. Stop the current instance of Geyser and re-run it.
#### Setup:
1. Make sure Velocity/BungeeCord is up-to-date. The proxy can be newer than the servers behind it (also called backend servers). If you're running the backend servers on an older version then the current {{ site.data.versions.java }}, you can use the plugin [ViaVersion](https://www.spigotmc.org/resources/19254/). It is recommended to have the plugin on all backend servers where necessary, instead to having it on the proxy.
2. Download a jar of Geyser from the [build server](https://ci.opencollab.dev/job/Geyser/job/master/) depending on what platform your server runs on. See the [FAQ](/geyser/faq/#which-plugin-version-of-geyser-do-i-need) if you're confused about which build to download.
3. Put the Geyser jar file in your plugins folder and start up the server.
4. Port-forwarding:
- If you are using a hosting provider, you will likely need to change your Bedrock port in the `config.yml` file. Information on your hosting provider might be available on the [Supported Hosting Providers](/geyser/supported-hosting-providers/) page. If your hosting provider is not listed there, and you are unable to port forward the default 19132 port on UDP, try setting `clone-remote-port` to true and connecting with the Java IP and port. Any port will work, as long as the UDP protocol is not blocked or already in use by the query feature (see `server.properties`) or another mod.
- If you are 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](https://www.lifewire.com/how-to-port-forward-4163829). Note: Any port will work, as long as UDP traffic is not blocked. Java uses the TCP protocol, so you will need to open both UDP and TCP if you wish to use the same port.
- To check whether it is working correctly, you can use the `geyser connectiontest [yourIP]:[yourPort]` command in your server console to check if the server is reachable from the outside.
- _Restart your server if you edited your config! Simply reloading will not work._
5. Besides the `port` entry in the _Bedrock Section_ of Geyser's `config.yml`, you rarely need to change anything. A few examples:
- `address: 0.0.0.0` The IP address that will listen for connections. There is no reason to change this unless you want to limit what IPs can connect to your server or if your hosting provider instructs you to do so.
- `port: 19132` The port bedrock players will use to connect. If the option `clone-remote-port` is set to true, this port is ignored, and you'll have to use the same port on Bedrock as you would on Java to connect.
6. The _remote_ section in the `config.yml` determines which Java proxy the Bedrock players join. The proxy then configures which server the players are sent to.
- `address: auto` Leaving this at auto is recommended, because it means that Geyser configures the proxy's IP, port and auth-type itself.
- `port: 25565` This should be the port of the Java server. By default, it is set to 25565 - your hosting provider may have assigned a different port to your proxy, set that here.
7. For further Geyser config changes, like allowing Bedrock players to build on the nether roof, refer to [the config help article](/geyser/understanding-the-config/).

### Console Setup
3. 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](/geyser/creating-a-startup-script/) page for what to put into it.
4. Run the startup script/bat, and all the necessary files for Geyser will be created.
5. 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](/geyser/understanding-the-config/) page.
6. 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](/floodgate/) wiki page for more details.
## Standalone Setup
Please read [Standalone Setup](/geyser/standalone/) to set up Geyser Standalone.

## 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](/geyser/supported-hosting-providers/) for a list of supported providers).

## Termux (Android)
Please read the disclaimer [here](/geyser/setup/#standalone-setup) before continuing.
1. Download and install [Termux](https://termux.com/)
2. Run `pkg install openjdk-17`
3. Run `wget https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/lastSuccessfulBuild/artifact/bootstrap/standalone/target/Geyser.jar`
4. 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](https://docs.google.com/spreadsheets/d/11DABHIIqwYQKj1L83AK9ywk_hYMjEkcaxpIg6phbTf0/edit?usp=sharing).
1. Install [Filza File Manager](http://cydia.saurik.com/package/com.tigisoftware.filza/).
2. Install [NewTerm 2](https://chariz.com/get/newterm).
4. Download jre-16 for iOS and install it using Filza [here](https://github.com/PojavLauncherTeam/PojavLauncher_iOS/releases/download/v16-openjdk/openjdk-16-jre_16.0.0+git20201217.8383f41-2_iphoneos-arm.deb).
3. Download my modified java commands, and install it using Filza [here](https://cdn.discordapp.com/attachments/558829512633090048/834014323755319306/com.letschill.java_0.1_iphoneos-arm.deb).
4. Open NewTerm 2 and run `wget https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/lastSuccessfulBuild/artifact/bootstrap/standalone/target/Geyser.jar`
5. Run `java -jar Geyser.jar`.
6. 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.

## Setup Videos
Setup tutorials in a variety of languages.

Expand Down
Loading