TRX/GeyserWebsite
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Re-write the setup pages (#171)

Browse Source 
* Initial setup page

* Cleanup new setup page

* Space out options

* Fix host providers with templates

* Cleanup host provider classes

* Fix spacing to make it all look more uniform

* Always show setup options and add provider infomation inside an alert

* Drop side margin

* Add collapsable sidebar

* Add build_in host on provider selector (#166)

* add buildin host provider support

* concat js loop

* Cleanup indent for cleaner commit

* Move all_providers

---------

Co-authored-by: rtm516 <rtm516@users.noreply.github.com>

* start on proper setup instructions

* Add self-hosting info

* Add not listed and fix some other minor issues

* - Floodgate setup/FAQ page
- Add version warnings/info in FAQ
- Merging upstream/master
- Replace old setup page with new one; minus videos

* Show Self-Host vs Hosting Provider pages

* Move to tabs, add icons and structure cleanup

* Less repetition, wording

* Updated Standalone setup instructions

* Show "Not listed" provider option at the top of the hosting provider list

---------

Co-authored-by: JensC <jenscollaertyprive@hotmail.com>
Co-authored-by: Jens Co <63231928+Jens-Co@users.noreply.github.com>
Co-authored-by: onebeastchris <github@onechris.mozmail.com>
This commit is contained in:
rtm516JensCJens Coonebeastchris
 authored and GitHub committed 2023-07-23 18:08:38 +01:00
1 parent 15b09b9c45
commit 897577f575
30 files changed
+641 -250
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

_data/toc.yml
+2 -5
View File
@@ -4,17 +4,12 @@
- title: Setting up Geyser
url: "geyser/setup/"
children:
- title: Plugin Setup
url: "geyser/setup/#plugin-setup"
- title: Supported Hosting Providers
url: "geyser/supported-hosting-providers/"
- title: Using Geyser with Consoles
url: "geyser/using-geyser-with-consoles/"
- title: Using playit.gg with Geyser
url: "geyser/playit-gg/"
- title: Setting up Geyser-Standalone
url: "geyser/standalone/"
children:
- title: Creating a Startup Script
url: "geyser/creating-a-startup-script/"
- title: Common Issues
@@ -73,6 +68,8 @@
url: "floodgate/setup/"
- title: "Issues"
url: "floodgate/issues/"
- title: "FAQ"
url: "floodgate/faq/"
- title: "Features"
url: "floodgate/features/"
children:
_docs/floodgate/faq.md
+24
View File
@@ -0,0 +1,24 @@
---
title: FAQ
---
# FAQ
## Changing/disabling the prefix
***Please note: we do not recommend removing the prefix unless you are certain that no one will share a username between a Java and Bedrock player. Duplicated usernames will cause weird situations, like being unable to teleport to one of the players.***
In your Floodgate config, change `username-prefix` to whichever prefix you desire - you can set it to `""` and there will be no prefix.
On some older Paper servers (or any forks that use them), you may need to also shut down your server and delete your `usercache.json` file located in the same folder as your server jar to prevent users who already joined from having the old prefix. See [this issue](/floodgate/issues/#prefix-is-not-changing-on-the-server-after-changing-it-in-the-config) for more information.
## Obtaining UUIDs for Floodgate players
Check your server logs, or use [this](https://uuid.kejona.dev/) page. If this doesn't work, then try this method:
First, you'll need to get the XUID of the player. There are several third-party websites to find this, for example, [this one](https://www.cxkes.me/xbox/xuid) (unaffiliated with Geyser). Make sure to choose "Hexidecimal." You'll need to enter the player's Xbox Gamertag, and, once submitted, and it should display the XUID in the format of `xxxxxxxxxxxxxxxx`. To turn the XUID into a UUID that Java Edition can recognize, you need to put the XUID in this format: `00000000-0000-0000-xxxx-xxxxxxxxxxxx`. If formatted right, Java Edition should accept it as a UUID.
## Using PlaceholderAPI
If you're using the Spigot version of Floodgate, download the Placeholder plugin [here](https://github.com/rtm516/FloodgatePlaceholders/). Using the placeholders shouldn't require additional setup other than having [PlaceholderAPI](https://www.spigotmc.org/resources/6245/) 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 Spigot version of Floodgate, there is an unofficial plugin that adds Skript support [here](https://github.com/Camotoy/floodgate-skript).
_docs/floodgate/setup.md
+42 -51
View File
@@ -1,59 +1,50 @@
---
title: Floodgate Setup
page_sidebar: false
---
## Downloads:
# Floodgate Setup
Download Geyser and Floodgate from the [Geyser download page](https://geysermc.org/download).
<div class="alert alert-warning" role="alert">
Floodgate does <b>NOT</b> replace Geyser! It allows Geyser players to join servers without needing to log into a paid Java Edition account. <br>
</div>
## Prerequisites
<div class="nav nav-tabs setup-tabs" role="tablist" aria-label="Setup Options">
<li class="nav-item" role="presentation">
<a class="nav-link active" href="#" data-bs-toggle="tab" data-bs-target="#spigot-option" type="button" role="tab" aria-controls="spigot-option" aria-selected="false"><img src="{{ '/img/icons/paper.png' | relative_url }}" alt="paper icon"> Paper / Spigot</a>
</li>
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#fabric-option" type="button" role="tab" aria-controls="fabric-option" aria-selected="false"><img src="{{ '/img/icons/fabric.png' | relative_url }}" alt="fabric icon"> Fabric</a>
</li>
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#proxy-option" type="button" role="tab" aria-controls="proxy-option" aria-selected="false"><img src="{{ '/img/icons/velocity.svg' | relative_url }}" alt="velocity icon"> Proxy Servers</a>
</li>
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#standalone-option" type="button" role="tab" aria-controls="standalone-option" aria-selected="false"><img src="{{ '/img/icons/geyser.png' | relative_url }}" alt="geyser icon"> Standalone</a>
</li>
</div>
- You must own/manage the server in order to add Floodgate. *If you do not own the server, Floodgate does not allow you to bypass logging into Java servers that require a Mojang Java account*.
- You must either be running Geyser as a [plugin](/geyser/setup/), or be running [Geyser Standalone](/geyser/standalone/). Floodgate does not replace Geyser.
- `floodgate-spigot.jar` cannot be installed on CraftBukkit/Bukkit servers.
<div class="tab-content mt-4">
<div id="spigot-option" class="tab-pane fade show active" role="tabpanel">
{% capture my_include %}{% include setup/instructions/floodgate/spigot.md %}{% endcapture %}
{{ my_include | markdownify }}
</div>
<div id="fabric-option" class="tab-pane fade" role="tabpanel">
{% capture my_include %}{% include setup/instructions/floodgate/fabric.md %}{% endcapture %}
{{ my_include | markdownify }}
</div>
<div id="proxy-option" class="tab-pane fade" role="tabpanel">
{% capture my_include %}{% include setup/instructions/floodgate/proxy.md %}{% endcapture %}
{{ my_include | markdownify }}
</div>
<div id="standalone-option" class="tab-pane fade" role="tabpanel">
{% capture my_include %}{% include setup/instructions/floodgate/standalone.md %}{% endcapture %}
{{ my_include | markdownify }}
</div>
</div>
## Setting Up
*Any reference to Spigot here also refers to any compatible server software such as Paper. For the proxy setup, backend server implies all the servers that are behind the proxy.*
For BungeeCord/Velocity setups: you only are required to install Floodgate on the BungeeCord or Velocity proxy unless you want to use the Floodgate API on the backend servers - see [below](#installing-floodgate-also-on-spigot-servers-behind-bungeecord-or-velocity) for the installation process.
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; *Note:* Installing Floodgate on the backend servers will allow Bedrock player skins to display without the Bedrock player having to switch backend servers.
- Download the Floodgate plugin and add it to your plugins folder on your frontend server.
- Select your platform on the download page linked above and click "Download Floodgate"
- If you are using Floodgate on Fabric, you will need to download the [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api).
- Change the `auth-type` in the Geyser config to `floodgate`.
- Restart/start up the server.
**ONLY do this step if using Geyser Standalone:**
- *Copy* the `key.pem` file in the Floodgate config folder to the same directory as Geyser Standalone. **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.
### Installing Floodgate also on Spigot servers behind BungeeCord or Velocity
This is only needed when you want to use the Floodgate API on your backend server(s) behind a proxy.
- Install Floodgate on the proxy and on *all* backend servers as per the [previous instructions](/floodgate/setup/)
- Enable `ip_forward` in your BungeeCord `config.yml` if using BungeeCord. For Velocity, set up "player-info-forwarding".
- Set `bungeecord` to `true` in your `spigot.yml`. When using Velocity, see their [guide](https://docs.papermc.io/velocity/player-information-forwarding), as they have multiple options that require different setups.
- Start the proxy server.
- Edit the Floodgate config on your proxy server and set `send-floodgate-data` to `true`.
- *Copy* the `key.pem` file in the proxy Floodgate config folder to all backend servers' Floodgate 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 backend servers and proxy server.
## Changing/disabling the prefix
***Please note: we do not recommend removing the prefix unless you are certain that no one will share a username between a Java and Bedrock player. Duplicated usernames will cause weird situations, like being unable to teleport to one of the players.***
In your Floodgate config, change `username-prefix` to whichever prefix you desire - you can set it to `""` and there will be no prefix.
On some older Paper servers (or any forks that use them), you may need to also shut down your server and delete your `usercache.json` file located in the same folder as your server jar to prevent users who already joined from having the old prefix. See [this issue](/floodgate/issues/#prefix-is-not-changing-on-the-server-after-changing-it-in-the-config) for more information.
## Obtaining UUIDs for Floodgate players
Check your server logs, or use [this](https://uuid.kejona.dev/) page. If this doesn't work, then try this method:
First, you'll need to get the XUID of the player. There are several third-party websites to find this, for example, [this one](https://www.cxkes.me/xbox/xuid) (unaffiliated with Geyser). Make sure to choose "Hexidecimal." You'll need to enter the player's Xbox Gamertag, and, once submitted, and it should display the XUID in the format of `xxxxxxxxxxxxxxxx`. To turn the XUID into a UUID that Java Edition can recognize, you need to put the XUID in this format: `00000000-0000-0000-xxxx-xxxxxxxxxxxx`. If formatted right, Java Edition should accept it as a UUID.
## Using PlaceholderAPI
If you're using the Spigot version of Floodgate, download the Placeholder plugin [here](https://github.com/rtm516/FloodgatePlaceholders/). Using the placeholders shouldn't require additional setup other than having [PlaceholderAPI](https://www.spigotmc.org/resources/6245/) 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 Spigot version of Floodgate, there is an unofficial plugin that adds Skript support [here](https://github.com/Camotoy/floodgate-skript).
<h4 class="mt-4">Further information:</h4>
<ul>
<li><a href="/floodgate/features/">Floodgate Features</a></li>
<li><a href="/floodgate/api/">Floodgate API</a></li>
</ul>
_docs/geyser/creating-a-startup-script.md
+2
View File
@@ -2,6 +2,8 @@
title: Creating a Startup Script
---
# Creating a Startup Script for Geyser-Standalone
**In order for this to work, you MUST have Java 16 (or higher) installed!**
Once you have downloaded and placed Geyser into its own folder, you will need to create a startup script; similar to how you'd run a Bukkit/Spigot/Paper server.
_docs/geyser/faq.md
+14 -4
View File
@@ -2,6 +2,9 @@
title: FAQ
---
# Frequently Asked Questions
Here you can find answers to frequently asked questions about Geyser - if you have a question that isn't answered here, feel free to ask in our [Discord](https://discord.gg/GeyserMC)!
## How Does it Work?
Geyser works as a translator, translating both the incoming and outgoing packets to a format both the client and server can understand. With this being said, it emulates a Minecraft: Java Edition client, so the server actually thinks you're joining from Java Edition. Regardless of the server or what plugins it has installed, you can join it with Geyser (as long as the server supports the latest vanilla (unmodified) Minecraft version).
@@ -32,6 +35,16 @@ Floodgate can cause issues with plugins as it modifies the login process. *Pleas
If you come across any more, please let us know via [Discord](http://discord.gg/geysermc).
## What server versions does Geyser support?
The Geyser-Spigot plugin supports any Minecraft server version 1.13.2 or later. Any earlier version is not supported by the plugin - use a proxy version or the standalone build instead.
Since Geyser emulates a {{ site.data.versions.java }} Java Edition client, you need to [install ViaVersion](https://www.spigotmc.org/resources/viaversion.19254/) on your server
if it is not running the latest version of Minecraft. <br>
In order for Bedrock players to chat (1.19.3+) or join (1.19.1/1.19.2), you need to disable chat signing. More information about that can be read on the [chat signing page](geyser/secure-chat/). <br>
You will also need to run at least Java 16 or later to use Geyser. See [here](https://docs.papermc.io/misc/java-install) for more info on updating Java.
Paper versions not supporting Java 16 can add `-DPaper.IgnoreJavaVersion=true` flag to the Java startup arguments to allow Paper to run on Java 16.
## Which plugin version of Geyser do I need?
This is a non-complete list of what platform each plugin version of Geyser is for, and the standalone version can be used for any as it isn't a plugin.
* Geyser-Spigot works with:
@@ -44,14 +57,11 @@ This is a non-complete list of what platform each plugin version of Geyser is fo
* Any other forks of the above
* Geyser-Velocity works with [Velocity](https://www.velocitypowered.com/)
* Geyser-Sponge works with [SpongeVanilla or SpongeForge](https://www.spongepowered.org/)
* Geyser-Fabric works with [Fabric](https://www.fabricmc.net/)
* Geyser-Fabric works with [Fabric](https://www.fabricmc.net/), and requires FabricAPI to be installed on the server as well.
## Which type of Geyser version is better, standalone or plugin?
Because of optimizations that hook into the plugin platforms, plugin versions of Geyser are preferable compared to standalone Geyser. On Spigot, Velocity, and BungeeCord versions of Geyser, direct connections allow for faster loading times, lower latency, and accurate IP addresses without requiring Floodgate. Geyser-Spigot has further optimizations due to having direct world access, including lower memory usage and greater translation accuracy. However, large server networks might prefer standalone Geyser because it can be updated without needing to restart any other proxies or servers, and can offload resource usage onto seperate machines.
## What server versions does Geyser-Spigot support?
The Geyser-Spigot plugin supports any Minecraft server version 1.13.2 or later. Any earlier version is not supported by the plugin - use a proxy version or the standalone build instead.
## If using BungeeCord or another fork, where do I need to put Geyser/Floodgate?
You only need Geyser and/or Floodgate on the BungeeCord server, as long as not using the Floodgate API. In this case, Floodgate is needed on the "backend" servers as well.
_docs/geyser/playit-gg.md
+4 -1
View File
@@ -4,7 +4,10 @@ title: playit.gg Setup
## Prerequisites
- You must be able to connect to your Geyser instance locally.
<div class="alert alert-info" role="alert">
You must be able to connect to your Geyser instance locally!
</div>
- If you already have playit.gg running & set up (for e.g. Minecraft Java edition), skip steps 1 and 2 and proceed with step 3.
## Setup
_docs/geyser/setup.md
+26 -110
View File
@@ -1,117 +1,33 @@
---
title: Geyser Setup
title: Setup
page_sidebar: false
---
<div class="row gap-4 mx-0" role="tablist">
<a class="col btn btn-outline-primary active" href="#" data-bs-toggle="tab" data-bs-target="#host-provider-options" type="button" role="tab" aria-controls="host-provider-options" aria-selected="true">Host Provider</a>
<a class="col btn btn-outline-primary" href="#" data-bs-toggle="tab" data-bs-target="#self-host-options" type="button" role="tab" aria-controls="self-host-options" aria-selected="false">Self Host</a>
</div>
# Setup
<div class="tab-content mt-4">
<div id="host-provider-options" class="tab-pane fade show active" role="tabpanel">
{% include setup/host-provider.html %}
## Overview
{% include setup/instructions/geyser/tabs.html type="provider" %}
</div>
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 (for setups that support vanilla Java clients; requires [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api)),
6. Geyser Standalone (Standalone Setup instructions are [here](/geyser/standalone/)).
<div id="self-host-options" class="tab-pane fade" role="tabpanel">
{% include setup/instructions/geyser/tabs.html type="selfhost" show_standalone=true %}
</div>
</div>
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.
<div class="alert alert-warning" role="alert">
<b>Experiencing issues?</b> <br>
Start with the <a href="/geyser/common-issues/">Common Issues</a> page.
If your issue is not included there, join our <a href="https://discord.gg/geysermc">Discord server</a> for support.
</div>
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.
## 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.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://docs.papermc.io/misc/java-install). 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.
- In order for Bedrock players to chat (1.19.3+) or join (1.19.1/1.19.2), you need to disable chat signing. More information about that can be read on the [chat signing page](/geyser/secure-chat/).
## Plugin Setup
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](/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 Geyser [here](https://geysermc.org/download) for the 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.
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'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.
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](/floodgate/setup/).
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!
#### 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 Geyser [here](https://geysermc.org/download) for the 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/).
## 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).
## Setup Videos
Setup tutorials in a variety of languages. Do note: Some might be outdated - but the written guide above is up-to-date.
### English
**Connect to Java servers from Bedrock Edition! | GeyserMC Proxy Tutorial by [raimuakuna](https://www.youtube.com/channel/UCIMZsNCD_-prDETwRypAqmQ)**
[![YouTube Video](https://img.youtube.com/vi/7rwfScY66Jc/0.jpg)](https://www.youtube.com/watch?v=7rwfScY66Jc)
**How to play Java Servers in Minecraft Bedrock! by [PatarHD](https://www.youtube.com/channel/UCpowCAl4XV_hTQSYQpMWF6A)**
[![YouTube Video](https://img.youtube.com/vi/IHg_ts3MgLY/0.jpg)](https://www.youtube.com/watch?v=IHg_ts3MgLY)
**How to connect Bedrock players to Java servers Part One.** by [Casper](https://www.youtube.com/channel/UCHL0K3bOH0o7YoO5T-2_MzA)
[![YouTube Video](https://img.youtube.com/vi/DHZHM1RBtfQ/0.jpg)](https://www.youtube.com/watch?v=DHZHM1RBtfQ)
**How To Add Crossplay to Your Minecraft Server (Geyser Setup Guide).** by [The Breakdown](https://www.youtube.com/channel/UC6Ec5NXzcESo60F3UgtgQRA)
[![YouTube Video](https://i.ytimg.com/vi/2HwqbDHWwu8/hqdefault.jpg)](https://youtu.be/2HwqbDHWwu8)
### Russian
**ЗАШЕЛ НА ХАЙПИКСЕЛЬ С МКПЕ? ЧИТЕРСКИЙ КОНФИГ!** by [TOWUK](https://www.youtube.com/channel/UCK8v-rGsfCOkpbi0slIpAng)
[![YouTube Video](https://img.youtube.com/vi/KcZZp05EfVQ/0.jpg)](https://www.youtube.com/watch?v=KcZZp05EfVQ)
**ПОДНИМАЕМ СЕРВЕР JAVA+BEDROCK MINECRAFT** by [UncleZak](https://www.youtube.com/watch?v=nrFQ6BlOsLc)
[![YouTube Video](https://img.youtube.com/vi/nrFQ6BlOsLc/0.jpg)](https://www.youtube.com/watch?v=nrFQ6BlOsLc)
**Кроссплатформенный сервер Minecraft | GeyserMC Installation** by [Plutonium](https://www.youtube.com/channel/UCxXjEZgHcjMIYoHoDKOCBOw)
[![YouTube Video](https://img.youtube.com/vi/nOwowRFZE9M/0.jpg)](https://www.youtube.com/watch?v=nOwowRFZE9M)
<h4 class="mt-4">Further information:</h4>
<ul>
<li><a href="/geyser/understanding-the-config/">Full config documentation</a></li>
<li><a href="/geyser/current-limitations/">Current Limitations</a></li>
<li><a href="/geyser/faq/">Frequently asked questions</a></li>
</ul>
_docs/geyser/standalone.md
-73
View File
@@ -1,73 +0,0 @@
---
title: Geyser Standalone
---
# Setup of Geyser Standalone
## 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/).
- 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 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 }}.
- To allow Geyser Standalone to be reached outside the local network, 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.
- 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`.
## 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 [Geyser Standalone](https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/standalone).
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.
### 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.
## 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/build/libs/Geyser-Standalone.jar`
4. Run `java -jar Geyser-Standalone.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 PojavLauncher's Java 16 JRE 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 this package containing modified java commands, and install it using Filza [here](https://cdn.discordapp.com/attachments/558829512633090048/834014323755319306/com.letschill.java_0.1_iphoneos-arm.deb) (Note: Not an official GeyserMC project, install at your own risk).
4. Open NewTerm 2 and run `wget https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/standalone`
5. Run `java -jar Geyser-Standalone.jar`.
6. Geyser should show up in the Friends tab inside Minecraft.
**Note:**
Due to the iOS 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.
_includes/setup/host-provider.html
+31
View File
@@ -0,0 +1,31 @@
{% assign all_providers = site.data.providers.support | concat: site.data.providers.built_in | sort: 'name' %}
<div class="mb-4">
<select id="provider-select" class="form-select" onchange="selectProvider()">
<option value="">Select a provider</option>
<option value="Not listed">Not listed</option>
{% for provider in all_providers %}
{% assign urlParts = provider.url | split: "/" %}
<option value="{{ provider.name }}">{{ provider.name }} - {{ urlParts[2] | remove_first: "www." }}</option>
{% endfor %}
</select>
<div id="search-result" class="mt-2"></div>
</div>
<script>
window.provider_data = {
"Not listed": {{ "If your hosting provider is not listed, try enabling the `clone-remote-port` option in the config. Then, restart the server, and try connecting with the same IP and port as on Java Edition. <br> If this does not work, ask your server hosting provider for a UDP port, and use that. For VPS/KVM servers please follow the self-hosting steps." | markdownify | jsonify }},
{% for provider in all_providers %}
"{{ provider.name }}": {{ site.data.providers.description_templates[provider.description_template] | append: " " | append: provider.description | markdownify | strip | jsonify }},
{% endfor %}
}
function selectProvider() {
var provider = document.getElementById("provider-select").value
showSearchResult(provider)
}
function showSearchResult(provider) {
var searchResultContainer = document.querySelector("#search-result")
searchResultContainer.innerHTML = provider in window.provider_data ? '<div class="alert alert-info no-p-margin mb-0" role="alert">' + window.provider_data[provider] + '</div>' : ""
}
</script>
_includes/setup/instructions/floodgate/fabric.md
+11
View File
@@ -0,0 +1,11 @@
# Floodgate-Fabric setup
1. Download Floodgate-Fabric from the [modrinth page](https://modrinth.com/mod/floodgate).
2. Place the Floodgate-Fabric.jar in the `mods` folder, and restart the server. **You also need [FabricAPI](https://modrinth.com/mod/fabric-api) installed.**
3. Change `auth-type` in Geyser's config to `floodgate`.
4. Restart the server.
**Note for Fabric behind a Velocity proxy:**
You will need to configure FabricProxyLite to allow the Fabric server to receive data from Velocity.
_includes/setup/instructions/floodgate/proxy.md
+27
View File
@@ -0,0 +1,27 @@
# Floodgate setup on a BungeeCord/Velocity proxy
<div class="alert alert-info" role="alert">
You only need to install Floodgate on the BungeeCord or Velocity proxy server, unless you want to use the Floodgate API on the backend servers.
Additionally, it will display Bedrock edition skins properly.
</div>
1. Download Floodgate for your proxy software from the [download page](https://geysermc.org/download).
2. Place the Floodgate jar in the `plugins` folder, and restart the proxy server.
3. Change `auth-type` in Geyser's config to `floodgate`.
4. Restart the server.
## Installing Floodgate on servers behind the proxy
This is only needed when you want to use the Floodgate API on your backend server(s) behind a proxy.
1. After installing Floodgate on the proxy, install Floodgate on the backend servers (either Floodgate-Spigot, or Floodgate-Fabric).
2. Enable `ip_forward` in your BungeeCord `config.yml` if using BungeeCord. For Velocity, set up [player information forwarding](https://docs.papermc.io/velocity/player-information-forwarding).
3. Set bungeecord to true in your spigot.yml. When using Velocity, see their guide, as they have multiple options that require different setups.
4. Start the proxy server.
5. Edit the Floodgate config on your proxy server and set send-floodgate-data to true.
6. Copy the `key.pem` file in the proxy Floodgate config folder to all backend servers’ Floodgate config folder.
7. Restart the backend servers and proxy server.
<div class="alert alert-warning" role="alert">
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.
</div>
_includes/setup/instructions/floodgate/spigot.md
+6
View File
@@ -0,0 +1,6 @@
# Floodgate-Spigot setup
1. Download Floodgate-Spigot from the [download page](https://download.geysermc.org/v2/projects/floodgate/versions/latest/builds/latest/downloads/spigot).
2. Place the Floodgate-Spigot.jar in the `plugins` folder, and restart the server.
3. Change `auth-type` in Geyser's config to `floodgate`.
4. Restart the server.
_includes/setup/instructions/floodgate/standalone.md
+15
View File
@@ -0,0 +1,15 @@
# Floodgate setup with Geyser-Standalone
<div class="alert alert-info" role="alert">
To be able to use Floodgate authentication, you need to be able to install Floodgate on the server you are connecting to.
</div>
1. Download Floodgate from the [download page](https://geysermc.org/download).
2. Install the Floodgate jar - see the platform instructions for detailed info.
3. Change `auth-type` in Geyser Standalone's config to `floodgate`.
4. Copy the `key.pem` file in the Floodgate config folder to the same directory as Geyser Standalone.
5. Restart Geyser-Standalone.
<div class="alert alert-warning" role="alert">
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.
</div>
_includes/setup/instructions/geyser/provider/fabric.md
+37
View File
@@ -0,0 +1,37 @@
# Fabric setup with server hosting provider
<div class="alert alert-warning" role="alert">
Geyser-Fabric runs <b>only</b> on a {{ site.data.versions.java }} Fabric server. <br>
To use Geyser on an older Fabric server, you can use Geyser on a BungeeCord/Velocity proxy, or Geyser Standalone instead.
</div>
1. Select your server hosting provider in the dropdown above.
2. Download the mod from [the download page](https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/fabric).
3. Place the Geyser-Fabric.jar in the `mods` folder, and restart the server. **You also need [FabricAPI](https://modrinth.com/mod/fabric-api).**
4. Open your Geyser config, located in `/config/Geyser-Fabric/config.yml`, and find the following:
```yaml
bedrock:
# The IP address that will listen for connections.
# Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server.
#address: 0.0.0.0
# The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.
port: 19132
# Some hosting services change your Java port everytime you start the server and require the same port to be used for Bedrock.
# This option makes the Bedrock port the same as the Java port every time you start the server.
# This option is for the plugin version only.
clone-remote-port: false
```
The vital part is the port. This is the port that Bedrock players will use to connect to your server.
Follow the instructions in the provider selector - change the port, and if necessary, `clone-remote-port` & `address`.
If `clone-remote-port` is enabled, the bedrock port will be overwritten with the Java port! <br>
**Important**: Other services/mods that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.
5. Verify whether connections are possible by running `geyser connectiontest <ip>:<port>` in the console.
<div class="alert alert-info" role="alert">
To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use <a href="/floodgate/setup/">Floodgate</a>.
</div>
_includes/setup/instructions/geyser/provider/proxy.md
+39
View File
@@ -0,0 +1,39 @@
# Proxy setup with server hosting provider
<div class="alert alert-info" role="alert">
NOTE: <br>
- Install Geyser <b>only</b> on the proxy server! You can install Floodgate on all servers for better skin support &
network-wide Floodgate API availability for other plugins. <br>
- All servers on the network must accept {{ site.data.versions.java }} Java clients, as Geyser imitates one.
</div>
1. Select your server hosting provider in the dropdown above.
2. Download the plugin for your proxy software from [the download page](https://geysermc.org/download).
3. Place the Geyser jar in the `plugins` folder, and restart the server.
4. Open your Geyser config, located in `/plugins/Geyser-xyz/config.yml`, and find the following:
```yaml
bedrock:
# The IP address that will listen for connections.
# Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server.
#address: 0.0.0.0
# The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.
port: 19132
# Some hosting services change your Java port everytime you start the server and require the same port to be used for Bedrock.
# This option makes the Bedrock port the same as the Java port every time you start the server.
# This option is for the plugin version only.
clone-remote-port: false
```
The vital part is the port. This is the port that Bedrock players will use to connect to your server.
Follow the instructions in the provider selector - change the port, and if necessary, `clone-remote-port` & `address`.
If `clone-remote-port` is enabled, the bedrock port will be overwritten with the Java port! <br>
**Important**: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.
5. Verify whether connections are possible by running `geyser connectiontest <ip>:<port>` in the console.
<div class="alert alert-info" role="alert">
To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use <a href="/floodgate/setup/">Floodgate</a>.
</div>
_includes/setup/instructions/geyser/provider/spigot.md
+37
View File
@@ -0,0 +1,37 @@
# Paper / Spigot setup with server hosting provider
<div class="alert alert-info" role="alert">
If your server is not running {{ site.data.versions.java }}, you will need to install <a href="https://www.spigotmc.org/resources/viaversion.19254/">ViaVersion</a>.
See also our <a href="/geyser/faq/#what-server-versions-does-geyser-support">FAQ article</a> on supported versions.
</div>
1. Select your server hosting provider in the dropdown above.
2. Download the plugin from [the download page](https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/spigot).
3. Place the Geyser-Spigot.jar in the `plugins` folder, and restart the server.
4. Open your Geyser config, located in `/plugins/Geyser-Spigot/config.yml`, and find the following:
```yaml
bedrock:
# The IP address that will listen for connections.
# Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server.
#address: 0.0.0.0
# The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.
port: 19132
# Some hosting services change your Java port everytime you start the server and require the same port to be used for Bedrock.
# This option makes the Bedrock port the same as the Java port every time you start the server.
# This option is for the plugin version only.
clone-remote-port: false
```
The vital part is the port. This is the port that Bedrock players will use to connect to your server.
Follow the instructions in the provider selector - change the port, and if necessary, `clone-remote-port` & `address`.
If `clone-remote-port` is enabled, the bedrock port will be overwritten with the Java port! <br>
**Important**: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.
5. Verify whether connections are possible by running `geyser connectiontest <ip>:<port>` in the console.
<div class="alert alert-info" role="alert">
To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use <a href="/floodgate/setup/">Floodgate</a>.
</div>
_includes/setup/instructions/geyser/selfhost/fabric.md
+51
View File
@@ -0,0 +1,51 @@
# Fabric setup - self-hosting
<div class="alert alert-warning" role="alert">
Geyser-Fabric runs <b>only</b> on a {{ site.data.versions.java }} Fabric server. <br>
To use Geyser on an older Fabric server, you can use Geyser on a BungeeCord/Velocity proxy, or Geyser Standalone instead.
</div>
1. Download the mod from [the download page](https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/fabric).
2. Place the Geyser-Fabric.jar in the `mods` folder, and restart the server. **You also need [FabricAPI](https://modrinth.com/mod/fabric-api).**
3. Open your Geyser config, located in `/config/Geyser-Fabric/config.yml`, and find the following:
```yaml
bedrock:
# The IP address that will listen for connections.
# Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server.
#address: 0.0.0.0
# The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.
port: 19132
```
The vital part is the port. This is the port that Bedrock players will use to connect to your server!
If you enable `clone-remote-port`, the port will be overridden and the Java port is used.
Since you are self-hosting, you can choose the port freely - the default port is 19132. <br>
**Important**: Other services/mods that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.
<br>
4. Connecting to your server
<br> <br>
**Connecting locally in the same network** <br>
On the same device as the server, you can connect using `localhost`, or `127.0.0.1` as the address.
Do note: When hosting and playing on the same Windows device, you will need the [loopback fix](/geyser/fixing-unable-to-connect-to-world/#Using-Geyser-on-the-same-computer).
Other devices in the same local network can use your local IPv4 to connect - it starts with `10.` or `192.168.`.
<br> <br>
**Connecting from a different network**<br>
You will need to expose the port Geyser runs on to the Internet if you want players from outside your network to join.
To achieve that, you have two options: <br>
- Portforwarding: Open the Geyser port (e.g. 19132) on the UDP protocol in your router/modem, and in the Windows/Linux firewall.
After doing this, players can connect with your public IPv4 + port to your server.
See [here](https://www.lifewire.com/how-to-port-forward-4163829) for a helpful guide. <br>
- playit.gg: Instead of opening a port (which might not be an option/if you do not want to expose your home ip), you can use
the playit.gg service to create a tunnel for you to route the traffic through. See our [playit.gg guide](/geyser/playit-gg).
Ngrok will not work since it is TCP-only. <br>
5. Verify whether connections from other networks are possible by running `geyser connectiontest <ip>:<port>` in the console.
<div class="alert alert-info" role="alert">
To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use <a href="/floodgate/setup/">Floodgate</a>.
</div>
_includes/setup/instructions/geyser/selfhost/proxy.md
+53
View File
@@ -0,0 +1,53 @@
# Proxy setup - self-hosting
<div class="alert alert-info" role="alert">
NOTE: <br>
- Install Geyser <b>only</b> on the proxy server! You can install Floodgate on all servers for better skin support &
network-wide Floodgate API availability for other plugins. <br>
- All servers on the network must accept {{ site.data.versions.java }} Java clients, as Geyser imitates one.
</div>
1. Download the plugin for your proxy software from [the download page](https://geysermc.org/download).
2. Place the Geyser jar in the `plugins` folder, and restart the server.
3. Open your Geyser config, located in `/plugins/Geyser-xyz/config.yml`, and find the following:
```yaml
bedrock:
# The IP address that will listen for connections.
# Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server.
#address: 0.0.0.0
# The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.
port: 19132
```
The vital part is the port. This is the port that Bedrock players will use to connect to your server!
If you enable `clone-remote-port`, the port will be overridden and the Java port is used.
Since you are self-hosting, you can choose the port freely - the default port is 19132. <br>
**Important**: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.
<br>
4. Connecting to your server
<br> <br>
**Connecting locally in the same network** <br>
On the same device as the server, you can connect using `localhost`, or `127.0.0.1` as the address.
Do note: When hosting and playing on the same Windows device, you will need the [loopback fix](/geyser/fixing-unable-to-connect-to-world/#Using-Geyser-on-the-same-computer).
Other devices in the same local network can use your local IPv4 to connect - it starts with `10.` or `192.168.`.
<br> <br>
**Connecting from a different network**<br>
You will need to expose the port Geyser runs on to the Internet if you want players from outside your network to join.
To achieve that, you have two options: <br>
- Portforwarding: Open the Geyser port (e.g. 19132) on the UDP protocol in your router/modem, and in the Windows/Linux firewall.
After doing this, players can connect with your public IPv4 + port to your server.
See [here](https://www.lifewire.com/how-to-port-forward-4163829) for a helpful guide. <br>
- playit.gg: Instead of opening a port (which might not be an option/if you do not want to expose your home ip), you can use
the playit.gg service to create a tunnel for you to route the traffic through. See our [playit.gg guide](/geyser/playit-gg).
Ngrok will not work since it is TCP-only. <br>
5. Verify whether connections from other networks are possible by running `geyser connectiontest <ip>:<port>` in the console.
<div class="alert alert-info" role="alert">
To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use <a href="/floodgate/setup/">Floodgate</a>.
</div>
_includes/setup/instructions/geyser/selfhost/spigot.md
+51
View File
@@ -0,0 +1,51 @@
# Paper / Spigot setup - self-hosting
<div class="alert alert-info" role="alert">
If your server is not running {{ site.data.versions.java }}, you will need to install <a href="https://www.spigotmc.org/resources/viaversion.19254/">ViaVersion</a>.
See also our <a href="/geyser/faq/#what-server-versions-does-geyser-support">FAQ article</a> on supported versions.
</div>
1. Download the plugin from [the download page](https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/spigot).
2. Place the Geyser-Spigot.jar in the `plugins` folder, and restart the server.
3. Open your Geyser config, located in `/plugins/Geyser-Spigot/config.yml`, and find the following:
```yaml
bedrock:
# The IP address that will listen for connections.
# Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server.
#address: 0.0.0.0
# The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.
port: 19132
```
The vital part is the port. This is the port that Bedrock players will use to connect to your server!
If you enable `clone-remote-port`, the port will be overridden and the Java port is used.
Since you are self-hosting, you can choose the port freely - the default port is 19132. <br>
**Important**: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.
<br>
4. Connecting to your server
<br> <br>
**Connecting locally in the same network** <br>
On the same device as the server, you can connect using `localhost`, or `127.0.0.1` as the address.
Do note: When hosting and playing on the same Windows device, you will need the [loopback fix](/geyser/fixing-unable-to-connect-to-world/#Using-Geyser-on-the-same-computer).
Other devices in the same local network can use your local IPv4 to connect - it starts with `10.` or `192.168.`.
<br> <br>
**Connecting from a different network**<br>
You will need to expose the port Geyser runs on to the Internet if you want players from outside your network to join.
To achieve that, you have two options: <br>
- Portforwarding: Open the Geyser port (e.g. 19132) on the UDP protocol in your router/modem, and in the Windows/Linux firewall.
After doing this, players can connect with your public IPv4 + port to your server.
See [here](https://www.lifewire.com/how-to-port-forward-4163829) for a helpful guide. <br>
- playit.gg: Instead of opening a port (which might not be an option/if you do not want to expose your home ip), you can use
the playit.gg service to create a tunnel for you to route the traffic through. See our [playit.gg guide](/geyser/playit-gg).
Ngrok will not work since it is TCP-only. <br>
5. Verify whether connections from other networks are possible by running `geyser connectiontest <ip>:<port>` in the console.
<div class="alert alert-info" role="alert">
To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use <a href="/floodgate/setup/">Floodgate</a>.
</div>
_includes/setup/instructions/geyser/selfhost/standalone.md
+101
View File
@@ -0,0 +1,101 @@
# Geyser-Standalone Setup
<div class="alert alert-info" role="alert">
You need to have Java 16 or higher installed to run Geyser. To run Geyser Standalone on Android or iOS, see the bottom of this page.
</div>
1. Download Geyser Standalone from [here](https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/standalone).
2. Create a new folder for Geyser, and drop the jar in there.
3. Start Geyser Standalone:
- **GUI** (Recommended): <br>
Double-click the jar file and all the necessary files for Geyser will be created.
- Or use the **console setup**: <br>
Create a new bat or startup script, similar to the one you'd use for a Spigot/Paper server, and take a look at [this](/geyser/creating-a-startup-script/) page for what to put into it. <br>
Run the startup script/bat, and all the necessary files for Geyser will be created.
4. Open your Geyser config (`config.yml`), and find the following:
```yaml
bedrock:
# The IP address that will listen for connections.
# Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server.
#address: 0.0.0.0
# The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.
port: 19132
```
The `port` is the port Bedrock players will enter to connect to the server. <br>
Uncommenting and changing `address` here is only needed if you need to limit connections to a specific IP address.
<br>
To configure which Java Edition server Geyser Standalone will send players to, find the remote section:
```yaml
remote:
# The IP address of the remote (Java Edition) server
# If it is "auto", for standalone version the remote address will be set to 127.0.0.1.
address: auto
# The port of the remote (Java Edition) server
port: 25565
# Authentication type. Can be offline, online, or floodgate (see https://github.com/GeyserMC/Geyser/wiki/Floodgate).
auth-type: online
```
Here, change `address` to the Java server's address, or to `auto` if the server is on the same machine as Geyser-Standalone.
Then, change `port` to the Java server's port. If you have set up Floodgate on the remote Java server, you can set auth-type to "floodgate" - otherwise,
set it to either `online` for an online mode server, or `offline` for an offline mode server. To install and set up Floodgate with a Standalone server, see [here](/floodgate/setup). <br>
5. Connecting to your server
<br> <br>
**Connecting locally in the same network** <br>
On the same device as the server, you can connect using `localhost`, or `127.0.0.1` as the address.
Do note: When hosting and playing on the same Windows device, you will need the [loopback fix](/geyser/fixing-unable-to-connect-to-world/#Using-Geyser-on-the-same-computer).
Other devices in the same local network can use your local IPv4 to connect - it starts with `10.` or `192.168.`.
Alternatively, open Minecraft: Bedrock edition, and join the LAN-Server in the **Friends** tab.
<br> <br>
**Connecting from a different network**<br>
You will need to expose the port Geyser runs on to the Internet if you want players from outside your network to join.
To achieve that, you have two options: <br>
- Portforwarding: Open the Geyser port (e.g. 19132) on the UDP protocol in your router/modem, and in the Windows/Linux firewall.
After doing this, players can connect with your public IPv4 + port to your server.
See [here](https://www.lifewire.com/how-to-port-forward-4163829) for a helpful guide. <br>
- playit.gg: Instead of opening a port (which might not be an option/if you do not want to expose your home ip), you can use
the playit.gg service to create a tunnel for you to route the traffic through. See our [playit.gg guide](/geyser/playit-gg).
Ngrok will not work since it is TCP-only. <br>
6. Verify whether connections from other networks are possible by running `geyser connectiontest <ip>:<port>` in the console.
# Running Geyser-Standalone on Android/iOS
<div class="alert alert-warning" role="alert">
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.
</div>
## Termux (Android)
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/build/libs/Geyser-Standalone.jar`
4. Run `java -jar Geyser-Standalone.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).
3. Download PojavLauncher's Java 16 JRE 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).
4. Download this package containing modified java commands, and install it using Filza [here](https://cdn.discordapp.com/attachments/558829512633090048/834014323755319306/com.letschill.java_0.1_iphoneos-arm.deb) (Note: Not an official GeyserMC project, install at your own risk).
5. Open NewTerm 2 and run `wget https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/standalone`
6. Run `java -jar Geyser-Standalone.jar`.
7. Geyser should show up in the Friends tab inside Minecraft.
**Note:**
Due to the iOS 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.
_includes/setup/instructions/geyser/tabs.html
+37
View File
@@ -0,0 +1,37 @@
<div class="nav nav-tabs setup-tabs" role="tablist" aria-label="Setup Options">
<li class="nav-item" role="presentation">
<a class="nav-link active" href="#" data-bs-toggle="tab" data-bs-target="#spigot-option-{{include.type}}" type="button" role="tab" aria-controls="spigot-option-{{include.type}}" aria-selected="false"><img src="{{ '/img/icons/paper.png' | relative_url }}" alt="paper icon"> Paper / Spigot</a>
</li>
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#fabric-option-{{include.type}}" type="button" role="tab" aria-controls="fabric-option-{{include.type}}" aria-selected="false"><img src="{{ '/img/icons/fabric.png' | relative_url }}" alt="fabric icon"> Fabric</a>
</li>
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#proxy-option-{{include.type}}" type="button" role="tab" aria-controls="proxy-option-{{include.type}}" aria-selected="false"><img src="{{ '/img/icons/velocity.svg' | relative_url }}" alt="velocity icon"> Proxy Servers</a>
</li>
{% if include.show_standalone != nil %}
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#standalone-option-{{include.type}}" type="button" role="tab" aria-controls="standalone-option-{{include.type}}" aria-selected="false"><img src="{{ '/img/icons/geyser.png' | relative_url }}" alt="geyser icon"> Standalone</a>
</li>
{% endif %}
</div>
<div class="tab-content mt-4">
<div id="spigot-option-{{include.type}}" class="tab-pane fade show active" role="tabpanel">
{% capture my_include %}{% include setup/instructions/geyser/{{include.type}}/spigot.md %}{% endcapture %}
{{ my_include | markdownify }}
</div>
<div id="fabric-option-{{include.type}}" class="tab-pane fade" role="tabpanel">
{% capture my_include %}{% include setup/instructions/geyser/{{include.type}}/fabric.md %}{% endcapture %}
{{ my_include | markdownify }}
</div>
<div id="proxy-option-{{include.type}}" class="tab-pane fade" role="tabpanel">
{% capture my_include %}{% include setup/instructions/geyser/{{include.type}}/proxy.md %}{% endcapture %}
{{ my_include | markdownify }}
</div>
{% if include.show_standalone != nil %}
<div id="standalone-option-{{include.type}}" class="tab-pane fade" role="tabpanel">
{% capture my_include %}{% include setup/instructions/geyser/{{include.type}}/standalone.md %}{% endcapture %}
{{ my_include | markdownify }}
</div>
{% endif %}
</div>
_includes/sidebar-nav.html
+10 -3
View File
@@ -6,10 +6,16 @@
</button>
<div class="collapse navbar-collapse flex-column align-items-start" id="sidebarNav">
{% for section in site.data.toc %}
<a class="fw-bold" href="{% if section.url %}{{ site.baseurl }}/{{ section.url }}{% else %}{{ section.external_url }}{% endif %}">{{ section.title }}</a>
<ul class="pe-3">
{% assign section_size = section.url | size %}
{% assign current_section = page.url | remove_first: "/" | | truncate: section_size, "" %}
{% if current_section == "" %}
{% assign current_section = "geyser/" %}
{% endif %}
<div class="nav-item dropdown">
<a class="nav-link dropdown-toggle fw-bold{% if current_section == section.url %} show{% endif %}" href="#" role="button" data-bs-toggle="dropdown" data-bs-auto-close="false" aria-expanded="false">{{ section.title }}</a>
<ul class="pe-3 pt-0 dropdown-menu position-relative border-0 list-disc{% if current_section == section.url %} show{% endif %}">
{% for entry in section.links %}
<li>
<li class="ms-4">
<a href="{% if entry.url %}{{ site.baseurl }}/{{ entry.url }}{% else %}{{ entry.external_url }}{% endif %}">{{ entry.title }}</a>
{% if entry.children %}
<ul>
@@ -23,6 +29,7 @@
</li>
{% endfor %}
</ul>
</div>
{% endfor %}
</div>
</div>
_includes/sidebar-page.html
+1 -1
View File
@@ -2,4 +2,4 @@
<a class="d-block text-decoration-none" href="{{ site.repo }}/issues/new?labels={% if page.editable %}{{ page.editable }}{% else %}question{% endif %}&title=Question:&body=Question on: {{ page.path }}" target="_blank"><i class="bi bi-github"></i> Create Wiki issue/bug report</a>
<a class="d-block text-decoration-none" href="{{ page.repo }}/issues/new" target="_blank"><i class="bi bi-list-check"></i> Create Geyser issue/bug report</a>
<div id="page-nav" class="py-3"></div>
<div id="page-nav" class="py-3 {% if page.page_sidebar == false %}d-none{% endif %}"></div>
_layouts/default.html
+2 -2
View File
@@ -80,9 +80,9 @@
</div>
</div>
</div>
<footer class="p-4 text-center bg-body-tertiary">
<!-- <footer class="p-4 text-center bg-body-tertiary">
&copy; {{ 'now' | date: "%Y" }} {{ site.author }}
</footer>
</footer> -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/js/bootstrap.bundle.min.js" integrity="sha384-w76AqPfDkMBDXo30jS1Sgez6pr3x5MlQ1ZAGC+nuZB+EYdgRZgiwxhTBTkF7CXvN" crossorigin="anonymous"></script>
<script src="{{ '/js/page-nav.js' | relative_url }}"></script>
</body>
css/style.css
+17
View File
@@ -56,6 +56,23 @@ div.highlight {
margin: 0;
}
.no-p-margin p {
margin: 0;
}
.list-disc {
list-style: disc;
}
main img {
max-width: 100%;
}
.setup-tabs .nav-link {
color: var(--bs-white) !important;
}
.setup-tabs .nav-link img {
width: 1.5em;
height: 1.5em;
}
img/icons/fabric.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.8 KiB

img/icons/geyser.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 35 KiB

img/icons/paper.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

img/icons/sponge.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 11 KiB

img/icons/velocity.svg
+1
View File
@@ -0,0 +1 @@
<svg viewBox="0 0 500 500" xmlns="http://www.w3.org/2000/svg"><g fill="#fff"><path d="M236.25 232.55l-54.08-73.79a11.86 11.86 0 00-11.91-4.62L84 171.57a11.88 11.88 0 00-8 5.88l-42.64 77.07a11.84 11.84 0 00.81 12.75l54.21 74a11.86 11.86 0 0011.91 4.62l86-17.37a11.85 11.85 0 008-5.89l42.78-77.3a11.86 11.86 0 00-.82-12.78zm-59.45 74.21a9.57 9.57 0 01-13.39-2.06l-31-42.24a16 16 0 00-16-6.21l-52.58 10.63a9.58 9.58 0 01-11.29-7.49A9.58 9.58 0 0160 248.1l57-11.52a16 16 0 0010.81-7.92L156.42 177a9.58 9.58 0 0113-3.75 9.58 9.58 0 013.75 13L146.81 234a16 16 0 001.09 17.16l31 42.23a9.58 9.58 0 01-2.1 13.37z"/><circle cx="416.44" cy="236.11" r="9.83"/><path d="M458.29 265.6H280.52a9.83 9.83 0 110-19.66h106.22a9.84 9.84 0 000-19.67h-70.2a9.83 9.83 0 110-19.66H422.9a9.84 9.84 0 000-19.67H202.83l33.42 45.61a11.86 11.86 0 01.81 12.75l-42.78 77.3a11.75 11.75 0 01-1.4 2h212.29a9.83 9.83 0 100-19.66h-53.53a9.84 9.84 0 110-19.67h106.65a9.84 9.84 0 100-19.67z"/></g></svg>
Side by Side

After

Width:  |  Height:  |  Size: 965 B