MattTheTekie/GeyserWiki
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'master' into patch-1

Browse source
This commit is contained in:
rtm516 2023-05-14 20:33:41 +01:00 • committed by GitHub
commit 5ff9f9ae8c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

25
_docs/other/geyserconnect.md
View file

@ -8,30 +8,15 @@ GeyserConnect is a extension for Geyser that allows you to join multiple servers
## Setup
(For GeyserConnect to work you need an open UDP port, by default it's `19132`.)
1. Download the latest build from [Github Actions](https://github.com/GeyserMC/GeyserConnect/actions)
1. Download the latest Geyser build from the [downloads page](https://geysermc.org/download#standalone)
2. Download the latest build from [Github Actions](https://github.com/GeyserMC/GeyserConnect/actions)
3. Extract the downloaded ZIP file, and put the extracted JAR file into the `extensions` folder in you're GeyserMC standalone installation.
4. Start Geyser standalone as you do with a normal Geyser install. EG: `java -Xms1024M -jar Geyser.jar` (More info on [Creating a Startup Script](/geyser/creating-a-startup-script/))
5. Shutdown the standalone Geyser instance, and make you're desired changes to the GeyserConnect configuration in `GeyserConnect` in the `extensions` folder.
6. Connect to it to make sure its all working.
## DNS and Docker
There are both [DNS](https://github.com/GeyserMC/GeyserConnect/tree/master/bind9) (using bind9) and [Docker](https://github.com/GeyserMC/GeyserConnect/tree/master/docker) configs in the repo if you would like to use them.
## DNS
There are [DNS](https://github.com/GeyserMC/GeyserConnect/tree/master/bind9) (using bind9) configs in the repo if you would like to use them.
## Config
* `address` - The IP address that will listen for connections.
* `remote-address` - The IP address to forward players to, this needs to be accessible by the client. Set it to `auto` to grab your public IP automatically.
* `port` - The port that will listen for connections.
* `debug-mode` - If debug messages should be sent through console.
* `max-players` - Maximum amount of players that can connect.
* `motd` - MOTD to display.
* `geyser`
* `debug-mode` - If debug messages should be sent through the console, has to be enabled in both places to work.
* `shutdown-time` - The time to wait after the last player disconnects to shutdown the proxy, in seconds. Set to -1 to disable.
* `servers` - A list of servers to show for everyone build from `address`, `port`, `name`, `online` and `bedrock` all optional apart from address.
* `custom-servers`
* `enabled` - Should custom servers be enabled for users.
* `max` - Max amount of custom servers per user.
* `storage-type` - Storage engine for custom servers. Can be `json`, `sqlite`, `mysql`
* `mysql` - Connection information for the MySQL database if enabled
The default config can be found [here](https://github.com/GeyserMC/GeyserConnect/blob/master/src/main/resources/config.yml).
See [here](https://github.com/GeyserMC/GeyserConnect/blob/master/src/main/resources/config.yml).