From 8fdb311b68cfe296624e61a4883873b754fd22bf Mon Sep 17 00:00:00 2001 From: onebeastchris Date: Sun, 12 Jan 2025 18:38:04 +0100 Subject: [PATCH] update mod/proxy pages --- src/components/Provider.tsx | 4 +- src/data/providers.ts | 2 +- wiki/geyser/setup.mdx | 8 +-- .../geyser/setup/provider/_modded-servers.mdx | 70 +++++++++++++++++++ wiki/geyser/setup/provider/_paper-spigot.mdx | 23 +++--- wiki/geyser/setup/provider/_proxy-servers.mdx | 68 ++++++++++++++++++ wiki/geyser/setup/provider/modded-servers.mdx | 45 ------------ wiki/geyser/setup/provider/proxy-servers.mdx | 43 ------------ 8 files changed, 156 insertions(+), 107 deletions(-) create mode 100644 wiki/geyser/setup/provider/_modded-servers.mdx create mode 100644 wiki/geyser/setup/provider/_proxy-servers.mdx delete mode 100644 wiki/geyser/setup/provider/modded-servers.mdx delete mode 100644 wiki/geyser/setup/provider/proxy-servers.mdx diff --git a/src/components/Provider.tsx b/src/components/Provider.tsx index d556df1..b805d67 100644 --- a/src/components/Provider.tsx +++ b/src/components/Provider.tsx @@ -46,8 +46,8 @@ export const ProviderSelector = ({setProvider}) => { message: 'Connect with the Java server IP and Java server port.' }), info: translate({ - id: 'providers.provider.not_listed.description', - message: "If this does not work, ask your server hosting provider for a UDP port, and use that. For VPS/KVM servers please follow the self-hosting steps." + id: 'providers.provider.not_listed.info', + message: "If these instructions do not work, contact your server hosting provider and ask for a UDP port. Then, set clone-remote-port to false, and set 'bedrock port' to the port you got. For VPS/KVM servers, please follow the self-hosting steps." }) } as HostingProvider); diff --git a/src/data/providers.ts b/src/data/providers.ts index 8019dd4..286ee44 100644 --- a/src/data/providers.ts +++ b/src/data/providers.ts @@ -62,7 +62,7 @@ const configChangeTemplates = { clone_remote_port: true, other_instructions: translate({ id: 'providers.config.templates.custom_port_dedicated_ip', - message: "If you have a dedicated IP, you can contact the support to use a custom port." + message: "If you have a dedicated IP, you can contact the server hosting provider's support to use a custom port." }) }, javaAddress: { diff --git a/wiki/geyser/setup.mdx b/wiki/geyser/setup.mdx index 70f5682..2a5fe76 100644 --- a/wiki/geyser/setup.mdx +++ b/wiki/geyser/setup.mdx @@ -9,8 +9,8 @@ import TabItem from '@theme/TabItem' import Admonition from '@theme/Admonition'; import Translate from "@docusaurus/Translate"; -import ModdedServers from '@site/wiki/geyser/setup/provider/modded-servers.mdx' -import ProxyServers from '@site/wiki/geyser/setup/provider/proxy-servers.mdx' +import ModdedServers from '@site/wiki/geyser/setup/provider/_modded-servers.mdx' +import ProxyServers from '@site/wiki/geyser/setup/provider/_proxy-servers.mdx' import PaperSpigot from '@site/wiki/geyser/setup/provider/_paper-spigot.mdx' import ModdedServersSelf from '@site/wiki/geyser/setup/self/modded-servers.mdx' @@ -43,10 +43,10 @@ export const SetupGuide = () => { }> - + }> - + ) : (Not supported}>{provider.warn})} diff --git a/wiki/geyser/setup/provider/_modded-servers.mdx b/wiki/geyser/setup/provider/_modded-servers.mdx new file mode 100644 index 0000000..ea81ed2 --- /dev/null +++ b/wiki/geyser/setup/provider/_modded-servers.mdx @@ -0,0 +1,70 @@ +import Admonition from '@theme/Admonition'; + +import { Versions } from '@site/src/components/Versions' + +:::caution +Geyser-Fabric and Geyser-NeoForge run **only** on a server. +See [this page](/wiki/geyser/supported-versions#fabric-neoforge-servers) for more details. +::: + +:::info +Geyser only works with **server-side** mods. Mods that require a client-side install will not work! +::: + +{props.provider.warn ? {props.provider.warn} : null} + +

Installing Geyser:

+{props.provider.custom_install_location ? props.provider.custom_install_location : ( +
    +
  1. Download the mod from [the download page](/download).
    2. +
  2. Place the Geyser mod jar in the `mods` folder. **For Fabric, you will also need the [FabricAPI](https://modrinth.com/mod/fabric-api) mod.**
    3. +
  3. Restart the server.
    4. +
+)} +
+ +{props.provider.config ? ( + <> +

Geyser config changes:

+ Open your Geyser config. It is located in `/config/Geyser-Fabric/config.yml` (or + `/config/Geyser-NeoForge/config.yml`), and change the following: +
    + {props.provider.config.address ?
  • Change the `address` to `{props.provider.config.address}`
    • : null} + {props.provider.config.port ?
  • Change the `port` to `{props.provider.config.port}`
    • : null} + {props.provider.config.clone_remote_port ?
  • Change `clone-remote-port` to `true`
    • : null} + {props.provider.config.port_instruction ?
  • {props.provider.config.port_instruction}
    • : null} + {props.provider.config.address_instruction ?
  • {props.provider.config.address_instruction}
    • : null} + {props.provider.config.other_instructions ?
  • {props.provider.config.other_instructions}
    • : null} +
+ +) : null} + +{props.provider.additional_step ? ( + <> +

Additional Steps:

+ {props.provider.additional_step} +
+ +) : null} + + +{props.provider.connect_instructions ? ( + <> +

Connecting on Bedrock:

+ {props.provider.connect_instructions} + +) : null} + + +{props.provider.info ? {props.provider.info} : null} + + +{props.provider.hosting_article || props.provider.hosting_support ? ( + <> +

More Information:

+ + +) : null} \ No newline at end of file diff --git a/wiki/geyser/setup/provider/_paper-spigot.mdx b/wiki/geyser/setup/provider/_paper-spigot.mdx index 5c75ca4..3bb3a42 100644 --- a/wiki/geyser/setup/provider/_paper-spigot.mdx +++ b/wiki/geyser/setup/provider/_paper-spigot.mdx @@ -9,24 +9,24 @@ See also [this page](/wiki/geyser/supported-versions/) on supported versions. {props.provider.warn ? {props.provider.warn} : null} - -

Install:

+

Installing Geyser:

{props.provider.custom_install_location ? props.provider.custom_install_location : (
  1. Download the plugin from [the download page](/download).
    2. -
  2. Place the Geyser-Spigot.jar in the `plugins` folder, and restart the server.
    3. +
  3. Place the Geyser-Spigot.jar in the `plugins` folder.
    4. +
  4. Restart the server.
)}
{props.provider.config ? ( <> -

Make the following config changes:

- Open your Geyser config, located in `/plugins/Geyser-Spigot/config.yml` +

Geyser config changes:

+ Open your Geyser config. It is located in `/plugins/Geyser-Spigot/config.yml`.
    {props.provider.config.address ?
  • Change the `address` to `{props.provider.config.address}`
    • : null} {props.provider.config.port ?
  • Change the `port` to `{props.provider.config.port}`
    • : null} - {props.provider.config.clone_remote_port ?
  • Change `clone-remote-port` to `{props.provider.config.clone_remote_port}`
    • : null} + {props.provider.config.clone_remote_port ?
  • Change `clone-remote-port` to `true`
    • : null} {props.provider.config.port_instruction ?
  • {props.provider.config.port_instruction}
    • : null} {props.provider.config.address_instruction ?
  • {props.provider.config.address_instruction}
    • : null} {props.provider.config.other_instructions ?
  • {props.provider.config.other_instructions}
    • : null} @@ -44,13 +44,12 @@ See also [this page](/wiki/geyser/supported-versions/) on supported versions. {props.provider.connect_instructions ? ( - + <> +

    Connecting on Bedrock:

    {props.provider.connect_instructions} -
    -
    -     -) : (
    Nope
    )} - + +) : null} +
    {props.provider.info ? {props.provider.info} : null} diff --git a/wiki/geyser/setup/provider/_proxy-servers.mdx b/wiki/geyser/setup/provider/_proxy-servers.mdx new file mode 100644 index 0000000..8377cd1 --- /dev/null +++ b/wiki/geyser/setup/provider/_proxy-servers.mdx @@ -0,0 +1,68 @@ +import Admonition from '@theme/Admonition'; + +import { Versions } from '@site/src/components/Versions' + +:::info +- Install Geyser **only** on the proxy server! You can install Floodgate on all servers for better skin support & +network-wide Floodgate API availability for other plugins. +- All servers on the network must accept Java clients, as Geyser imitates one. +::: + +{props.provider.warn ? {props.provider.warn} : null} + +

    Installing Geyser:

    +{props.provider.custom_install_location ? props.provider.custom_install_location : ( +
      +
    1. Download the plugin for your proxy software from [the download page](/download).
      2. +
    2. Place the Geyser plugin jar in the `plugins` folder.
      3. +
    3. Restart the proxy.
      4. +
    +)} +
    + +{props.provider.config ? ( + <> +

    Geyser config changes:

    + Open your Geyser config. It is located in `/config/Geyser-Velocity/config.yml` (or + `/config/Geyser-BungeeCord/config.yml`), and change the following: +
      + {props.provider.config.address ?
    1. Change the `address` to `{props.provider.config.address}`
      2. : null} + {props.provider.config.port ?
    2. Change the `port` to `{props.provider.config.port}`
      3. : null} + {props.provider.config.clone_remote_port ?
    3. Change `clone-remote-port` to `true`
      4. : null} + {props.provider.config.port_instruction ?
    4. {props.provider.config.port_instruction}
      5. : null} + {props.provider.config.address_instruction ?
    5. {props.provider.config.address_instruction}
      6. : null} + {props.provider.config.other_instructions ?
    6. {props.provider.config.other_instructions}
      7. : null} +
    + +) : null} + + +{props.provider.additional_step ? ( + <> +

    Additional Steps:

    + {props.provider.additional_step} +
    + +) : null} + + +{props.provider.connect_instructions ? ( + <> +

    Connecting on Bedrock:

    + {props.provider.connect_instructions} + +) : null} + + +{props.provider.info ? {props.provider.info} : null} + + +{props.provider.hosting_article || props.provider.hosting_support ? ( + <> +

    More Information:

    + + +) : null} \ No newline at end of file diff --git a/wiki/geyser/setup/provider/modded-servers.mdx b/wiki/geyser/setup/provider/modded-servers.mdx deleted file mode 100644 index 4b31801..0000000 --- a/wiki/geyser/setup/provider/modded-servers.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Geyser Hosting Provider Modded Setup -description: Learn how to set up Geyser on your Fabric or NeoForge server from a hosting provider. ---- - -import { Versions } from '@site/src/components/Versions' - -:::caution -Geyser-Fabric and Geyser-NeoForge run **only** on a server. -See [this page](/wiki/geyser/supported-versions#fabric-neoforge-servers) for more details. -::: - -:::info -Geyser only works with **server-side** mods. Mods that require a client-side install will not work! -::: - -1. Select your server hosting provider in the dropdown above. -2. Download the mod from [the download page](/download). -3. Place the Geyser mod jar in the `mods` folder, and restart the server. **For Fabric, you will also need [FabricAPI](https://modrinth.com/mod/fabric-api).** -4. Open your Geyser config, located in `/config/Geyser-Fabric/config.yml` (or `/config/Geyser-NeoForge/config.yml`), and find the following: - - ```yaml - bedrock: - # The IP address that will listen for connections. - # Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server. - #address: 0.0.0.0 - - # The port that will listen for connections. This is the port that Bedrock players will use to connect to your server. - port: 19132 - - # Some hosting services change your Java port everytime you start the server and require the same port to be used for Bedrock. - # This option makes the Bedrock port the same as the Java port every time you start the server. - # This option is for the plugin version only. - clone-remote-port: false - ``` - The vital part is the port. This is the port that Bedrock players will use to connect to your server. - Follow the instructions in the provider selector - change the port, and if necessary, `clone-remote-port` & `address`. - If `clone-remote-port` is enabled, the bedrock port will be overwritten with the Java port! - **Important**: Other services/mods that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser. - -5. Verify whether connections are possible by running `geyser connectiontest ` in the console. - -:::info -To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use Floodgate. -::: \ No newline at end of file diff --git a/wiki/geyser/setup/provider/proxy-servers.mdx b/wiki/geyser/setup/provider/proxy-servers.mdx deleted file mode 100644 index a248c66..0000000 --- a/wiki/geyser/setup/provider/proxy-servers.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Geyser Hosting Provider Proxy Servers Setup -description: Learn how to set up Geyser on your Bungee, Waterfall, or Velocity server from a hosting provider. -hide_title: true ---- - -import { Versions } from '@site/src/components/Versions' - -:::info -- Install Geyser **only** on the proxy server! You can install Floodgate on all servers for better skin support & - network-wide Floodgate API availability for other plugins. -- All servers on the network must accept Java clients, as Geyser imitates one. -::: - -1. Select your server hosting provider in the dropdown above. -2. Download the plugin for your proxy software from [the download page](/download). -3. Place the Geyser jar in the `plugins` folder, and restart the server. -4. Open your Geyser config, located in `/plugins/Geyser-xyz/config.yml`, and find the following: - - ```yaml - bedrock: - # The IP address that will listen for connections. - # Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server. - #address: 0.0.0.0 - - # The port that will listen for connections. This is the port that Bedrock players will use to connect to your server. - port: 19132 - - # Some hosting services change your Java port everytime you start the server and require the same port to be used for Bedrock. - # This option makes the Bedrock port the same as the Java port every time you start the server. - # This option is for the plugin version only. - clone-remote-port: false - ``` - The vital part is the port. This is the port that Bedrock players will use to connect to your server. - Follow the instructions in the provider selector - change the port, and if necessary, `clone-remote-port` & `address`. - If `clone-remote-port` is enabled, the bedrock port will be overwritten with the Java port! - **Important**: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser. - -5. Verify whether connections are possible by running `geyser connectiontest ` in the console. - -:::info -To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use Floodgate. -::: \ No newline at end of file