2020-06-20 14:40:12 -05:00
< img src = "https://geysermc.org/img/geyser-1760-860.png" alt = "Geyser" width = "600" / >
2019-07-24 21:08:28 +01:00
[](LICENSE)
2021-07-20 23:19:51 -04:00
[](https://discord.gg/geysermc)
2020-07-30 21:07:59 +01:00
[](https://translate.geysermc.org/)
2019-07-24 21:08:28 +01:00
2019-09-22 15:43:05 -07:00
Geyser is a bridge between Minecraft: Bedrock Edition and Minecraft: Java Edition, closing the gap from those wanting to play true cross-platform.
2019-07-08 13:04:39 -05:00
2020-05-13 17:53:13 -05:00
Geyser is an open collaboration project by [CubeCraft Games ](https://cubecraft.net ).
2019-07-08 13:04:39 -05:00
## What is Geyser?
2019-08-10 12:22:12 -05:00
Geyser is a proxy, bridging the gap between Minecraft: Bedrock Edition and Minecraft: Java Edition servers.
2021-07-21 22:31:54 -05:00
The ultimate goal of this project is to allow Minecraft: Bedrock Edition users to join Minecraft: Java Edition servers as seamlessly as possible. However, due to the nature of Geyser translating packets over the network of two different games, *do not expect everything to work perfectly!*
2019-07-08 13:04:39 -05:00
2021-04-09 23:34:29 -05:00
Special thanks to the DragonProxy project for being a trailblazer in protocol translation and for all the team members who have joined us here!
2020-05-13 17:53:13 -05:00
2023-06-07 18:19:35 +02:00
### Currently supporting Minecraft Bedrock 1.19.80 - 1.20 and Minecraft Java 1.20.
2019-07-08 13:04:39 -05:00
2019-09-25 22:11:31 -05:00
## Setting Up
2022-03-18 16:01:14 -04:00
Take a look [here ](https://wiki.geysermc.org/geyser/setup/ ) for how to set up Geyser.
2019-09-28 00:03:24 -05:00
2019-12-22 10:09:23 -06:00
[](https://www.youtube.com/watch?v=U7dZZ8w7Gi4)
2019-09-25 22:11:31 -05:00
2019-12-22 10:09:23 -06:00
## Links:
2019-07-31 17:48:16 -05:00
- Website: https://geysermc.org
2022-03-18 16:01:14 -04:00
- Docs: https://wiki.geysermc.org/geyser/
2023-03-19 15:24:52 -05:00
- Download: https://geysermc.org/download
2021-04-09 23:34:29 -05:00
- Discord: https://discord.gg/geysermc
2021-08-08 17:36:51 +01:00
- Donate: https://opencollective.com/geysermc
2020-09-29 01:09:57 +03:00
- Test Server: `test.geysermc.org` port `25565` for Java and `19132` for Bedrock
2019-07-08 13:04:39 -05:00
2019-12-22 10:09:23 -06:00
## What's Left to be Added/Fixed
2020-12-11 22:46:29 -08:00
- Near-perfect movement (to the point where anticheat on large servers is unlikely to ban you)
2019-12-22 10:09:23 -06:00
- Some Entity Flags
2021-02-26 14:06:00 -05:00
- Structure block UI
2019-07-17 13:16:30 -05:00
2020-12-15 01:22:18 +02:00
## What can't be fixed
2022-03-18 16:01:14 -04:00
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 ](https://wiki.geysermc.org/geyser/current-limitations/ ) page.
2020-12-15 01:22:18 +02:00
2019-07-08 13:04:39 -05:00
## Compiling
2019-09-22 15:43:05 -07:00
1. Clone the repo to your computer
2022-09-05 10:35:47 +07:00
2. 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.
3. Run `gradlew build` and locate to `bootstrap/build` folder.
2019-07-08 13:04:39 -05:00
## Contributing
2019-09-22 18:06:53 -05:00
Any contributions are appreciated. Please feel free to reach out to us on [Discord ](http://discord.geysermc.org/ ) if
2019-09-22 15:43:05 -07:00
you're interested in helping out with Geyser.
2019-07-17 13:16:30 -05:00
## Libraries Used:
2021-06-01 15:51:01 -04:00
- [Adventure Text Library ](https://github.com/KyoriPowered/adventure )
2019-07-17 13:16:30 -05:00
- [NukkitX Bedrock Protocol Library ](https://github.com/NukkitX/Protocol )
- [Steveice10's Java Protocol Library ](https://github.com/Steveice10/MCProtocolLib )
- [TerminalConsoleAppender ](https://github.com/Minecrell/TerminalConsoleAppender )
- [Simple Logging Facade for Java (slf4j) ](https://github.com/qos-ch/slf4j )
