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

Update all links

Browse Source
This commit is contained in:
rtm516 committed 2022-02-20 12:51:51 +00:00
1 parent 5e1bd344d8
commit 7e03698f69
17 files changed
+189 -67
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+1 -1
View File
@@ -6,7 +6,7 @@ The wiki can be accessed using [this link](https://wiki.geysermc.org).
## Contributing
If you would like to contribute to the wiki, please [open a pull request](https://pull-request-url-goes-here.org/).
If you would like to contribute to the wiki, please [open a pull request](https://github.com/GeyserMC/GeyserWiki/pulls).
### Creating a new page
_data/providers.json
+4 -4
View File
@@ -206,7 +206,7 @@
{
"name": "Heavynode",
"url": "https://www.heavynode.com/",
"description": "Get Geyser as a plugin. Use default port and 0.0.0.0 as the address. 19132 is blocked for DDOS reasons so your best bet is to use the same port as your Java server for the Bedrock port in your config and connect with that port. Also, see [here](https://github.com/GeyserMC/Geyser/wiki/Fixing-%22Unable-to-Connect-to-World%22#bedrock-players-can-connect-after-hitting-the-server-on-a-tcp-port-eg-on-java-or-a-website-on-the-same-server)"
"description": "Get Geyser as a plugin. Use default port and 0.0.0.0 as the address. 19132 is blocked for DDOS reasons so your best bet is to use the same port as your Java server for the Bedrock port in your config and connect with that port. Also, see [here](https://wiki.geysermc.org/geyser/fixing-unable-to-connect-to-world/#bedrock-players-can-connect-after-hitting-the-server-on-a-tcp-port-eg-on-java-or-a-website-on-the-same-server-or-only-people-who-also-play-on-java-edition-can-join-from-geyser)"
},
{
"name": "Hetzner",
@@ -276,7 +276,7 @@
{
"name": "NiCraft",
"url": "https://www.ni-host.com/",
"description": "Use the same port as your Java server for the Bedrock port in your config and connect with that port.\n - See [here](https://github.com/GeyserMC/Geyser/wiki/Fixing-%22Unable-to-Connect-to-World%22#bedrock-players-can-connect-after-hitting-the-server-on-a-tcp-port-eg-on-java-or-a-website-on-the-same-server).\n - So if your players encounter this issue, please ask them to try to connect (even if they don't have Minecraft) from Java Edition first while their Bedrock client is opened, and after they should be able to join on Bedrock Edition."
"description": "Use the same port as your Java server for the Bedrock port in your config and connect with that port.\n - See [here](https://wiki.geysermc.org/geyser/fixing-unable-to-connect-to-world/#bedrock-players-can-connect-after-hitting-the-server-on-a-tcp-port-eg-on-java-or-a-website-on-the-same-server-or-only-people-who-also-play-on-java-edition-can-join-from-geyser).\n - So if your players encounter this issue, please ask them to try to connect (even if they don't have Minecraft) from Java Edition first while their Bedrock client is opened, and after they should be able to join on Bedrock Edition."
},
{
"name": "Nitrado",
@@ -301,7 +301,7 @@
{
"name": "OVH",
"url": "https://www.ovh.com/",
"description": "See [here](https://github.com/GeyserMC/Geyser/wiki/Fixing-'Unable-to-Connect-to-World'#issues-connecting-with-ovh-or-a-subsidiary)."
"description": "See [here](https://wiki.geysermc.org/geyser/fixing-unable-to-connect-to-world/#issues-connecting-with-ovh-or-a-subsidiary)."
},
{
"name": "Pebblehost",
@@ -362,7 +362,7 @@
{
"name": "SoYouStart",
"url": "https://www.soyoustart.com",
"description": "See [here](https://github.com/GeyserMC/Geyser/wiki/Fixing-'Unable-to-Connect-to-World'#bedrock-players-can-connect-after-hitting-the-server-on-a-tcp-port-eg-on-java-or-a-website-on-the-same-server)."
"description": "See [here](https://wiki.geysermc.org/geyser/fixing-unable-to-connect-to-world/#bedrock-players-can-connect-after-hitting-the-server-on-a-tcp-port-eg-on-java-or-a-website-on-the-same-server-or-only-people-who-also-play-on-java-edition-can-join-from-geyser)."
},
{
"name": "Sparked Host",
_data/toc.yml
+3 -1
View File
@@ -20,7 +20,7 @@
url: "geyser/common-issues/"
children:
- title: Fixing 'Unable to Connect to World'
url: "geyser/common-issues/#see-here-for-fixing-unable-to-connect-to-world-with-no-console-errors"
url: "geyser/fixing-unable-to-connect-to-world/"
- title: Understanding the Config
url: "geyser/understanding-the-config/"
- title: Standalone Command Line Arguments
@@ -63,6 +63,8 @@
url: "floodgate/api/"
- title: "FloodgatePlayer"
url: "floodgate/player/"
- title: "Linking"
url: "floodgate/linking/"
- title: "Forms and Cumulus"
url: "floodgate/forms/"
- title: "Commands"
_docs/floodgate/api.md
+4 -4
View File
@@ -4,7 +4,7 @@ title: Floodgate API
permalink: /floodgate/api/
---
### Floodgate has an API to extend what is possible and allow servers to get information about the Bedrock client. It also allows other plugins access to [Cumulus](Forms)
### Floodgate has an API to extend what is possible and allow servers to get information about the Bedrock client. It also allows other plugins access to [Cumulus](/floodgate/forms/)
This page will contain information about class FloodgateApi.<br>
See the sidebar for more information about other parts of the API.
@@ -46,18 +46,18 @@ Used to check if the given UUID of an **online** player is a Bedrock player.
`FloodgateApi#getPlayer(UUID)`<br>
Used to get the FloodgatePlayer instance of an **online** player.<br>
Click [here](FloodgatePlayer) to get more information about the FloodgatePlayer class.
Click [here](/floodgate/player/) to get more information about the FloodgatePlayer class.
**Note**: You don't need to wait until the Bedrock player is online to use the getPlayer and isFloodgatePlayer methods.<br>
You can even use them in the pre-login events.
`FloodgateApi#getPlayerLink()`<br>
Used to get the PlayerLink instance used by Floodgate to check for linked accounts.<br>
Click [here](PlayerLink) to get more information about the PlayerLink class
Click [here](/floodgate/linking/) to get more information about the PlayerLink class
`FloodgateApi#sendForm(UUID, Form(Builder))`<br>
Used to send a form to the Bedrock player with the given UUID.<br>
Click [here](Forms) to get more information about Forms.
Click [here](/floodgate/forms/) to get more information about Forms.
### Using the API on backend servers
In order to successfully use the API on backend Spigot servers when using a proxy, `send-floodgate-data` must be set to `true` on the proxy Floodgate's config, and the `key.pem` file must be identical between all Floodgate instances.
_docs/floodgate/features.md
+3 -3
View File
@@ -15,14 +15,14 @@ You can also specify a UUID: `fwhitelist add 00000000-0000-0000-0009-01f64f65c7c
The permission node is `floodgate.command.whitelist`.
## What is the Global Api?
The Global Api is an API that is available for every server. It currently includes: [Global Linking](#What-is-Global-Linking), [skin uploading](#What-is-skin-uploading), getting a xuid by gamertag, and getting a gamertag by xuid.
The Global Api is an API that is available for every server. It currently includes: [Global Linking](#what-is-global-linking), [skin uploading](#what-is-skin-uploading), getting a xuid by gamertag, and getting a gamertag by xuid.
We don't store anything else than you can access by the Global Api, except for some non-identifiable metrics. The source code of the Global Api is available [here](https://github.com/GeyserMC/global_api) and the source code of the Global Linking server is available [here](https://github.com/GeyserMC/GlobalLinkServer).
## What is Global Linking?
Instructions and information about how to link can also be found here: https://link.geysermc.org/
Before we introduced Global Linking, you always had to link your Java and Bedrock account on every individual server you visited (that has Floodgate). Global Linking is here to fix that problem. Link once, join everywhere.<br>
Global Linking is part of the [Global Api](#What-is-the-Global-Api) and uses the GlobalLinkServer to link your account. To be able to link your account you have to do the following:
Global Linking is part of the [Global Api](#what-is-the-global-api) and uses the GlobalLinkServer to link your account. To be able to link your account you have to do the following:
1. Join the GlobalLinkServer with both your Java and Bedrock account
(IP: `link.geysermc.org`, Java port: `25565`, Bedrock port: `19132`)
2. Start the linking process by typing `/linkaccount` on your Java **or** Bedrock account
@@ -67,7 +67,7 @@ That should be it. You can then link your accounts by following the instructions
Skins of Bedrock player should be visible to Java players on servers with Floodgate 2.0 installed.
If they aren't, it's most likely that the skin uploading queue has grown too large and can take a while to upload your skin.
Skin uploading is also a part of the [Global Api](#What-is-the-Global-Api). It is responsible for converting Bedrock skins to Java skins and uploading them to Mojang servers make them show up on Java Edition.
Skin uploading is also a part of the [Global Api](#what-is-the-global-api). It is responsible for converting Bedrock skins to Java skins and uploading them to Mojang servers make them show up on Java Edition.
We're using MineSkin internally. MineSkin is running on accounts donated by the community. So if you want to support MineSkin and make the upload times faster, feel free to look at [this page](https://mineskin.org/account) for more info.
_docs/floodgate/forms.md
+3 -3
View File
@@ -7,8 +7,8 @@ permalink: /floodgate/forms/
# What is Cumulus?
Bedrock Edition has a cool exclusive feature called Forms.<br>
Cumulus is the new Forms API that we use in Geyser and Floodgate. The source code is available [here](https://wiki.geysermc.org/floodgate/forms/).
You can access the Cumulus API through the [Floodgate API](https://wiki.geysermc.org/floodgate/api/).
Cumulus is the new Forms API that we use in Geyser and Floodgate. The source code is available [here](/floodgate/forms/).
You can access the Cumulus API through the [Floodgate API](/floodgate/api/).
Bedrock knows three types of Forms:
* ModalForm
@@ -57,7 +57,7 @@ SimpleForm.builder()
While the CustomForm is the last one on our list (and thus the least easy one), it also has the greatest customizability.<br>
This form exists of a title, content and a list of different components e.g. label, slider and input.<br>
See [Components](#Components) for more information about every component you can use and in which form type.
See [Components](#components) for more information about every component you can use and in which form type.
![Example of a CustomForm](https://i.imgur.com/zHgxELm.png)
_docs/floodgate/linking.md
+7
View File
@@ -0,0 +1,7 @@
---
layout: page
title: Linking
permalink: /floodgate/linking/
---
## TODO
_docs/floodgate/setup.md
+5 -5
View File
@@ -12,13 +12,13 @@ Geyser: https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/
## Prerequisites
- 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](https://wiki.geysermc.org/geyser/setup/), or be running [Geyser Standalone](https://wiki.geysermc.org/geyser/setup/#standalone-setup). Floodgate does not replace Geyser.
- You must either be running Geyser as a [plugin](/geyser/setup/), or be running [Geyser Standalone](/geyser/setup/#standalone-setup). Floodgate does not replace Geyser.
- `floodgate-spigot.jar` cannot be installed on CraftBukkit/Bukkit servers.
## Setting Up
*Any reference to Spigot here also refers to any compatible server software such as Paper.*
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.
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 from [here](https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/) and add it to your plugins folder on your frontend server.
@@ -35,7 +35,7 @@ For BungeeCord/Velocity setups: you only are required to install Floodgate on th
This is only needed when you want to use the Floodgate API on your Spigot server(s) behind a proxy.
- Install Floodgate on the proxy and on *all* backend servers as per the [previous instructions](https://wiki.geysermc.org/floodgate/setup/)
- 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
- Set `bungeecord` to `true` in your `spigot.yml`
- Start the proxy server.
@@ -49,7 +49,7 @@ This is only needed when you want to use the Floodgate API on your Spigot server
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](Issues#Prefix-is not-changing-on-the-server-after-changing-it in-the-config.) for more information.
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://floodgate-uuid.heathmitchell1.repl.co/) page. If this doesn't work, then try this method:
@@ -57,7 +57,7 @@ Check your server logs, or use [this](https://floodgate-uuid.heathmitchell1.repl
First, you'll need to get the XUID of the player. There are several third-party websites to find this, for example, this one (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 Bukkit 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/placeholderapi.6245/) installed. See the section above on installing Floodgate on backend servers if you wish to use this on BungeeCord.
If you're using the Bukkit 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 Bukkit version of Floodgate, there is an unofficial plugin that adds Skript support [here](https://github.com/Camotoy/floodgate-skript).
_docs/geyser/anticheat-compatibility.md
+12 -12
View File
@@ -10,23 +10,23 @@ Do note that this is a community-compiled list and is incomplete! If you wish to
Full Compatibility (Checks Bedrock Players Accurately)
- [AntiAura](https://www.spigotmc.org/resources/antiaura-premium-anti-cheat-plugin.1368/) - Last Updated on 19th August 2021
- [Themis](https://www.spigotmc.org/resources/themis-anti-cheat-1-16-x-bedrock-support-paper-tuinity-compatibility-free-optimized.90766/) - Last Updated on 19th August 2021
- [LightAntiCheat](https://www.spigotmc.org/resources/lightanticheat.96341/) - Last Updated on 4th December 2021
- [AntiAura](https://www.spigotmc.org/resources/1368/) - Last Updated on 19th August 2021
- [Themis](https://www.spigotmc.org/resources/90766/) - Last Updated on 19th August 2021
- [LightAntiCheat](https://www.spigotmc.org/resources/96341/) - Last Updated on 4th December 2021
Partially Compatible (Does not Check/Ignores Bedrock Players)
- [AAC](https://www.spigotmc.org/resources/aac-advanced-anti-cheat-hack-kill-aura-blocker.6442/) - Last Updated on 19th August 2021
- [Flappy Anticheat](https://www.spigotmc.org/resources/flappy-anticheat-1-16-1-17.92180/) - Last Updated on 14th September 2021
- [AAC](https://www.spigotmc.org/resources/6442/) - Last Updated on 19th August 2021
- [Flappy Anticheat](https://www.spigotmc.org/resources/92180/) - Last Updated on 14th September 2021
- [Matrix](https://matrix.rip/) - Last updated on 2nd September 2021
- [Spartan](https://www.spigotmc.org/resources/spartan-anti-cheat-advanced-cheat-detection-hack-blocker-1-7-2-1-16-5.25638/) (Spartan Syn offers full Bedrock checks for an additional $43) - Last Updated on 19th August 2021
- [Vulcan](https://www.spigotmc.org/resources/vulcan-advanced-cheat-detection-1-7-1-16-5.83626/) - Last Updated on 19th August 2021
- [Spartan](https://www.spigotmc.org/resources/25638/) (Spartan Syn offers full Bedrock checks for an additional $43) - Last Updated on 19th August 2021
- [Vulcan](https://www.spigotmc.org/resources/83626/) - Last Updated on 19th August 2021
Incompatible (False Positives on Bedrock Players, no Compatibility at All)
- [AntiCheatReloaded](https://www.spigotmc.org/resources/anticheatreloaded.23799/) - Last Updated on 19th August 2021
- [Negativity](https://www.spigotmc.org/resources/negativity-v2-1-7-to-1-17-bungee-velocity-sponge.86874/) - Last Updated on 19th August 2021
- [AntiCheatReloaded](https://www.spigotmc.org/resources/23799/) - Last Updated on 19th August 2021
- [Negativity](https://www.spigotmc.org/resources/86874/) - Last Updated on 19th August 2021
- [NoCheatPlus](https://ci.codemc.io/job/Updated-NoCheatPlus/job/Updated-NoCheatPlus/) ([Compat NCP](https://github.com/Updated-NoCheatPlus/CompatNoCheatPlus/) is an addon that enables Partial Compatibility) - Last Updated on 19th August 2021
- [Reflex](https://www.spigotmc.org/resources/「reflex」machine-learning-cheat-detection-»-1-8-1-17.21122/) - Last Updated on 19th August 2021
- [SoaromaSAC](https://www.spigotmc.org/resources/soaromasac-lightweight-cheat-detection-system.87702/) - Last Updated on 19th August 2021
- [Wraith](https://www.spigotmc.org/resources/✅-wraith-anticheat-⛔%EF%B8%8F-haunts-every-cheater.66887/) - Last Updated on 19th August 2021
- [Reflex](https://www.spigotmc.org/resources/21122/) - Last Updated on 19th August 2021
- [SoaromaSAC](https://www.spigotmc.org/resources/87702/) - Last Updated on 19th August 2021
- [Wraith](https://www.spigotmc.org/resources/66887/) - Last Updated on 19th August 2021
_docs/geyser/common-issues.md
+7 -7
View File
@@ -4,10 +4,10 @@ title: Common Issues
permalink: /geyser/common-issues/
---
Commonly, people may have issues with Geyser not showing up in their server list or run into similar issues. This page contains a few common issues people may encounter that you might have as well as potential fixes for them. If you still can't make it work, join [our Discord](https://discord.geysermc.org) for support.
Commonly, people may have issues with Geyser not showing up in their server list or run into similar issues. This page contains a few common issues people may encounter that you might have as well as potential fixes for them. If you still can't make it work, join [our Discord](https://discord.gg/geysermc) for support.
# Floodgate
For Floodgate issues see: [Floodgate: Known Issues/Caveats](https://github.com/GeyserMC/Floodgate/wiki/Issues).
For Floodgate issues see: [Floodgate: Known Issues/Caveats](/floodgate/issues/).
# I can't connect! (Either the server doesn't show up in the friends list or I get "Unable to connect to world")
* If you don't use a reverse proxy such as TCPShield make sure that `enable-proxy-protocol` is set to false.
@@ -15,14 +15,14 @@ For Floodgate issues see: [Floodgate: Known Issues/Caveats](https://github.com/G
## If the server doesn't show up in the friends list
* *If using Windows 10, iOS, or Android*: try adding the server to the Servers list in-game.
* *If using Xbox One*: try connecting with [BedrockConnect](https://github.com/GeyserMC/Geyser/wiki/Using-Geyser-with-Consoles).
* *If using PS4*: [try using a LAN proxy.](https://github.com/GeyserMC/Geyser/wiki/Using-Geyser-with-Consoles#playstation-4)
* *If using Nintendo Switch*: there is currently no way for local servers to show up in the Friends tab, but you can still connect using [BedrockConnect](https://github.com/GeyserMC/Geyser/wiki/Using-Geyser-with-Consoles).
* *If using Xbox One*: try connecting with [BedrockConnect](/geyser/using-geyser-with-consoles/).
* *If using PS4*: [try using a LAN proxy.](/geyser/using-geyser-with-consoles/#playstation-4)
* *If using Nintendo Switch*: there is currently no way for local servers to show up in the Friends tab, but you can still connect using [BedrockConnect](/geyser/using-geyser-with-consoles/).
*If the Geyser instance is locally hosted:* try using `localhost` or `0.0.0.0` as the IP address.
*If that doesn't work, or your Geyser instance is on another computer in the network*: use your **local** IPv4 address.
## See [here](https://github.com/GeyserMC/Geyser/wiki/Fixing-%27Unable-to-Connect-to-World%27) for fixing "Unable to Connect to World" with no console errors
## See [here](/geyser/fixing-unable-to-connect-to-world/) for fixing "Unable to Connect to World" with no console errors
### `java.net.BindException: Address already in use: bind` on startup.
This means something (likely another instance of Geyser) is running on the port you have specified in the config. Please make sure you close all applications running on this port. If you don't recall opening anything, usually restarting your computer fixes this.
@@ -70,7 +70,7 @@ Connection Refused usually means that a Java server could not be found on that p
If you're updating from an old build of Geyser, set your remote address to `auto` and try again.
### Floodgate Misconfiguration
See [this page](https://github.com/GeyserMC/Floodgate/wiki/Issues) for more information.
See [this page](/floodgate/issues/) for more information.
### Mojang Resetting Account Credentials
This is unfortunately something we have no control over, and is most likely the case when you're running Geyser as a plugin on a server host or joining a friend far away from your location. If you're running Geyser locally, this should not happen to you, but what we recommend for servers is a plugin we make called [Floodgate](https://github.com/GeyserMC/Floodgate), which allows for Bedrock clients to join your server without needing a Java Edition account. Take a look [here](Floodgate) for more information.
_docs/geyser/fixing-unable-to-connect-to-world.md
+113
View File
@@ -0,0 +1,113 @@
---
layout: page
title: Fixing 'Unable to Connect to World'
permalink: /geyser/fixing-unable-to-connect-to-world/
---
*Unable to Connect to World* is by far the most common error people get when attempting to set up Geyser. Here's some steps on how to solve that.
**_If you are using a hosting provider: Many providers and remote hostings have additional steps you have to perform in order to be supported; see [Supporting Hosting Providers](https://github.com/GeyserMC/Geyser/wiki/Supported-Hosting-Providers). If you're self-hosting from home, you don't need to worry about this._**
# Before we start...
## ...Java players can't connect either!
This **should not be** a Geyser problem. Geyser does not modify server behavior. Floodgate does modify the login structure but only for Bedrock players. Contact your hosting provider or look elsewhere for fixing this connection issue.
## ...I just updated, and now it doesn't work!
If this occurred after updating a plugin version of Geyser, ensure that you shut off your server, swapped the Geyser jar, and then started up your server.
## ...There are errors in my console!
Please read through the [common issues page](https://github.com/GeyserMC/Geyser/wiki/Common-Issues). If there is another error not documented there, join us on our [Discord](https://discord.geysermc.org).
## ...Have you tried restarting?
Especially on mobile devices, sometimes just restarting Minecraft fixes the issue.
# Is it the server or the client?
Run your Java server IP and Bedrock address here: https://mcsrvstat.us/. It's a great way of determining if the server is reachable in the first place.
# General troubleshooting steps
## Ensure you're connecting on the right IP
You should be connecting with the Java server IP and the Bedrock port. If you port forwarded 19132, for example, you should specify port 19132 when connecting from Bedrock.
## I'm using a hosting provider or VPS!
Please read [this page on supported hosting providers](https://github.com/GeyserMC/Geyser/wiki/Supported-Hosting-Providers) to see if there are extra configuration steps required for your hosting or server provider.
## Port forwarding
Your server does need to be port forwarded. Generally, you can follow any Minecraft: Java Edition port forwarding guide; however, you need to replace any mention of TCP with UDP and, by default, any mention of 25565 with 19132.
## Using TCP in DNS options/port forwarding Instead of UDP
Minecraft: Java Edition uses TCP for connecting; Minecraft: Bedrock Edition uses UDP. Port forwarding your Bedrock Edition port with only TCP will not work, it has to be UDP. Forwarding your Bedrock Edition port with `TCP/UDP` (both protocols) should also work but is not recommended unless Java Edition and Bedrock Edition is sharing the same port.
## Bedrock port is less than 10000
Historically, having a Bedrock port that is a lower number will cause issues. Setting it to 10000 or above seems safe.
## Bedrock players can connect *after* hitting the server on a TCP port (e.g. on Java or a website on the same server), OR only people who also play on Java Edition can join from Geyser
This is likely a firewall issue on your server. Try the following workaround:
Attempt to connect to the Bedrock IP and port through a web browser - for example, `http://test.geysermc.org:19132`. It won't work, but then try connecting through Bedrock, and it should work.
Specific host fixes:
SoYouStart (a subsidiary of OVH):
In the SoYouStart control panel:
1. Click the IP tab.
2. Click the gear at the right of the public IP address; select "Game mitigation".
3. Pick "Add a rule".
4. Select "minecraftPocketEdition" in the dropdown list and enter the target UDP ports.
5. Save and wait a few seconds for the changes to come into effect.
## Issues connecting with OVH or a subsidiary
If you're running into issues with some Bedrock players being unable to connect on OVH, navigate through the following settings:
- Navigate to `Network interfaces`
- Click on the `...` button on the table for your IP -> then `...` and `Configure the GAME firewall` -> `Add rule` -> `Other protocol` (or `minecraftPocketEdition` if available)
- Add your Geyser port into `outgoing port`
## Changing the `bedrock` `address` in the Geyser config.
Except for a few specific hosting providers, you generally do not need to change this part of the Geyser config. However, in rare instances, it does fix issues
# Using a hosting provider or other location
## Pterodactyl
If you get this error while using the Pterodactyl Panel, try editing the Geyser config and changing the port to something besides `19132` (e.g. `25566`).
## Hosting Geyser on another computer on the same network
### Can only connect from the same computer and not anywhere else
Your firewall is likely in the way. Try adding an exception to Java, or disable the firewall for testing purposes.
# Using Geyser on the same computer
## Windows 10
_This only affects people trying to join Geyser from Windows 10 Edition with Geyser hosted on the same computer._
This is an issue caused by Loopback restrictions not being lifted. By default, Microsoft Apps have this restriction on all their apps for local connections. Geyser will attempt to resolve this automatically; however, if you're still having connection problems, you can lift it by typing the following in Windows PowerShell in administrator mode: (it should return `OK.` if it worked)
```powershell
CheckNetIsolation LoopbackExempt -a -n="Microsoft.MinecraftUWP_8wekyb3d8bbwe"
```
Should this not work, you can try this set of steps:
1. Hold down Windows Key + R
2. In the prompt, type `hdwwiz.exe`, then press Enter then Next
3. Install the Hardware Manually
4. Choose Network Adapter > Next > Microsoft > "Microsoft KM-TEST Loopback Adapter" then hit Next until it's done.
_docs/geyser/setup.md
+15 -15
View File
@@ -6,11 +6,11 @@ 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](https://github.com/GeyserMC/Geyser/wiki/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.
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.
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](FAQ#can-i-use-geyser-with-pterodactyl-panel) for more information.
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](Common-Issues) page.\
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](Understanding-the-Config) page, and the [FAQ](FAQ) page.\
And if you still have questions, feel free to join the [Discord](https://discord.geysermc.org) if you haven't already.
@@ -18,15 +18,15 @@ And if you still have questions, feel free to join the [Discord](https://discord
- The server you are connecting to has to support the latest version of Minecraft Java Edition (at this time this is Minecraft 1.18.1)
The server itself does not have to be the latest version but does have to allow connections. If you're running the server on an older version, you can use the plugin [ViaVersion](https://www.spigotmc.org/resources/19254/), but do note that only **1.12.2 and any version above is officially supported**.
- The device running Geyser must support Java 16 or later. If you need help installing or updating, please see https://paper.readthedocs.io/en/latest/java-update/index.html. If you're running a version of Paper that does not support Java 16 or later, you can add the flag `-DPaper.ignoreJavaVersion=true` to your startup Java arguments to allow Paper to run on Java 16. You can run Geyser standalone on another device if a server software cannot be updated to use Java 16.
- If you are connecting to an online mode Java server, a paid Java account is required. If you are running the server, you can bypass this requirement for your server with [Floodgate](https://github.com/GeyserMC/Floodgate/wiki).
- 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 1.17.30 - 1.18.2.
- If you are running the server, you need to have a UDP port opened. See below for more instructions.
## Plugin Setup
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](FAQ#which-plugin-version-of-geyser-do-i-need) if you're confused about which build to download.
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](https://github.com/GeyserMC/Geyser/wiki/Supported-Hosting-Providers) page.
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).
@@ -35,25 +35,25 @@ If you are trying to join from the same LAN, the server should show up in the fr
### 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](https://github.com/GeyserMC/Floodgate/wiki/Setup-and-Usage).
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!
## 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](Setup#termux-android).
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](https://github.com/GeyserMC/Geyser/wiki/Understanding-the-Config) page.
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](Creating-a-Startup-Script) page for what to put into it.
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](https://github.com/GeyserMC/Geyser/wiki/Understanding-the-Config) page.
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.
@@ -61,14 +61,14 @@ Once you're done, open up Minecraft: Bedrock Edition and in the **Friends** tab,
### 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](https://github.com/GeyserMC/Floodgate/wiki/) wiki page for more details.
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](https://github.com/GeyserMC/Geyser/wiki/Supported-Hosting-Providers) for a list of supported providers).
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](Setup#standalone-setup) before continuing.
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`
_docs/geyser/understanding-the-config.md
+3 -3
View File
@@ -32,7 +32,7 @@ Options for the remote (java) server.
**`auth-type`**: The authentication type of the Minecraft: Java Edition server. Valid options are `online`, `offline`, and `floodgate`.
**Please keep in mind, what you specify in the Geyser `auth-type` option MUST be the same as what the remote server has (with the exception of Geyser being in online mode and remote being in offline mode). You simply cannot join an online mode server without a genuine account. If you want to allow Minecraft: Bedrock Edition accounts to join without a Minecraft: Java Edition account, see the [Floodgate](https://github.com/GeyserMC/Floodgate/wiki/) wiki page.**
**Please keep in mind, what you specify in the Geyser `auth-type` option MUST be the same as what the remote server has (with the exception of Geyser being in online mode and remote being in offline mode). You simply cannot join an online mode server without a genuine account. If you want to allow Minecraft: Bedrock Edition accounts to join without a Minecraft: Java Edition account, see the [Floodgate](/floodgate/) wiki page.**
**`use-proxy-protocol`**: Whether to enable PROXY/HAProxy protocol or not while connecting to the server. This is useful only when:
- Your server supports PROXY protocol (it probably doesn't)
@@ -43,7 +43,7 @@ Options for the remote (java) server.
## General Options
General Geyser options that are mostly specific to Geyser itself.
**`floodgate-key-file`**: The key file path for Floodgate. Requires that you have [Floodgate](https://github.com/GeyserMC/Floodgate/wiki/) installed and the `auth-type` set to `floodgate`.
**`floodgate-key-file`**: The key file path for Floodgate. Requires that you have [Floodgate](/floodgate/) installed and the `auth-type` set to `floodgate`.
**`userAuths`**: A section where you can put the authentication information for your Minecraft: Java Edition account for immediate login when joining Geyser. **It is advised you ONLY use this option if you are running Geyser locally and that ONLY you have access to the config as it requires you put your Minecraft: Java Edition credentials in plain text!**
@@ -90,7 +90,7 @@ Put two spaces before the username and four spaces before the email and password
- `no-emotes` - emotes will NOT be sent to other Bedrock clients and offhand will be swapped. This effectively disables all emotes from being seen.
- `emotes-and-offhand` - emotes will be sent to Bedrock clients and offhand will be swapped
**`default-locale`**: The default locale to send to players if their locale could not be found. Check [this](https://github.com/GeyserMC/Geyser/wiki/FAQ#what-languages-does-geyser-support) page to find the code corresponding to your language.
**`default-locale`**: The default locale to send to players if their locale could not be found. Check [this](/geyser/faq/#what-languages-does-geyser-support) page to find the code corresponding to your language.
**`chunk-caching`**: Cache chunks for each Bedrock player, adds support for additional sounds and fixing movement issues at the expense of slightly more RAM usage. This option is always on for Spigot as we can use the server's API to get block information at no expense. *Geyser does not recommend disabling this option.*
_docs/geyser/using-geyser-or-floodgate-as-a-dependency.md
+1 -1
View File
@@ -47,7 +47,7 @@ GeyserSession session = GeyserConnector.getInstance().getPlayerByUuid(uuid);
## Using Floodgate
This page has a very simple primer for the Floodgate API. For a full breakdown, see [here](https://github.com/GeyserMC/Floodgate/wiki/FloodgateApi).
This page has a very simple primer for the Floodgate API. For a full breakdown, see [here](/floodgate/api/).
Add Floodgate's API as a dependency:
```xml
_docs/other/geyserconnect.md
+1 -1
View File
@@ -10,7 +10,7 @@ GeyserConnect is a version of Geyser that allows you to join multiple servers us
(For GeyserConnect to work you need an open UDP port, by default it's `19132`.)
1. Download the latest build from [Jenkins](https://ci.opencollab.dev/job/GeyserMC/job/GeyserConnect/job/master/)
2. Edit the config as needed
3. Start the server as you do with a normal Geyser install. EG: `java -Xms1024M -jar GeyserConnect.jar` (More info on [Creating a Startup Script](Creating-a-Startup-Script))
3. Start the server as you do with a normal Geyser install. EG: `java -Xms1024M -jar GeyserConnect.jar` (More info on [Creating a Startup Script](/geyser/creating-a-startup-script/))
4. Connect to it to make sure its all working.
## DNS and Docker
_docs/other/test-server.md
+2 -2
View File
@@ -9,11 +9,11 @@ permalink: /other/test-server/
- World size: 20k x 20k
### Infomation
Geyser has a test server for those who want to test how Java <-> Bedrock crossplay works on their device, and to see the limitations and restrictions. You can join from either Bedrock or Java, and the server has [Floodgate](Floodgate) installed so you don’t need a Java account to join from Bedrock.
Geyser has a test server for those who want to test how Java <-> Bedrock crossplay works on their device, and to see the limitations and restrictions. You can join from either Bedrock or Java, and the server has [Floodgate](/floodgate/) installed so you don’t need a Java account to join from Bedrock.
If you can't build/destroy/interact with the world in the test server, run `/rtp` to get away from the protected spawn area.
If you have any questions or problems be sure to join our [Discord](https://discord.geysermc.org)!
If you have any questions or problems be sure to join our [Discord](https://discord.gg/geysermc)!
### Commands:
|Command|Desc|
pages/index.md
+5 -5
View File
@@ -35,11 +35,11 @@ permalink: /
<div class="container">
<div class="row">
<div class="col">
<iframe src="https://www.youtube.com/watch?v=JjwR-3FkvUQ" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
<iframe src="https://www.youtube.com/embed/U7dZZ8w7Gi4" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
<div class="col">
<h1>How do I use it?</h1>
<p>Geyser can be downloaded from our Jenkins server <a href="http://ci.geysermc.org">here</a> and setup installations can be found on our <a href="https://github.com/GeyserMC/Geyser/wiki#Setup">wiki</a> or in the tutorial video. Geyser can be used to join any modern Java server and doesn't require anything extra to be done on their end.</p>
<p>Geyser can be downloaded from our Jenkins server <a href="http://ci.geysermc.org">here</a> and setup installations can be found on our <a href="/geyser/setup/">wiki</a> or in the tutorial video. Geyser can be used to join any modern Java server and doesn't require anything extra to be done on their end.</p>
</div>
</div>
</div>
@@ -63,10 +63,10 @@ permalink: /
<div class="col">
<h1>Join from anywhere</h1>
<p>Geyser can be joined from Windows 10, iOS, Android, and even consoles
(see <a href="https://wiki.geysermc.org/geyser/using-geyser-with-consoles/">here</a>
(see <a href="/geyser/using-geyser-with-consoles/">here</a>
for how to set this up!) Geyser is tested working with a
<a href="https://wiki.geysermc.org/geyser/supported-hosting-providers/">wide array of hosting providers</a>,
and, if you own the server, you aren't limited by a Java account with our <a href="https://wiki.geysermc.org/floodgate/">Floodgate</a>
<a href="/geyser/supported-hosting-providers/">wide array of hosting providers</a>,
and, if you own the server, you aren't limited by a Java account with our <a href="/floodgate/">Floodgate</a>
plugin!</p>
</div>
</div>