From 05c4ec92fc3aa0e1b9452e929658f227767394c9 Mon Sep 17 00:00:00 2001 From: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> Date: Sun, 3 Mar 2024 20:04:11 -0800 Subject: [PATCH] Explicitly define md/x header links for i18n Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> --- docs/floodgate/api.md | 6 ++-- docs/floodgate/features.md | 4 +-- docs/floodgate/index.md | 4 +-- docs/floodgate/issues.md | 24 +++++++-------- docs/floodgate/linking.md | 4 +-- docs/floodgate/setup/proxy-servers.mdx | 2 +- docs/geyser/anticheat-compatibility.md | 2 +- docs/geyser/api.md | 30 +++++++++---------- docs/geyser/commands.md | 6 ++-- docs/geyser/common-issues.md | 20 ++++++------- docs/geyser/creating-a-startup-script.md | 6 ++-- docs/geyser/current-limitations.md | 4 +-- docs/geyser/custom-blocks.md | 10 +++---- docs/geyser/custom-items.md | 10 +++---- docs/geyser/custom-skulls.md | 16 +++++----- docs/geyser/events.md | 6 ++-- docs/geyser/extensions.md | 16 +++++----- docs/geyser/faq.mdx | 4 +-- .../fixing-unable-to-connect-to-world.md | 30 +++++++++---------- docs/geyser/forms.md | 12 ++++---- docs/geyser/getting-started-with-the-api.md | 4 +-- ...nd-line-arguments-and-system-properties.md | 12 ++++---- docs/geyser/global-api.md | 2 +- docs/geyser/playit-gg.md | 8 ++--- docs/geyser/port-forwarding.md | 24 +++++++-------- docs/geyser/setup/self/standalone.mdx | 6 ++-- docs/geyser/supported-hosting-providers.mdx | 6 ++-- docs/geyser/translations.md | 10 +++---- docs/geyser/understanding-the-config.md | 10 +++---- docs/geyser/using-geyser-with-consoles.md | 14 ++++----- docs/other/community-geyser-projects.md | 28 ++++++++--------- docs/other/developer-guide.md | 26 ++++++++-------- docs/other/discord-bot-usage.md | 16 +++++----- docs/other/geyserconnect.md | 6 ++-- docs/other/geyseroptionalpack.md | 4 +-- docs/other/hurricane.md | 6 ++-- docs/other/test-server.md | 6 ++-- 37 files changed, 202 insertions(+), 202 deletions(-) diff --git a/docs/floodgate/api.md b/docs/floodgate/api.md index 9ebe82e..50a42d6 100644 --- a/docs/floodgate/api.md +++ b/docs/floodgate/api.md @@ -7,7 +7,7 @@ Floodgate has an API to extend what is possible and allow servers to get informa This page will contain information about class FloodgateApi. See the sidebar for more information about other parts of the API. -### Accessing the Floodgate API +### Accessing the Floodgate API {#accessing-the-floodgate-api} See [here](/geyser/getting-started-with-the-api) for how to include the Floodgate API in your project. @@ -29,7 +29,7 @@ To see full, detailed documentation, see the [javadocs](https://repo.opencollab. ::: -#### We'll highlight a few to get you started quickly: +#### We'll highlight a few to get you started quickly: {#well-highlight-a-few-to-get-you-started-quickly} `FloodgateApi#isFloodgatePlayer(UUID)` Used to check if the given UUID of an **online** player is a Bedrock player. @@ -48,5 +48,5 @@ Click [here](/floodgate/linking/) to get more information about the PlayerLink c Used to send a form to the Bedrock player with the given UUID. Click [here](/geyser/forms/) to get more information about Forms. -### Using the API on backend servers +### Using the API on backend servers {#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. diff --git a/docs/floodgate/features.md b/docs/floodgate/features.md index 7309b9c..8da7f26 100644 --- a/docs/floodgate/features.md +++ b/docs/floodgate/features.md @@ -2,7 +2,7 @@ title: Features --- -## Whitelist command +## Whitelist command {#whitelist-command} Floodgate 2.0 has a whitelist command, `fwhitelist`, that should be used for adding or removing Floodgate players to whitelist.json. The username prefix doesn't need to be included. `fwhitelist add Tim203` @@ -12,7 +12,7 @@ You can also specify a UUID: `fwhitelist add 00000000-0000-0000-0009-01f64f65c7c The permission node is `floodgate.command.fwhitelist`. -## What is skin uploading? +## What is skin uploading? {#what-is-skin-uploading} 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. diff --git a/docs/floodgate/index.md b/docs/floodgate/index.md index ec31434..8e2ea6f 100644 --- a/docs/floodgate/index.md +++ b/docs/floodgate/index.md @@ -4,11 +4,11 @@ permalink: /floodgate/ --- # Floodgate -## What is Floodgate? +## What is Floodgate? {#what-is-floodgate} Floodgate is a hybrid mode plugin that allows Minecraft: Bedrock Accounts to join Minecraft: Java Edition servers without needing a Minecraft: Java Edition account. This is something you install in addition to Geyser. Unlike Geyser, Floodgate can only be installed as a plugin on Spigot (including Paper and forks), Bungeecord, Velocity, and as a mod on Fabric servers, and can only be utilized on servers that have it installed. -## What has Floodgate 2.0 to offer? +## What has Floodgate 2.0 to offer? {#what-has-floodgate-20-to-offer} Floodgate 2.0 is a rewrite of Floodgate 1.0, with various bugfixes and improvements. It also introduces new features: being able to [see Bedrock player skins on Java edition](/floodgate/features/#what-is-skin-uploading), being able to [use Bedrock forms](/geyser/forms/), link your account once and login on every server that has [Global Linking](/floodgate/linking/#what-is-global-linking) enabled, and the [Global Api](/geyser/global-api). diff --git a/docs/floodgate/issues.md b/docs/floodgate/issues.md index 6b6e9da..4ac9a2e 100644 --- a/docs/floodgate/issues.md +++ b/docs/floodgate/issues.md @@ -5,54 +5,54 @@ title: Issues # Known Issues & Caveats If an issue you're experiencing is not listed here, please consider joining the Geyser [Discord](http://discord.geysermc.org/). -## Running commands +## Running commands {#running-commands} In some instances, like if you have the `username-prefix` set to `*`, you may need to wrap the Bedrock player's username in quotes; for example: `/tp "*BedrockPlayer"`. Setting the prefix to `.` should also fix this. -## If you wish to use IP forwarding, please enable it in your BungeeCord config as well! +## If you wish to use IP forwarding, please enable it in your BungeeCord config as well! {#if-you-wish-to-use-ip-forwarding-please-enable-it-in-your-bungeecord-config-as-well} It is likely you have enabled `send-floodgate-data` in your Floodgate config but either Floodgate isn't installed on the target server, or your floodgate key isn't the same between the installs of the plugin (please copy them so they all use the same key). -## `java.lang.IllegalStateException: Cannot reply to EncryptionRequestPacket without profile and access token.` +## `java.lang.IllegalStateException: Cannot reply to EncryptionRequestPacket without profile and access token.` {#javalangillegalstateexception-cannot-reply-to-encryptionrequestpacket-without-profile-and-access-token} Make sure the server has Floodgate installed and started up correctly. Otherwise, see if the next line fixes your error. -## `javax.crypto.AEADBadTagException: Tag mismatch!` +## `javax.crypto.AEADBadTagException: Tag mismatch!` {#javaxcryptoaeadbadtagexception-tag-mismatch} If Geyser and Floodgate are on the same server, shut down your server, delete the `floodgate` plugin folder, delete any key file in the Geyser folder, and restart your server. If Geyser and Floodgate are not on the same server and you had to copy the key file, this could also be an error related to uploading through FTP. Using ASCII will not work here, and you need to make sure you're on binary when uploading. We recommend using [WinSCP](https://winscp.net) if you need to use FTP. -## java.lang.NumberFormatException: For input string: "" +## java.lang.NumberFormatException: For input string: "" {#javalangnumberformatexception-for-input-string-} You're trying to log in without an Xbox account. Floodgate requires an Xbox account to authenticate the Bedrock player. -## Geyser-Floodgate:51777 lost connection: Internal Exception: java.lang.NumberFormatException: For input string: "SfqdXv36" (or a similar error) +## Geyser-Floodgate:51777 lost connection: Internal Exception: java.lang.NumberFormatException: For input string: "SfqdXv36" (or a similar error) {#geyser-floodgate51777-lost-connection-internal-exception-javalangnumberformatexception-for-input-string-sfqdxv36-or-a-similar-error} Set `ip-forwarding` in your BungeeCord to `true`. -## "Please connect through the official Geyser" disconnect message +## "Please connect through the official Geyser" disconnect message {#please-connect-through-the-official-geyser-disconnect-message} Ensure that Floodgate and Geyser are both up-to-date. -## Prefix is not changing on the server after changing it in the config. +## Prefix is not changing on the server after changing it in the config. {#prefix-is-not-changing-on-the-server-after-changing-it-in-the-config} Between the Paper builds of 1.15.2-355 and 1.16.5-505, there was a bug where Floodgate players who had already connected to the server would not have their prefixed changed. Paper builds 1.16.5-506 and later fix this issue. Ensure that you removed the `usercache.json` file from the server root directory and restart your server. -## Issues with LuckPerms and prefixes +## Issues with LuckPerms and prefixes {#issues-with-luckperms-and-prefixes} Set `allow-invalid-usernames` to `true` in LuckPerms' config. -## Failed to verify username! (with Paper) +## Failed to verify username! (with Paper) {#failed-to-verify-username-with-paper} To completely mitigate this issue, disable `perform-username-validation` in the [unsupported settings of the `config/paper-global.yml` file](https://paper.readthedocs.io/en/latest/server/configuration.html#unsupported_settings) (`paper.yml` in the root server folder on servers below 1.19). Using Floodgate on the backend servers will also mitigate this issue. -## Error with Forge or Fabric Bukkit Hybrid +## Error with Forge or Fabric Bukkit Hybrid {#error-with-forge-or-fabric-bukkit-hybrid} At this time, there is no way to run Floodgate on servers that mix Forge and Bukkit or Fabric and Bukkit (For example: Magma, Mohist, and Cardboard/Bukkit4Fabric) - most hybrids do not support the complicated procedures we need to do in order to allow Bedrock players to connect (for the technically minded: these server softwares typically don't support NMS). If you wish to use Floodgate in combination with hybrid servers, we recommend putting these servers behind a BungeeCord or Velocity proxy, and running Floodgate on the proxy. -## After enabling global linking in offline mode, player data is not synced between Java and Bedrock players. +## After enabling global linking in offline mode, player data is not synced between Java and Bedrock players. {#after-enabling-global-linking-in-offline-mode-player-data-is-not-synced-between-java-and-bedrock-players} This occurs in offline mode because the UUID of the Java account linked to the Bedrock account does not match the online mode UUID returned by Floodgate's global linking server. diff --git a/docs/floodgate/linking.md b/docs/floodgate/linking.md index 5604d8a..2b59be3 100644 --- a/docs/floodgate/linking.md +++ b/docs/floodgate/linking.md @@ -2,7 +2,7 @@ title: Linking --- -## What is Global Linking? +## What is Global Linking? {#what-is-global-linking} Instructions and information about how to link can also be found here: [https://link.geysermc.org/](https://link.geysermc.org/) @@ -37,7 +37,7 @@ Once you saved the config and restarted your server you should be using Global L If you don't want to use Global Linking, you can disable `enable-global-linking` in the Floodgate config. -## Local Linking +## Local Linking {#local-linking} You can also set up a local linking database on your server. Local linking can work with Global Linking at the same time. Link entries in your local database will override entries in the Global Linking Server. Note that you only have to follow these steps on your proxy (BungeeCord or Velocity), if you have one. diff --git a/docs/floodgate/setup/proxy-servers.mdx b/docs/floodgate/setup/proxy-servers.mdx index c66a97c..91f4041 100644 --- a/docs/floodgate/setup/proxy-servers.mdx +++ b/docs/floodgate/setup/proxy-servers.mdx @@ -8,7 +8,7 @@ Additionally, it will display Bedrock edition skins properly. 3. Change `auth-type` in Geyser's config to `floodgate`. 4. Restart the server. -### Installing Floodgate on servers behind the proxy +### Installing Floodgate on servers behind the proxy {#installing-floodgate-on-servers-behind-the-proxy} This is only needed when you want to use the Floodgate API on your backend server(s) behind a proxy. diff --git a/docs/geyser/anticheat-compatibility.md b/docs/geyser/anticheat-compatibility.md index 4ff7273..8cd9d87 100644 --- a/docs/geyser/anticheat-compatibility.md +++ b/docs/geyser/anticheat-compatibility.md @@ -9,7 +9,7 @@ This is a community-compiled list and does not indicate any endorsement from Gey ::: -### AntiCheat compatibility reports +### AntiCheat compatibility reports {#anticheat-compatibility-reports} Full Compatibility (Checks Bedrock Players Accurately) diff --git a/docs/geyser/api.md b/docs/geyser/api.md index ceb0309..526f1cb 100644 --- a/docs/geyser/api.md +++ b/docs/geyser/api.md @@ -4,16 +4,16 @@ title: Geyser API Geyser has an API to extend what is possible with Geyser, and to allow you to interact with Geyser in your own plugins, mods, or extensions. -### Where can I use the Geyser API? +### Where can I use the Geyser API? {#where-can-i-use-the-geyser-api} You could use the Geyser API in: - A plugin for Paper/Spigot, Velocity, Waterfall/BungeeCord, etc. - A mod for Fabric or NeoForge - A Geyser Extension -### Accessing the Geyser API +### Accessing the Geyser API {#accessing-the-geyser-api} See [here](/geyser/getting-started-with-the-api) for how to include the Geyser API dependency in your project. -### Documentation +### Documentation {#documentation} The Geyser API offers events to subscribe to, or information on whether a player is joining through Geyser, and gives you the ability to enhance what is possible with Geyser (i.e. register custom items). (soon, blocks and entities too). @@ -24,7 +24,7 @@ It can be used easily in Geyser Extensions, see [here](/geyser/extensions) for d Note: To see full, detailed documentation, see the javadocs. -#### [GeyserApi](https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/GeyserApi.java): +#### [GeyserApi](https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/GeyserApi.java): {#geyserapi} The GeyserApi interface serves as a central access point to various functionalities provided by the Geyser API, providing methods to e.g. interact with player connections. It extends the [Base API](https://github.com/GeyserMC/api/blob/master/base/src/main/java/org/geysermc/api/GeyserApiBase.java) interface, which provides basic information about individual players. @@ -40,7 +40,7 @@ Most [API methods have a simple explanation](https://github.com/GeyserMC/Geyser/ Since the Geyser API extends the Base API that is shared across Floodgate and Geyser, you can also use the [methods from the Base API](https://github.com/GeyserMC/api/blob/master/base/src/main/java/org/geysermc/api/GeyserApiBase.java). -#### We'll highlight a few to get you started quickly: +#### We'll highlight a few to get you started quickly: {#well-highlight-a-few-to-get-you-started-quickly} `GeyserApi#isBedrockPlayer(UUID)` Used to check if the given UUID of an **online** player is a Bedrock player. @@ -60,38 +60,38 @@ Click [here](/geyser/forms/) to get more information about Forms. `GeyserApi#onlineConnectionsCount()` Used to get the amount of online Bedrock players. -### Short Overview of the Geyser API +### Short Overview of the Geyser API {#short-overview-of-the-geyser-api} -#### [Cumulus](https://github.com/GeyserMC/Cumulus/tree/master/src/main/java/org/geysermc/cumulus) +#### [Cumulus](https://github.com/GeyserMC/Cumulus/tree/master/src/main/java/org/geysermc/cumulus) {#cumulus} While technically not directly in the Geyser API, the Cumulus library is also provided by the Geyser API. It allows you to send Bedrock edition forms to players. See [Cumulus](/geyser/forms/) for more information. -#### [Events](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/event) +#### [Events](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/event) {#events} The event package contains all the events that Geyser fires. See [here](/geyser/events) for detailed information on how to listen to Geyser events. -#### [Command](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/command) +#### [Command](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/command) {#command} This package contains classes and interfaces related to commands in Geyser, which allows [Geyser Extensions](/geyser/extensions) to register custom commands. -#### [Entity](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/entity) +#### [Entity](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/entity) {#entity} The Entity package contains classes and interfaces related to entities in Geyser, like the GeyserPlayerEntity interface, which represents a player entity in Geyser. This interface extends the GeyserEntity interface, while providing additional functionality specifically for player entities, like currently, showing emotes. -#### [Item](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/item) +#### [Item](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/item) {#item} The item package contains classes and interfaces related to items in Geyser. You can create custom items and register them using the Geyser API. See [here](/geyser/custom-items) for detailed information on how to register custom items. -#### [Block](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/block) +#### [Block](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/block) {#block} The block package contains classes and interfaces related to blocks in Geyser. You can create custom blocks using this package, and register them in using the [GeyserDefineCustomBlocksEvent](https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/event/lifecycle/GeyserDefineCustomBlocksEvent.java). See [here](/geyser/custom-blocks) for detailed information. -#### [Network](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/network) +#### [Network](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/network) {#network} The network package contains basic information about the remote server via the [RemoteServer](https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/network/RemoteServer.java) interface, such as the server's IP address and port, and the protocol version of the remote server. Or the auth type. You can also get the port/IP that Geyser listens to via the [BedrockListener](https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/network/BedrockListener.java) interface. -#### [Pack](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/pack) +#### [Pack](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/pack) {#pack} The pack package contains classes and interfaces related to resource packs in Geyser. You can create custom resource packs and send them to individual sessions before they log in using the [SessionLoadResourcePacksEvent](https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/event/bedrock/SessionLoadResourcePacksEvent.java). If you wish to send a resource pack to all sessions, you can use the [GeyserLoadResourcePacksEvent](https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/event/lifecycle/GeyserLoadResourcePacksEvent.java). @@ -101,6 +101,6 @@ This allows you to load a Bedrock resource pack from a file path: ResourcePack pack = ResourcePack.create(PackCodec.path(path)); ``` -#### [Extension](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/extension) +#### [Extension](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/extension) {#extension} This package provides the necessary components to create and manage extensions. For a more detailed explanation of extensions, see [here](/geyser/extensions). diff --git a/docs/geyser/commands.md b/docs/geyser/commands.md index c909e25..efd60d1 100644 --- a/docs/geyser/commands.md +++ b/docs/geyser/commands.md @@ -13,7 +13,7 @@ on the proxy server to assign permissions to players. Assigning permissions on t ::: -## Geyser commands & their permissions +## Geyser commands & their permissions {#geyser-commands--their-permissions} | Command | Permission | Description | |:--------------------------------------:|:------------------------------:|:-------------------------------------------------------------------:| @@ -29,7 +29,7 @@ on the proxy server to assign permissions to players. Assigning permissions on t | `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) | -## Other Permissions +## Other Permissions {#other-permissions} Besides commands, there are other permissions that are used to guard specific Geyser features. @@ -37,6 +37,6 @@ Besides commands, there are other permissions that are used to guard specific Ge |--------------------------|------------------------------------------------------------------------------------------------------------| | `geyser.settings.server` | Allow players to use the [game settings menu](/img/wiki/game_menu.png). (Also requires player to have op.) | -## Floodgate commands and permissions +## Floodgate commands and permissions {#floodgate-commands-and-permissions} For Floodgate commands, see [here](/floodgate/commands/). diff --git a/docs/geyser/common-issues.md b/docs/geyser/common-issues.md index 25493ad..6ef4e70 100644 --- a/docs/geyser/common-issues.md +++ b/docs/geyser/common-issues.md @@ -15,7 +15,7 @@ For Floodgate issues see: [Floodgate: Known Issues/Caveats](/floodgate/issues/). * If you don't use a reverse proxy such as TCPShield make sure that `enable-proxy-protocol` is set to false. To fix "Unable to connect to world" with no console errors, see [here](/geyser/fixing-unable-to-connect-to-world/). -## If the server doesn't show up in the friends list +## If the server doesn't show up in the friends list {#if-the-server-doesnt-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](/geyser/using-geyser-with-consoles/). @@ -31,14 +31,14 @@ See [here](/geyser/fixing-unable-to-connect-to-world/) for fixing "Unable to Con ::: -### `java.net.BindException: Address already in use: bind` on startup. +### `java.net.BindException: Address already in use: bind` on startup. {#javanetbindexception-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. -### [...]` has been compiled by a more recent version of the Java Runtime (class file version 60.0)` +### [...]` has been compiled by a more recent version of the Java Runtime (class file version 60.0)` {#-has-been-compiled-by-a-more-recent-version-of-the-java-runtime-class-file-version-600} See this link for updating to Java 17: https://paper.readthedocs.io/en/latest/java-update/index.html. -### Hosting provider will not immediately open up UDP. +### Hosting provider will not immediately open up UDP. {#hosting-provider-will-not-immediately-open-up-udp} These steps only apply for the standalone version of Geyser. This usually has something to do on your host's end. Most commonly, it's because they do not open up ports over the UDP protocol, which is what Minecraft: Bedrock Edition uses, opposed to Minecraft: Java Edition using TCP. @@ -58,7 +58,7 @@ This option will most likely not help if you are getting "Unable to Connect to W ***If you are using a plugin version:*** in your Geyser config, set your remote address to `127.0.0.1`. If that does not work, check your startup log for a message about Docker, and use that address in the remote address -### Cannot reply to EncryptionRequestPacket without profile and access token +### Cannot reply to EncryptionRequestPacket without profile and access token {#cannot-reply-to-encryptionrequestpacket-without-profile-and-access-token} There are two causes of this message: @@ -70,21 +70,21 @@ This message can occur with a Floodgate setup. Usually, it means that a misconfi If you have your configuration set up like this, put simply, it won't work. If authentication for the Java server is set to online, it is expected Geyser is configured the same way. The server requires a valid Minecraft: Java Edition account, and if you aren't logging into one with Geyser, then you will be unable to join the server. If your configuration is set up properly and you're still getting this issue, it could be that your credentials are invalid. -### Connection Refused: \ +### Connection Refused: \ {#connection-refused-insert-ip-andor-domain} Connection Refused usually means that a Java server could not be found on that port, or the server denied access to the connection on a network level. The latter can happen with anti-DDOS plugins such as TCPShield, but otherwise ensure that the server you're trying to connect to is spelled correctly in the config, is up and is port forwarded correctly. If you're updating from an old build of Geyser, set your remote address to `auto` and try again. -### Floodgate Misconfiguration +### Floodgate Misconfiguration {#floodgate-misconfiguration} See [this page](/floodgate/setup/) for more information. -### Missing profile key. This server requires secure profiles. +### Missing profile key. This server requires secure profiles. {#missing-profile-key-this-server-requires-secure-profiles} See [this page](/geyser/secure-chat/). -### Mojang Resetting Account Credentials +### Mojang Resetting Account Credentials {#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. # "Invalid IP address!" from Bedrock @@ -129,5 +129,5 @@ And so on. If your players can't connect from the lobby to another backend server, check console. -### Plugins that can cause issues +### Plugins that can cause issues {#plugins-that-can-cause-issues} * `HamsterAPI` diff --git a/docs/geyser/creating-a-startup-script.md b/docs/geyser/creating-a-startup-script.md index f4dc0fd..d283270 100644 --- a/docs/geyser/creating-a-startup-script.md +++ b/docs/geyser/creating-a-startup-script.md @@ -12,7 +12,7 @@ In order for this to work, you MUST have Java 17 (or higher) installed! Once you have downloaded and placed Geyser into its own folder, you will need to create a startup script; similar to how you'd run a Bukkit/Spigot/Paper server. -### Windows +### Windows {#windows} * Create a new text file in the same location as the Geyser-Standalone jar file, and call it `run.bat`. Open this with a text editor (preferably Notepad++), and insert the text below: ```batch title="run.bat" @@ -23,7 +23,7 @@ pause * Double-click the **run.bat**, and Geyser should start up. Geyser will generate all the needed files. -### macOS +### macOS {#macos} * Create a text file called **run.command**, and open it with a text editor such as TextEdit or TextMate. Type the text below into the **run.command** file: ```sh title="run.command" @@ -35,7 +35,7 @@ java -Xms1024M -jar Geyser-Standalone.jar * Open Terminal, and type in `chmod a+x` **(Do NOT press return!)**, and drag your *run.command* file into the Terminal. * Press return on your keyboard, and Geyser will start up. Geyser will generate all the needed files. -### Linux +### Linux {#linux} * Create a file called *run.sh*, and open it with a text editor. Type the text below into your `run.sh` file: ```sh title="run.sh" diff --git a/docs/geyser/current-limitations.md b/docs/geyser/current-limitations.md index 36b69b2..3f0f2d1 100644 --- a/docs/geyser/current-limitations.md +++ b/docs/geyser/current-limitations.md @@ -7,7 +7,7 @@ title: Current Limitations With Geyser being a protocol translator between two different games with two different codebases, there are a handful of limitations that Geyser is unfortunately unable to handle. Despite Minecraft Bedrock and Java being quite close in comparison, there are some vast differences in many areas. -## Unfixable +## Unfixable {#unfixable} The following things cannot be fixed without changes to Bedrock or the Java protocol in general. As of now, they are not fixable in Geyser. @@ -32,7 +32,7 @@ The following things cannot be fixed without changes to Bedrock or the Java prot - Saddled camels unmoveable/unrideable on bedrock. - Bedrock edition players cannot see the changes to fence block states made by the Java Debug Stick. -## Fixable With GeyserOptionalPack +## Fixable With GeyserOptionalPack {#fixable-with-geyseroptionalpack} The following changes **are supported** with the [GeyserOptionalPack](/other/geyseroptionalpack/), which is a Bedrock resource pack you can install for additional functionality for features Bedrock does not natively support: - Custom armor stand poses diff --git a/docs/geyser/custom-blocks.md b/docs/geyser/custom-blocks.md index 29af0c2..8e12a18 100644 --- a/docs/geyser/custom-blocks.md +++ b/docs/geyser/custom-blocks.md @@ -8,7 +8,7 @@ To setup custom blocks in geyser, you have to choose how you are going to regist It should be noted that blocks and their associated components are not very stable. Mojang tends to make changes to these much more often than they do for items. This means that any components Geyser allows you to register are liable to break in future versions of Bedrock. -## Enabling custom blocks +## Enabling custom blocks {#enabling-custom-blocks} Before beginning, ensure that `add-non-bedrock-items` is set to `true` in your `config.yml` file. @@ -21,13 +21,13 @@ Before beginning, ensure that `add-non-bedrock-items` is set to `true` in your ` add-non-bedrock-items: true ``` -## JSON mappings +## JSON mappings {#json-mappings} The JSON mappings use a similar structure to that of behavior packs registering blocks. The equivalent components are listed in the [Minecraft: Bedrock Edition Creator Documentation](https://learn.microsoft.com/en-us/minecraft/creator/reference/content/blockreference/examples/blockcomponents/blockcomponentslist). Custom mappings files that register blocks or items should be placed in the `custom_mappings` folder. This folder is created when you start your server. It is located in the same folder as the `Geyser-Standalone.jar` file for standalone and inside your Geyser data folder for a plugin. If you do not have this folder, ensure you are on the latest version of Geyser. -### Example mappings file +### Example mappings file {#example-mappings-file} ```json { @@ -80,7 +80,7 @@ Custom mappings files that register blocks or items should be placed in the `cus } ``` -### Schema +### Schema {#schema} The following details the schema for the mappings file. Only the `name` field is strictly required. All other fields are optional. @@ -317,7 +317,7 @@ The following details the schema for the mappings file. Only the `name` field is -## Geyser extensions +## Geyser extensions {#geyser-extensions} In this example, we will create a custom block that overrides the vanilla redstone dot. This block will be placed on top of a block and will emit a visible redstone signal when powered. diff --git a/docs/geyser/custom-items.md b/docs/geyser/custom-items.md index 27682df..dd81e70 100644 --- a/docs/geyser/custom-items.md +++ b/docs/geyser/custom-items.md @@ -6,7 +6,7 @@ title: Custom items with Geyser To setup custom items in geyser, you have to choose how you are going to register your items. The easiest is [using a json file](#json-mappings) but you can also [use a Geyser extension](#geyser-extensions). -## JSON mappings +## JSON mappings {#json-mappings} 1. Start your server, and you should have a folder called `custom_mappings` that is created. That would be with the folder of `Geyser.jar` file for standalone and inside your Geyser data folder for a plugin. 2. Create a `.json` file, it can be any name you like and as many files as you like. You don't need to make one file per item. Here is the structure of the file: @@ -73,9 +73,9 @@ To setup custom items in geyser, you have to choose how you are going to registe } ``` -## Geyser extensions +## Geyser extensions {#geyser-extensions} -### Extending a vanilla item +### Extending a vanilla item {#extending-a-vanilla-item} 1. Create your custom item options or registrations, to which you can add any of the following. They can be stacked, so that all of the specified types need to match, but you **do NOT need all of them.** ```java @@ -108,7 +108,7 @@ public void onGeyserPreInitializeEvent(GeyserDefineCustomItemsEvent event) { } ``` -### Non vanilla (modded) items with Geyser extensions (for example to use with Fabric) +### Non vanilla (modded) items with Geyser extensions (for example to use with Fabric) {#non-vanilla-modded-items-with-geyser-extensions-for-example-to-use-with-fabric} 1. Create your item data: ```java @@ -126,7 +126,7 @@ public void onGeyserDefineCustomItemsEvent(GeyserDefineCustomItemsEvent event) { } ``` -## Resource pack +## Resource pack {#resource-pack} 1. Setup a basic bedrock resource pack. If you need help, you can find it [here](https://wiki.bedrock.dev/guide/project-setup.html#rp-manifest). 2. Make a `textures` folder. diff --git a/docs/geyser/custom-skulls.md b/docs/geyser/custom-skulls.md index b87254b..73dc11a 100644 --- a/docs/geyser/custom-skulls.md +++ b/docs/geyser/custom-skulls.md @@ -8,7 +8,7 @@ Unlike Java Edition, Bedrock does not have native support for custom skull items To setup custom skulls in geyser, you have to choose how you are going to register your blocks. The easiest is [using custom-skulls.yml](#custom-skullsyml), but you can also [use a Geyser extension](#geyser-extensions). -## Enabling custom skulls +## Enabling custom skulls {#enabling-custom-skulls} To enable custom skulls, you must set `add-non-bedrock-items` to `true` in the `config.yml` file. This will enable the generation of the custom resource pack and the translation of custom skulls to custom blocks. You can then add custom skulls to the `custom-skulls.yml` file. @@ -21,7 +21,7 @@ To enable custom skulls, you must set `add-non-bedrock-items` to `true` in the ` add-non-bedrock-items: true ``` -## custom-skulls.yml +## custom-skulls.yml {#custom-skullsyml} The configuration file `custom-skulls.yml` is present in Geyser's configuration folder and is laid out as follows: @@ -59,15 +59,15 @@ skin-hashes: To add a skull, you need to choose any of the four methods, and add a new entry. The following sections will explain each method: -### Player usernames +### Player usernames {#player-usernames} Skulls can be registered in this section via player usernames. These will be updated when Geyser starts. As a result, they may change if the player's username or skin changes. -### Player UUIDs +### Player UUIDs {#player-uuids} Skulls can be registered in this section via player UUIDs. These will be updated when Geyser starts. As a result, they may change if skin changes. -### Player profiles +### Player profiles {#player-profiles} Skulls can be registered in this section via the texture string found in the NBT of custom player heads. Unless the value is changed manually, these will not be updated when Geyser starts. As a result, they will not change if the player's username or skin changes. The data is simply base64 encoded JSON. For instance, the example given in the config decodes as follows: @@ -94,13 +94,13 @@ If on a paper server, this data can be obtained for a skull by holding the item [05:58:07 INFO]: minecraft:player_head{display: {Name: '{"text":"Test"}'}, SkullOwner: {Properties: {textures: [{Value: "ewogICJ0aW1lc3RhbXAiIDogMTY1NzMyMjIzOTgzMywKICAicHJvZmlsZUlkIiA6ICJjZGRiZTUyMGQwNDM0YThiYTFjYzlmYzkyZmRlMmJjZiIsCiAgInByb2ZpbGVOYW1lIiA6ICJkYXZjaG9vIiwKICAidGV4dHVyZXMiIDogewogICAgIlNLSU4iIDogewogICAgICAidXJsIiA6ICJodHRwOi8vdGV4dHVyZXMubWluZWNyYWZ0Lm5ldC90ZXh0dXJlL2E5MDc5MGM1N2UxODFlZDEzYWRlZDE0YzQ3ZWUyZjdjOGRlMzUzM2UwMTdiYTk1N2FmN2JkZjlkZjFiZGU5NGYiLAogICAgICAibWV0YWRhdGEiIDogewogICAgICAgICJtb2RlbCIgOiAic2xpbSIKICAgICAgfQogICAgfQogIH0KfQ"}]}, Id: [I; -229048314, -553040501, -1407961158, 465313087]}} ``` -### Skin Hashes +### Skin Hashes {#skin-hashes} Skulls can be registered in this section via the hash of the skin on Minecraft's skin server. This is found at the end of the URL. For example, in the URL `http://textures.minecraft.net/texture/a90790c57e181ed13aded14c47ee2f7c8de3533e017ba957af7bdf9df1bde94f` the hash is `a90790c57e181ed13aded14c47ee2f7c8de3533e017ba957af7bdf9df1bde94f`.Unless the value is changed manually, these will not be updated when Geyser starts. As a result, they will not change if the player's username or skin changes. This can be obtained by decoding the base64 data obtained from a player profile. -## Geyser extensions +## Geyser extensions {#geyser-extensions} In this example, we will register a custom skull from a player profile. We will use the player profile from the example above. @@ -135,6 +135,6 @@ public class RegisterCustomSkull implements Extension { } ``` -## Scraping custom skulls from a world +## Scraping custom skulls from a world {#scraping-custom-skulls-from-a-world} Custom skulls can be extracted from an existing world for easy implementation via mappings or API using the tool [HeadExtractor](https://github.com/davchoo/HeadExtractor) made by Amberichu. See the linked repository for usage instructions. diff --git a/docs/geyser/events.md b/docs/geyser/events.md index 9435625..c52eb2f 100644 --- a/docs/geyser/events.md +++ b/docs/geyser/events.md @@ -7,7 +7,7 @@ Geyser has a powerful event system that allows you to listen to events that are Full documentation can be found [here](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/event). -## Event Categories +## Event Categories {#event-categories} To use events in a Spigot/Paper plugin or a Fabric mod, you need to register the Geyser Event Bus as a listener and then subscribe to the events you want to listen to. Extensions can use the @Subscribe annotation. @@ -21,7 +21,7 @@ Events are categorized into the following categories: To see all the events in the respective categories, click on the links above. -## Usage Examples: +## Usage Examples: {#usage-examples} Each method that you want to subscribe to an event needs to be annotated with the @Subscribe annotation (from the GeyserMC events package). ```java @@ -92,7 +92,7 @@ public class ExamplePlugin extends JavaPlugin implements EventRegistrar { GeyserApi.api().eventBus().subscribe(this, GeyserEvent.class, this::yourMethod); ``` -## Event Priority +## Event Priority {#event-priority} Events can have a priority, which is used to determine the order in which the listeners are called. The default priority is NORMAL. To (optionally) set the priority of your event listener, you can add the priority to the `@Subscribe` annotation: ```java diff --git a/docs/geyser/extensions.md b/docs/geyser/extensions.md index c51769c..54ffe30 100644 --- a/docs/geyser/extensions.md +++ b/docs/geyser/extensions.md @@ -8,7 +8,7 @@ Geyser Extensions are the equivalent of "plugins", but specifically for the Geys This brings the advantage of them being platform-agnostic, meaning that you won't have to worry about supporting all platforms individually. Additionally, they will be, by design, only applied for Bedrock players joining via Geyser. -## What can Geyser Extensions do? +## What can Geyser Extensions do? {#what-can-geyser-extensions-do} Extensions can fully utilize the Geyser API to add additional functionality to Geyser. See [Geyser API docs](/geyser/api/) for info on what is currently possible. @@ -22,7 +22,7 @@ To name a few examples: The underlying Geyser API is steadily expanding, creating more and more opportunities. -## Which Geyser Extensions exist? +## Which Geyser Extensions exist? {#which-geyser-extensions-exist} At the moment, extensions are still a new system, so there is only a small list of known extensions for Geyser. However, new extensions are always being created! @@ -30,12 +30,12 @@ However, new extensions are always being created! There is an [official list](https://github.com/GeyserMC/GeyserExtensionList) of available extensions you can check out. If you have an extension you'd like to see on this list, feel free to open a PR! -## Installing Extensions +## Installing Extensions {#installing-extensions} To install an extension, simply put the extension .jar file into Geyser's 'extensions' folder. Then, restart Geyser (or the server Geyser runs on). -## Creating Geyser Extensions +## Creating Geyser Extensions {#creating-geyser-extensions} The easiest way to create an extension would be utilizing [this official template](https://github.com/GeyserMC/GeyserExampleExtension/). Simply create a new repository from the template, customize the `extension.yml` & `settings.gradle` files, and get started making the extension. @@ -58,7 +58,7 @@ Explanations for the individual fields: - api: The Base API version your extension targets. - authors: The author(s) of the extension. To add more than one entry, separate entries with a comma. -## Creating the main class +## Creating the main class {#creating-the-main-class} The main class, the entrypoint for the extension, needs to [implement the 'Extension' interface provided by Geyser](https://github.com/GeyserMC/GeyserExampleExtension/blob/master/src/main/java/org/geyser/extension/exampleid/ExampleExtension.java#L12). That way, Geyser recognizes the extension, and gives you access to important methods - such as 'logger()', to get your extensions logger. @@ -84,7 +84,7 @@ and register them in the event. You can find an example for custom items [here]( To build your extension, run the Gradle build task, and install the extension. -## Creating commands with Geyser Extensions +## Creating commands with Geyser Extensions {#creating-commands-with-geyser-extensions} To create a command, you would need to use the "Commands" package in the Geyser API. Brief rundown: - [Command.java](https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/command/Command.java) This interface represents a command in Geyser - to make one, you can use the CommandBuilder. You can register it with the @@ -126,12 +126,12 @@ Here, it would send "Hello World" to the source that ran the command. Since we also set aliases, you could also run `/exampleid example` or `/exampleid ex` for the same command. To provide args, simple run `/exampleid examplecommand [args]` - replacing [args] with the arguments you want to pass to the command. -## Listening to Events +## Listening to Events {#listening-to-events} See [here](/geyser/events) for documentation. You do not need to register the event listener, Geyser will do that for you. --- -## Facing troubles with extensions? +## Facing troubles with extensions? {#facing-troubles-with-extensions} - Make sure you are using the latest version of Geyser - older versions might not have the latest API changes. - Add debug prints. diff --git a/docs/geyser/faq.mdx b/docs/geyser/faq.mdx index b26b3fe..11f5519 100644 --- a/docs/geyser/faq.mdx +++ b/docs/geyser/faq.mdx @@ -5,7 +5,7 @@ title: Frequently Asked Questions import { Questions, Q, A } from "../../src/components/Questions"; import { Versions } from '../../src/components/Versions' -### General Questions +### General Questions {#general-questions} Here you can find answers to frequently asked questions about Geyser - if you have a question that isn't answered here, feel free to ask in our [Discord](https://discord.gg/GeyserMC)! @@ -246,7 +246,7 @@ Here you can find answers to frequently asked questions about Geyser - if you ha -### Additional Questions +### Additional Questions {#additional-questions} These additional frequently asked questions are not related to Geyser gameplay. diff --git a/docs/geyser/fixing-unable-to-connect-to-world.md b/docs/geyser/fixing-unable-to-connect-to-world.md index 048f18c..c0f6186 100644 --- a/docs/geyser/fixing-unable-to-connect-to-world.md +++ b/docs/geyser/fixing-unable-to-connect-to-world.md @@ -18,25 +18,25 @@ If you are not using a Minecraft server hosting provider, carry on. geyser connectiontest <ip>:<port>, and see what it suggests to try. -### Java Edition players can't connect! +### Java Edition players can't connect! {#java-edition-players-cant-connect} 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. -### Connecting fails after updating Geyser +### Connecting fails after updating Geyser {#connecting-fails-after-updating-geyser} 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. Incase you reset your configuration file, check out the [setup guide](/geyser/setup/) again. -### There are errors in my console! +### There are errors in my console! {#there-are-errors-in-my-console} Please read through the [common issues page](/geyser/common-issues/). If there is another error not documented there, join us on our [Discord](https://discord.geysermc.org). -### Try restarting the server and game +### Try restarting the server and game {#try-restarting-the-server-and-game} Especially on mobile devices, sometimes just restarting Minecraft fixes the issue. -### Is it the server or the client? +### Is it the server or the client? {#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. Additionally, check if you can see a connection attempt in the server console. If you can't, it's likely a network issue. @@ -45,38 +45,38 @@ For console players specifically: If only they can't join, while other Bedrock p # General troubleshooting steps -### Ensure you're connecting on the right IP and Port +### Ensure you're connecting on the right IP and Port {#ensure-youre-connecting-on-the-right-ip-and-port} You should be connecting with the Java server IP and the Bedrock port (set in the Geyser config). If you port forwarded 19132, for example, you should specify port 19132 when connecting from Bedrock. -### I'm using a hosting provider or VPS! +### I'm using a hosting provider or VPS! {#im-using-a-hosting-provider-or-vps} Please read [this page on supported hosting providers](/geyser/supported-hosting-providers/) to see if there are extra configuration steps required for your hosting or server provider. Some VPS/KVM providers may require further setup, such as OVH, SoYouStart, and Oracle Cloud. Please read this [note](/geyser/port-forwarding/#issues-with-specific-vpskvm-providers) for more information. -### Issues using Docker or Pterodactyl +### Issues using Docker or Pterodactyl {#issues-using-docker-or-pterodactyl} Make sure you assign the port to pterodactyl, and on docker, to the docker compose file. See our [port-forwarding](/geyser/port-forwarding/#using-docker-or-pterodactyl) page for fixes. # Port forwarding issues Your server does need to be port forwarded to allow connections from outside the local network. See [our port-forwarding guide](/geyser/port-forwarding/) for more information. -### Using TCP in DNS options/port forwarding instead of UDP +### Using TCP in DNS options/port forwarding instead of UDP {#using-tcp-in-dns-optionsport-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 +### Bedrock port is less than 10000 {#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 +### 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 {#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} 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 for OVH/SoYouStart can be found [here](/geyser/port-forwarding/#issues-with-specific-vpskvm-providers). -### Changing the `bedrock` `address` in the Geyser config. +### Changing the `bedrock` `address` in the Geyser config. {#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 - for example, when Windows has multiple network adapters (check by running `ipconfig` in cmd), @@ -84,13 +84,13 @@ it can help to set the `address` to the local IP of the adapter you want to use. # Using a hosting provider or other location -### Pterodactyl +### Pterodactyl {#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 +### Can only connect from the same computer and not anywhere else {#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. @@ -100,7 +100,7 @@ Minecraft offers a vanilla Bedrock server [here](https://www.minecraft.net/downl # Using Geyser on the same computer -### Windows 10/11 +### Windows 10/11 {#windows-1011} _This only affects people trying to join Geyser from Windows 10/11 Edition with Geyser hosted on the same computer._ diff --git a/docs/geyser/forms.md b/docs/geyser/forms.md index 62ba37b..0672acd 100644 --- a/docs/geyser/forms.md +++ b/docs/geyser/forms.md @@ -17,7 +17,7 @@ We'll discuss them one by one starting with the easiest and ending with the leas After that, you get an overview of every single component. Then we'll talk about sending the form, receiving a response and doing advanced stuff. -## ModalForm +## ModalForm {#modalform} While this is the easiest form type it's also the least customisable. You have a title, description (content) and two buttons. @@ -34,7 +34,7 @@ ModalForm.builder() .button2("Button 2") ``` -## SimpleForm +## SimpleForm {#simpleform} While this one is less easy than ModalForm is, it also has more customizability. It's still limited to a title, content and buttons, but these buttons can also have images and do not have a minimum and maximum of two. @@ -51,7 +51,7 @@ SimpleForm.builder() .button("Button with path image", FormImage.Type.PATH, "textures/i/glyph_world_template.png") ``` -## CustomForm +## CustomForm {#customform} While the CustomForm is the last one on our list (and thus the least easy one), it also has the greatest customizability. This form exists of a title, content and a list of different components e.g. label, slider and input. @@ -70,7 +70,7 @@ CustomForm.builder() .slider("Text", 0, 10, 1, 5) ``` -## Sending a form +## Sending a form {#sending-a-form} After you decided which form type you want to use and finished filling in the actual content, it's time to send the Form to the Bedrock player. You can do that by calling the API and send a form to the player's UUID and the form: @@ -93,7 +93,7 @@ player.sendForm( ); ``` -## Receiving a response from the client +## Receiving a response from the client {#receiving-a-response-from-the-client} It's nice and all that we can send forms to a client, but we also want to be able to get a response from a client and being able to handle them. We can do that using one (or multiple) result handers. The most used result handlers are: `validResultHandler(BiConsumer | Consumer)`, `invalidResultHandler`, `closedResultHandler` and `closedOrInvalidResultHandler`. @@ -108,7 +108,7 @@ CustomForm.builder() .validResultHandler(response -> session.authenticate(response.next(), response.next()))); ``` -## Advanced stuff +## Advanced stuff {#advanced-stuff} The FormBuilder also has support for translating the data used in the builder. To add a translator, you can use the `translator(BiFunction)` or the `translator(BiFunction, String)` method: diff --git a/docs/geyser/getting-started-with-the-api.md b/docs/geyser/getting-started-with-the-api.md index 38db495..f28a4fc 100644 --- a/docs/geyser/getting-started-with-the-api.md +++ b/docs/geyser/getting-started-with-the-api.md @@ -22,7 +22,7 @@ repositories { } ``` -## Using Geyser +## Using Geyser {#using-geyser} Add Geyser's API codebase as a dependency: @@ -55,7 +55,7 @@ GeyserConnection connection = GeyserApi.api().connectionByUuid(uuid); For more information on the Geyser API, see [here](/geyser/api/). -## Using Floodgate +## Using Floodgate {#using-floodgate} 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: diff --git a/docs/geyser/geyser-command-line-arguments-and-system-properties.md b/docs/geyser/geyser-command-line-arguments-and-system-properties.md index 1084cfa..4328b9d 100644 --- a/docs/geyser/geyser-command-line-arguments-and-system-properties.md +++ b/docs/geyser/geyser-command-line-arguments-and-system-properties.md @@ -7,7 +7,7 @@ title: Geyser Command Line Arguments and System Properties Geyser offers a few command line arguments/system properties to allow you to configure Geyser without editing the config files. Additionally, you can suppress some warnings that may be printed to the console. -## Configuration system properties +## Configuration system properties {#configuration-system-properties} You can set Geyser to automatically bind to a specific address and port by using the following command line arguments. This is primarily aimed at server hosting providers to automatically configure servers for users. @@ -27,7 +27,7 @@ The Geyser specific properties are prioritized over the plugin properties! - ```server``` means to match the bind address of the TCP server - any other string will be used as-is for the bind address. -## Disabling warnings and advanced configuration +## Disabling warnings and advanced configuration {#disabling-warnings-and-advanced-configuration} You may disable some warnings that may be printed to the console by using the following command line arguments: :::caution @@ -55,17 +55,17 @@ Disabling Geyser warnings from being logged will not fix the real issue! Only di - Allows you to turn off suggestions for teams in the scoreboard command. This is enabled by default, disabling this can help with performance if there are a lot of teams defined. Setting "command-suggestions" to false in the config will also disable this. -## Geyser-Standalone Specific Options +## Geyser-Standalone Specific Options {#geyser-standalone-specific-options} -### `--config [file]` +### `--config [file]` {#--config-file} - **Alias: `-c`** - Points to an alternative config file to use. -### `--gui` / `--nogui` +### `--gui` / `--nogui` {#--gui----nogui} - **Alias: `gui` / `nogui`**: - Forces GUI or non-GUI usage, depending on context. -## Overriding specific config values +## Overriding specific config values {#overriding-specific-config-values} Overriding a standard config option (e.g. `command-suggestions`): `--command-suggestions=false` diff --git a/docs/geyser/global-api.md b/docs/geyser/global-api.md index 8cd32a4..64aca7b 100644 --- a/docs/geyser/global-api.md +++ b/docs/geyser/global-api.md @@ -13,7 +13,7 @@ As a user of the API, you can get various info about Geyser (or specifically, Fl See the [Global API docs](https://api.geysermc.org/docs) for more info, and detailed usage. -## Examples +## Examples {#examples} Here are a few examples of how you could use the Global API. diff --git a/docs/geyser/playit-gg.md b/docs/geyser/playit-gg.md index 6ac9e69..4140f73 100644 --- a/docs/geyser/playit-gg.md +++ b/docs/geyser/playit-gg.md @@ -2,7 +2,7 @@ title: playit.gg Setup --- -## Prerequisites +## Prerequisites {#prerequisites} :::info You must be able to connect to your Geyser instance locally! @@ -14,7 +14,7 @@ The playit.gg Minecraft server plugin does not support UDP tunnels. You will nee - If you already have playit.gg running & set up (for e.g. Minecraft Java edition), skip steps 1 and 2 and proceed with step 3. -## Setup +## Setup {#setup} 1. Head over to [playit.gg's website](https://playit.gg/) - download the program & run it. It will open the login site in the browser - create an account & sign in. Or, use a guest account. 2. Once logged in, make sure to connect the program + site, until step 4 is reached. This should happen automatically, if it does not, follow the instructions on the website and the playit.gg program console. ![img](/img/wiki/playit-gg/running.png) @@ -27,9 +27,9 @@ The playit.gg Minecraft server plugin does not support UDP tunnels. You will nee 6. 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 {#troubleshooting} -### I can't connect to my server! +### I can't connect to my server! {#i-cant-connect-to-my-server} * *Are there errors in your minecraft server console?* * *Make sure to check [here](/geyser/fixing-unable-to-connect-to-world/) beforehand.* * *If you changed the port that Geyser would bind to, you'll have to tell playit.gg to use that port instead! See step 5 here.* diff --git a/docs/geyser/port-forwarding.md b/docs/geyser/port-forwarding.md index c03edef..e27429c 100644 --- a/docs/geyser/port-forwarding.md +++ b/docs/geyser/port-forwarding.md @@ -12,7 +12,7 @@ If you are using a Minecraft server hosting provider (e.g. Aternos, or Nodecraft ::: -## Port forwarding on Linux/Windows/macOS +## 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. 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. @@ -26,7 +26,7 @@ As an alternative to port forwarding, you can use p ::: -### Windows +### 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) @@ -48,7 +48,7 @@ To open a port on Windows, you will need to open the port through the Windows Fi 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"), and click "Finish". ([Image](/img/wiki/port-forwarding/windows-7.png)) -### Linux +### 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 UDP, run the following command: @@ -72,15 +72,15 @@ Different Linux distributions, even different VPS providers ship and configure d 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 {#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 {#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 {#pterodactyl} Make sure to allocate the port to the server in the Pterodactyl panel's `Network` tab, additionally to port forwarding the port. See [here](https://pterodactyl.io/community/games/minecraft.html#allocations-in-the-panel) for more information. @@ -94,7 +94,7 @@ If you are not able to allocate ports in the Pterodactyl panel, you will need to ::: -### Docker +### 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 UDP to the docker-compose file. This is done by adding the following to the `ports` section: ```yaml ports: @@ -110,10 +110,10 @@ ports: Alternatively, add another port with the `-p 19132:19132/udp` flag to the docker run command. -## Issues with specific VPS/KVM providers +## 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 UDP ports by default/in most cases. -### OVH and SoYouStart +### OVH and SoYouStart {#ovh-and-soyoustart} By default, OVHs firewall requires a TCP ping to the server before allowing UDP connections. This is not possible with Geyser, so you will need to disable the firewall. :::caution @@ -141,7 +141,7 @@ SoYouStart (subsidiary of OVH): 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. -### Oracle Cloud/OCI +### 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. @@ -161,7 +161,7 @@ The steps below assume that you are using the default ports for the Java server - Set "IP Protocol" to UDP 8. Select "Add Ingress Rules" -#### Oracle Linux +#### Oracle Linux {#oracle-linux} Run the following commands to allow Minecraft and Geyser through the OS firewall: @@ -171,7 +171,7 @@ sudo firewall-cmd --add-port=19132/udp --permanent sudo firewall-cmd --reload ``` -#### Ubuntu +#### Ubuntu {#ubuntu} 1. Remove/comment out `-A INPUT -j REJECT --reject-with icmp-host-prohibited` in the `/etc/iptables/rules.v4` file. 2. Run the following command to fix `ufw`: diff --git a/docs/geyser/setup/self/standalone.mdx b/docs/geyser/setup/self/standalone.mdx index 161a57c..fca0806 100644 --- a/docs/geyser/setup/self/standalone.mdx +++ b/docs/geyser/setup/self/standalone.mdx @@ -6,7 +6,7 @@ You need to have Java 17 or higher installed to run Geyser. To run Geyser Standa Geyser-Standalone is NOT a plugin or mod! It is a standalone Java program that you would run separately to your Java Edition server. ::: -### General Setup & Configuration +### General Setup & Configuration {#general-setup--configuration} 1. Download Geyser Standalone from [here](https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/standalone). 2. Create a new folder for Geyser, and drop the jar in there. @@ -71,13 +71,13 @@ set it to either `online` for an online mode server, or `offline` for an offline 6. Verify whether connections from other networks are possible by running `geyser connectiontest :` in the console. -### Running Geyser-Standalone on Android +### Running Geyser-Standalone on Android {#running-geyser-standalone-on-android} :::caution 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. ::: -#### Termux (Android) +#### Termux (Android) {#termux-android} 1. Download and install [Termux](https://termux.com/) 2. Run `pkg install openjdk-17` 3. Run `wget https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/standalone` diff --git a/docs/geyser/supported-hosting-providers.mdx b/docs/geyser/supported-hosting-providers.mdx index 72090f8..bf87f04 100644 --- a/docs/geyser/supported-hosting-providers.mdx +++ b/docs/geyser/supported-hosting-providers.mdx @@ -28,14 +28,14 @@ The below information is for the plugin versions of Geyser unless otherwise spec ::: -## Built-in Geyser +## Built-in Geyser {#built-in-geyser} -## Support for Geyser +## Support for Geyser {#support-for-geyser} -## Does not support Geyser +## Does not support Geyser {#does-not-support-geyser} diff --git a/docs/geyser/translations.md b/docs/geyser/translations.md index 70a67bc..c5c3181 100644 --- a/docs/geyser/translations.md +++ b/docs/geyser/translations.md @@ -5,7 +5,7 @@ title: Supported Languages & Translations Geyser supports a wide variety of languages to offer the best experience for players all over the globe. When players join your server, Geyser will automatically detect their locale and provide the appropriate language. -## What languages are supported? +## What languages are supported? {#what-languages-are-supported} We aim to support any of the Bedrock languages - below is a list of them and all the language codes. | Name | Code | @@ -40,7 +40,7 @@ We aim to support any of the Bedrock languages - below is a list of them and all | Chinese Simplified (China) | zh_cn | | Chinese Traditional (Taiwan) | zh_tw | -### Additional languages +### Additional languages {#additional-languages} These languages are also supported, and are available in the Bedrock client using [the Translations for Minecraft resource pack](https://www.curseforge.com/minecraft-bedrock/addons/translations-for-minecraft). | Name | Code | @@ -50,12 +50,12 @@ These languages are also supported, and are available in the Bedrock client usin | Hebrew | he_il | | Hindi | hi_in | -## How can I help translate Geyser? +## How can I help translate Geyser? {#how-can-i-help-translate-geyser} We use [Crowdin](https://crowdin.com/project/geyser) to manage our translations. We also can add support for more languages, and please request them in the Discord server if you are willing to translate them. (Those can be enabled clientside via [https://www.curseforge.com/minecraft-bedrock/addons/translations-for-minecraft](https://www.curseforge.com/minecraft-bedrock/addons/translations-for-minecraft)) -## Adding custom Geyser translation overrides +## Adding custom Geyser translation overrides {#adding-custom-geyser-translation-overrides} These strings are only for places where Geyser uses them. To edit Minecraft Java translations, see the section below. To start, create a `languages` folder in the same directory as the Geyser config file. @@ -65,7 +65,7 @@ you can download these as a starting point, or you can just add the strings you You must restart Geyser for the changes to apply. -## Modifying/Adding Minecraft Java translations +## Modifying/Adding Minecraft Java translations {#modifyingadding-minecraft-java-translations} Geyser also downloads the Minecraft Java translations from Mojang's servers and sends them to Bedrock clients when needed. To modify these, open the `overrides` subfolder in the `locales` folder. Then, place your modified `.json` files in the `overrides` folder. You can also add custom Java translation strings to that json file. diff --git a/docs/geyser/understanding-the-config.md b/docs/geyser/understanding-the-config.md index 4b00fde..c85215d 100644 --- a/docs/geyser/understanding-the-config.md +++ b/docs/geyser/understanding-the-config.md @@ -4,7 +4,7 @@ title: Understanding the Config This page covers basic information about the Geyser config and what each option does. Though they are explained in the configuration itself, this explains what each option does in more detail. -## Bedrock Section +## Bedrock Section {#bedrock-section} The options for Geyser on the Bedrock-facing end. Mostly contains options for how Bedrock edition will see the server. **`address`**: The address of Geyser on the Bedrock end. In most all scenarios, this should not need to be changed, unless you want to limit what IPs can connect to your server. Leave it at 0.0.0.0 (default), unless otherwise instructed in the setup guide. @@ -25,7 +25,7 @@ The options for Geyser on the Bedrock-facing end. Mostly contains options for ho **`proxy-protocol-whitelisted-ips`**: Disabled by default, and only enable this if you use "enable-proxy-protocol". A list of allowed PROXY protocol speaking proxy IP addresses/subnets. Should really only be used when you are not able to use a proper firewall (usually true with shared hosting providers etc.). Keeping this list empty means there is no IP address whitelist. Both IP addresses and subnets are supported. -## Remote Section +## Remote Section {#remote-section} Options for the remote (Java) server. **`address`**: The address of the Minecraft: Java Edition server you want to join. By default, this value is `auto`. By keeping it as `auto`, the address, port, and Floodgate support will be automatically configured. In standalone, keeping this as `auto` sets the remote address to 127.0.0.1. @@ -43,7 +43,7 @@ Options for the remote (Java) server. **`forward-hostname`**: Forwards the hostname/IP address that the Bedrock client used to connect over to the Java server. This is designed to be used for forced hosts on proxies. -## General Options +## General Options {#general-options} General Geyser options that are mostly specific to Geyser itself. **`floodgate-key-file`**: Floodgate uses encryption to ensure use from authorised sources. This should point to the public key generated by Floodgate (BungeeCord, Spigot or Velocity). You can ignore this when not using Floodgate. If you're using a plugin version of Floodgate on the same server, the key will automatically be picked up from Floodgate.The key file path for Floodgate. Requires that you have [Floodgate](/floodgate/) installed and the `auth-type` set to `floodgate`. @@ -120,7 +120,7 @@ saved-user-logins: **`unusable-space-block`**: Which item to use to mark unavailable slots in a Bedrock player inventory. Examples of this are the 2x2 crafting grid while in creative, or custom inventory menus with sizes different from the usual 3x9. A barrier block is the default item (minecraft:barrier is therefore the default value). Takes any Minecraft Bedrock identifier, e.g. `minecraft:apple`. To set this to a custom item, you will need to add the `geyser_custom:` namespace. -## Metrics +## Metrics {#metrics} bStats is a stat tracker that is entirely anonymous and tracks only basic information about Geyser, such as how many people are online, how many servers are using Geyser, what OS is being used, etc. You can learn more about bStats [here](https://bstats.org/). To see Geyser Stats, see [here](https://bstats.org/plugin/server-implementation/GeyserMC/). @@ -128,7 +128,7 @@ bStats is a stat tracker that is entirely anonymous and tracks only basic inform **`uuid`**: UUID of the server, don't change this! -## Advanced Options +## Advanced Options {#advanced-options} **`scoreboard-packet-threshold`**: Geyser updates the Scoreboard after every Scoreboard packet, but when Geyser tries to handle a lot of scoreboard packets per second can cause serious lag. This option allows you to specify after how many Scoreboard packets per seconds the Scoreboard updates will be then limited to four updates per second. diff --git a/docs/geyser/using-geyser-with-consoles.md b/docs/geyser/using-geyser-with-consoles.md index 420be5c..c74cc8f 100644 --- a/docs/geyser/using-geyser-with-consoles.md +++ b/docs/geyser/using-geyser-with-consoles.md @@ -17,19 +17,19 @@ or the [Public GeyserConnect](https://www.geyserconnect.net) which allows connec ::: -## Xbox One +## Xbox One {#xbox-one} (Video linked below) [![Xbox One BedrockConnect](https://img.youtube.com/vi/g8mHvasVHMs/0.jpg)](https://www.youtube.com/watch?v=g8mHvasVHMs) -## Nintendo Switch +## Nintendo Switch {#nintendo-switch} (Video linked below) [![Nintendo Switch BedrockConnect](https://img.youtube.com/vi/zalT_oR1nPM/0.jpg)](https://www.youtube.com/watch?v=zalT_oR1nPM) -## PlayStation 4 +## PlayStation 4 {#playstation-4} 1. Go to your PS4 Home screen. 2. Go to Settings. @@ -42,16 +42,16 @@ or the [Public GeyserConnect](https://www.geyserconnect.net) which allows connec 9. Under DNS Settings, select Manual. 10. Enter the BedrockConnect IP for the preferred Primary DNS (Multiple options depending on region can be found on the [BedrockConnect GitHub Page](https://github.com/Pugmatt/BedrockConnect)) and something like Google or Cloudflare's IP for the Secondary DNS (8.8.8.8 or 1.1.1.1). -## Alternative Methods +## Alternative Methods {#alternative-methods} If you'd rather try emulating a LAN game on your network on another device, here's how you'd do that. *Note that this method will not work with the Nintendo Switch.* -### Using a PC +### Using a PC {#using-a-pc} If you have a PC, you can use [Phantom](https://github.com/jhead/phantom). -### Using an Android Device +### Using an Android Device {#using-an-android-device} If you have an Android device, you have several options: - ~~[Geyser Android app](https://github.com/GeyserMC/GeyserAndroid)~~ (Discontinued) - [BedrockTogether](https://play.google.com/store/apps/details?id=pl.extollite.bedrocktogetherapp) @@ -60,5 +60,5 @@ If you have an Android device, you have several options: - [MC Server Connector](https://play.google.com/store/apps/details?id=com.smokiem.mcserverconnector) - [Tempest](https://play.google.com/store/apps/details?id=net.ahmed.tempest) -### Using an iOS device +### Using an iOS device {#using-an-ios-device} If you have an iOS 14+ device, you can use [BedrockTogether](https://apps.apple.com/app/bedrocktogether/id1534593376). diff --git a/docs/other/community-geyser-projects.md b/docs/other/community-geyser-projects.md index 62449df..05c2934 100644 --- a/docs/other/community-geyser-projects.md +++ b/docs/other/community-geyser-projects.md @@ -13,7 +13,7 @@ Please check the linked pages for their support systems. If you wish to add your own plugin to this list, please reach out in the #development channel of Geyser first! -## BedrockFormShop +## BedrockFormShop {#bedrockformshop} A Spigot shop plugin that uses Bedrock forms. @@ -21,21 +21,21 @@ A Spigot shop plugin that uses Bedrock forms. Creator: [KejonaMC](https://github.com/kejonaMC) -## Bedrock Player Manager for Floodgate +## Bedrock Player Manager for Floodgate {#bedrock-player-manager-for-floodgate} A Spigot plugin that is able to run certain commands when a Bedrock player joins, or have Bedrock players able to bypass the anticheat, etc. * [Spigot page](https://www.spigotmc.org/resources/82278/) Creator: ofunny -## BedrockSkinUtility +## BedrockSkinUtility {#bedrockskinutility} This is a Fabric mod that allows you to view Bedrock capes from Java. * [GitHub](https://github.com/Camotoy/BedrockSkinUtility) Creator: [Camotoy](https://github.com/Camotoy) -## CreeperNation Skin API +## CreeperNation Skin API {#creepernation-skin-api} An SkinAPI that displays Java or Bedrock skins based on the UUID or username. @@ -43,14 +43,14 @@ An SkinAPI that displays Java or Bedrock skins based on the UUID or username. Creators: [creeperz653](https://github.com/creeperz653), [BlueTree242](https://github.com/BlueTree242) -## CrossplatForms +## CrossplatForms {#crossplatforms} A Spigot, BungeeCord, and Velocity plugin to create custom Bedrock Edition forms and inventory menus through configurations. * [Spigot page](https://www.spigotmc.org/resources/101043/) * [GitHub](https://github.com/kejonaMC/CrossplatForms) Creators: [Konicai](https://github.com/Konicai), [Jens](https://github.com/Jens-Co) -## CustomCommandPrefix +## CustomCommandPrefix {#customcommandprefix} A Spigot plugin that allows users to enter commands starting with `.`, to work around Xbox achievements being disabled. * [Spigot page](https://www.spigotmc.org/resources/87224/) @@ -58,7 +58,7 @@ A Spigot plugin that allows users to enter commands starting with `.`, to work a Creator: [Chew](https://github.com/Chew) -## FloodgatePlaceholders +## FloodgatePlaceholders {#floodgateplaceholders} Placeholders support for Floodgate. * [GitHub](https://github.com/rtm516/FloodgatePlaceholders) @@ -66,34 +66,34 @@ Placeholders support for Floodgate. Creator: [rtm516](https://github.com/rtm516) -## Floodgate-Skript +## Floodgate-Skript {#floodgate-skript} Floodgate support for Skript. * [GitHub](https://github.com/kejonaMC/floodgate-skript) Creator: [Camotoy](https://github.com/Camotoy) -## GeyserBlockJavaPlayers +## GeyserBlockJavaPlayers {#geyserblockjavaplayers} Plugin that blocks Java players from joining your Geyser server, so you can have a Bedrock only server that can use Spigot plugins. * [GitHub](https://github.com/kejonaMC/GeyserBlockJavaPlayers) Creator: [Camotoy](https://github.com/Camotoy) -## GeyserPreventServerSwitch +## GeyserPreventServerSwitch {#geyserpreventserverswitch} Prevent Bedrock players from joining specific sub-servers on a proxy * [GitHub](https://github.com/kejonaMC/GeyserPreventServerSwitch) Creator: [Camotoy](https://github.com/Camotoy) -## GeyserSkinManager +## GeyserSkinManager {#geyserskinmanager} Spigot and Bungee plugin to make Bedrock skins work; requires Geyser to be installed on the server. * [GitHub](https://github.com/Camotoy/GeyserSkinManager) Creator: [Camotoy](https://github.com/Camotoy) -## GeyserUpdater +## GeyserUpdater {#geyserupdater} This is a Spigot/BungeeCord/Velocity plugin that can be used to automatically update Geyser. * [GitHub](https://github.com/kejonaMC/GeyserUpdater) @@ -101,13 +101,13 @@ This is a Spigot/BungeeCord/Velocity plugin that can be used to automatically up Creators: [Jens](https://github.com/Jens-Co), [YHDiamond](https://github.com/YHDiamond), [Konicai](https://github.com/Konicai) -## SleepingServerStarter +## SleepingServerStarter {#sleepingserverstarter} Small application that waits for a player to connect before launching actual minecraft server. * [GitHub](https://github.com/vincss/mcsleepingserverstarter) Creator: [Vincss](https://github.com/vincss) -## TydiumCraft Skin API +## TydiumCraft Skin API {#tydiumcraft-skin-api} An API makes it easier for your Bedrock skin to be rendered and outputted! * [Website](https://tydiumcraft.net/api) diff --git a/docs/other/developer-guide.md b/docs/other/developer-guide.md index 269150a..555a1b5 100644 --- a/docs/other/developer-guide.md +++ b/docs/other/developer-guide.md @@ -2,19 +2,19 @@ title: Developer Guide --- -## Compiling +## Compiling {#compiling} 1. Clone the repo to your computer (EG: `git clone https://github.com/GeyserMC/Geyser.git`) 2. [Install Maven](https://maven.apache.org/install.html) 3. Navigate to the Geyser root directory and run `git submodule update --init --recursive`. This downloads all the needed submodules for Geyser and is a crucial step in this process. 4. Run `mvn clean install` and locate to the `bootstrap`, then your desired Geyser version, then `target` folder. -## Project layout +## Project layout {#project-layout} * `bootstrap` is where we hold the specific platform code. So if you're porting Geyser to a new platform, or working with platform-specific code, you likely want to be in here. * `core` is where connections are handled and the data conversion is done. The majority of Geyser work is held here. # Compiler Tools -## Lombok +## Lombok {#lombok} *Note that the latest version of IntelliJ IDEA does not require additional setup in order to develop with Geyser.* @@ -22,37 +22,37 @@ If you're using an IDE for editing any of the GeyserMC projects you will most li # Protocol Information -## GopherTunnel +## GopherTunnel {#gophertunnel} [GopherTunnel](https://github.com/Sandertv/gophertunnel/tree/master/minecraft/protocol/packet) is a library for Bedrock Edition written in Go. The source code is an excellent documentation for the Bedrock protocol. -## wiki.vg +## wiki.vg {#wikivg} For a full rundown of the Java Edition protocol, see [here](https://wiki.vg/Protocol). -## wiki.vg (Bedrock) +## wiki.vg (Bedrock) {#wikivg-bedrock} The Bedrock Edition protocol is documented [here](https://wiki.vg/Bedrock_Protocol), but it's currently incomplete so only use it as a reference. # Programs -## debuginfo-be +## debuginfo-be {#debuginfo-be} [debuginfo-be](https://github.com/Heath123/debuginfo-be) is a Spigot plugin that displays an overlay to Geyser clients with useful debug information, similar to the F3 screen in Java Edition. -## pakkit +## pakkit {#pakkit} pakkit is a GUI-based tool for intercepting packets between a server and client developed by Geyser contributor [circuit10/Heath123](https://github.com/Heath123/) built using Electron. It works for both Java Edition (using node-minecraft-protocol) and Bedrock (as a GUI wrapper for ProxyPass adding extra features). It supports features such as viewing packet data in JSON format, Edit and Resend and a hex view for raw packet data. You can download it from [here](https://github.com/Heath123/pakkit/releases/). It's currently WIP, so expect bugs. -## Gadget +## Gadget {#gadget} Gadget is a fabric client mod to inspect & log, amongst other things, packets sent between a java server and a java client. It can be useful to determine java behavior. You can download it from [here](https://modrinth.com/mod/gadget). -## ProxyPass +## ProxyPass {#proxypass} ProxyPass is a tool for intercepting packets between a Bedrock server and client developed by the Cloudburst team. It can be found [here](https://github.com/CloudburstMC/ProxyPass) and the vanilla Bedrock server can be found [here](https://www.minecraft.net/download/server/bedrock/). -## MCC Toolchest +## MCC Toolchest {#mcc-toolchest} MCC Toolchest is a tool for viewing and editing NBT data for Bedrock edition, this allows you to see data as it is stored in Bedrock. You can download it from [here](https://mcctoolchest.weebly.com/). -## NBTExplorer +## NBTExplorer {#nbtexplorer} NBTExplorer is a tool for viewing and editing NBT data for Java edition, this allows you to see data as it is stored in Java edition. You can download it from [here](https://github.com/jaquadro/NBTExplorer/releases). -## Windows 10 Multi-Version Launcher +## Windows 10 Multi-Version Launcher {#windows-10-multi-version-launcher} The Windows 10 Multi-Version launcher allows you to switch between release and beta versions of Minecraft Bedrock. Its GitHub repository can be viewed [here](https://github.com/MCMrARM/mc-w10-version-launcher/). Alternatively, use FoxyNoTail's Version Switcher, found [here](https://foxynotail.com/software/mcbe-switcher). Note: To apply the [loopback fix](/geyser/fixing-unable-to-connect-to-world/#windows-1011) for Minecraft Preview, use the following loopback restriction lifting command with the different app ID: `CheckNetIsolation LoopbackExempt -a -n="Microsoft.MinecraftWindowsBeta_8wekyb3d8bbwe"` diff --git a/docs/other/discord-bot-usage.md b/docs/other/discord-bot-usage.md index 85e12f4..3ec484c 100644 --- a/docs/other/discord-bot-usage.md +++ b/docs/other/discord-bot-usage.md @@ -4,7 +4,7 @@ title: Discord Bot Usage Our discord bot provides some very useful toos to debug/issue track your server. We will go in-depth on how to use the bot commands and its tools. -## Server Logs +## Server Logs {#server-logs} If you are having console errors or Geyser isn't functioning/starting up, server logs are very useful to find the root cause of why Geyser is not running. You can safely share your server logs with [mclogs](https://mclo.gs) as it will remove all IP addresses and other sensitive information from the logs. @@ -12,13 +12,13 @@ If you paste the logs URL into our Discord, our bot will analyze the error and w ![Example of an error](/img/wiki/discord-bot/logs.png) -## OCR +## OCR {#ocr} OCR or Optical Character Recognition is something that our discord bot can process, which means if you upload a picture/image into our discord that contains an error like seen below the bot might be able to help you out with our issue. ![Example of an error](/img/wiki/discord-bot/ocr.png) -## Ping Server +## Ping Server {#ping-server} If you are not sure if your server is reachable from the outside you can use our ping tool. Using the ping command in #bot-spam; /ping "serverip" as seen below, The bot will check if your server is online/reachable. When you are not running your server on default port: java 25565 and bedrock 19132 you will need to specify the port like /ping "serverip:serverport". @@ -26,25 +26,25 @@ If the bot returns `Unable to find Java/Bedrock server at the requested address` ![Example of the ping command](/img/wiki/discord-bot/ping.png) -## Provider List +## Provider List {#provider-list} Some hosting providers have unique setup methods for Geyser. If you do not know how to setup Geyser on your provider you can either checkout the [Geyser Host Provider List](/geyser/supported-hosting-providers/) manually, or use our bot command `/provider "providername"` as seen below. ![Example of the provider command](/img/wiki/discord-bot/provider.png) -## Download Command +## Download Command {#download-command} Sends the download link of the chosen program/plugin. `/download "Geyser"` or `/download "ViaVersion"` and so on. -## Leaderboard Command +## Leaderboard Command {#leaderboard-command} Provides a link to the Geyser Bot XP leaderboards. -## Rank Command +## Rank Command {#rank-command} You can give yourself two types of roles on our discord, "GeyserNews" and "Testers". You can use the command `/rank "chosen rank"` to give one to yourself. -## Queue Command +## Queue Command {#queue-command} Displays Current global api skin queue upload times. diff --git a/docs/other/geyserconnect.md b/docs/other/geyserconnect.md index 79d3e8f..77970bd 100644 --- a/docs/other/geyserconnect.md +++ b/docs/other/geyserconnect.md @@ -4,7 +4,7 @@ title: GeyserConnect GeyserConnect is a extension for Geyser that allows you to join multiple servers using a single GeyserMC proxy. -## Setup +## Setup {#setup} (For GeyserConnect to work you need an open UDP port, by default it's `19132`). 1. Download the latest Geyser build from the [downloads page](https://geysermc.org/download#standalone) 2. Download the latest build from [Github Actions](https://github.com/GeyserMC/GeyserConnect/actions) @@ -13,8 +13,8 @@ GeyserConnect is a extension for Geyser that allows you to join multiple servers 5. Shutdown the standalone Geyser instance, and make you're desired changes to the GeyserConnect configuration in `GeyserConnect` in the `extensions` folder. 6. Connect to it to make sure its all working. -## DNS +## DNS {#dns} There are [DNS](https://github.com/GeyserMC/GeyserConnect/tree/master/bind9) (using bind9) configs in the repo if you would like to use them. -## Config +## Config {#config} See [here](https://github.com/GeyserMC/GeyserConnect/blob/master/src/main/resources/config.yml). diff --git a/docs/other/geyseroptionalpack.md b/docs/other/geyseroptionalpack.md index a00c4c0..8b4e536 100644 --- a/docs/other/geyseroptionalpack.md +++ b/docs/other/geyseroptionalpack.md @@ -4,7 +4,7 @@ title: GeyserOptionalPack # GeyserOptionalPack -## [Download here](https://ci.opencollab.dev/job/GeyserMC/job/GeyserOptionalPack/job/master/lastSuccessfulBuild/artifact/GeyserOptionalPack.mcpack) +## [Download here](https://ci.opencollab.dev/job/GeyserMC/job/GeyserOptionalPack/job/master/lastSuccessfulBuild/artifact/GeyserOptionalPack.mcpack) {#download-here} GeyserOptionalPack is a Bedrock resource pack that adds more features to Geyser to bring Bedrock Edition in line with Java Edition. A resource pack allows various features and bug fixes to be implemented in Bedrock, including: @@ -17,6 +17,6 @@ A more complete list can be found on the optional pack's [README](https://github While recommended, it is not required to install the resource pack on the server - clients can install it themselves. Additionally, if you use a proxy like WaterdogPE, you can install the pack on the server without impacting gameplay on other Bedrock servers. -## Resource pack conflicts +## Resource pack conflicts {#resource-pack-conflicts} If your current server resource pack contains any [entity definitions](https://github.com/GeyserMC/GeyserOptionalPack/tree/master/entity) that overlap with the optional pack, you will need to merge the definitions for these entities for the optional pack and your own pack to work correctly. Otherwise, the prevailing entity definition will be based on pack application order. This process is best performed manually due to the complexity of entity definition files, though it can also be [scripted](https://gist.github.com/Kas-tle/89c6adc3e7901fbabd1b9f71d902d0a6). diff --git a/docs/other/hurricane.md b/docs/other/hurricane.md index f63abe7..4474544 100644 --- a/docs/other/hurricane.md +++ b/docs/other/hurricane.md @@ -6,7 +6,7 @@ title: Hurricane Hurricane is a Paper/Spigot plugin, and Fabric mod (unofficial port), that fixes some bugs that otherwise cannot be fixed without server modification. -## Fixes +## Fixes {#fixes} Issues with each workaround are listed in the plugin's config. **Please take your time to read them as the workarounds in this plugin can be used for exploitative purposes.** - Bamboo and dripstone collision (by setting them to no server-side collision) @@ -16,10 +16,10 @@ Supported Versions: - 1.14.x - 1.20.x - 1.17.x & above for pig riding -## Download +## Download {#download} - Spigot/Paper: [GitHub releases](https://github.com/GeyserMC/Hurricane/releases) - Fabric: [Modrinth](https://modrinth.com/mod/hurricane) -## Source +## Source {#source} - Main: [GeyserMC/Hurricane](https://github.com/GeyserMC/Hurricane) - Unofficial fabric fork: [onebeastchris/Hurricane-fabric](https://github.com/onebeastchris/hurricane-fabric) diff --git a/docs/other/test-server.md b/docs/other/test-server.md index 5c91e9e..4dc7e7a 100644 --- a/docs/other/test-server.md +++ b/docs/other/test-server.md @@ -2,18 +2,18 @@ title: Test Server --- -### Details +### Details {#details} - IP: `test.geysermc.org` (default ports on both Bedrock and Java) - World size: 20k x 20k -### Infomation +### Infomation {#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. 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.gg/geysermc)! -### Commands: +### Commands: {#commands} |Command|Desc| |---|---|