Geyser/README.md

60 lines
2.5 KiB
Markdown
Raw Normal View History

2019-08-12 23:03:30 +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
2019-08-12 12:57:28 +00:00
[![forthebadge made-with-java](http://ForTheBadge.com/images/badges/made-with-java.svg)](https://java.com/)
2019-08-12 12:56:48 +00:00
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-09-13 20:06:45 +00:00
[![Discord](https://img.shields.io/discord/597838753859633172.svg?color=%237289da&label=discord)](https://discord.gg/GPMF8E2)
2019-08-01 23:52:52 +00:00
[![HitCount](http://hits.dwyl.io/Geyser/GeyserMC.svg)](http://hits.dwyl.io/Geyser/GeyserMC)
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
## 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.
2019-07-08 18:04:39 +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-07-31 22:48:16 +00:00
Links:
- Website: https://geysermc.org
- Docs: https://geysermc.org/docs
- Download: http://ci.geysermc.org
2019-09-22 21:14:49 +00:00
- Discord: https://discord.gg/GPMF8E
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
- [ ] Scoreboard
- [x] Objective-based scoreboards
- [ ] Team-based scoreboards
2019-07-17 18:16:30 +00:00
- [ ] Inventory support
- [x] Inventory viewing
2019-09-14 01:24:43 +00:00
- [x] NBT data
- [ ] Inventory movement (transactions)
2019-09-14 01:24:43 +00:00
- [x] Player movement support
- [x] Entity support
2019-09-14 01:24:43 +00:00
- [ ] Chunks (Experimental)
- [x] Block translation (may be missing mappings)
- [x] Block updates
2019-09-14 01:24:43 +00:00
- [ ] Block entities
- [ ] Extra data
- [ ] Biome colors
2019-07-17 18:16:30 +00:00
- [ ] Block break/place support
2019-07-08 18:04:39 +00:00
## Compiling
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
Any contributions are appreciated. Please feel free to reach out to us on [Discord](https://discord.gg/GPMF8E) if
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)