Skip to main content

Setup

Spigot / Paper / Purpur Setup​

Prerequisites​

  • Geyser-Spigot
  • Floodgate (optional)

Instructions​

  1. Place the GeyserExtras.jar under the plugins/ folder

  2. Ensure that external-address and external-port in the config.yml are set to whatever your external Geyser address is. This is usually the address you give to your players.

You will need to load the plugin on the server at least once for the config to generate, and to reload the configuration you will need to restart the server (/reload command will be added eventually)

  1. Done! The plugin should now work.

Proxy Setup​

Instructions​

  1. Place the GeyserExtras.jar under the plugins/ folder in both your proxy and your backend.

  2. Boot up your backend, and ensure that proxy-mode in the config.yml is set to true on your backend server.

You will need to load the plugin on the server at least once for the config to generate, and to reload the configuration you will need to restart the server (/reload command will be added eventually)

  1. Ensure that external-address and external-port in the config.yml are set to whatever your proxy's external Geyser address is. This is usually the address you give to your players.

  2. Set up floodgate for proxy, ensuring that send-floodgate-data is true in floodgates config.

  3. Copy GeyserOptionalPack.mcpack and GeyserExtrasPack.mcpack from the GeyserExtras folder on your backend to your proxy's Geyser instance.

  4. Restart both your proxy and your backend.

  5. Done! The plugin should now work.

Config

If Geyser-Spigot is detected, all required config changes will be automatically applied.

Java Parity

enable-custom-cooldown​

Requires show-cooldown: "false" in Geyser's config.​

Values: true | false​

Default: true​

Enable the custom cooldown.

enable-java-only-block-placement​

Requires disable-bedrock-scaffolding: true in Geyser's config for forward block placements.​

Values: true | false​

Default: false​

Forces block placements to not be hold-bridgable/scaffold-bridgeable.

Fixes

enable-block-ghosting-fix​

Values: true | false​

Default: false​

Updates the block at the player's line of sight every tick to remove ghost blocks.

enable-knockback-attack-sprint-fix​

Values: true | false​

Default: true​

Enables the Knockback Attack Sprint fix.

In Java, when you execute a Knockback attack, the player stops sprinting for one tick. The workaround for Bedrock tricks the client into having no hunger for a tick, however this temporarily makes the hunger bar look empty.

Features

auto-reconnect​

Values: true | false​

Default: true​

When the server closes or Geyser reloads, reconnect all Bedrock Players to the server using external-address and external-port.

external-address​

Values: Any valid IP or Domain Address​

Default: "mc.exampleaddress.net"​

This is the external Bedrock address players connect to via WAN, NOT LAN/localhost. You should set this to the address you give to your players.

external-port​

Values: Any whole number from 0-65535​

Default: 19132​

This is the external Bedrock port players connect to via WAN, NOT LAN/localhost. You should set this to the port you give to your players.

enable-skin-saving​

Values: true | false​

Default: false​

Enables downloading of Bedrock Player skins.

Please note that this is only the skin that Floodgate converts to the Java model format, meaning that some marketplace skins like 128x128 skins, character creator skins or even some classic skins with weird geometry may not look 100% identical or may look lower resolution.

Quick Menu

quick-menu-actions​

The actions that will show up in the Quick-Menu. Quick-Menu requires the plugin version of Geyser.

Actions are formatted as shown below,

{title} >> {command}

Commands are executed as the player.

Available Placeholders​

%player_name%​

The name that is the Java Username of the player. For example: .Geyser_Extras If the player is linked the linked Java account's name is used.

%xbox_username%​

The username that the Bedrock player has.

For example: Geyser Extras

%player_device%​

Possible values: Android | iOS | Amazon | Windows Phone | Gear VR | Hololens | Windows | macOS | Apple TV | PlayStation | Switch | Xbox | Dedicated | Unknown​

The device the player is using currently.

%player_platform%​

Possible values: Console | Mobile | PC | VR | Unknown​

The platform the player is using currently.

%player_inputtype%​

Possible values: Keyboard | Touch | Controller | VR | Unknown​

The input type the player is using.

%player_uiprofile%​

Possible values: Classic | Pocket​

The UI Profile the player is using.

Default:​

quick-menu-actions:
  - "Swap Items with Off-hand >> /geyser offhand"
  - "Toggle Tooltips >> /geyser tooltips"
  - "Open GeyserExtras Menu >> /ge"
  - "Open Advancements >> /geyser advancements"
  - "Open Statistics >> /geyser statistics"
  - "Player List >> /playerlist"
  - "Platform List >> /platformlist"