-
Notifications
You must be signed in to change notification settings - Fork 9
Add Guides: GeyserMC/Floodgate #71
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
coderrquitsreality
wants to merge
6
commits into
master
Choose a base branch
from
guides-new-content
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
8615a29
Add Guide: GeyserMC/Floodgate
coderrquitsreality 7fce834
Update Guide: GeyserMC/Floodgate and Descriptions
coderrquitsreality 0d304b5
Restore original description filename for GeyserMC
coderrquitsreality d1702a7
GeyserMC: Add guides
coderrquitsreality 68b2a92
GeyserMC: Paper specific image
coderrquitsreality 8b9e33c
GeyserMC: Add descriptor files
coderrquitsreality File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| +++ | ||
| title = "Setting up Geyser on Fabric" | ||
| tags = ["Minecraft", "Guide", "GeyserMC", "FabricMC"] | ||
| description_file = "descriptions/use-geyser-on-fabric.txt" | ||
| +++ | ||
|
|
||
| This guide will walk you through how to configure Geyser on Fabric with playit.gg | ||
|
|
||
| You can download GeyserMC here: | ||
| * **GeyserMC** - [[geysermc.org]](https://geysermc.org/download/?project=geyser) | ||
|
|
||
| Additionally, you need Fabric API and the Fabric Loader for this to work. Both sources are the same, so this is your preference. | ||
| * **Fabric API** - [[modrinth.com]](https://modrinth.com/mod/fabric-api) | ||
| * **Fabric API** - [[github.com]](https://github.com/FabricMC/fabric-api/releases) | ||
| * **Fabric Loader** [[fabricmc.net]](https://fabricmc.net/use/server/) | ||
|
|
||
| Optional: Floodgate | ||
| Floodgate allows Bedrock clients to connect to Java servers without the need for a Java Edition account. Without this, players will still be able to join, but they will need to authenticate with a Java Edition account. | ||
| * **Floodgate (Bedrock Authentication)** - [[geysermc.org]](https://geysermc.org/download/?project=floodgate) | ||
|
|
||
| ## Prefer to watch a video? | ||
| {{< youtube id="NBZt04WUcUk" start="0" >}} | ||
|
|
||
| ### Server | ||
| > The server we used for this guide is **Fabric 26.1.2**, and you can download it [here.](https://fabricmc.net/use/server/) The setup process is the same across all server platforms. See {{< link "how-to-setup-a-mc-server.md" >}} | ||
|
|
||
| ### Config | ||
| > `server.properties` | ||
| > | ||
| > By default, `enforce-secure-profile` is set to `true`. Set this to `false` to allow Bedrock clients to chat. | ||
|
|
||
| ### Installation | ||
| All files downloaded will be a `.jar` file. For Fabric, these files should be placed in the `./mods` folder, not `./plugins`. | ||
|
|
||
| {{< image src="post-img/playit-geyser-fabric-mods.png" alt="Geyser Mods Folder" >}} | ||
|
|
||
| ### Starting the server | ||
| Run your server's JAR file. We need to start the server in order for the server plugins to generate their config files for you. You can either open it using a batch file, or by running it inside of a command line. | ||
| ```batch | ||
| java -Xmx4G -jar fabric-server-mc.26.1.2-loader.0.19.3-launcher.1.1.1.jar nogui | ||
| pause | ||
| ``` | ||
|
|
||
| ### Creating a tunnel | ||
| > This server uses game presets, which means that all users will be able to create this. | ||
|
|
||
| You will create two tunnels. Minecraft Java, and Minecraft Bedrock. Follow the instructions shown on screen and create the tunnels. | ||
| Your tunnel list should look something like this: | ||
|
|
||
| {{< image src="post-img/playit-geyser-tunnel_list.png" alt="Geyser Setup Tunnel List" >}} | ||
|
|
||
| ### Modifying a tunnel | ||
| We'll need to change the origin configuration on the Minecraft Bedrock tunnel. Copy the port of your tunnel, and set the local port to this value. | ||
| For example, `1201`. Your port will be different. | ||
|
|
||
| {{< image src="post-img/playit-geyser-bedrock-origin.png" alt="Geyser Setup Bedrock Origin Configuration" >}} | ||
|
|
||
| ### Basic Geyser Config | ||
| Open and edit `./config/Geyser-Fabric/config.yml` (or similar file path). We need to change the port to the one provided by playit. Since our port is `1201`, we need to tell Geyser to listen on this port. | ||
|
|
||
| >```yml | ||
| ># Network settings for the Bedrock listener | ||
| >bedrock: | ||
| > # The IP address that Geyser will bind on to listen for incoming Bedrock connections. | ||
| > # Generally, you should only change this if you want to limit what IPs can connect to your server. | ||
| > address: 0.0.0.0 | ||
| > | ||
| > # The port that will Geyser will listen on for incoming Bedrock connections. | ||
| > # Since Minecraft: Bedrock Edition uses UDP, this port must allow UDP traffic. | ||
| > port: 1201 | ||
| > | ||
| > # 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. | ||
| > clone-remote-port: false | ||
| >``` | ||
|
|
||
| On a successful install, your logs should look like this: | ||
| ```bash | ||
| [00:00:00] [Server thread/INFO]: Took 15ms to boot Floodgate | ||
| [00:00:00] [Server thread/INFO]: ****************************************** | ||
| [00:00:00] [Server thread/INFO]: | ||
| [00:00:00] [Server thread/INFO]: Loading Geyser version 2.10.1-b1165 (git-master-a09c335) | ||
| [00:00:00] [Server thread/INFO]: | ||
| [00:00:00] [Server thread/INFO]: ****************************************** | ||
| [00:00:00] [GeyserServer-3-1/INFO]: Started Geyser on UDP port 1201 | ||
| [00:00:00] [Server thread/INFO]: Done (1.250s)! Run /geyser help for help! | ||
| ``` | ||
|
|
||
| Connecting to the server is the same as usual. Share playit's IP address with people to connect! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| +++ | ||
| title = "Setting up Geyser on Paper" | ||
| tags = ["Minecraft", "Guide", "GeyserMC", "PaperMC"] | ||
| description_file = "descriptions/use-geyser-on-paper.txt" | ||
| +++ | ||
|
|
||
| This guide will walk you through how to configure GeyserMC on Paper with playit.gg | ||
|
|
||
| You can download GeyserMC here: | ||
| * **GeyserMC** - [[geysermc.org]](https://geysermc.org/download/?project=geyser) | ||
|
|
||
| Optional: Floodgate | ||
| Floodgate allows Bedrock clients to connect to Java servers without the need for a Java Edition account. Without this, players will still be able to join, but they will need to authenticate with a Java Edition account. | ||
| * **Floodgate (Bedrock Authentication)** - [[geysermc.org]](https://geysermc.org/download/?project=floodgate) | ||
|
|
||
| ### Server | ||
| > The server we used for this guide is **Paper 26.1.2**, and you can download it here. [[papermc.io]](https://papermc.io/downloads/paper) The setup process is the same across all server platforms. See {{< link "how-to-setup-a-mc-server.md" >}} | ||
|
|
||
| ### Config | ||
| > `server.properties` | ||
| > | ||
| > By default, `enforce-secure-profile` is set to `true`. Set this to `false` to allow Bedrock clients to chat. | ||
|
|
||
| ### Installation | ||
| All files downloaded will be a `.jar` file. For Paper, these files should be placed in `./plugins` folder. | ||
|
|
||
| {{< image src="post-img/playit-geyser-paper-plugins.png" alt="Paper Plugins Folder" >}} | ||
|
|
||
| ### Starting the server | ||
| Run your server's JAR file. We need to start the server in order for the server plugins to generate their config files for you. You can either open it using a batch file, or by running it inside of a command line. | ||
| ```batch | ||
| java -Xmx4G -jar paper-26.1.2-72.jar nogui | ||
| pause | ||
| ``` | ||
|
|
||
| ### Creating a tunnel | ||
| > This server uses game presets, which means that all users will be able to create this. | ||
|
|
||
| You will create two tunnels. Minecraft Java, and Minecraft Bedrock. Follow the instructions shown on screen and create the tunnels. | ||
| Your tunnel list should look something like this: | ||
|
|
||
| {{< image src="post-img/playit-geyser-tunnel_list.png" alt="Geyser Setup Tunnel List" >}} | ||
|
|
||
| ### Modifying a tunnel | ||
| We'll need to change the origin configuration on the Minecraft Bedrock tunnel. Copy the port of your tunnel, and set the local port to this value. | ||
| For example, `1201`. Your port will be different. | ||
|
|
||
| {{< image src="post-img/playit-geyser-bedrock-origin.png" alt="Geyser Setup Bedrock Origin Configuration" >}} | ||
|
|
||
| ### Basic Geyser Config | ||
| Open and edit `./plugins/Geyser-Fabric/config.yml`. We need to change the port to the one provided by playit. Since our port is `1201`, we need to tell Geyser to listen on this port. | ||
|
|
||
| >```yml | ||
| ># Network settings for the Bedrock listener | ||
| >bedrock: | ||
| > # The IP address that Geyser will bind on to listen for incoming Bedrock connections. | ||
| > # Generally, you should only change this if you want to limit what IPs can connect to your server. | ||
| > address: 0.0.0.0 | ||
| > | ||
| > # The port that will Geyser will listen on for incoming Bedrock connections. | ||
| > # Since Minecraft: Bedrock Edition uses UDP, this port must allow UDP traffic. | ||
| > port: 1201 | ||
| > | ||
| > # 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. | ||
| > clone-remote-port: false | ||
| >``` | ||
|
|
||
| On a successful install, your logs should look like this: | ||
| ```bash | ||
| [00:00:00] [Server thread/INFO]: Took 15ms to boot Floodgate | ||
| [00:00:00] [Server thread/INFO]: ****************************************** | ||
| [00:00:00] [Server thread/INFO]: | ||
| [00:00:00] [Server thread/INFO]: Loading Geyser version 2.10.1-b1177 (git-master-232f873) | ||
| [00:00:00] [Server thread/INFO]: | ||
| [00:00:00] [Server thread/INFO]: ****************************************** | ||
| [00:00:00] [GeyserServer-3-1/INFO]: Started Geyser on UDP port 1201 | ||
| [00:00:00] [Server thread/INFO]: Done (1.250s)! Run /geyser help for help! | ||
| ``` | ||
|
|
||
| Connecting to the server is the same as usual. Share playit's IP address with people to connect! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| +++ | ||
| title = "Setting up Geyser with playit" | ||
| tags = ["Minecraft", "Guide", "Geyser"] | ||
| description_file = "descriptions/use-geyser-with-playit.txt" | ||
| +++ | ||
|
|
||
| This guide will walk you through how to configure Geyser with playit.gg | ||
|
|
||
| ## Requirements | ||
| * **Minecraft: Java Edition** - [[minecraft.net]](https://www.minecraft.net/en-us/store/minecraft-java-bedrock-edition-pc) | ||
|
|
||
| * **GeyserMC** - [[geysermc.org]](https://geysermc.org/download/?project=geyser) | ||
| * **Floodgate (Bedrock Authentication)** - [[geysermc.org]](https://geysermc.org/download/?project=floodgate) | ||
|
|
||
| ### Server | ||
| > The server we used for this guide is **Fabric 26.1.2**, and you can download it [here.](https://fabricmc.net/use/server/) The setup process is the same across all server platforms. See {{< link "how-to-setup-a-mc-server.md" >}} | ||
|
|
||
| ### Config | ||
| > `server.properties` | ||
| > | ||
| > By default, `enforce-secure-profile` is set to `true`. Set this to `false` to allow Bedrock clients to chat. | ||
|
|
||
| ### Creating a tunnel | ||
| > This server uses game presets, which means that all users will be able to create this. | ||
|
|
||
| You will create two tunnels. Minecraft Java, and Minecraft Bedrock. Follow the instructions shown on screen and create the tunnels. | ||
| Your tunnel list should look something like this: | ||
|
|
||
| {{< image src="post-img/playit-geyser-tunnel_list.png" alt="Geyser Setup Tunnel List" >}} | ||
|
|
||
| ### Modifying a tunnel | ||
| We'll need to change the origin configuration on the Minecraft Bedrock tunnel. Copy the port of your tunnel, and set the local port to this value. | ||
| For example, `1201`. | ||
|
|
||
| {{< image src="post-img/playit-geyser-bedrock-origin.png" alt="Geyser Setup Bedrock Origin Configuration" >}} | ||
|
|
||
| ### Basic Geyser Config | ||
| Open and edit `./config/Geyser-Fabric/config.yml` (or similar file path). We need to change the port to the one provided by playit. Since our port is `1201`, we need to tell Geyser to listen on this port. | ||
|
|
||
| ### Starting the server | ||
| Run your server's JAR file. We need to start the server in order for the server plugins to generate their config files for you. You can either open it using a batch file, or by running it inside of a command line. | ||
| ```batch | ||
| java -Xmx4G -jar fabric-server-mc.26.1.2-loader.0.19.3-launcher.1.1.1.jar nogui | ||
| pause | ||
| ``` | ||
|
|
||
| * The `java` command will invoke the Java runtime. `-Xmx4G` defines how much RAM the server can consume in total. 4G is 4 Gigabytes. `nogui` means there will not be a UI to interact with. This option is not required. | ||
| * `pause` will stop the console from automatically closing if there are errors. This allows you to look and read the errors. | ||
|
|
||
| >```yml | ||
| ># Network settings for the Bedrock listener | ||
| >bedrock: | ||
| > # The IP address that Geyser will bind on to listen for incoming Bedrock connections. | ||
| > # Generally, you should only change this if you want to limit what IPs can connect to your server. | ||
| > address: 0.0.0.0 | ||
| > | ||
| > # The port that will Geyser will listen on for incoming Bedrock connections. | ||
| > # Since Minecraft: Bedrock Edition uses UDP, this port must allow UDP traffic. | ||
| > port: 1201 | ||
| > | ||
| > # 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. | ||
| > clone-remote-port: false | ||
| >``` | ||
|
|
||
| On a successful install, your logs should look like this: | ||
| ```bash | ||
| [00:00:00] [Server thread/INFO]: Took 15ms to boot Floodgate | ||
| [00:00:00] [Server thread/INFO]: ****************************************** | ||
| [00:00:00] [Server thread/INFO]: | ||
| [00:00:00] [Server thread/INFO]: Loading Geyser version 2.10.1-b1165 (git-master-a09c335) | ||
| [00:00:00] [Server thread/INFO]: | ||
| [00:00:00] [Server thread/INFO]: ****************************************** | ||
| [00:00:00] [GeyserServer-3-1/INFO]: Started Geyser on UDP port 1201 | ||
| [00:00:00] [Server thread/INFO]: Done (1.250s)! Run /geyser help for help! | ||
| ``` | ||
|
|
||
| Connecting to the server is the same as usual. Share playit's IP address with people to connect! | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| This guide will walk you through how to configure Geyser on Fabric with playit.gg |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| This guide will walk you through how to configure Geyser on Paper with playit.gg |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| This guide will walk you through how to configure Geyser with playit.gg |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This guide seems quite redundant to the Fabric guide. Am I missing something? Could this just be a page to direct to the Fabric and Paper guides?