Skip to content
This repository has been archived by the owner on Jul 21, 2024. It is now read-only.

Commit

Permalink
Add documentation for splitscreen on consoles
Browse files Browse the repository at this point in the history
  • Loading branch information
markmetcalfe committed Jul 3, 2022
1 parent 90552f9 commit d913556
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 0 deletions.
5 changes: 5 additions & 0 deletions _docs/geyser/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,11 @@ This is a Bedrock client issue caused by Bedrock being 32-bit and Java being 64-
## Can I use Geyser to allow Java players to connect to my Bedrock server?
No, this is a translation tool to allow Bedrock players to connect to Java servers. It does not work the opposite way.

## Can players join via splitscreen on Xbox/Playstation/Nintendo Switch?
Geyser supports additional players joining via splitscreen, with the caveat that each player must have their own bedrock account.

See [these docs](/geyser/understanding-the-config/#splitscreen) for the configuration settings for splitscreen.

## Can I use Geyser with Pterodactyl Panel?
Yes, you can use Geyser as a plugin or a mod for your Minecraft server software running on Pterodactyl. There is also an official egg for the standalone version. It supports auto-updating and has all config options easily editable. You can find it [here](https://github.com/GeyserMC/pterodactyl-stuff), download the JSON egg, and import it into your panel.

Expand Down
9 changes: 9 additions & 0 deletions _docs/geyser/understanding-the-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,15 @@ saved-user-logins:

**`xbox-achievements-enabled`**: Allows Xbox achievements to be unlocked. **This disables certain commands so the Bedrock client can't "cheat" to get them; this cannot be worked around if you want to enable this**. Commands such as /gamemode and /give will not work from Bedrock with this enabled.

## Splitscreen

Options for setting up splitscreen support on consoles.

**`users`**: A list of mappings of console profile usernames to their respective bedrock accounts.
Any console profile that attempts to join via splitscreen won't be able to unless they are mapped to a bedrock account in this list.

Each `users` entry requires a `bedrock-username` and `xuid` value. They are the Gamertag and Xbox ID associated with the Bedrock account. These values can be found in the server logs when a player logs in to the server normally (not via splitscreen).

## Advanced Options

**`scoreboard-packet-threshold`**: Geyser updates the Scoreboard after every Scoreboard packet, but when Geyser tries to handle a lot of scoreboard packets per second can cause serious lag. This option allows you to specify after how many Scoreboard packets per seconds the Scoreboard updates will be then limited to four updates per second.
Expand Down
5 changes: 5 additions & 0 deletions _docs/geyser/using-geyser-with-consoles.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,8 @@ If you have an Android device, you have several options:

### Using an iOS device
If you have an iOS 14+ device, you can use [BedrockTogether](https://apps.apple.com/app/bedrocktogether/id1534593376).

# Splitscreen
Geyser supports additional players joining via splitscreen, with the caveat that each player must have their own bedrock account.

See [these docs](/geyser/understanding-the-config/#splitscreen) for the configuration settings for splitscreen.

0 comments on commit d913556

Please sign in to comment.