diff --git a/README.md b/README.md index 828b01e..64a3cbe 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,10 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more information. - [`blog/`](/blog/): Blog markdown files - [`docs/`](/docs/): Wiki markdown files - [`api/`](/docs/api/): Rest API documentation - - [`floodgate/`](/docs/floodgate/): Floodgate documentation - - [`geyser/`](/docs/geyser): Geyser documentation - - [`other/`](/docs/other/): Other projects documentation + - [`wiki/`](/docs/wiki/): Wiki documentation + - [`floodgate/`](/docs/floodgate/): Floodgate documentation + - [`geyser/`](/docs/geyser): Geyser documentation + - [`other/`](/docs/other/): Other projects documentation - [`i18n/`](/i18n/): Translations for the website - [`openapi/`](/openapi/): OpenAPI spec files to auto-generate REST API documentation - [`src/`](/src/): Source of the website diff --git a/docs/api/api.geysermc.org/global-api.info.mdx b/docs/api/api.geysermc.org/global-api.info.mdx index 6fe73b4..b09603e 100644 --- a/docs/api/api.geysermc.org/global-api.info.mdx +++ b/docs/api/api.geysermc.org/global-api.info.mdx @@ -27,7 +27,7 @@ import Export from "@theme/ApiExplorer/Export"; > -The Global API is available for every server. It currently includes: [Global Linking](/floodgate/linking/#what-is-global-linking), [skin uploading](/floodgate/features/#what-is-skin-uploading), getting a xuid by gamertag, and getting a gamertag by xuid. +The Global API is available for every server. It currently includes: [Global Linking](/wiki/floodgate/linking/#what-is-global-linking), [skin uploading](/wiki/floodgate/features/#what-is-skin-uploading), getting a xuid by gamertag, and getting a gamertag by xuid. We don't store anything else than you can access by the Global API, except for some non-identifiable metrics. The source code of the Global API is available [here](https://github.com/GeyserMC/global_api) and the source code of the Global Linking server is available [here](https://github.com/GeyserMC/GlobalLinkServer). As a user of the API, you can get various info about Geyser (or specifically, Floodgate players) that joined any Geyser + Floodgate server before. This includes: diff --git a/docs/floodgate/api.md b/docs/wiki/floodgate/api.md similarity index 85% rename from docs/floodgate/api.md rename to docs/wiki/floodgate/api.md index ac00f44..da320b1 100644 --- a/docs/floodgate/api.md +++ b/docs/wiki/floodgate/api.md @@ -3,13 +3,13 @@ title: Floodgate API description: Floodgate has an API to allow servers to get information about the Bedrock client. It also allows plugins access to Cumulus, an API to send and collect form data from Bedrock players. --- -Floodgate has an API to extend what is possible and allow servers to get information about the Bedrock client. It also allows other plugins access to [Cumulus](/geyser/forms/) +Floodgate has an API to extend what is possible and allow servers to get information about the Bedrock client. It also allows other plugins access to [Cumulus](/wiki/geyser/forms/) 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} -See [here](/geyser/getting-started-with-the-api) for how to include the Floodgate API in your project. +See [here](/wiki/geyser/getting-started-with-the-api) for how to include the Floodgate API in your project. The Floodgate API has changed in Floodgate 2.0. The most important change is that the API methods are no longer static and instead instance-based, as shown below. @@ -36,18 +36,18 @@ Used to check if the given UUID of an **online** player is a Bedrock player. `FloodgateApi#getPlayer(UUID)` Used to get the FloodgatePlayer instance of an **online** player. -Click [here](/floodgate/player/) to get more information about the FloodgatePlayer class. +Click [here](/wiki/floodgate/player/) to get more information about the FloodgatePlayer class. **Note**: You don't need to wait until the Bedrock player is online to use the getPlayer and isFloodgatePlayer methods. You can even use them in the pre-login events. `FloodgateApi#getPlayerLink()` Used to get the PlayerLink instance used by Floodgate to check for linked accounts. -Click [here](/floodgate/linking/) to get more information about the PlayerLink class +Click [here](/wiki/floodgate/linking/) to get more information about the PlayerLink class `FloodgateApi#sendForm(UUID, Form(Builder))` Used to send a form to the Bedrock player with the given UUID. -Click [here](/geyser/forms/) to get more information about Forms. +Click [here](/wiki/geyser/forms/) to get more information about Forms. ### 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/commands.md b/docs/wiki/floodgate/commands.md similarity index 80% rename from docs/floodgate/commands.md rename to docs/wiki/floodgate/commands.md index 86729fb..51341d5 100644 --- a/docs/floodgate/commands.md +++ b/docs/wiki/floodgate/commands.md @@ -5,6 +5,6 @@ description: Commands and their associated permission nodes for Floodgate. | Command | Permission | Description | |:---:|:---:|:---:| -| `fwhitelist` | `floodgate.command.fwhitelist` | Whitelist command for Floodgate players. See [here](/floodgate/features#whitelist-command) for details. | +| `fwhitelist` | `floodgate.command.fwhitelist` | Whitelist command for Floodgate players. See [here](/wiki/floodgate/features#whitelist-command) for details. | | `linkaccount` | `floodgate.command.linkaccount` | Link your account for local linking. | | `unlinkaccount` | `floodgate.command.unlinkaccount` | Unlink your account for local linking. | diff --git a/docs/floodgate/faq.mdx b/docs/wiki/floodgate/faq.mdx similarity index 93% rename from docs/floodgate/faq.mdx rename to docs/wiki/floodgate/faq.mdx index 4b3b4bf..de890c6 100644 --- a/docs/floodgate/faq.mdx +++ b/docs/wiki/floodgate/faq.mdx @@ -3,7 +3,7 @@ title: FAQ description: Frequently asked questions about Floodgate such as changing prefixes, obtaining Bedrock player UUIDs, and using Floodgate with PlaceholderAPI and Skript. --- -import { Questions, Q, A } from "../../src/components/Questions"; +import { Questions, Q, A } from "@site/src/components/Questions"; Here you can find answers to frequently asked questions about Floodgate - if you have a question that isn't answered here, feel free to ask in our [Discord](https://discord.gg/GeyserMC)! @@ -15,7 +15,7 @@ Here you can find answers to frequently asked questions about Floodgate - if you In your Floodgate config, change `username-prefix` to whichever prefix you desire - you can set it to `""` and there will be no prefix. - On some older Paper servers (or any forks that use them), you may need to also shut down your server and delete your `usercache.json` file located in the same folder as your server jar to prevent users who already joined from having the old prefix. See [this issue](/floodgate/issues#prefix-is-not-changing-on-the-server-after-changing-it-in-the-config) for more information. + On some older Paper servers (or any forks that use them), you may need to also shut down your server and delete your `usercache.json` file located in the same folder as your server jar to prevent users who already joined from having the old prefix. See [this issue](/wiki/floodgate/issues#prefix-is-not-changing-on-the-server-after-changing-it-in-the-config) for more information. diff --git a/docs/floodgate/features.md b/docs/wiki/floodgate/features.md similarity index 84% rename from docs/floodgate/features.md rename to docs/wiki/floodgate/features.md index a085ddd..82c23c4 100644 --- a/docs/floodgate/features.md +++ b/docs/wiki/floodgate/features.md @@ -17,7 +17,7 @@ The permission node is `floodgate.command.fwhitelist`. 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. -Skin uploading is also a part of the [Global Api](/geyser/global-api). It is responsible for converting Bedrock skins to Java skins and uploading them to Mojang servers make them show up on Java Edition. +Skin uploading is also a part of the [Global Api](/wiki/geyser/global-api). It is responsible for converting Bedrock skins to Java skins and uploading them to Mojang servers make them show up on Java Edition. We're using MineSkin internally. MineSkin is running on accounts donated by the community. So if you want to support MineSkin and make the upload times faster, feel free to look at [this page](https://mineskin.org/account) for more info. diff --git a/docs/floodgate/index.md b/docs/wiki/floodgate/index.md similarity index 73% rename from docs/floodgate/index.md rename to docs/wiki/floodgate/index.md index f6f46b2..d6df5da 100644 --- a/docs/floodgate/index.md +++ b/docs/wiki/floodgate/index.md @@ -10,6 +10,6 @@ Floodgate is a hybrid mode plugin that allows Minecraft: Bedrock Accounts to joi 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-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). +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](/wiki/floodgate/features#what-is-skin-uploading), +being able to [use Bedrock forms](/wiki/geyser/forms/), link your account once and login on every server that has [Global Linking](/wiki/floodgate/linking#what-is-global-linking) enabled, +and the [Global Api](/wiki/geyser/global-api). diff --git a/docs/floodgate/issues.md b/docs/wiki/floodgate/issues.md similarity index 100% rename from docs/floodgate/issues.md rename to docs/wiki/floodgate/issues.md diff --git a/docs/floodgate/linking.md b/docs/wiki/floodgate/linking.md similarity index 95% rename from docs/floodgate/linking.md rename to docs/wiki/floodgate/linking.md index 752eb54..3397025 100644 --- a/docs/floodgate/linking.md +++ b/docs/wiki/floodgate/linking.md @@ -11,7 +11,7 @@ Before we introduced Global Linking, you always had to link your Java and Bedroc Keep in mind: While having your accounts linked, you will use the Java account's location, inventory data, and achievements etc. regardless of which platform you sign in from (therefore, "synchronising" the player data). The player data from the Bedrock account will not be accessible until you unlink again. As a result, you should transfer everything (ender chest contents, items, armor) to the Java account before linking to not "lose" your Bedrock progress. If you forgot to do this, you can unlink, transfer everything over, and link again. -Global Linking is part of the [Global Api](/geyser/global-api) and uses the GlobalLinkServer to link your account. To be able to link your account you have to do the following: +Global Linking is part of the [Global Api](/wiki/geyser/global-api) and uses the GlobalLinkServer to link your account. To be able to link your account you have to do the following: 1. Join the GlobalLinkServer with both your Java and Bedrock account (IP: `link.geysermc.org`, Java port: `25565`, Bedrock port: `19132`) 2. Start the linking process by typing `/linkaccount` on your Java **or** Bedrock account diff --git a/docs/floodgate/player.md b/docs/wiki/floodgate/player.md similarity index 100% rename from docs/floodgate/player.md rename to docs/wiki/floodgate/player.md diff --git a/docs/floodgate/setup.mdx b/docs/wiki/floodgate/setup.mdx similarity index 96% rename from docs/floodgate/setup.mdx rename to docs/wiki/floodgate/setup.mdx index 2b39045..b8781b5 100644 --- a/docs/floodgate/setup.mdx +++ b/docs/wiki/floodgate/setup.mdx @@ -13,7 +13,7 @@ import PaperSpigot from './setup/paper-spigot.mdx'; import ViaProxy from './setup/viaproxy.mdx'; import Standalone from './setup/standalone.mdx'; -import PlatformIcon from '../../src/components/PlatformIcon' +import PlatformIcon from '@site/src/components/PlatformIcon' import FabricIcon from '@site/static/img/icons/fabric.png'; import ProxyServersIcon from '@site/static/img/icons/velocity.png'; import PaperSpigotIcon from '@site/static/img/icons/paper.png'; diff --git a/docs/floodgate/setup/fabric.mdx b/docs/wiki/floodgate/setup/fabric.mdx similarity index 100% rename from docs/floodgate/setup/fabric.mdx rename to docs/wiki/floodgate/setup/fabric.mdx diff --git a/docs/floodgate/setup/paper-spigot.mdx b/docs/wiki/floodgate/setup/paper-spigot.mdx similarity index 100% rename from docs/floodgate/setup/paper-spigot.mdx rename to docs/wiki/floodgate/setup/paper-spigot.mdx diff --git a/docs/floodgate/setup/proxy-servers.mdx b/docs/wiki/floodgate/setup/proxy-servers.mdx similarity index 100% rename from docs/floodgate/setup/proxy-servers.mdx rename to docs/wiki/floodgate/setup/proxy-servers.mdx diff --git a/docs/floodgate/setup/standalone.mdx b/docs/wiki/floodgate/setup/standalone.mdx similarity index 100% rename from docs/floodgate/setup/standalone.mdx rename to docs/wiki/floodgate/setup/standalone.mdx diff --git a/docs/floodgate/setup/viaproxy.mdx b/docs/wiki/floodgate/setup/viaproxy.mdx similarity index 100% rename from docs/floodgate/setup/viaproxy.mdx rename to docs/wiki/floodgate/setup/viaproxy.mdx diff --git a/docs/geyser/anticheat-compatibility.md b/docs/wiki/geyser/anticheat-compatibility.md similarity index 100% rename from docs/geyser/anticheat-compatibility.md rename to docs/wiki/geyser/anticheat-compatibility.md diff --git a/docs/geyser/api.md b/docs/wiki/geyser/api.md similarity index 90% rename from docs/geyser/api.md rename to docs/wiki/geyser/api.md index 5f107b0..c33520a 100644 --- a/docs/geyser/api.md +++ b/docs/wiki/geyser/api.md @@ -12,13 +12,13 @@ You could use the Geyser API in: - A Geyser Extension ### 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. +See [here](/wiki/geyser/getting-started-with-the-api) for how to include the Geyser API dependency in your project. ### 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). -It can be used easily in Geyser Extensions, see [here](/geyser/extensions) for details on those. +It can be used easily in Geyser Extensions, see [here](/wiki/geyser/extensions) for details on those. **Quick overview:**