Added ViaProxy setup instructions (#236)

* Added ViaProxy setup instructions * Added more clarification * Clarified and improved instructions * Updated floodgate link --------- Co-authored-by: chris <github@onechris.mozmail.com>
2024-02-19 22:25:52 +01:00
1 parent fa665dd1bb
commit 4878bc24b8
@@ -19,6 +19,9 @@ page_sidebar: false
    <li class="nav-item" role="presentation">
        <a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#proxy-option" type="button" role="tab" aria-controls="proxy-option" aria-selected="false"><img src="{{ '/img/icons/velocity.svg' | relative_url }}" alt="velocity icon"> Proxy Servers</a>
    </li>
+    <li class="nav-item" role="presentation">
+        <a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#viaproxy-option" type="button" role="tab" aria-controls="viaproxy-option" aria-selected="false"><img src="{{ '/img/icons/viaproxy.png' | relative_url }}" alt="viaproxy icon"> ViaProxy</a>
+    </li>
    <li class="nav-item" role="presentation">
        <a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#standalone-option" type="button" role="tab" aria-controls="standalone-option" aria-selected="false"><img src="{{ '/img/icons/geyser.png' | relative_url }}" alt="geyser icon"> Standalone</a>
    </li>
@@ -37,6 +40,10 @@ page_sidebar: false
        {% capture my_include %}{% include setup/instructions/floodgate/proxy.md %}{% endcapture %}
        {{ my_include | markdownify }}
    </div>
+    <div id="viaproxy-option" class="tab-pane fade" role="tabpanel">
+        {% capture my_include %}{% include setup/instructions/floodgate/viaproxy.md %}{% endcapture %}
+        {{ my_include | markdownify }}
+    </div>
    <div id="standalone-option" class="tab-pane fade" role="tabpanel">
        {% capture my_include %}{% include setup/instructions/floodgate/standalone.md %}{% endcapture %}
        {{ my_include | markdownify }}
@@ -15,7 +15,7 @@ page_sidebar: false
  </div>

  <div id="self-host-options" class="tab-pane fade" role="tabpanel">
-    {% include setup/instructions/geyser/tabs.html type="selfhost" show_standalone=true %}
+    {% include setup/instructions/geyser/tabs.html type="selfhost" show_viaproxy=true show_standalone=true %}
  </div>
 </div>

@@ -0,0 +1,14 @@
+# Floodgate setup with Geyser for ViaProxy
+
+<div class="alert alert-info" role="alert">
+	To be able to use Floodgate authentication, you need to be able to install Floodgate on the Java server you are connecting to.
+</div>
+
+1. Download and install the platform-specific Floodgate jar (e.g. floodgate-spigot, or floodgate-fabric) [here](https://geysermc.org/download#floodgate). 
+See the platform setup instructions for a detailed, platform specific setup guide. Then, continue with the instructions below.
+2. Copy the `key.pem` file in the Floodgate config folder to the `/plugins/Geyser/´ directory.
+3. Restart ViaProxy.
+
+<div class="alert alert-warning" role="alert">
+	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.
+</div>
@@ -0,0 +1,50 @@
+# ViaProxy Setup
+
+1. [Setup ViaProxy](https://github.com/ViaVersion/ViaProxy?tab=readme-ov-file#usage-for-players-gui).
+2. Download the plugin from [the download page](https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/viaproxy).
+3. Place the Geyser-ViaProxy.jar in the `plugins` folder, and restart ViaProxy.
+4. Open your Geyser config, located in `/plugins/Geyser/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 
+    ```
+    The vital part is the port. This is the port that Bedrock players will use to connect to your server!
+    If you enable `clone-remote-port`, the port will be overridden and the ViaProxy port is used.
+    Since you are self-hosting, you can choose the port freely - the default port is 19132. <br>
+    **Important**: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.
+   <br>
+
+    If you use the ViaProxy GUI you can use its account management system to join online mode servers with Bedrock Edition. If you use the ViaProxy CLI and want to allow Bedrock players to join your online mode server you have to install and [set up Floodgate](/floodgate/setup). <br>
+
+    NOTE: The value of the `auth-type` field is ignored and managed by ViaProxy automatically.
+
+5. Connecting to your server
+   <br> <br>
+    **Connecting locally in the same network** <br>
+    On the same device as the server, you can connect using `localhost`, or `127.0.0.1` as the address.
+    Do note: When hosting and playing on the same Windows device, you will need the [loopback fix](/geyser/fixing-unable-to-connect-to-world/#Using-Geyser-on-the-same-computer).
+    Other devices in the same local network can use your local IPv4 to connect - it starts with `10.` or `192.168.`.
+   <br> <br>
+    **Connecting from a different network**<br>
+    You will need to expose the port Geyser runs on to the Internet if you want players from outside your network to join.
+    To achieve that, you have two options: <br>
+
+    - Port forwarding: Open the Geyser port (e.g. 19132) on the UDP protocol in your router/modem, and in the Windows/Linux firewall. 
+   [Our port forwarding guide](/geyser/port-forwarding) explains how to do this in detail.
+   After doing this, players can connect with your public IPv4 + port to your server. <br>
+
+    - playit.gg: Instead of opening a port (which might not be an option/if you do not want to expose your home ip), you can use
+   the playit.gg service to create a tunnel for you to route the traffic through. See our [playit.gg guide](/geyser/playit-gg).
+   Ngrok will not work since it is TCP-only. <br>
+
+6. Verify whether connections from other networks are possible by running `geyser connectiontest <ip>:<port>` in the console.
+
+<div class="alert alert-info" role="alert">
+    To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use <a href="/floodgate/setup/">Floodgate</a>.
+</div>
@@ -8,6 +8,11 @@
    <li class="nav-item" role="presentation">
        <a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#proxy-option-{{include.type}}" type="button" role="tab" aria-controls="proxy-option-{{include.type}}" aria-selected="false"><img src="{{ '/img/icons/velocity.svg' | relative_url }}" alt="velocity icon"> Proxy Servers</a>
    </li>
+    {% if include.show_viaproxy != nil %}
+    <li class="nav-item" role="presentation">
+        <a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#viaproxy-option-{{include.type}}" type="button" role="tab" aria-controls="viaproxy-option-{{include.type}}" aria-selected="false"><img src="{{ '/img/icons/viaproxy.png' | relative_url }}" alt="viaproxy icon"> ViaProxy</a>
+    </li>
+    {% endif %}
    {% if include.show_standalone != nil %}
    <li class="nav-item" role="presentation">
        <a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#standalone-option-{{include.type}}" type="button" role="tab" aria-controls="standalone-option-{{include.type}}" aria-selected="false"><img src="{{ '/img/icons/geyser.png' | relative_url }}" alt="geyser icon"> Standalone</a>
@@ -28,6 +33,12 @@
        {% capture my_include %}{% include setup/instructions/geyser/{{include.type}}/proxy.md %}{% endcapture %}
        {{ my_include | markdownify }}
    </div>
+    {% if include.show_viaproxy != nil %}
+    <div id="viaproxy-option-{{include.type}}" class="tab-pane fade" role="tabpanel">
+        {% capture my_include %}{% include setup/instructions/geyser/{{include.type}}/viaproxy.md %}{% endcapture %}
+        {{ my_include | markdownify }}
+    </div>
+    {% endif %}
    {% if include.show_standalone != nil %}
    <div id="standalone-option-{{include.type}}" class="tab-pane fade" role="tabpanel">
        {% capture my_include %}{% include setup/instructions/geyser/{{include.type}}/standalone.md %}{% endcapture %}