GeyserMC/README.md

Geyser is a bridge between Minecraft: Bedrock Edition and Minecraft: Java Edition, closing the gap from those wanting to play true cross-platform.

What is Geyser?

Geyser is a proxy, bridging the gap between Minecraft: Bedrock Edition and Minecraft: Java Edition servers. The ultimate goal of this project is to allow Minecraft: Bedrock Edition users to join Minecraft: Java Edition servers as seamlessly as possible.

Please note, this project is still a work in progress and should not be used on production.

Setting Up

Please note, Geyser is not a plugin. Watch the video below or take a look here for how to set it up.

Links:

• Website: https://geysermc.org
• Docs: https://github.com/GeyserMC/Geyser/wiki
• Download: http://ci.geysermc.org
• Discord: http://discord.geysermc.org/

What's Completed

• Server recognized in server list
• Join detection from remote
• Online mode/auth support
• Chat/command support
• Scoreboard
• Inventory support
  • Inventory viewing
  • NBT data
  • Inventory movement (transactions)
• Player movement support
• Entity support
• Player support
• Chunks
  • Block translation (may be missing mappings)
  • Block updates
  • Block entities
  • Extra data
  • Biome colors
• Block break/place support

Compiling

1. Clone the repo to your computer
2. Install Maven
3. Navigate to the Geyser root directory and run mvn clean install

Contributing

Any contributions are appreciated. Please feel free to reach out to us on Discord if you're interested in helping out with Geyser.

Libraries Used:

• NukkitX Bedrock Protocol Library
• Steveice10's Java Protocol Library
• TerminalConsoleAppender
• Simple Logging Facade for Java (slf4j)