2020-06-20 21:40:12 +02:00
< img src = "https://geysermc.org/img/geyser-1760-860.png" alt = "Geyser" width = "600" / >
2019-07-24 22:08:28 +02:00
2021-04-10 06:34:29 +02:00
[](https://java.com/)
2019-08-12 14:56:48 +02:00
2019-07-24 22:08:28 +02:00
[](LICENSE)
2020-12-26 21:40:49 +01:00
[](https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/)
2021-04-10 06:34:29 +02:00
[](https://discord.gg/geysermc/)
2021-03-24 16:04:41 +01:00
[](http://hits.dwyl.com/Geyser/GeyserMC)
2020-07-30 22:07:59 +02:00
[](https://translate.geysermc.org/)
2019-07-24 22:08:28 +02:00
2019-09-23 00:43:05 +02: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 20:04:39 +02:00
2020-05-14 00:53:13 +02:00
Geyser is an open collaboration project by [CubeCraft Games ](https://cubecraft.net ).
2019-07-08 20:04:39 +02:00
## What is Geyser?
2019-08-10 19:22:12 +02:00
Geyser is a proxy, bridging the gap between Minecraft: Bedrock Edition and Minecraft: Java Edition servers.
2020-02-17 01:08:24 +01:00
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!**
2019-07-08 20:04:39 +02:00
2021-04-10 06:34:29 +02: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-14 00:53:13 +02:00
2021-06-29 01:24:06 +02:00
### Currently supporting Minecraft Bedrock 1.17 - 1.17.2 and Minecraft Java 1.17.
2019-07-08 20:04:39 +02:00
2019-09-26 05:11:31 +02:00
## Setting Up
2021-06-09 03:16:56 +02:00
Take a look [here ](https://github.com/GeyserMC/Geyser/wiki/Setup ) for how to set up Geyser.
2019-09-28 07:03:24 +02:00
2019-12-22 17:09:23 +01:00
[](https://www.youtube.com/watch?v=U7dZZ8w7Gi4)
2019-09-26 05:11:31 +02:00
2019-12-22 17:09:23 +01:00
## Links:
2019-08-01 00:48:16 +02:00
- Website: https://geysermc.org
2019-09-29 19:00:00 +02:00
- Docs: https://github.com/GeyserMC/Geyser/wiki
2021-04-10 06:34:29 +02:00
- Download: https://ci.geysermc.org
- Discord: https://discord.gg/geysermc
2020-07-31 21:57:06 +02:00
- ~~Donate: https://patreon.com/GeyserMC~~ Currently disabled.
2020-09-29 00:09:57 +02:00
- Test Server: `test.geysermc.org` port `25565` for Java and `19132` for Bedrock
2019-07-08 20:04:39 +02:00
2019-12-22 17:09:23 +01:00
## What's Left to be Added/Fixed
2020-12-12 07:46:29 +01:00
- Near-perfect movement (to the point where anticheat on large servers is unlikely to ban you)
- Resource pack conversion/CustomModelData
2019-12-22 17:09:23 +01:00
- Some Entity Flags
2021-02-26 20:06:00 +01:00
- Structure block UI
2019-07-17 20:16:30 +02:00
2021-05-20 04:24:11 +02:00
Extended height features can be "supported", but require additional work.
2020-12-15 00:22:18 +01:00
## What can't be fixed
2021-05-22 01:46:26 +02: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://github.com/GeyserMC/Geyser/wiki/Current-Limitations ) page.
2020-12-15 00:22:18 +01:00
2019-07-08 20:04:39 +02:00
## Compiling
2019-09-23 00:43:05 +02:00
1. Clone the repo to your computer
2. [Install Maven ](https://maven.apache.org/install.html )
2021-04-10 06:34:29 +02:00
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.
2019-12-29 20:57:02 +01:00
4. Run `mvn clean install` and locate to the `target` folder.
2019-07-08 20:04:39 +02:00
## Contributing
2019-09-23 01:06:53 +02:00
Any contributions are appreciated. Please feel free to reach out to us on [Discord ](http://discord.geysermc.org/ ) if
2019-09-23 00:43:05 +02:00
you're interested in helping out with Geyser.
2019-07-17 20:16:30 +02:00
## Libraries Used:
2021-06-01 21:51:01 +02:00
- [Adventure Text Library ](https://github.com/KyoriPowered/adventure )
2019-07-17 20:16:30 +02: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 )
