mirror of
https://github.com/GeyserMC/Geyser.git
synced 2024-08-14 23:57:35 +00:00
Create README.md
This commit is contained in:
parent
e7a9cf1e79
commit
5a57996e6e
1 changed files with 18 additions and 0 deletions
18
README.md
Normal file
18
README.md
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
# Geyser
|
||||||
|
A bridge between Minecraft: Java Edition and Minecraft: Bedrock edition, breaking the gap from those wanting to play together.
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
### Please note, this project is still a HEAVY work in progress and probably won't be complete any time soon.
|
||||||
|
|
||||||
|
If you're interested in development, please join our Discord server:
|
||||||
|
https://discord.gg/cnb7wch
|
||||||
|
|
||||||
|
## 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.
|
Loading…
Reference in a new issue