OpenSource/GeyserMC
OpenSource/GeyserMC
1
0
Fork 0
mirror of https://github.com/GeyserMC/Geyser.git synced 2024-11-24 15:58:59 +01:00
Code Issues Projects Releases Packages Wiki Activity
GeyserMC/README.md
Camotoy 9aa7240f37
Update README
2021-07-06 10:20:06 -04:00

3.5 KiB
Raw Blame History

Geyser

forthebadge made-with-java

License: MIT Build Status Discord HitCount Crowdin

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

Geyser is an open collaboration project by CubeCraft Games.

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. Expect bugs!

Special thanks to the DragonProxy project for being a trailblazer in protocol translation and for all the team members who have joined us here!

Currently supporting Minecraft Bedrock 1.17 - 1.17.2 and Minecraft Java 1.17.1.

Setting Up

Take a look here for how to set up Geyser.

YouTube Video

Links:

What's Left to be Added/Fixed

  • Near-perfect movement (to the point where anticheat on large servers is unlikely to ban you)
  • Resource pack conversion/CustomModelData
  • Some Entity Flags
  • Structure block UI

Extended height features can be "supported", but require additional work.

What can't be fixed

There are a few things Geyser is unable to support due to various differences between Minecraft Bedrock and Java. For a list of these limitations, see the Current Limitations page.

Compiling

  1. Clone the repo to your computer
  2. Install Maven
  3. Navigate to the Geyser root directory and run git submodule update --init --recursive. This command downloads all the needed submodules for Geyser and is a crucial step in this process.
  4. Run mvn clean install and locate to the target folder.

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: