Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add compatibility.md page to wiki, move some faq guides #30

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add compatibility.md page to wiki, move some faq guides #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d3336d
Add compatibility.md page to wiki, remove some faq guides
onebeastchris Aug 25, 2024
c6895b3
oops
onebeastchris Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sidebars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ const sidebars: SidebarsConfig = {
id: 'geyser/faq'
},
items: [
'geyser/compatibility',
'geyser/supported-versions',
'geyser/anticheat-compatibility',
'geyser/current-limitations'
]
},
Expand Down
35 changes: 0 additions & 35 deletions wiki/geyser/anticheat-compatibility.md
View file
Open in desktop

This file was deleted.

120 changes: 120 additions & 0 deletions wiki/geyser/compatibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
---

Title: Compatibility with 3rd Party Services and Plugins
Description: A help page related to 3rd-party services and plugins.

---

# Compatibility

:::caution
This page highlights selected incompatibilities and warnings. We are NOT affiliated with these services or plugins, nor do we endorse them. If you have further questions, please refer to their provided documentation.
:::

## Port-forwarding / Tunnelling Services {#tunnelling-services}

These are commonly used to allow players to join a server hosted at home without needing to set up port-forwarding.

- **[playit.gg](https://playit.gg/)** <br/>
The playit.gg plugin unfortunately does not support UDP tunnels, but the standalone version of playit.gg can be used
with Geyser. See [our guide](/wiki/geyser/playit-gg/) for help.


- **[ngrok](https://ngrok.com/)** <br/>
Unfortunately, ngrok does not support UDP traffic, and can therefore not be used with Geyser. We recommend using playit.gg instead.

## DDoS-Protection {#ddos-protection}

These services can be used to protect your server from DDoS attacks. These are paid, and are usually only needed for larger
networks.

Do note: With haproxy protocol enabled, you should also configure `proxy-protocol-whitelisted-ips` in your Geyser config
to whitelist the IP's from your ddos protection provider.

The config option accepts either single strings, or an array of entries. These can either be IP addresses,
or a URL containing a new-line separated list of IPs/CIDRs. For example, TCPShield and Cosmic provide a URL with an updated list of their CIDRs:
```yaml
bedrock:
# ...
proxy-protocol-whitelisted-ips: [ "https://cosmic.global/ips/", "https://tcpshield.com/v4/" ]
```

Provider-specific information:

- **[TCPShield](https://tcpshield.com/)**: <br/>
Requires `only-allow-proxy-connections` to be disabled unless you have a paid plan. The "Premium" plan supports Geyser —
see [their docs](https://docs.tcpshield.com/miscellaneous/geyser) for setup instructions.


- **[Cosmicguard](https://cosmicguard.com/)** <br/>
Setup instructions:
1. Access the host system's terminal. (This guide is for Linux systems only.)
2. Set up a "Guard," selecting "gaming" and then "Minecraft: Bedrock edition."
3. Click "setup" for Linux, run the guardian installer, and start the service.
4. Run "guardian status" and note the "Local IP" (starts with "10.31.x.x").
5. Go to the Geyser `config.yml` and update the Bedrock address to the Local IP you found above.
6. Restart the Minecraft server and test it out. It should work for both Java and Bedrock.

For further questions, contact their support.

## Web Stores {#web-stores}

- **[Tebex](https://www.tebex.io/)** <br/>
Tebex (formerly Buycraft) supports Java & Bedrock players via the 'Minecraft Offline/Geyser' store option. <br/>
See [their blog entry](https://blog.tebex.io/setting-up-geyser-minecraft/), or below for a guide:
1. Go to Tebex and create a webstore.
2. Select the game as "Minecraft Offline/Geyser"
3. Continue and click "Create my Webstore."
4. Name your server and select the currency, then continue.
5. Select the game server and continue.
6. Download the plugin version that matches your server type.
7. Execute the secret command from your server's console.

**Note:** If you are using a prefix with Floodgate, Bedrock players will have to enter the prefix.


- **[CraftingStore](https://craftingstore.net/)** <br/>
CraftingStore works with Geyser. However, if you are using a Floodgate prefix that is not `+`, you will need to disable the premium name checking config option.

## Plugin Incompatibilities {#plugin-incompatibilities}

Geyser generally works fine with most plugins as it emulates a Java client. However, there are some exceptions:

- **[ExploitFixer](https://www.spigotmc.org/resources/62842/):** Thinks that Floodgate users are UUID spoofing — disable the `uuidspoof` setting in ExploitFixer's config.
- **[LibHatesMods](https://www.spigotmc.org/resources/78202/):** Causes authentication failures with `com.github.steveice10.mc.auth.exception.request.InvalidCredentialsException`.
- **[ProtocolSupport](https://www.spigotmc.org/resources/7201/):** Works with Floodgate, but we recommend using [ViaBackwards](https://hangar.papermc.io/ViaVersion/ViaBackwards) instead.
- **[ProtocolSupportBungee](https://www.spigotmc.org/resources/8733/):** Changes how the login process works, breaking Floodgate's injection code.
- **[SayNoToMcLeaks](https://www.spigotmc.org/resources/40906/):** Prevents Floodgate from completing its login system.

If you come across any more plugin incompatibilities, please let us know via [Discord](https://discord.gg/geysermc).

:::caution

The AntiCheats listed below have been categorized based on their compatibility with Geyser.
This is a community-compiled list and does not indicate any endorsement from GeyserMC. Use them at your own risk!

:::

## AntiCheat compatibility reports {#anticheat-compatibility-reports}

Full Compatibility (Checks Bedrock Players Accurately)

- [AntiAura](https://www.spigotmc.org/resources/1368/) (Paid) - Last checked on 24th January 2023
- [LightAntiCheat](https://modrinth.com/plugin/lightanticheat) - Last checked on 19rd July 2024
- [Spartan: Bedrock Edition](https://builtbybit.com/resources/12832/) (Paid) - Last checked on 18th July 2024
- [Themis](https://www.spigotmc.org/resources/90766/) - Last checked on 11th July 2024

Partially Compatible (Does not Check/Ignores Bedrock Players)

- [GrimAC](https://github.com/MWHunter/Grim) - Last checked on 30th June 2024
- [Intave](https://intave.ac) (Paid) Requires [GeyserMC addon](https://github.com/intave/bedrock) - Last checked on 2nd July 2024
- [Matrix](https://matrix.rip/) (Paid) - Last checked on 23rd July 2024
- [Spartan: Java Edition](https://www.spigotmc.org/resources/25638/) (Paid) - Last checked on 18th July 2024
- [Verus](https://verus.ac) (Paid) - Last checked on 4th February 2024
- [Vulcan](https://www.spigotmc.org/resources/83626/) (Paid) - Last checked on 20th July 2024

Incompatible (False Positives on Bedrock Players, no Compatibility at All)

- [GodsEye](https://www.spigotmc.org/resources/69595/) ([GodsEyeGeyserMC](https://github.com/TheDejavu/GodsEyeGeyserMC/releases) is an addon that enables Partial Compatibility) (Paid) - Last checked on 23rd March 2024
- [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 checked on 14th July 2024
- [Wraith](https://www.spigotmc.org/resources/66887/) (Paid) - Last checked on 26th January 2023
65 changes: 3 additions & 62 deletions wiki/geyser/faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Frequently asked questions about Geyser, including how it works, wh
---

import { Questions, Q, A } from "@site/src/components/Questions";
import { Versions } from '@site/src/components/Versions'

### General Questions {#general-questions}

Expand All @@ -30,24 +29,9 @@ Here you can find answers to frequently asked questions about Geyser - if you ha
</A>
</Q>
<Q>
What plugins don't work with Geyser?
What plugins/services don't work with Geyser?
<A>
Geyser should generally work fine with plugins, as we emulate a Java client. There are exceptions, though:

* [TCPShield](https://tcpshield.com/) requires `only-allow-proxy-connections` disabled without a paid plan. However, their "Premium" plan will allow the support of Geyser - please see [here](https://docs.tcpshield.com/miscellaneous/geyser) for setup instructions.

Floodgate can cause issues with plugins as it modifies the login process. *Please note that any offline mode authenticator plugins are only here for documentation; Geyser does not support offline mode usage.*

* [DynamicBungeeAuth](https://www.spigotmc.org/resources/27480/) Currently working on latest version 10.28B+ (10.27B and older versions produces invalid credentials for Bedrock players)
* [FastLogin](https://www.spigotmc.org/resources/14153/) does not let floodgate add player prefix.
* [ExploitFixer](https://www.spigotmc.org/resources/62842/) thinks that Floodgate users are UUID spoofing - disable the `uuidspoof` setting in ExploitFixer's config.
* [JPremium](https://www.spigotmc.org/resources/27766/) alters the UUID of a player, causing Floodgate not to be able to get the Bedrock data from its map.
* [LibHatesMods](https://www.spigotmc.org/resources/78202/) causes authentication to fail with `com.github.steveice10.mc.auth.exception.request.InvalidCredentialsException`
* [ProtocolSupport](https://www.spigotmc.org/resources/7201/) ~~is currently incompatible with Floodgate.~~ Works with Floodgate, but we recommend using [ViaBackwards](https://hangar.papermc.io/ViaVersion/ViaBackwards) instead.
* [ProtocolSupportBungee](https://www.spigotmc.org/resources/8733/) changes how the login process works and therefore breaks the Floodgate injection code.
* [SayNoToMcLeaks](https://www.spigotmc.org/resources/40906/) prevents Floodgate from finishing its login system.

If you come across any more, please let us know via [Discord](https://discord.gg/geysermc).
See [our compatibility wiki page](/wiki/geyser/compatibility) for infos.
</A>
</Q>
<Q>
Expand Down Expand Up @@ -119,7 +103,7 @@ Here you can find answers to frequently asked questions about Geyser - if you ha

1. Use Floodgate’s built-in whitelist command: `/fwhitelist add <bedrock_username>`. This will only work if the player has joined any Geyser server already.

2. Turn off the whitelist using `/whitelist off`, then get the Geyser player to join. After that, run `/whitelist add ".<bedrock_username>"`, and finally, turn the whitelist back on using `/whitelist on`.
2. Turn off the whitelist using `/whitelist off`, then get the Geyser player to join. After that, run `/whitelist add ".<bedrock_username/>"`, and finally, turn the whitelist back on using `/whitelist on`.
When using Local Linking: If you're linking a Bedrock account to an existing whitelisted Java account, you don't need to whitelist the Bedrock account separately. You can link the accounts and immediately turn the whitelist back on.

3. Add the player’s UUID, as given by Floodgate, to the `whitelist.json` file. Then, run `/whitelist reload` to update the whitelist.
Expand Down Expand Up @@ -165,23 +149,6 @@ Here you can find answers to frequently asked questions about Geyser - if you ha
Yes, you can use Geyser as a plugin or a mod for your Minecraft server software running on Pterodactyl. There is also an official egg for the standalone version. It supports auto-updating and has all config options easily editable. You can find it [here](https://github.com/GeyserMC/pterodactyl-stuff), download the JSON egg, and import it into your panel. Make sure the Geyser port (using UDP) is exported out to the host & allocated the port to the server.
</A>
</Q>
<Q>
Can I use Geyser with Ngrok?
<A>
Unfortunately, Ngrok is TCP-only, so you will not be able to use Geyser with Ngrok. As an alternative, you can use [playit.gg](https://playit.gg), which supports both TCP and UDP.
</A>
</Q>
<Q>
How do I setup Cosmic Guard?
<A>
1. You will need access to the host systems terminal. Note: This guide is for Linux systems only!
2. Setup a "Guard" select gaming then Minecraft: Bedrock edition.
3. Click setup for linux and run the guardian installer and start the service.
4. Run "guardian status" and take note of the "Local IP" it starts with "10.31.x.x".
5. Go to the Geyser config.yml and update the Bedrock address to the Local IP which you found above.
6. Restart the mc server and test it out, it should work for both Java and Bedrock.
</A>
</Q>
<Q>
Can I connect Geyser to an older server?
<A>
Expand Down Expand Up @@ -212,32 +179,6 @@ Here you can find answers to frequently asked questions about Geyser - if you ha
Alternatively, if you cannot get the above AvatarUrl to work with DiscordSRV, or you'd like to use it with another plugin that does not support texture ids, you can use the [TydiumCraft Skin API.](https://tydiumcraft.net/docs/skinapi)
</A>
</Q>
<Q>
Can I use Buycraft (Tebex) with Geyser?
<A>
You sure can! Buycraft supports Java & Bedrock players via the Offline store mode **(Recommended to be used with Floodgate)**

**(Currently, Buycraft does not support special symbols like `*` or `-`, so you'll have to change the Floodgate prefix to `_` or remove it entirely.)**
<h3>Steps to create a store to support both versions</h3>
- Buycraft-> Create Webstore
- Select Game-> Minecraft Offline
- Continue-> Click "Create my Webstore"
- Name your server & Select currency-> Continue
- Select Game Server-> Continue
- Download the plugin version that best suits your server.
- Execute the secret command from your server's console

Your store is now set up to support Bedrock & Java players.

**(Please note, if you are using a prefix with Floodgate, Bedrock players will have to enter the prefix.)**
</A>
</Q>
<Q>
Can I use CraftingStore with Geyser?
<A>
Yes, CraftingStore works with Geyser. However, if you are using a Floodgate prefix that is not `+`, you will need to disable the premium name checking config option.
</A>
</Q>
</Questions>

### Additional Questions {#additional-questions}
Expand Down