GeyserMC/README.md

<img src="https://geysermc.org/img/geyser-1760-860.png" alt="Geyser" width="600"/>

[![forthebadge made-with-java](http://ForTheBadge.com/images/badges/made-with-java.svg)](https://java.com/)

[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Build Status](https://ci.nukkitx.com/job/Geyser/job/master/badge/icon)](https://ci.nukkitx.com/job/Geyser/job/master/)
[![Discord](https://img.shields.io/discord/613163671870242838.svg?color=%237289da&label=discord)](http://discord.geysermc.org/)
[![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/)

Geyser is a bridge between Minecraft: Bedrock Edition and Minecraft: Java Edition, closing the gap from those wanting to play true cross-platform.

Geyser is an open collaboration project by [CubeCraft Games](https://cubecraft.net).

## What is Geyser?
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. **Please note, this project is still a work in progress and should not be used on production. Expect bugs!**

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.

## Setting Up
Take a look [here](https://github.com/GeyserMC/Geyser/wiki#Setup) for how to set up Geyser.

[![YouTube Video](https://img.youtube.com/vi/U7dZZ8w7Gi4/0.jpg)](https://www.youtube.com/watch?v=U7dZZ8w7Gi4)

## Links:
- Website: https://geysermc.org
- Docs: https://github.com/GeyserMC/Geyser/wiki
- Download: http://ci.geysermc.org
- Discord: http://discord.geysermc.org/
- ~~Donate: https://patreon.com/GeyserMC~~ Currently disabled.
- Test Server: test.geysermc.org port 25565 for Java and 19132 for Bedrock

## What's Left to be Added/Fixed
- The Following Inventories 
  - [ ] Enchantment Table (as a proper GUI)
  - [ ] Beacon
  - [ ] Cartography Table
  - [ ] Stonecutter
  - [ ] Structure Block
  - [ ] Horse Inventory
  - [ ] Loom
  - [ ] Smithing Table
- Some Entity Flags

## 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 `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.

## Contributing
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.

## 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)
Use higher res logo 2020-06-20 21:40:12 +02:00			`<img src="https://geysermc.org/img/geyser-1760-860.png" alt="Geyser" width="600"/>`
Add Readme widgets 2019-07-24 22:08:28 +02:00
Update README.md 2019-08-12 14:57:28 +02:00			`[![forthebadge made-with-java](http://ForTheBadge.com/images/badges/made-with-java.svg)](https://java.com/)`
Update README.md 2019-08-12 14:56:48 +02:00
Add Readme widgets 2019-07-24 22:08:28 +02:00			`[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)`
Fix url mistake 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/)`
Update Discord badge 2019-12-15 21:57:56 +01:00			`[![Discord](https://img.shields.io/discord/613163671870242838.svg?color=%237289da&label=discord)](http://discord.geysermc.org/)`
Update README.md 2019-08-02 01:52:52 +02:00			`[![HitCount](http://hits.dwyl.io/Geyser/GeyserMC.svg)](http://hits.dwyl.io/Geyser/GeyserMC)`
Add translation badge and remove manual remapping of language codes (#1060) 2020-07-30 22:07:59 +02:00			`[![Crowdin](https://badges.crowdin.net/geyser/localized.svg)](https://translate.geysermc.org/)`
Add Readme widgets 2019-07-24 22:08:28 +02:00
Light grammatical changes to main README 2019-09-23 00:43:05 +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.`
Create README.md 2019-07-08 20:04:39 +02:00
Update README.md 2020-05-14 00:53:13 +02:00			`Geyser is an open collaboration project by [CubeCraft Games](https://cubecraft.net).`

Create README.md 2019-07-08 20:04:39 +02:00			`## What is Geyser?`
Update README.md 2019-08-10 19:22:12 +02:00			`Geyser is a proxy, bridging the gap between Minecraft: Bedrock Edition and Minecraft: Java Edition servers.`
Add versions supported onto README 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!`
Create README.md 2019-07-08 20:04:39 +02:00
Update README.md 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!`

Update to 1.16.3 (#1272) * Update for 1.16.3-rc1 * Update to 1.16.3 * Update README * Update MCProtocolLib 2020-09-10 17:30:56 +02:00			`### Currently supporting Minecraft Bedrock v1.16.x and Minecraft Java v1.16.3.`
Create README.md 2019-07-08 20:04:39 +02:00
Update README.md 2019-09-26 05:11:31 +02:00			`## Setting Up`
Merge branch 'master' into plugin 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.`
Add YouTube tutorial video to setting up 2019-09-28 07:03:24 +02:00
Update README.md 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)`
Update README.md 2019-09-26 05:11:31 +02:00
Update README.md 2019-12-22 17:09:23 +01:00			`## Links:`
Update README.md 2019-08-01 00:48:16 +02:00			`- Website: https://geysermc.org`
Fix invalid docs link 2019-09-29 19:00:00 +02:00			`- Docs: https://github.com/GeyserMC/Geyser/wiki`
Update README.md 2019-08-01 00:48:16 +02:00			`- Download: http://ci.geysermc.org`
Update all discord links to static URL 2019-09-23 01:06:53 +02:00			`- Discord: http://discord.geysermc.org/`
Add test server to README 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`
Create README.md 2019-07-08 20:04:39 +02:00
Update README.md 2019-12-22 17:09:23 +01:00			`## What's Left to be Added/Fixed`
Update what's left on README 2020-04-22 07:45:29 +02:00			`- The Following Inventories`
Implement an enchantment table GUI (#1177) Until 1.16, enchantment tables were impossible to implement properly in Geyser. When a user selects an enchantment in Bedrock, the client creates the book on its end and assumes the server is OK with it. Java requires a button to be pressed to select the enchantment. With 1.16, server authoritative inventories remove that on Bedrock. However, until our inventory rewrite is finished we are still stuck without enchantment table support. This commit serves as an alternative as we wait. Enchantment table GUI support is still impossible since we are using the pre-1.16 inventory system. To solve this, this commit replaces the enchantment table GUI with a hopper GUI. The first slot serves as the spot you place the weapon. The second slot acts as the lapis slot - Geyser prevents any item from going in there that is not lapis. The final three slots act as the buttons; an enchanted book acts as each button, with the ability to show the translated text of each enchantment. https://cdn.discordapp.com/attachments/613194828359925800/746164042359504927/unknown.png 2020-08-21 02:53:47 +02:00			`- [ ] Enchantment Table (as a proper GUI)`
Update what's left on README 2020-04-22 07:45:29 +02:00			`- [ ] Beacon`
			`- [ ] Cartography Table`
			`- [ ] Stonecutter`
Add Command Block and Structure block to the fix list (#1119) * Add Command Block and Structure block to the fix list * Add Horse Inventory to the fix list Added Horse to the What's left to be added/fixed list. 2020-08-11 11:57:49 +02:00			`- [ ] Structure Block`
			`- [ ] Horse Inventory`
Add Loom to fix list (#1185) Added loom to the What's Left to be Added/Fixed list. 2020-08-23 17:24:31 +02:00			`- [ ] Loom`
Add smithing table to what's left to be added/fixed (#1187) Co-authored-by: Camotoy <20743703+DoctorMacc@users.noreply.github.com> 2020-08-23 17:29:02 +02:00			`- [ ] Smithing Table`
Update README.md 2019-12-22 17:09:23 +01:00			`- Some Entity Flags`
Update README.md 2019-07-17 20:16:30 +02:00
Create README.md 2019-07-08 20:04:39 +02:00			`## Compiling`
Light grammatical changes to main README 2019-09-23 00:43:05 +02:00			`1. Clone the repo to your computer`
			`2. [Install Maven](https://maven.apache.org/install.html)`
Update compiling instructions 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.
Create README.md 2019-07-08 20:04:39 +02:00
			`## Contributing`
Update all discord links to static URL 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`
Light grammatical changes to main README 2019-09-23 00:43:05 +02:00			`you're interested in helping out with Geyser.`
Update README.md 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)`