mirror of
https://github.com/GeyserMC/Geyser.git
synced 2024-12-23 15:00:37 +01:00
59 lines
3.4 KiB
Markdown
59 lines
3.4 KiB
Markdown
<img src="https://geysermc.org/img/geyser-1760-860.png" alt="Geyser" width="600"/>
|
|
|
|
[](https://java.com/)
|
|
|
|
[](LICENSE)
|
|
[](https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/)
|
|
[](https://discord.gg/geysermc)
|
|
[](https://translate.geysermc.org/)
|
|
|
|
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](https://cubecraft.net).
|
|
|
|
## 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. However, due to the nature of Geyser translating packets over the network of two different games, *do not expect everything to work perfectly!*
|
|
|
|
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.41 + 1.18.0 - 1.18.10 and Minecraft Java 1.18/1.18.1.
|
|
|
|
## Setting Up
|
|
Take a look [here](https://github.com/GeyserMC/Geyser/wiki/Setup) for how to set up Geyser.
|
|
|
|
[](https://www.youtube.com/watch?v=U7dZZ8w7Gi4)
|
|
|
|
## Links:
|
|
- Website: https://geysermc.org
|
|
- Docs: https://github.com/GeyserMC/Geyser/wiki
|
|
- Download: https://ci.geysermc.org
|
|
- Discord: https://discord.gg/geysermc
|
|
- Donate: https://opencollective.com/geysermc
|
|
- Test Server: `test.geysermc.org` port `25565` for Java and `19132` for Bedrock
|
|
|
|
## 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
|
|
|
|
## 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](https://github.com/GeyserMC/Geyser/wiki/Current-Limitations) page.
|
|
|
|
## Compiling
|
|
1. Clone the repo to your computer
|
|
2. [Install Maven](https://maven.apache.org/install.html)
|
|
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](http://discord.geysermc.org/) if
|
|
you're interested in helping out with Geyser.
|
|
|
|
## Libraries Used:
|
|
- [Adventure Text Library](https://github.com/KyoriPowered/adventure)
|
|
- [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)
|