From bcdd1b1d1bcea7db92382a30b80c347dd3062ad5 Mon Sep 17 00:00:00 2001 From: Jens Collaert Date: Sat, 29 Jan 2022 22:10:46 +0100 Subject: [PATCH] rerouting github wiki links to new wiki urls. added more updated tutorial video. --- _docs/floodgate/forms.md | 4 ++-- _docs/floodgate/root.md | 4 ++-- _docs/floodgate/setup.md | 24 +++--------------------- pages/index.md | 8 ++++---- 4 files changed, 11 insertions(+), 29 deletions(-) diff --git a/_docs/floodgate/forms.md b/_docs/floodgate/forms.md index a9daf56..8274647 100644 --- a/_docs/floodgate/forms.md +++ b/_docs/floodgate/forms.md @@ -7,8 +7,8 @@ permalink: /floodgate/forms/ # What is Cumulus? Bedrock Edition has a cool exclusive feature called Forms.
-Cumulus is the new Forms API that we use in Geyser and Floodgate. The source code is available [here](https://github.com/GeyserMC/Cumulus). -You can access the Cumulus API through the [Floodgate API](FloodgateApi). +Cumulus is the new Forms API that we use in Geyser and Floodgate. The source code is available [here](https://wiki.geysermc.org/floodgate/forms/). +You can access the Cumulus API through the [Floodgate API](https://wiki.geysermc.org/floodgate/api/). Bedrock knows three types of Forms: * ModalForm diff --git a/_docs/floodgate/root.md b/_docs/floodgate/root.md index 2f6329b..14ce5f9 100644 --- a/_docs/floodgate/root.md +++ b/_docs/floodgate/root.md @@ -15,6 +15,6 @@ Hybrid mode plugin to allow for connections from [Geyser](https://github.com/Gey Geyser is an open collaboration project by [CubeCraft Games](https://cubecraft.net). -See the [Floodgate](https://github.com/GeyserMC/Geyser/wiki/Floodgate) page in the Geyser Wiki for more info about the what Floodgate is, how you setup Floodgate and known issues/caveats. +See the [Floodgate Setup](https://wiki.geysermc.org/floodgate/setup/) to setup Floodgate on your server/network. -See the [Floodgate wiki](https://github.com/GeyserMC/Floodgate/wiki) (currently work in progress) for a more in-depth look into Floodgate, how it works and the Floodgate API. +See the [Floodgate API](https://wiki.geysermc.org/floodgate/api/) for a more in-depth look into Floodgate, how it works and the Floodgate API. diff --git a/_docs/floodgate/setup.md b/_docs/floodgate/setup.md index 9940aab..f7f985a 100644 --- a/_docs/floodgate/setup.md +++ b/_docs/floodgate/setup.md @@ -6,14 +6,13 @@ permalink: /floodgate/setup/ ## Downloads: -Floodgate 2.0: https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/ +Floodgate: https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/ Geyser: https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/ ## Prerequisites - You must own/manage the server in order to add Floodgate. *If you do not own the server, Floodgate does not allow you to bypass logging into Java servers that require a Mojang Java account*. -- You must either be running Geyser as a [plugin](https://github.com/GeyserMC/Geyser/wiki/Setup#plugin-setup), or be running [Geyser Standalone](https://github.com/GeyserMC/Geyser/wiki/Setup#Standalone-Setup). Floodgate does not replace Geyser. -- You should make sure your Geyser is on the latest version (old versions of Geyser that worked with Floodgate 1.0 will not work with Floodgate 2.0) +- You must either be running Geyser as a [plugin](https://wiki.geysermc.org/geyser/setup/), or be running [Geyser Standalone](https://wiki.geysermc.org/geyser/setup/#standalone-setup). Floodgate does not replace Geyser. - `floodgate-spigot.jar` cannot be installed on CraftBukkit/Bukkit servers. ## Setting Up @@ -36,7 +35,7 @@ For BungeeCord/Velocity setups: you only are required to install Floodgate on th This is only needed when you want to use the Floodgate API on your Spigot server(s) behind a proxy. -- Install Floodgate on the proxy and on *all* backend servers as per the [previous insructions](#setting-up) +- Install Floodgate on the proxy and on *all* backend servers as per the [previous instructions](https://wiki.geysermc.org/floodgate/setup/) - Enable `ip_forward` in your BungeeCord `config.yml` if using BungeeCord - Set `bungeecord` to `true` in your `spigot.yml` - Start the proxy server. @@ -44,23 +43,6 @@ This is only needed when you want to use the Floodgate API on your Spigot server - *Copy* the `key.pem` file in the proxy Floodgate config folder to all Spigot servers' Floodgate config folder. **DO NOT DISTRIBUTE THIS KEY TO ANYBODY!** This key is what allows for Bedrock accounts to bypass the Java Edition authentication, and if anyone gets ahold of this, they can wreak havoc on your server. - Restart the Spigot servers and proxy server. -## How do I migrate from Floodgate 1.0 to Floodgate 2.0? -Floodgate 2.0 is not compatible with Floodgate 1.0 and Floodgate 1.0 is not compatible with Floodgate 2.0, which means there may be some manual upgrading required. When Floodgate 2.0 is loaded for the first time (on your server), it will try to convert the Floodgate 1.0 config to a Floodgate 2.0 config and it will generate a new key (the old one can be found under `old-key.pem`). Floodgate 2.0 uses a different algorithm for the key and because of that, you now only have one key (called `key.pem`) instead of two. You will have to copy the new Floodgate key (like you had to do in the initial startup) to all the servers that use Floodgate, including Geyser-Standalone.
- -Probably not everyone will understand what has been said, so here is a step-by-step guide: -1. Replace Geyser with the [latest version](https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/) (builds of Geyser that worked with floodgate 1.0, don't work) and replace every server that uses Floodgate with the [latest version](https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/). -2. Restart **one** server that uses Floodgate and let Floodgate update the config and generate a new `key.pem` file. -3. Look at the Floodgate configuration of that server and check if `config-version` is present in the Floodgate config. If it isn't, you have not installed Floodgate 2.0. While you are there, please decide if you want to continue using the legacy player name prefix `*` or use one of the recommended prefixes: `.` (the new default), `+` or `-`. All those new prefixes are easier to use for commands since you don't have to wrap the player's name in quotes. -4. Copy the files: `config.yml` and `key.pem` to all your servers that use Floodgate. -5. If you are using Geyser-Standalone, only copy `key.pem` to the Geyser-Standalone folder. -6. Make sure that you edit the Geyser config to point to `key.pem` instead of `public-key.pem` (the setting is`floodgate-key-file`). -7. Restart the other servers and check for errors. -8. Try to join Geyser with one account to check if everything works as expected. If it doesn't, please make sure that you followed every step correctly. If you did everything correctly and it still doesn't work, join our Discord to get support. - -Depending on if you want to keep using [Global Linking](Features#What-is-Global-Linking), which is enabled by default, you should be ready to go. - -To migrate your Floodgate 1.0 local account linking database, follow [these](Features#Local-Linking) steps. - ## Changing/disabling the prefix ***Please note: we do not recommend removing the prefix unless you are certain that no one will share a username between a Java and Bedrock player. Duplicated usernames will cause weird situations, like being unable to teleport to one of the players.*** diff --git a/pages/index.md b/pages/index.md index c95fa1e..858f2f7 100644 --- a/pages/index.md +++ b/pages/index.md @@ -35,7 +35,7 @@ permalink: /
- +

How do I use it?

@@ -63,10 +63,10 @@ permalink: /

Join from anywhere

Geyser can be joined from Windows 10, iOS, Android, and even consoles - (see here + (see here for how to set this up!) Geyser is tested working with a - wide array of hosting providers, - and, if you own the server, you aren't limited by a Java account with our Floodgate + wide array of hosting providers, + and, if you own the server, you aren't limited by a Java account with our Floodgate plugin!