Add Crowdin, introduce new provider schema, introduce NetherNet blog post (#51)
* Begin testing i18n Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Add crowdin in-context demo for non-mdx Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Add crowdin-sync system Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Working sync system for translations Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Only build en locale for PRs Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Modify yarn install Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Do not immute cache Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Try with standard yarn install Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Revert to yarn --immutable Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Remove explicit url/file-loader resolutions Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Only log webpack errors Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Added MCServerHost to hosting providers (#47) * Added MCServerHost to hosting providers * Update providers.ts * Correct grammar and make instructions more concise --------- Co-authored-by: Kas-tle <26531652+Kas-tle@users.noreply.github.com> * Update supported Bedrock versions * Remove and Replace "TydiumCraft Skin API" (#53) * Update community-geyser-projects.md I no longer will run TydiumCraft Skin API. I have no interest in continuing it at this time (or anything minecraft related). However I have switched out the spot with an API that 100% is always updated and active. Hosted by my good friend Bret06. This works so much better as well. Thanks for everything over the years guys! Tydium out! * Update wiki/other/community-geyser-projects.md 👍 Co-authored-by: chris <github@onechris.mozmail.com> --------- Co-authored-by: chris <github@onechris.mozmail.com> * Update wording for creepernation api Update wording because it’s bothering me * Update GeyserExtras description (#52) * Update community-geyser-projects.md * Update wiki/other/community-geyser-projects.md Co-authored-by: chris <github@onechris.mozmail.com> --------- Co-authored-by: Luke <32024335+lukeeey@users.noreply.github.com> Co-authored-by: chris <github@onechris.mozmail.com> * Try matrix build strategy Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Fix matrix output Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Matrix goes to GITHUB_OUTPUT Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Fix deploy needs to combine Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Ensure correct commit is used if crowdin updates Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Make sure excluded content is respected Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Allow permission for commit action write Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Sync translations with Crowdin * Update index.md to make clear that this is for servers, not purely for clients (#57) * Update providers.ts (#58) * Update providers.ts VemoxHost added * Maintain alphabetized list --------- Co-authored-by: Kas-tle <26531652+Kas-tle@users.noreply.github.com> * Start on re-writing the providers page to provide more useful details to improve the setup guide * more work on this * Rework paper page for setup * Don't try and build paper setup as a full page * adjust not listed message * update mod/proxy pages * Initial setup i18n Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Add ability to hide proxy setup instructions by provider Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Temporary auto deployment; fix broken links Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Fix heading consistency Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Update language on provider instructions * Update language on new provider instructions * Upgrade actions/setup-node due to hang issue * Both * Forgot how many times we setup node... * Documentation for changes in API/2.6.2 (#62) * Document latest Geyser changes: - remote resource packs * Update/Finish pack docs * small typo fixes * Update page content * fix build * Update supported Bedrock version * Add Modrinth Servers to providers (#63) * Update supported versions & api version * Update versions.json to include 1.21.72 (#64) * Update bedrock version (#67) * Add 'we are not mojang' disclaimer to footer * Stop translations from overriding footer message Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Fix Standalone dump view (#68) * Add OrionNodes to providers (#69) * Update supported Bedrock versions in versions.json (1.21.81, 1.21.82) (#70) * Update faq.mdx to include recommended API (#73) Tydium skin API is abandoned, please direct users to a working API such as the one recommended by Tydium Derived from: https://github.com/GeyserMC/GeyserWebsite/commit/19ae50f95ddbfc24ff34a42d278bdc263e0200e6 * Update anticheat-compatibility.md (#74) * Update versions.json * Update versions.json (#75) * Remove LAC because it is no longer being maintained (#76) * Update versions.json for 1.21.7 (#77) * Update versions.json for 1.21.93 (#78) * Update versions.json for 1.21.94 (#79) * Update versions.json for Java 1.21.8 (#80) * Update Geyser Api version (#81) * Readd Hydraulic and add Rainbow, provide Item API V2 warning for Hydraulic (#82) * Fix incorrect Ubuntu on Oracle Cloud instructions (#84) * Remove Geyser Android App and Tempest (#83) * Update version.json for 1.21.100 (#88) * Update getting-started-with-the-api.md (#89) * Add and update wiki pages, add Thunder download. (#90) * Add a Thunder and Rainbow wiki page, touch up some other pages * Fix mobile sidebar * Address review 1/2 * Address review 1.5/2 (oops) * Address review 2/2 Co-authored-by: chris <github@onechris.mozmail.com> --------- Co-authored-by: chris <github@onechris.mozmail.com> * Indicate 1.21.101 on the Geyser Website (#93) * Added GeyserFloatingPoints to FAQ (#92) * Added GeyserFloatingPoints. * Update wiki/geyser/faq.mdx Co-authored-by: chris <github@onechris.mozmail.com> --------- Co-authored-by: chris <github@onechris.mozmail.com> * Update versions.json to indicate support for bedrock 1.21.111 * Update versions.json for Java 1.21.9/1.21.10 (#97) * Update versions.json for Java 1.21.9 * Update versions.json to include 1.21.10 * Update supported Bedrock version --------- Co-authored-by: Aurorawr <auroranova8756@gmail.com> Co-authored-by: chris <github@onechris.mozmail.com> * Update extensions file for new dependency system (#98) * Update extensions file for new dependency system * Update version * Update wiki/geyser/extensions.md --------- Co-authored-by: chris <github@onechris.mozmail.com> * Replace the Crowdin link with the current one (#101) * Replace the Crowdin link with the current one * Replace the link with the subdomain redirect * Update versions.json to include 1.21.114 (#102) * Update rainbow.md to indicate 1.21.9/.10 (#103) * Revise port forwarding instructions for Ubuntu Updated instructions for allowing Minecraft and Geyser through the OS firewall on Ubuntu. * Update providers and deploy action Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Sync translations with Crowdin * Correct providers syntax Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Use more templates wherever possible * Add build cache; update docusaurus-og Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Test deploy time with cache hit Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Use read-only cache for matrix build Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Unlikely we will use gh actions on arm... Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * This time cache will hit Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Hopefully correct yarn cache path... Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Maybe npm? Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Surely... Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * This time... Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Include yarn/docusaurus cache for PRs Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Add page IDs to more pages, fix broken pages * Update i18n pages * Sync translations with Crowdin * Add missing support pages and articles on providers, add Discord links * Add blog post on preparing Geyser servers for NetherNet Drafted with the help of Claude Opus 5.5. * Rewrite the hosted setup guide for NetherNet, add hosting page Provider entries now describe ports, signaling and install steps, grouped in the order the setup guide shows them. The guide generates the NetherNet config from them, and the old supported hosting providers list is replaced by a hosting page for Open Collaboration supporters. Drafted with the help of Claude Opus 5.5. * Rewrite the self-hosted setup guides for NetherNet The self-hosting pages now use the same steps and generated config as the hosted guide, and point out that the Geyser port needs both TCP and UDP. Drafted with the help of Claude Opus 5.5. * Add HTTPS for NetherNet page Covers serving built-in signaling over HTTPS, with a certificate in the Geyser config or with a reverse proxy (Caddy, nginx). Drafted with the help of Claude Opus 5.5. * Skip Crowdin sync in deploy workflow when no token is set Forks do not have the Crowdin secrets, so the sync step failed there and nothing got deployed. Without a token, the workflow now builds and deploys the pushed commit as is. Drafted with the help of Claude Opus 5.5. * Address: rtm's comments * Improve layout, drop confusing 26.40 note on setup guide * Cleanup blog post language / line breaks * Merge proxy server guides for server hosts, adjust exarotron provider entry, adjust setup guides to work with crowdin * Split the proxy setup guides back into Velocity and BungeeCord Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Update hosting providers to upstream and collapse strings into defaults Port upstream's provider changes to the new format: add Minehost and ConsulHosting, update MCServerHost, rename Feather to Dawn and Modrinth Servers to Modrinth Hosting, merge RamShard into RackGenius, add MyArena, and drop hosts upstream removed. Restore link fixes the rewrite undid and install details dropped from the live page. Replace host-specific strings with templates or the generated steps where they say the same thing. Hosts that pick the port themselves show where it comes from instead of the config step. Hosts without NetherNet details that shared the Java server's port now ask for a new port, open for both TCP and UDP, and the generated config turns clone-remote-port off. Hosts that cannot give out a port fall back to the "Not listed" guide for the Java server's port, which uses Warden. BisectHosting no longer uses assumed example data. Entries keep the date of their last edit. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Remove Dawn and date Aternos and exaroton today Dawn now integrates with Aternos, so it no longer needs its own entry. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Remove unused translation strings and fix the English GeyserConnect text Drop keys the code no longer uses from every locale: the old EmoteOffhand description ID, the theme's old unlisted content strings, strings removed on this branch, and the removed Custom Resource Packs sidebar category. The English GeyserConnect description had an outdated message that overrode the current one on the English site. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Hide the NetherNet and RakNet option when only the Java port is available With only the Java server's port there is no second UDP port for RakNet, so the "Not listed" Java port guide shows the NetherNet config without transport tabs. Drop the placeholder text that only applied there. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Add an HTTPS step to the self-hosted guides and correct external signaling HTTPS claims Self-hosted guides end with a recommended step to serve signaling over HTTPS, since Geyser's built-in signaling uses plain HTTP by default and players get a "Trust on First Use?" prompt. External signaling services do not all provide HTTPS, so the blog post and HTTPS page now name Warden as one that does instead of implying all do. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Update port forwarding guide, update OVH note * Sync translations with Crowdin * Hide entire placeholder strings and correcntly mark chrome json in crowdin Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Update actions and yarn Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Sync translations with Crowdin * Apply batched suggestions from code review Co-authored-by: Eclipse <eclipse@eclipseisoffline.xyz> * Fix NetherNet docs for the final Geyser PR - Built-in signaling serves HTTPS instead of HTTP once a certificate is configured (blog, system properties) - "Free port" is now "available port" in the blog - System properties: drop the removed "none" signaling mode, fix the signaling port default - playit.gg: note that the guide is for RakNet, and link playit.gg's NetherNet progress Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Build the setup guides from translation strings The per-platform setup pages are replaced by SetupGuide.tsx, which renders the hosted and self-hosted guides from shared MDXTranslatable strings, so Crowdin translates each sentence once instead of every page separately. Also: - "Not listed" with only the Java port sets mode: nxs instead of relying on Geyser's fallback - The playit.gg note links playit.gg's NetherNet progress instead of describing a setup - "free port" is now "available port" Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Remove the trustedProxies.fetch system property for now Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Fix crowdin sync and don't translate trade names Signed-off-by: GitHub <noreply@github.com> * Sync translations with Crowdin * Fix build Signed-off-by: GitHub <noreply@github.com> * Sync translations with Crowdin * Address more concerns with nethernet https guide Signed-off-by: GitHub <noreply@github.com> * Fix signaling-trusted-proxies config in nethernet https article Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Remove port forwarding from the HTTPS guide Ports are already covered by the setup guide, and HTTPS does not change which ports need to be opened. Reverse proxies now use signaling-trusted-proxies, which reads X-Forwarded-For. * Remove placeholder hosts, hide the hosting page until it launches - Remove the placeholder hosts and their logos - Aternos and exaroton are bronze supporters: highlighted with a badge in the setup guide, without a "last updated" date, but not listed on the hosting page, which only shows gold and silver - Hide the hosting page and its links for now, and mention in the blog post that it is coming soon * Supporting hosts configure Geyser, they do not install it * Sync translations with Crowdin * Move nethernet https guide up on sidebar * Update to docusaurus 3.10 and fix all type errors Signed-off-by: GitHub <noreply@github.com> * HTTP and HTTPS do not both run at once * Link win-acme's and nginx's own Windows guides in the HTTPS guide * Fix crowdin key exclusion logic Signed-off-by: GitHub <noreply@github.com> * Sync translations with Crowdin * Address reviews, clear up instructions for users. Adds info on haproxy, NXS and MOTD forwarding * Note certificate permissions and where to save the Caddyfile * Sync translations with Crowdin * Document the geyser nethernet command * Sync translations with Crowdin * Support directly linking to the "not listed" or a specific hosts' guide * Mention warden supporting custom domains * Add HOSTING_PROVIDERS.md, update existing server host setup entries to reduce translation strings used * Sync translations with Crowdin --------- Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> Signed-off-by: GitHub <noreply@github.com> Co-authored-by: Yara Durand <87721861+Roolps@users.noreply.github.com> Co-authored-by: chris <github@onechris.mozmail.com> Co-authored-by: Tydium <67938521+Tydium@users.noreply.github.com> Co-authored-by: Creeperz653 <76449952+Creeperz653@users.noreply.github.com> Co-authored-by: LetsGoAway <68365423+letsgoawaydev@users.noreply.github.com> Co-authored-by: Luke <32024335+lukeeey@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Dan <20766261+D4n2021@users.noreply.github.com> Co-authored-by: santevemox <57247088+santevemox@users.noreply.github.com> Co-authored-by: rtm516 <ryantmilner@hotmail.co.uk> Co-authored-by: Emma Alexia <wafflecoffee7@gmail.com> Co-authored-by: Alex <zomka@fard.ing> Co-authored-by: Aurorawr <100384210+Novampr@users.noreply.github.com> Co-authored-by: Jens Collaert <63231928+Jens-Co@users.noreply.github.com> Co-authored-by: OrionNodes <ethan@orionnodes.com> Co-authored-by: SylentHuntress <91935048+sylenthuntress@users.noreply.github.com> Co-authored-by: oryxel <gamingnoob681@gmail.com> Co-authored-by: Eclipse <eclipse@eclipseisoffline.xyz> Co-authored-by: Nebojsa Majic <79749977+Onako2@users.noreply.github.com> Co-authored-by: qscbm187531 <1309635304@qq.com> Co-authored-by: Eveline Carter <6444703+drakon64@users.noreply.github.com> Co-authored-by: SleepyPop <81194303+SleepyPopp@users.noreply.github.com> Co-authored-by: Aurorawr <auroranova8756@gmail.com> Co-authored-by: rtm516 <rtm516@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
315 files changed
+27919
-9717
No files matched your search
@@ -0,0 +1,83 @@
|
||||
---
|
||||
title: Commands and Permissions
|
||||
description: Commands and their associated permission nodes for Geyser.
|
||||
crowdin_sync: true
|
||||
crowdin_page_id: cd92ff4f-9105-46a2-8696-8b0e2f8b9d31
|
||||
---
|
||||
|
||||
# Commands and Permissions
|
||||
|
||||
Geyser features many built-in commands that can be used by players or server owners.
|
||||
|
||||
:::info
|
||||
|
||||
When using BungeeCord and Velocity, you will need to use a permission plugin such as [LuckPerms](https://luckperms.net/)
|
||||
on the proxy server to assign permissions to players. Assigning permissions on the backend servers will not work.
|
||||
|
||||
:::
|
||||
|
||||
## Geyser commands & their permissions {#geyser-commands--their-permissions}
|
||||
|
||||
| Command | Permission | Description |
|
||||
| :-----------------------------------: | :---------------------------: | :----------------------------------------------------------------------------------------------------------------------------------: |
|
||||
| `geyser` <br/> Geyser root command | `geyser.command` | The permission required to see/run any Geyser commands. |
|
||||
| `geyser help` <br/> `geyser ?` | `geyser.command.help` | Shows help for all registered commands. |
|
||||
| `geyser advancements` | `geyser.command.advancements` | Open the Java advancements menu. |
|
||||
| `geyser dump` | `geyser.command.dump` | Dumps Geyser debug information for bug reports. |
|
||||
| `geyser list` | `geyser.command.list` | List all players connected through Geyser. |
|
||||
| `geyser nethernet` | `geyser.command.nethernet` | Shows NetherNet signaling status and diagnostics, for use with external signaling. |
|
||||
| `geyser offhand` | `geyser.command.offhand` | Puts an item in your offhand. |
|
||||
| `geyser reload` | `geyser.command.reload` | Reloads the Geyser configurations. Kicks all players when used! |
|
||||
| `geyser settings` | `geyser.command.settings` | Opens a settings menu allowing you to modify aspects of the world. |
|
||||
| `geyser shutdown` <br/> `geyser stop` | `geyser.command.shutdown` | Shuts down Geyser.<br/>*This command only works on Standalone.* |
|
||||
| `geyser statistics` | `geyser.command.statistics` | Open the Java statistics menu. |
|
||||
| `geyser version` | `geyser.command.version` | Shows the current Geyser version and checks for updates. |
|
||||
| `geyser tooltips` | `geyser.command.tooltips` | Toggle showing Advanced Tooltips (F3 + H on Java) |
|
||||
| `geyser extensions` | `geyser.command.extensions` | Lists all currently loaded extensions. This command is only registered if any extensions are loaded. |
|
||||
| `geyser ping` | `geyser.command.ping` | Shows the ping between the player and the Geyser instance. |
|
||||
| `geyser options` | `geyser.command.options` | Opens the "pause screen additions" dialogue, if sent by the Java server |
|
||||
| `geyser quickactions` | `geyser.command.quickactions` | Opens the "quick actions" dialogue, if sent by the Java server. |
|
||||
|
||||
## Permissions for Geyser extensions {#extension-permissions}
|
||||
|
||||
For the following, `<id>` refers to the extensions' id.
|
||||
|
||||
| Command | Permission | Description |
|
||||
| :------------------------- | :---------------------------- | :------------------------------------------------------------------------ |
|
||||
| `<id> help` <br/> `<id> ?` | `geyser.command.exthelp.<id>` | Shows help for all commands registered by this extension. |
|
||||
|
||||
## Other Permissions {#other-permissions}
|
||||
|
||||
Besides commands, there are other permissions that are used to guard specific Geyser features.
|
||||
|
||||
| Permission | Description |
|
||||
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `geyser.settings.server` | Allow players to use the [game settings menu](/img/wiki/game_menu.png). (Also requires player to have op.) |
|
||||
| `geyser.settings.gamerules` | Defines whether a user can alter gamerules in the [game settings menu](/img/wiki/game_menu.png). (Also requires player to have op.) |
|
||||
| `geyser.update` | Whether this player will receive Geyser update notifications upon joining. |
|
||||
|
||||
## Permissions when using Geyser-Standalone/Geyser-ViaProxy {#standalone-viaproxy-permissions}
|
||||
|
||||
Geyser-ViaProxy and Geyser-Standalone feature their own basic permission handler. To edit base permissions,
|
||||
open the `permissions.yml` file and add or remove permissions that Geyser players should receive when joining.
|
||||
See the file for more information.
|
||||
|
||||
You can further customize permission handling by creating a [Geyser extension](/wiki/geyser/extensions/) that makes use of Geysers API
|
||||
to deal with permission checking.
|
||||
|
||||
## Permissions when using Geyser on platforms without permission handlers {#permissions-platforms-no-permission-handlers}
|
||||
|
||||
The following affects Geyser-BungeeCord, Geyser-Velocity, and Geyser-Fabric.
|
||||
These platforms unfortunately do not have built-in permission handlers. Because of that, you will need to grant permissions on those platforms
|
||||
manually using permission handlers, such as [LuckPerms](https://luckperms.net/). Geyser's permission are listed above. For extension permissions, consult their documentation.
|
||||
|
||||
Alternatively, you can use [LuckLink](https://github.com/onebeastchris/LuckLink), a third-party Geyser extension, to automatically register permissions using [LuckPerms](https://luckperms.net/).
|
||||
|
||||
- Install [LuckPerms](https://luckperms.net/) on the platform where you've installed Geyser (BungeeCord/Velocity/Fabric).
|
||||
- To allow Geyser to automatically register permission defaults, install the [LuckLink](https://github.com/onebeastchris/LuckLink) Geyser extension
|
||||
by downloading the `LuckLink.jar` and adding it to Geyser's `extensions` folder.
|
||||
- Restart the server, and permissions should be automatically registered.
|
||||
|
||||
## Floodgate commands and permissions {#floodgate-commands-and-permissions}
|
||||
|
||||
For Floodgate commands, see [here](/wiki/floodgate/commands/).
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
title: playit.gg Setup
|
||||
description: How to set up playit.gg to use Geyser without port forwarding.
|
||||
crowdin_sync: true
|
||||
crowdin_page_id: 3aee52d0-b943-4e37-8797-4a83ef55e42a
|
||||
---
|
||||
|
||||
## Prerequisites {#prerequisites}
|
||||
|
||||
:::info
|
||||
You must be able to connect to your Geyser instance locally!
|
||||
:::
|
||||
|
||||
:::warning
|
||||
The playit.gg Minecraft server plugin does not support UDP tunnels. You will need to use the program agent instead!
|
||||
:::
|
||||
|
||||
:::caution
|
||||
This guide was written for RakNet, and does not cover NetherNet. For NetherNet, see [playit.gg's progress on NetherNet support](https://status.playit.gg/3/adding-nethernet-support).
|
||||
:::
|
||||
|
||||
## Setup {#setup}
|
||||
|
||||
1. Head over to [playit.gg's website](https://playit.gg/) - download the program & run it.
|
||||
2. The program will provide a claiming link. Visit that link, log in.
|
||||

|
||||
3. Confirm your agent.
|
||||

|
||||
4. Add the agent.
|
||||

|
||||
5. After the agent is created, create a tunnel.
|
||||

|
||||
6. Name your tunnel and click Next.
|
||||

|
||||
7. Select "Minecraft Bedrock" as the tunnel type and click Next.
|
||||

|
||||
8. Select the Free Network and click Next.
|
||||

|
||||
**Do not change your Geyser port in `config.yml` unless you have a reason (for example, hosting another Geyser server on the same machine).** The Bedrock (Geyser) port in `config.yml` and the playit.gg ports are separate. playit.gg will forward its port to the default Geyser port and should work as-is. Changing it can cause errors. If you have changed your config port, set the Bedrock port back to the default `19132` and ensure `clone-remote-port` is `false`.
|
||||
9. If the playit.gg agent and Geyser are running on the same device, leave the IP as `127.0.0.1` and set the port to whatever you configured in Geyser's config.
|
||||

|
||||
10. Select `proxy-protocol-v2` for the Proxy Protocol section and click Next.
|
||||
11. In the Geyser config, under `advanced:` `bedrock:`, set `use-haproxy-protocol` to `true`.
|
||||
12. Click Create Tunnel and wait for the tunnel to be created.
|
||||

|
||||
13. Copy your tunnel's port. For example, if your tunnel address is `visiting-phone.gl.at.ply.gg:6695`, then `6695` is the tunnel port.
|
||||
14. In the Geyser config under `advanced:` `bedrock:`, set `broadcast-port` to your tunnel port (`6695` in the example).
|
||||
15. Save your config. Start your Minecraft server and connect using your tunnel's IP and port.
|
||||
16. If you join successfully, then you are done! Make sure to leave the playit.gg program running as closing it will close the tunnel. You also may want to ratelimit individual connections - use the "Per Connection Rate Limit" option to do so.
|
||||
(If you failed to join, check out the [troubleshooting](#troubleshooting) section of the page.)
|
||||
|
||||
## Troubleshooting {#troubleshooting}
|
||||
|
||||
### I can't connect to my server! {#i-cant-connect-to-my-server}
|
||||
|
||||
- *Try going to the Agents page, set your agent to IPv4 only, and change the region. You may need to switch regions a few times before you can connect.*
|
||||
- *Are there errors in your minecraft server console?*
|
||||
- *Unless you manually changed the "Local Port" on the playit.gg website, in Geyser config, ensure that the bedrock port is the default of `19132` and that `clone-remote-port` is `false`.*
|
||||
- *If you changed the `bedrock-port` or set `clone-remote-port` to `true` and have a reason for doing so (e.g. hosting another Geyser server on the same machine), you'll have to tell playit.gg to use that port instead! See the last paragraph in step 8.*
|
||||
- *Check that you're joining with playit.gg's IP and port from the "Allocation" tab.*
|
||||
- *Make sure that you have the program agent open while trying to join.*
|
||||
- *See [here](/wiki/geyser/fixing-unable-to-connect-to-world/) for general troubleshooting steps.*
|
||||
@@ -0,0 +1,208 @@
|
||||
---
|
||||
title: Port forwarding
|
||||
description: Information on how to set up port forwarding required for Geyser.
|
||||
crowdin_sync: true
|
||||
crowdin_page_id: be7c5a22-1e8e-4ffe-8d13-7d763dd75886
|
||||
---
|
||||
|
||||
# Port forwarding {#port-forwarding}
|
||||
|
||||
This page contains information on how to set up port forwarding required for Geyser to work when self-hosting.
|
||||
There are also guides for specific configurations, such as Docker/Pterodactyl, or on specific VPS/KVM providers, such as OVH or Oracle Cloud.
|
||||
|
||||
:::caution
|
||||
|
||||
If you are using a Minecraft server hosting provider (e.g. Aternos, or Nodecraft), you should refer to the hosting provider setup on the [setup](/wiki/geyser/setup) page instead.
|
||||
|
||||
:::
|
||||
|
||||
:::info Ports that need to be opened
|
||||
With NetherNet, the Geyser port (by default 19132) has to be open for **both TCP and UDP**: players find the server over TCP (signaling), and play on it over UDP.
|
||||
If you use the "NetherNet and RakNet" option, also open the `webrtc-port` for UDP.
|
||||
With external signaling, such as [Warden](https://warden.cloud), only UDP for WebRTC is needed.
|
||||
:::
|
||||
|
||||
## Port forwarding on Linux/Windows/macOS {#port-forwarding-on-linuxwindowsmacos}
|
||||
|
||||
To allow others to play on your server, you will need to set up port forwarding on the device hosting Geyser.
|
||||
Additionally, you will need to port forward the port on your router/modem (in other words, allow and route traffic on that port to the proper machine) if you want the server to be accessible outside your own home network.
|
||||
Forward it for both TCP and UDP; many routers offer a "TCP/UDP" or "Both" option for this.
|
||||
See [here](https://www.howtogeek.com/66214/how-to-forward-ports-on-your-router/) or [here](https://www.lifewire.com/how-to-port-forward-4163829) for helpful guides.
|
||||
Do note: if you do not have a static IP address, your IP address may change over time.
|
||||
|
||||
:::info
|
||||
|
||||
Some ISPs (Internet Service Providers) block certain ports, or don't allow you to open ports (e.g. by using CGNAT, which doesn't allow you to open a port with a dynamic IP).
|
||||
Other ISPs may require you to pay extra for a static IP address.
|
||||
As an alternative to port forwarding, you can use [playit.gg](/wiki/geyser/playit-gg/) to create a tunnel.
|
||||
|
||||
:::
|
||||
|
||||
### Windows {#windows}
|
||||
|
||||
To open a port on Windows, you will need to open the port through the Windows Firewall. There are multiple ways to do this:
|
||||
|
||||
- `Powershell` (recommended)
|
||||
|
||||
To open a port on TCP and UDP (in our example, port 19132), run the following commands in an administrator Powershell:
|
||||
|
||||
```powershell
|
||||
New-NetFirewallRule -DisplayName "Geyser (TCP)" -Direction Inbound -Protocol TCP -LocalPort 19132 -Action Allow
|
||||
New-NetFirewallRule -DisplayName "Geyser (UDP)" -Direction Inbound -Protocol UDP -LocalPort 19132 -Action Allow
|
||||
```
|
||||
|
||||
Running these commands creates two rules that allow TCP and UDP traffic on port 19132.
|
||||
|
||||
- Windows Defender Firewall with Advanced Security (GUI)
|
||||
1. Search for "Windows Defender Firewall with Advanced Security" in the start menu, and open it. ([Image](/img/wiki/port-forwarding/windows-1.png))
|
||||
2. Click on "Inbound Rules" in the left sidebar. ([Image](/img/wiki/port-forwarding/windows-2.png))
|
||||
3. Click on "New Rule..." in the right sidebar. ([Image](/img/wiki/port-forwarding/windows-2.png))
|
||||
4. Select "Port" as the rule type and click "Next". ([Example](/img/wiki/port-forwarding/windows-3.png))
|
||||
5. Select "UDP" and "Specific local ports", and enter the port you want to open (in our example, 19132). Click "Next". ([Example](/img/wiki/port-forwarding/windows-4.png))
|
||||
6. Select "Allow the connection" and click "Next". ([Example](/img/wiki/port-forwarding/windows-5.png))
|
||||
7. Select the profiles you want to apply the rule to (e.g. "Domain", "Private", "Public"), and click "Next". ([Example](/img/wiki/port-forwarding/windows-6.png))
|
||||
8. Enter a name for the rule (e.g. "Geyser (UDP)"), and click "Finish". ([Image](/img/wiki/port-forwarding/windows-7.png))
|
||||
9. Repeat these steps, selecting "TCP" in step 5 and naming the rule e.g. "Geyser (TCP)".
|
||||
|
||||
### Linux {#linux}
|
||||
|
||||
Different Linux distributions, even different VPS providers ship and configure different firewalls. In the following examples, we will use `19132` as the port to open, but you should replace this with the port you are using for Geyser.
|
||||
|
||||
- `ufw` is a simple firewall front-end for iptables that is commonly used on Ubuntu and Debian. To open a port on TCP and UDP, run the following commands:
|
||||
```bash
|
||||
sudo ufw allow 19132/tcp
|
||||
sudo ufw allow 19132/udp
|
||||
```
|
||||
Then, reload the firewall with `sudo ufw reload`, and see all open rules with `sudo ufw status`.
|
||||
Further helpful guides: [DigitalOcean](https://www.digitalocean.com/community/tutorials/how-to-setup-a-firewall-with-ufw-on-an-ubuntu-and-debian-cloud-server), [Baeldung](https://www.baeldung.com/linux/uncomplicated-firewall)
|
||||
|
||||
- `firewalld` Add a port on TCP and UDP by running:
|
||||
```bash
|
||||
sudo firewall-cmd --zone=public --permanent --add-port=19132/tcp
|
||||
sudo firewall-cmd --zone=public --permanent --add-port=19132/udp
|
||||
```
|
||||
Then, reload the firewall with `sudo firewall-cmd --reload`, and see all open rules with `sudo firewall-cmd --list-all`.
|
||||
Further helpful guides: [DigitalOcean](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-firewall-using-firewalld-on-centos-7)
|
||||
|
||||
- `iptables` is a common firewall that is used on many Linux distributions. To open a port on TCP and UDP, run the following commands:
|
||||
```bash
|
||||
sudo iptables -A INPUT -p tcp --dport 19132 -j ACCEPT
|
||||
sudo iptables -A INPUT -p udp --dport 19132 -j ACCEPT
|
||||
```
|
||||
Then, save the firewall with `sudo iptables-save`, and see all open rules with `sudo iptables -L`.
|
||||
Further helpful guides for iptables: [DigitalOcean](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-firewall-using-iptables-on-ubuntu-14-04), [Ubuntu](https://help.ubuntu.com/community/IptablesHowTo)
|
||||
|
||||
### macOS {#macos}
|
||||
|
||||
You will need to disable `Block all incoming connections` in your Firewall settings, as that will block any connections and won't allow you to make exceptions.
|
||||
To allow incoming connections, click `Allow` when getting [these prompts](/img/wiki/port-forwarding/macos_warning.png).
|
||||
If you are still facing issues, see Apple's official guide [here](https://support.apple.com/guide/mac-help/MH11783) to open a port on macOS.
|
||||
|
||||
## Using Docker or Pterodactyl {#using-docker-or-pterodactyl}
|
||||
|
||||
In addition to port forwarding the port in your server's firewall (and, if applicable, your router/modem), you will need to assign the port in Docker/Pterodactyl.
|
||||
|
||||
### Pterodactyl {#pterodactyl}
|
||||
|
||||
Make sure to allocate the port(s) to the server in the Pterodactyl panel's `Network` tab, additionally to port forwarding the port(s).
|
||||
See [here](https://pterodactyl.io/community/games/minecraft.html#allocations-in-the-panel) for more information.
|
||||
|
||||

|
||||
|
||||
There are also different Geyser eggs for Pterodactyl, which can be found [here](https://github.com/GeyserMC/pterodactyl-stuff).
|
||||
|
||||
:::caution
|
||||
|
||||
If you are not able to allocate ports in the Pterodactyl panel, you will need to contact your server host to allocate one for you or try to use an existing port allocation.
|
||||
|
||||
:::
|
||||
|
||||
### Docker {#docker}
|
||||
|
||||
For Geyser to work under Docker (e.g. using [Itzg's Docker image](https://github.com/itzg/docker-minecraft-server)), you will need to add the Geyser port on TCP and UDP to the docker-compose file. This is done by adding the following to the `ports` section:
|
||||
|
||||
```yaml
|
||||
ports:
|
||||
- "25565:25565"
|
||||
- "19132:19132"
|
||||
- "19132:19132/udp"
|
||||
```
|
||||
|
||||
Without a suffix, Docker exposes the port on TCP. The additional `/udp` suffix exposes it on UDP.
|
||||
Alternatively, add the ports with the `-p 19132:19132 -p 19132:19132/udp` flags to the docker run command.
|
||||
|
||||
## Issues with specific VPS/KVM providers {#issues-with-specific-vpskvm-providers}
|
||||
|
||||
Some providers, such as OVH, Oracle Cloud, and SoYouStart, have a firewall that blocks the ports Geyser needs by default/in most cases.
|
||||
|
||||
### OVH and SoYouStart {#ovh-and-soyoustart}
|
||||
|
||||
OVH's GAME firewall filters traffic with rules made for specific games. The Minecraft Bedrock and Minecraft Pocket Edition rules currently only support RakNet, the protocol Bedrock used before NetherNet.
|
||||
With NetherNet, players find the server over HTTP (TCP) and play over WebRTC (UDP), which these rules currently do not support.
|
||||
For now, use the `Other` rule for the Geyser port(s) instead.
|
||||
|
||||
:::caution
|
||||
|
||||
If you do not have access to these firewall settings, but got linked to this page, please contact your server host and provide them with this link - they are likely using OVH internally.
|
||||
|
||||
:::
|
||||
|
||||
**To resolve it:**
|
||||
|
||||
OVH:
|
||||
|
||||
1. Navigate to `Network interfaces`
|
||||
2. Click on the `...` button on the table for your IP -> then `...` and `Configure the GAME firewall` -> `Add rule` -> `Other protocol`
|
||||
3. Add your Geyser port into `outgoing port`. If you use the "NetherNet and RakNet" option, add a rule for the `webrtc-port` as well.
|
||||
4. If you use OVH's Edge Network Firewall, make sure it allows the Geyser port over both TCP and UDP.
|
||||
|
||||
SoYouStart (subsidiary of OVH):
|
||||
|
||||
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 "Other" in the dropdown list and enter the Geyser port. If you use the "NetherNet and RakNet" option, add the `webrtc-port` as well.
|
||||
5. Save and wait a few seconds for the changes to come into effect.
|
||||
|
||||
### Oracle Cloud/OCI {#oracle-cloudoci}
|
||||
|
||||
By default, Oracle Cloud will block all incoming traffic except for SSH and RDP. This must be resolved within Oracle Cloud itself and the Compute Instance running Geyser.
|
||||
|
||||
The steps below assume that you are using the default ports for the Java server and Geyser, and should be adjusted accordingly.
|
||||
|
||||
1. Find your Compute Instance in the OCI Console
|
||||
2. Click on the instances Virtual Cloud Network (this will be under "Instance details")
|
||||
3. On the left-hand side, select "Security Lists"
|
||||
4. Select one of the security lists. By default only one security list will exist. It doesn't matter which security list we add the rules to.
|
||||
5. Select "Add Ingress Rules"
|
||||
6. Configure rules for Java (optional)
|
||||
- Set "Source CIDR" to `0.0.0.0/0`
|
||||
- Set "Destination Port Range" to `25565-25565`
|
||||
- Select "Another Ingress Rule"
|
||||
7. Configure rules for Geyser, once for TCP and once for UDP
|
||||
- Set "Source CIDR" to `0.0.0.0/0`
|
||||
- Set "Destination Port Range" to `19132-19132`
|
||||
- Set "IP Protocol" to TCP
|
||||
- Select "Another Ingress Rule", and repeat with "IP Protocol" set to UDP
|
||||
8. Select "Add Ingress Rules"
|
||||
|
||||
#### Oracle Linux {#oracle-linux}
|
||||
|
||||
Run the following commands to allow Minecraft and Geyser through the OS firewall:
|
||||
|
||||
```bash
|
||||
sudo firewall-cmd --add-port=25565/tcp --permanent
|
||||
sudo firewall-cmd --add-port=19132/tcp --permanent
|
||||
sudo firewall-cmd --add-port=19132/udp --permanent
|
||||
sudo firewall-cmd --reload
|
||||
```
|
||||
|
||||
#### Ubuntu {#ubuntu}
|
||||
|
||||
Run the following commands to allow Minecraft and Geyser through the OS firewall:
|
||||
|
||||
```bash
|
||||
sudo ufw allow 25565/tcp
|
||||
sudo ufw allow 19132/tcp
|
||||
sudo ufw allow 19132/udp
|
||||
```
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: Supported versions
|
||||
description: Information on the versions Geyser supports.
|
||||
crowdin_sync: true
|
||||
crowdin_page_id: f199ae24-f711-486d-8e42-3079be87e8cd
|
||||
---
|
||||
|
||||
import { Versions } from '@site/src/components/Versions'
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
# Currently supported versions \ {#currently-supported-versions}
|
||||
|
||||
:::info
|
||||
**Geyser currently supports Minecraft Bedrock <Versions.bedrock /> and Minecraft Java <Versions.java />**.
|
||||
:::
|
||||
|
||||
## Using Geyser with older Minecraft: Bedrock edition versions \ {#using-geyser-with-older-minecraft-bedrock-edition-versions}
|
||||
|
||||
Older Bedrock versions are not supported. Minecraft: Bedrock Edition updates automatically on all platforms, so there are few users who would
|
||||
want to use older versions. Further, older Bedrock versions do not have all features which Geyser support, which would lead to a sub-par experience.
|
||||
|
||||
## Using Geyser on older Minecraft: Java edition servers \ {#using-geyser-on-older-minecraft-java-edition-servers}
|
||||
|
||||
Geyser emulates a <Versions.java /> client, so a Java server must accept users using that version in order for Geyser to work.
|
||||
This is possible thanks to [ViaVersion](https://viaversion.com/viaversion), which allows Java edition players with newer versions to join servers
|
||||
that run older versions of the game.
|
||||
|
||||
### Using Geyser-Spigot on a Spigot/Paper server running on 1.20.5 or above
|
||||
|
||||
You can use Geyser-Spigot on servers that run on 1.20.5 or above. You will also need to run at least Java 21 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 21 can add `-DPaper.IgnoreJavaVersion=true` flag to the Java startup arguments to allow Paper to run on Java 21.
|
||||
|
||||
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](/wiki/geyser/secure-chat).
|
||||
|
||||
### Using Geyser-Spigot on a Spigot/Paper server running on a version below 1.20.5
|
||||
|
||||
This is unfortunately not possible. You'll need to use a proxy such as Velocity or BungeeCord, or set up Geyser-Standalone separately with the [ViaVersion](https://viaversion.com/viaversion) plugin. Another alternative would be to install [ViaProxy](https://viaversion.com/viaproxy), which is a standalone ViaVersion proxy that
|
||||
translates between different Minecraft: Java edition versions, and to install Geyser-ViaProxy on it.
|
||||
|
||||
### Using Geyser on Fabric/NeoForge servers not on the latest Minecraft version \ {#using-geyser-on-fabric-neoforge-servers-not-on-the-latest-minecraft-version}
|
||||
|
||||
Unfortunately, Geyser-Fabric and Geyser-NeoForge only support the latest version of Minecraft: Java edition. The recommended way to still use
|
||||
Geyser with older versions would be to install [ViaProxy](https://viaversion.com/viaproxy), which is a standalone ViaVersion proxy that
|
||||
translates between different Minecraft: Java edition versions, and to install Geyser-ViaProxy on it. This will also work with Floodgate auth.
|
||||
|
||||
### Using Geyser-Velocity or Geyser-BungeeCord on a proxy
|
||||
|
||||
Make sure you update your proxy software to the latest available version, and, if the backend servers are not on <Versions.java />, also install the [ViaVersion](https://viaversion.com/viaversion) plugin on the backend servers. Velocity/BungeeCord support most Minecraft versions, so you can update them regardless of the backend server versions.
|
||||
Reference in new issue
Block a user