forked from GeyserMC/Geyser
35 lines
1.5 KiB
Markdown
35 lines
1.5 KiB
Markdown
# Geyser
|
|
A bridge between Minecraft: Bedrock Edition and Minecraft: Java Edition, closing the gap from those wanting to play together.
|
|
|
|
## What is Geyser?
|
|
Geyser is a (heavy work in progress) connector (or proxy), bridging the gap between Minecraft: Bedrock Edition and Minecraft: Java Edition servers.
|
|
The ultimate goal for this project is to allow those to join Minecraft: Java Edition servers using the Bedrock Edition.
|
|
|
|
### Please note, this project is still a HEAVY work in progress and probably won't be complete any time soon.
|
|
|
|
If you're interested in development, please join our Discord server:
|
|
https://discord.gg/mRjbCsS
|
|
|
|
## What's Completed
|
|
- [x] Server recognized in server list
|
|
- [x] Join detection from remote
|
|
- [ ] Online mode/auth support
|
|
- [x] Chat/command support
|
|
- [ ] Inventory support
|
|
- [ ] Movement support
|
|
- [ ] Entity support
|
|
- [ ] Chunks
|
|
- [ ] Block break/place support
|
|
|
|
## Compiling
|
|
Clone the repo to your computer, and run `mvn clean install`.
|
|
|
|
## Contributing
|
|
As a project that is still nowhere near completion, any contributions are appreciated. Please feel free to reach out to us on Discord if
|
|
you're interested in helping this project come along.
|
|
|
|
## 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)
|