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-09-22 22:43:05 +00:00
### Please note, this project is still a work in progress and should not be used on production.
2019-07-08 18:04:39 +00:00
2019-09-26 03:11:31 +00:00
## Setting Up
2019-09-28 05:03:58 +00:00
Please note, Geyser is **not** a plugin. Watch the video below or take a look [here ](https://github.com/GeyserMC/Geyser/wiki#Setup ) for how to set it up.
2019-09-28 05:03:24 +00:00
[](https://www.youtube.com/watch?v=OmLxwl7_UzQ)
2019-09-26 03:11:31 +00:00
2019-07-31 22:48:16 +00:00
Links:
- 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-07-08 18:04:39 +00:00
2019-07-17 18:16:30 +00:00
## What's Completed
- [x] Server recognized in server list
- [x] Join detection from remote
2019-07-24 06:29:54 +00:00
- [x] Online mode/auth support
2019-07-21 01:22:09 +00:00
- [x] Chat/command support
2019-10-12 00:25:09 +00:00
- [x] Scoreboard
2019-07-17 18:16:30 +00:00
- [ ] Inventory support
2019-08-04 03:24:53 +00:00
- [x] Inventory viewing
2019-09-14 01:24:43 +00:00
- [x] NBT data
2019-08-04 03:24:53 +00:00
- [ ] Inventory movement (transactions)
2019-09-14 01:24:43 +00:00
- [x] Player movement support
2019-09-15 04:19:13 +00:00
- [x] Entity support
2019-10-12 00:33:23 +00:00
- [x] Player support
2019-10-12 00:25:09 +00:00
- [ ] Chunks
2019-09-14 01:24:43 +00:00
- [x] Block translation (may be missing mappings)
2019-09-15 23:34:14 +00:00
- [x] Block updates
2019-09-14 01:24:43 +00:00
- [ ] Block entities
2019-10-12 00:25:09 +00:00
- [x] Extra data
2019-09-14 01:24:43 +00:00
- [ ] Biome colors
2019-09-27 21:41:55 +00:00
- [x] Block break/place support
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 )
