Geyser/README.md

44 lines
1.9 KiB
Markdown
Raw Normal View History

2019-08-01 00:22:50 +00:00
<img src="https://geysermc.org/img/oss_logo.png" alt="Geyser" width="600" height="170"/>
2019-07-24 20:08:28 +00:00
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
2019-07-24 20:10:08 +00:00
[![Build Status](https://ci.nukkitx.com/job/Geyser/job/master/badge/icon)](https://ci.nukkitx.com/job/Geyser/job/master/)
2019-07-24 20:08:28 +00:00
[![Discord](https://img.shields.io/discord/597838753859633172.svg?color=%237289da&label=discord)](https://discord.gg/mRjbCsS)
2019-07-08 18:15:49 +00:00
A bridge between Minecraft: Bedrock Edition and Minecraft: Java Edition, closing the gap from those wanting to play together.
2019-07-08 18:04:39 +00:00
## 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.
2019-07-31 22:48:16 +00:00
### Please note, this project is still a work in progress and probably won't be complete any time soon.
2019-07-08 18:04:39 +00:00
2019-07-31 22:48:16 +00:00
Links:
- Website: https://geysermc.org
- Docs: https://geysermc.org/docs
- Download: http://ci.geysermc.org
- Discord: https://discord.gg/mRjbCsS
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-07-17 18:16:30 +00:00
- [ ] Inventory support
- [ ] Movement support
- [ ] Entity support
- [ ] Chunks
- [ ] Block break/place support
2019-07-08 18:04:39 +00:00
## 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.
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)