Geyser/README.md

54 lines
3 KiB
Markdown
Raw Normal View History

2020-06-20 19:40:12 +00:00
<img src="https://geysermc.org/img/geyser-1760-860.png" alt="Geyser" width="600"/>
2019-07-24 20:08:28 +00:00
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
2021-07-21 03:19:51 +00:00
[![Discord](https://img.shields.io/discord/613163671870242838.svg?color=%237289da&label=discord)](https://discord.gg/geysermc)
2024-04-08 09:05:48 +00:00
[![Crowdin](https://badges.crowdin.net/e/51361b7f8a01644a238d0fe8f3bddc62/localized.svg)](https://translate.geysermc.org/)
2019-07-24 20:08:28 +00: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 18:04:39 +00:00
2020-05-13 22:53:13 +00:00
Geyser is an open collaboration project by [CubeCraft Games](https://cubecraft.net).
2019-07-08 18:04:39 +00:00
## What is Geyser?
2019-08-10 17:22:12 +00:00
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!*
2019-07-08 18:04:39 +00: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 22:53:13 +00:00
### Currently supporting Minecraft Bedrock 1.20.80 - 1.21.0 and Minecraft Java 1.21
2019-07-08 18:04:39 +00:00
2019-09-26 03:11:31 +00:00
## Setting Up
2022-03-18 20:01:14 +00:00
Take a look [here](https://wiki.geysermc.org/geyser/setup/) for how to set up Geyser.
2019-12-22 16:09:23 +00:00
[![YouTube Video](https://img.youtube.com/vi/U7dZZ8w7Gi4/0.jpg)](https://www.youtube.com/watch?v=U7dZZ8w7Gi4)
2019-09-26 03:11:31 +00:00
2019-12-22 16:09:23 +00:00
## Links:
2019-07-31 22:48:16 +00:00
- Website: https://geysermc.org
2022-03-18 20:01:14 +00:00
- Docs: https://wiki.geysermc.org/geyser/
2023-03-19 20:24:52 +00:00
- Download: https://geysermc.org/download
- Discord: https://discord.gg/geysermc
- Donate: https://opencollective.com/geysermc
- Test Server: `test.geysermc.org` port `25565` for Java and `19132` for Bedrock
2019-07-08 18:04:39 +00:00
2019-12-22 16:09:23 +00:00
## What's Left to be Added/Fixed
2020-12-12 06:46:29 +00:00
- Near-perfect movement (to the point where anticheat on large servers is unlikely to ban you)
2019-12-22 16:09:23 +00:00
- Some Entity Flags
2019-07-17 18:16:30 +00:00
## What can't be fixed
2022-03-18 20:01:14 +00: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.
2019-07-08 18:04:39 +00:00
## Compiling
1. Clone the repo to your computer
2022-09-05 03:35:47 +00: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 18:04:39 +00:00
## Contributing
2019-09-22 23:06:53 +00:00
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.
2019-07-17 18:16:30 +00:00
## Libraries Used:
2021-06-01 19:51:01 +00:00
- [Adventure Text Library](https://github.com/KyoriPowered/adventure)
2019-07-17 18:16:30 +00: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)