From 9376e2669ac5772398706bebd8e91b7c90fce303 Mon Sep 17 00:00:00 2001 From: qscbm187531 <1309635304@qq.com> Date: Tue, 22 Aug 2023 05:24:44 +0800 Subject: [PATCH] Fix hyperlinks and add a limitation. (#184) --- _data/faq.yml | 10 +++++----- _data/toc.yml | 5 ++--- _docs/floodgate/faq.md | 2 +- _docs/floodgate/issues.md | 2 +- _docs/geyser/api.md | 6 +++--- _docs/geyser/current-limitations.md | 4 +++- _docs/geyser/fixing-unable-to-connect-to-world.md | 8 ++++---- _docs/geyser/playit-gg.md | 2 +- _docs/other/community-geyser-projects.md | 9 +-------- _docs/other/developer-guide.md | 6 +++--- _docs/other/hurricane.md | 4 ++-- 11 files changed, 26 insertions(+), 32 deletions(-) diff --git a/_data/faq.yml b/_data/faq.yml index 3b398c4..0873bc9 100644 --- a/_data/faq.yml +++ b/_data/faq.yml @@ -31,7 +31,7 @@ * [ProtocolSupportBungee](https://www.spigotmc.org/resources/8733/) changes how the login process works and therefore breaks the Floodgate injection code. * [SayNoToMcLeaks](https://www.spigotmc.org/resources/40906/) prevents Floodgate from finishing its login system. - If you come across any more, please let us know via [Discord](http://discord.gg/geysermc). + If you come across any more, please let us know via [Discord](https://discord.gg/geysermc). - title: What server versions does Geyser support? content: | @@ -39,7 +39,7 @@ Since Geyser emulates a {{ site.data.versions.java }} Java Edition client, you need to [install ViaVersion](https://www.spigotmc.org/resources/viaversion.19254/) on your server if it is not running the latest version of Minecraft.
- In order for Bedrock players to chat (1.19.3+) or join (1.19.1/1.19.2), you need to disable chat signing. More information about that can be read on the [chat signing page](geyser/secure-chat/).
+ In order for Bedrock players to chat (1.19.3+) or join (1.19.1/1.19.2), you need to disable chat signing. More information about that can be read on the [chat signing page](/geyser/secure-chat/).
You will also need to run at least Java 16 or later to use Geyser. See [here](https://docs.papermc.io/misc/java-install) for more info on updating Java. Paper versions not supporting Java 16 can add `-DPaper.IgnoreJavaVersion=true` flag to the Java startup arguments to allow Paper to run on Java 16. @@ -49,11 +49,11 @@ This is a non-complete list of what platform each plugin version of Geyser is for, and the standalone version can be used for any as it isn't a plugin. * Geyser-Spigot works with: * [Spigot](https://www.spigotmc.org/) - * [Paper](https://papermc.io/downloads) (recommended) + * [Paper](https://papermc.io/downloads/paper) (recommended) * Any other forks of the above * Geyser-Bungee works with: * [BungeeCord](https://www.spigotmc.org/wiki/bungeecord/) - * [Waterfall](https://papermc.io/downloads#Waterfall) + * [Waterfall](https://papermc.io/downloads/Waterfall) * Any other forks of the above * Geyser-Velocity works with [Velocity](https://www.velocitypowered.com/) * Geyser-Sponge works with [SpongeVanilla or SpongeForge](https://www.spongepowered.org/) @@ -149,7 +149,7 @@ - title: How can I auto-update Geyser? content: | - GeyserUpdater ([GitHub page](https://github.com/ProjectG-Plugins/GeyserUpdater)/[Spigot page](https://www.spigotmc.org/resources/88555/)) is a Spigot/BungeeCord plugin option for auto-updating. Please note that this plugin is also unaffiliated and unsupported by Geyser, and users should redirect support for the plugin to its [Discord](https://discord.gg/U5MC2tcCz9). + GeyserUpdater ([GitHub page](https://github.com/kejonaMC/GeyserUpdater)/[Spigot page](https://www.spigotmc.org/resources/88555/)) is a Spigot/BungeeCord plugin option for auto-updating. Please note that this plugin is also unaffiliated and unsupported by Geyser, and users should redirect support for the plugin to its [Discord](https://discord.gg/U5MC2tcCz9). - title: How can I make DiscordSRV show Floodgate 2.0 or GeyserSkinManager skins? content: | diff --git a/_data/toc.yml b/_data/toc.yml index 0479835..9d277a4 100644 --- a/_data/toc.yml +++ b/_data/toc.yml @@ -46,7 +46,7 @@ - title: Getting Started url: "geyser/getting-started-with-the-api/" - title: Overview - url: "geyser/api/#short-overview-of-the-api" + url: "geyser/api/#short-overview-of-the-geyser-api" - title: Events url: "geyser/events/" - title: Forms and Cumulus @@ -60,7 +60,6 @@ url: "geyser/extensions/#creating-commands-with-geyser-extensions" - title: Global API url: "geyser/global-api/" - - title: Floodgate Documentation url: "floodgate/" links: @@ -109,4 +108,4 @@ - title: "Developer Guide" url: "other/developer-guide/" - title: "Geyser Discord Bot Usage" - url: "other/discord-bot-usage/" \ No newline at end of file + url: "other/discord-bot-usage/" diff --git a/_docs/floodgate/faq.md b/_docs/floodgate/faq.md index 1808122..0920c4d 100644 --- a/_docs/floodgate/faq.md +++ b/_docs/floodgate/faq.md @@ -21,4 +21,4 @@ First, you'll need to get the XUID of the player. There are several third-party If you're using the Spigot version of Floodgate, download the Placeholder plugin [here](https://github.com/rtm516/FloodgatePlaceholders/). Using the placeholders shouldn't require additional setup other than having [PlaceholderAPI](https://www.spigotmc.org/resources/6245/) installed. See the section above on installing Floodgate on backend servers if you wish to use this on BungeeCord. ## Using Skript -If you're using the Spigot version of Floodgate, there is an unofficial plugin that adds Skript support [here](https://github.com/Camotoy/floodgate-skript). +If you're using the Spigot version of Floodgate, there is an unofficial plugin that adds Skript support [here](https://github.com/kejonaMC/floodgate-skript). diff --git a/_docs/floodgate/issues.md b/_docs/floodgate/issues.md index 2299c9c..6b6e9da 100644 --- a/_docs/floodgate/issues.md +++ b/_docs/floodgate/issues.md @@ -18,7 +18,7 @@ Make sure the server has Floodgate installed and started up correctly. Otherwise ## `javax.crypto.AEADBadTagException: 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/eng/index.php) if you need to use FTP. +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: "" diff --git a/_docs/geyser/api.md b/_docs/geyser/api.md index 941c8f0..b51fb88 100644 --- a/_docs/geyser/api.md +++ b/_docs/geyser/api.md @@ -55,7 +55,7 @@ This method will return null if the player is not a Bedrock player. `GeyserApi#sendForm(UUID, Form(Builder))`
Used to send a form to the Bedrock player with the given UUID.
-Click [here](/floodgate/forms/) to get more information about Forms. +Click [here](/geyser/forms/) to get more information about Forms. `GeyserApi#onlineConnectionsCount()`
Used to get the amount of online Bedrock players. @@ -64,7 +64,7 @@ Used to get the amount of online Bedrock players. #### [Cumulus](https://github.com/GeyserMC/Cumulus/tree/master/src/main/java/org/geysermc/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](/floodgate/forms/) for more information. +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) The event package contains all the events that Geyser fires. See [here](/geyser/events) for detailed information on how to listen to Geyser events. @@ -97,6 +97,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/extensions) +#### [Extension](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/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/current-limitations.md b/_docs/geyser/current-limitations.md index 37696ed..caf8c99 100644 --- a/_docs/geyser/current-limitations.md +++ b/_docs/geyser/current-limitations.md @@ -17,12 +17,14 @@ The following things cannot be fixed without changes to Bedrock or the Java prot - Various command arguments for any command that doesn't use the Minecraft Brigadier library - Anything that relies on tab complete or typing in the chat UI (related to the above) - Bedrock sends no packet that indicates they are in this menu - Unable to see banner layers past 6 -- Movement issues around bamboo due to offset differences between Java and Bedrock. The following plugin works around this, but please read the README before using: https://github.com/Camotoy/GeyserHacks +- Movement issues around bamboo due to offset differences between Java and Bedrock: [Hurricane](/other/hurricane) can work around it. +- Can't move mounted entities with carrot/warped fungus on a stick. Hurricane also works around this. - Custom anvil recipes - Heights lower than -64 or higher than 320 in the overworld with extended height enabled, and heights lower than 0 or higher than 256 in other dimensions - Dolphin's Grace potion effect visuals (effects should still work correctly) - Invisible item frames - Blocks (excluding jack-o-lantern) on entity heads (E.G. armor stands, players) +- Saddled camels unmoveable/unrideable on bedrock. 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/fixing-unable-to-connect-to-world.md b/_docs/geyser/fixing-unable-to-connect-to-world.md index a9e4354..04e5024 100644 --- a/_docs/geyser/fixing-unable-to-connect-to-world.md +++ b/_docs/geyser/fixing-unable-to-connect-to-world.md @@ -4,7 +4,7 @@ title: Fixing 'Unable to Connect to World' *Unable to Connect to World* is by far the most common error people get when attempting to set up Geyser. Here's some steps on how to solve that. -**_If you are using a hosting provider: Many providers and remote hostings have additional steps you have to perform in order to be supported; see [Supporting Hosting Providers](https://wiki.geysermc.org/geyser/supported-hosting-providers/). If you're self-hosting from home, you don't need to worry about this._** +**_If you are using a hosting provider: Many providers and remote hostings have additional steps you have to perform in order to be supported; see [Supporting Hosting Providers](/geyser/supported-hosting-providers/). If you're self-hosting from home, you don't need to worry about this._** # Before we start... @@ -18,7 +18,7 @@ If this occurred after updating a plugin version of Geyser, ensure that you shut ## ...There are errors in my console! -Please read through the [common issues page](https://wiki.geysermc.org/geyser/common-issues/). If there is another error not documented there, join us on our [Discord](https://discord.geysermc.org). +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). ## ...Have you tried restarting? @@ -36,7 +36,7 @@ You should be connecting with the Java server IP and the Bedrock port. If you po ## I'm using a hosting provider or VPS! -Please read [this page on supported hosting providers](https://wiki.geysermc.org/geyser/supported-hosting-providers/) to see if there are extra configuration steps required for your hosting or server provider. +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. ## Port forwarding @@ -93,7 +93,7 @@ Your firewall is likely in the way. Try adding an exception to Java, or disable # As a last resort for troubleshooting... -Minecraft offers a vanilla Bedrock server [here](https://www.minecraft.net/en-us/download/server/bedrock). Downloading, running, and attempting to connect to it may help isolate if the issue is on Geyser's end, or your computer/network's end. +Minecraft offers a vanilla Bedrock server [here](https://www.minecraft.net/download/server/bedrock). Downloading, running, and attempting to connect to it may help isolate if the issue is on Geyser's end, or your computer/network's end. # Using Geyser on the same computer diff --git a/_docs/geyser/playit-gg.md b/_docs/geyser/playit-gg.md index 032f2e3..56861f8 100644 --- a/_docs/geyser/playit-gg.md +++ b/_docs/geyser/playit-gg.md @@ -21,7 +21,7 @@ title: playit.gg Setup If you have Geyser running on a port that is not 19132, update the port there. The "Local Address" does not need to be changed unless you are not running playit.gg and Geyser on the same device. 5. Connect to your server - use the IP and Port from the "Allocation" tab. In our example - "180.ip.ply.gg" as the IP, and "17019" as the port. Alternatively, use the Domain it gives you instead of the IP. 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](/geyser/setting-up-playit-gg/#troubleshooting) section of the page.) + (If you failed to join, check out the [troubleshooting](#troubleshooting) section of the page.) ## Troubleshooting diff --git a/_docs/other/community-geyser-projects.md b/_docs/other/community-geyser-projects.md index 6a53fd6..e9da51f 100644 --- a/_docs/other/community-geyser-projects.md +++ b/_docs/other/community-geyser-projects.md @@ -34,7 +34,7 @@ Creator: [Camotoy](https://github.com/Camotoy) An SkinAPI that displays Java or Bedrock skins based on the UUID or username. -* [Website](https://docs.creepernation.net/skinapi) +* [Website](https://docs.creepernation.net) Creators: [creeperz653](https://github.com/creeperz653), [BlueTree242](https://github.com/BlueTree242) @@ -75,13 +75,6 @@ Plugin that blocks Java players from joining your Geyser server, so you can have Creator: [Camotoy](https://github.com/Camotoy) -## GeyserPlaceholders -Placeholders support for Geyser. - -* [GitHub](https://github.com/ImDaBigBoss/GeyserPlaceholders) - -Creator: [ImDaBigBoss](https://github.com/ImDaBigBoss) - ## GeyserPreventServerSwitch Prevent Bedrock players from joining specific sub-servers on a proxy diff --git a/_docs/other/developer-guide.md b/_docs/other/developer-guide.md index 187de34..269150a 100644 --- a/_docs/other/developer-guide.md +++ b/_docs/other/developer-guide.md @@ -44,10 +44,10 @@ Gadget is a fabric client mod to inspect & log, amongst other things, packets se You can download it from [here](https://modrinth.com/mod/gadget). ## 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/NukkitX/ProxyPass) and the vanilla Bedrock server can be found [here](https://www.minecraft.net/en-us/download/server/bedrock/). +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 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](http://mcctoolchest.com/). +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 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). @@ -55,4 +55,4 @@ NBTExplorer is a tool for viewing and editing NBT data for Java edition, this al ## 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](https://wiki.geysermc.org/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"` \ No newline at end of file +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/hurricane.md b/_docs/other/hurricane.md index e7389b3..d69f6c8 100644 --- a/_docs/other/hurricane.md +++ b/_docs/other/hurricane.md @@ -17,9 +17,9 @@ Supported Versions: - 1.17.x & above for pig riding ### Download -Spigot/Paper: [GitHub releases](https://github.com/GeyserMC/Hurricane/) +Spigot/Paper: [GitHub releases](https://github.com/GeyserMC/Hurricane/releases) Fabric: [Modrinth](https://modrinth.com/mod/hurricane) ### Source Main: [GeyserMC/Hurricane](https://github.com/GeyserMC/Hurricane) -Unofficial fabric fork: [onebeastchris/Hurricane-fabric](https://github.com/onebeastchris/hurricane-fabric) \ No newline at end of file +Unofficial fabric fork: [onebeastchris/Hurricane-fabric](https://github.com/onebeastchris/hurricane-fabric)