2019-11-21 03:46:08 +00:00
|
|
|
<img src="https://geysermc.org/img/geyserlogo.png" alt="Geyser" width="600"/>
|
2019-07-24 20:08:28 +00:00
|
|
|
|
2019-08-12 12:57:28 +00:00
|
|
|
[](https://java.com/)
|
2019-08-12 12:56:48 +00:00
|
|
|
|
2019-07-24 20:08:28 +00:00
|
|
|
[](LICENSE)
|
2019-07-24 20:10:08 +00:00
|
|
|
[](https://ci.nukkitx.com/job/Geyser/job/master/)
|
2019-12-15 20:57:56 +00:00
|
|
|
[](http://discord.geysermc.org/)
|
2019-08-01 23:52:52 +00:00
|
|
|
[](http://hits.dwyl.io/Geyser/GeyserMC)
|
2019-07-24 20:08:28 +00:00
|
|
|
|
2019-09-22 22:43:05 +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
|
|
|
|
|
|
|
|
## 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.
|
2019-09-22 22:43:05 +00:00
|
|
|
The ultimate goal of this project is to allow Minecraft: Bedrock Edition users to join Minecraft: Java Edition servers as seamlessly as possible.
|
2019-07-08 18:04:39 +00:00
|
|
|
|
2019-12-22 16:09:23 +00:00
|
|
|
### Please note, this project is still a work in progress and should not be used on production. Expect bugs!
|
2019-07-08 18:04:39 +00:00
|
|
|
|
2019-09-26 03:11:31 +00:00
|
|
|
## Setting Up
|
2020-01-04 05:25:00 +00:00
|
|
|
Take a look [here](https://github.com/GeyserMC/Geyser/wiki#Setup) for how to set up Geyser.
|
2019-09-28 05:03:24 +00:00
|
|
|
|
2019-12-22 16:09:23 +00:00
|
|
|
[](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
|
2019-09-29 17:00:00 +00:00
|
|
|
- Docs: https://github.com/GeyserMC/Geyser/wiki
|
2019-07-31 22:48:16 +00:00
|
|
|
- Download: http://ci.geysermc.org
|
2019-09-22 23:06:53 +00:00
|
|
|
- Discord: http://discord.geysermc.org/
|
2019-12-23 03:01:48 +00:00
|
|
|
- Donate: https://patreon.com/GeyserMC
|
2019-07-08 18:04:39 +00:00
|
|
|
|
2019-12-22 16:09:23 +00:00
|
|
|
## What's Left to be Added/Fixed
|
|
|
|
|
- Inventories ([#67](https://github.com/GeyserMC/Geyser/pull/67))
|
|
|
|
|
- Crafting ([#67](https://github.com/GeyserMC/Geyser/pull/67))
|
|
|
|
|
- Creative Mode ([#67](https://github.com/GeyserMC/Geyser/pull/67))
|
|
|
|
|
- Sounds
|
|
|
|
|
- Block Particles
|
|
|
|
|
- Block Entities ([`block-entities`](https://github.com/GeyserMC/Geyser/tree/block-entities))
|
|
|
|
|
- Biome Colors
|
|
|
|
|
- Some Entity Flags
|
|
|
|
|
- Proper Movement
|
|
|
|
|
- Support to be Ran as a Plugin ([`plugin`](https://github.com/GeyserMC/Geyser/tree/plugin))
|
2019-07-17 18:16:30 +00:00
|
|
|
|
2019-07-08 18:04:39 +00:00
|
|
|
## Compiling
|
2019-09-22 22:43:05 +00:00
|
|
|
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 `mvn clean install`
|
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
|
2019-09-22 22:43:05 +00:00
|
|
|
you're interested in helping out with Geyser.
|
2019-07-17 18:16:30 +00:00
|
|
|
|
|
|
|
|
## Libraries Used:
|
|
|
|
|
- [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)
|
