GeyserMC/README.md

63 lines
3.1 KiB
Markdown
Raw Normal View History

2020-06-20 21:40:12 +02:00
<img src="https://geysermc.org/img/geyser-1760-860.png" alt="Geyser" width="600"/>
2019-07-24 22:08:28 +02:00
2019-08-12 14:57:28 +02:00
[![forthebadge made-with-java](http://ForTheBadge.com/images/badges/made-with-java.svg)](https://java.com/)
2019-08-12 14:56:48 +02:00
2019-07-24 22:08:28 +02:00
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
2019-07-24 22:10:08 +02:00
[![Build Status](https://ci.nukkitx.com/job/Geyser/job/master/badge/icon)](https://ci.nukkitx.com/job/Geyser/job/master/)
2019-12-15 21:57:56 +01:00
[![Discord](https://img.shields.io/discord/613163671870242838.svg?color=%237289da&label=discord)](http://discord.geysermc.org/)
2019-08-02 01:52:52 +02:00
[![HitCount](http://hits.dwyl.io/Geyser/GeyserMC.svg)](http://hits.dwyl.io/Geyser/GeyserMC)
[![Crowdin](https://badges.crowdin.net/geyser/localized.svg)](https://translate.geysermc.org/)
2019-07-24 22:08:28 +02: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 20:04:39 +02:00
2020-05-14 00:53:13 +02:00
Geyser is an open collaboration project by [CubeCraft Games](https://cubecraft.net).
2019-07-08 20:04:39 +02:00
## What is Geyser?
2019-08-10 19:22:12 +02:00
Geyser is a proxy, bridging the gap between Minecraft: Bedrock Edition and Minecraft: Java Edition servers.
2020-02-17 01:08:24 +01:00
The ultimate goal of this project is to allow Minecraft: Bedrock Edition users to join Minecraft: Java Edition servers as seamlessly as possible. **Please note, this project is still a work in progress and should not be used on production. Expect bugs!**
2019-07-08 20:04:39 +02:00
2020-05-14 00:53:13 +02:00
Special thanks to the DragonProxy project for being a trailblazer in protocol translation and for all the team members who have now joined us here!
### Currently supporting Minecraft Bedrock v1.16.x and Minecraft Java v1.16.3.
2019-07-08 20:04:39 +02:00
2019-09-26 05:11:31 +02:00
## Setting Up
2020-01-04 06:25:00 +01:00
Take a look [here](https://github.com/GeyserMC/Geyser/wiki#Setup) for how to set up Geyser.
2019-12-22 17:09:23 +01:00
[![YouTube Video](https://img.youtube.com/vi/U7dZZ8w7Gi4/0.jpg)](https://www.youtube.com/watch?v=U7dZZ8w7Gi4)
2019-09-26 05:11:31 +02:00
2019-12-22 17:09:23 +01:00
## Links:
2019-08-01 00:48:16 +02:00
- Website: https://geysermc.org
2019-09-29 19:00:00 +02:00
- Docs: https://github.com/GeyserMC/Geyser/wiki
2019-08-01 00:48:16 +02:00
- Download: http://ci.geysermc.org
2019-09-23 01:06:53 +02:00
- Discord: http://discord.geysermc.org/
2020-07-31 21:57:06 +02:00
- ~~Donate: https://patreon.com/GeyserMC~~ Currently disabled.
- Test Server: test.geysermc.org port 25565 for Java and 19132 for Bedrock
2019-07-08 20:04:39 +02:00
2019-12-22 17:09:23 +01:00
## What's Left to be Added/Fixed
2020-04-22 07:45:29 +02:00
- The Following Inventories
- [ ] Enchantment Table (as a proper GUI)
2020-04-22 07:45:29 +02:00
- [ ] Beacon
- [ ] Cartography Table
- [ ] Stonecutter
- [ ] Structure Block
- [ ] Horse Inventory
- [ ] Loom
- [ ] Smithing Table
2019-12-22 17:09:23 +01:00
- Some Entity Flags
2019-07-17 20:16:30 +02:00
2019-07-08 20:04:39 +02:00
## Compiling
1. Clone the repo to your computer
2. [Install Maven](https://maven.apache.org/install.html)
2019-12-29 20:57:02 +01:00
3. Navigate to the Geyser root directory and run `git submodule update --init --recursive`. This downloads all the needed submodules for Geyser and is a crucial step in this process.
4. Run `mvn clean install` and locate to the `target` folder.
2019-07-08 20:04:39 +02:00
## Contributing
2019-09-23 01:06:53 +02:00
Any contributions are appreciated. Please feel free to reach out to us on [Discord](http://discord.geysermc.org/) if
you're interested in helping out with Geyser.
2019-07-17 20:16:30 +02: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)