Geyser/README.md

54 lines
2.8 KiB
Markdown
Raw Normal View History

<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
[![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-12-15 20:57:56 +00:00
[![Discord](https://img.shields.io/discord/613163671870242838.svg?color=%237289da&label=discord)](http://discord.geysermc.org/)
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.
2020-02-17 00:08:24 +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. **Please note, this project is still a work in progress and should not be used on production. Expect bugs!**
2019-07-08 18:04:39 +00:00
2020-02-17 00:08:24 +00:00
### Currently supporting Minecraft Bedrock v1.14.X and Minecraft Java v1.15.2.
2019-07-08 18:04:39 +00:00
2019-09-26 03:11:31 +00:00
## Setting Up
2020-01-04 05:25:00 +00:00
Take a look [here](https://github.com/GeyserMC/Geyser/wiki#Setup) for how to set up Geyser.
2019-12-22 16:09:23 +00:00
[![YouTube Video](https://img.youtube.com/vi/U7dZZ8w7Gi4/0.jpg)](https://www.youtube.com/watch?v=U7dZZ8w7Gi4)
2019-09-26 03:11:31 +00:00
2019-12-22 16:09:23 +00:00
## Links:
2019-07-31 22:48:16 +00:00
- 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-12-23 03:01:48 +00:00
- Donate: https://patreon.com/GeyserMC
2019-07-08 18:04:39 +00:00
2019-12-22 16:09:23 +00:00
## What's Left to be Added/Fixed
- Inventories ([`inventory`](https://github.com/GeyserMC/Geyser/tree/inventory))
- Crafting ([`inventory`](https://github.com/GeyserMC/Geyser/tree/inventory))
- Creative Mode ([`inventory`](https://github.com/GeyserMC/Geyser/tree/inventory))
2019-12-22 16:09:23 +00:00
- Sounds
- Block Particles
- Block Entities ([`inventory`](https://github.com/GeyserMC/Geyser/tree/inventory))
2019-12-22 16:09:23 +00:00
- Some Entity Flags
2019-07-17 18:16:30 +00:00
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)
2019-12-29 19:57:02 +00: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 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
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)