OpenSource/GeyserMC
OpenSource/GeyserMC
1
0
Fork 0
mirror of https://github.com/GeyserMC/Geyser.git synced 2024-11-25 08:16:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

Refactor the page

Camotoy 2020-09-04 18:51:38 -04:00
parent 99cf804955
commit 5a75e8855c
1 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
Developer-Guide.md

@ -9,20 +9,23 @@
* `common` is where some data types are and other parts used in other plugins such as Floodgate.
* `connector` is where connections are handled and the data conversion is done. If adding in some new packet conversions you likely want to be in here.
# Compiler Tools
## Lombok
If you're using an IDE for editing any of the GeyserMC projects you will most likely need to install Project Lombok plugin as it is used to generate a bunch of handy functions. You can edit without it but you may get missing functions and or other issues displayed in your IDE. Please see the IDE section on their site for the supported plugins and install methods [https://projectlombok.org/setup/overview](https://projectlombok.org/setup/overview).
# Protocol Information
## GopherTunnel
[GopherTunnel](https://github.com/Sandertv/gophertunnel/tree/master/minecraft/protocol/packet) is a library for Bedrock Edition written in Go. The source code is an excellent documentation for the Bedrock protocol.
## wiki.vg
For a full rundown of the Java Edition protocol, see [here](https://wiki.vg/Protocol).
## wiki.vg (Bedrock)
The Bedrock Edition protocol is documented [here](https://wiki.vg/Bedrock_Protocol), but it's currently incomplete so only use it as a reference.
## gophertunnel
[gophertunnel's packets](https://github.com/Sandertv/gophertunnel/tree/master/minecraft/protocol/packet) have very good documentation, so they make a good reference for the Bedrock protocol.
## ProxyPass
ProxyPass is a tool for intercepting packets between a Bedrock server and client developed by the NukkitX team. It can be found [here](https://github.com/NukkitX/ProxyPass) and the vanilla Bedrock server can be found [here](https://www.minecraft.net/en-us/download/server/bedrock/).
# Programs
## MCC Toolchest
MCC Toolchest is a tool for viewing and editing NBT data for Bedrock edition, this allows you to see data as it is stored in Bedrock. You can download it from [here](http://mcctoolchest.com/).
@ -30,6 +33,8 @@ MCC Toolchest is a tool for viewing and editing NBT data for Bedrock edition, th
## NBTExplorer
NBTExplorer is a tool for viewing and editing NBT data for Java edition, this allows you to see data as it is stored in Java edition. You can download it from [here](https://github.com/jaquadro/NBTExplorer/releases).
## pakkit
pakkit is a GUI based tool for intercepting packets between a Java edition server and client developed by our own [circuit10/Heath123](https://github.com/Heath123/) built using Electron. It also has experimental support for Bedrock Edition as a friendlier GUI wrapper for ProxyPass. You can download it from [here](https://github.com/Heath123/pakkit) under releases, or clone from GitHub for the latest version. It's currently WIP, so expect bugs.
pakkit is a GUI based tool for intercepting packets between a Java edition server and client developed by Geyser contributor [circuit10/Heath123](https://github.com/Heath123/) built using Electron. It also has experimental support for Bedrock Edition as a friendlier GUI wrapper for ProxyPass. You can download it from [here](https://github.com/Heath123/pakkit) under releases, or clone from GitHub for the latest version. It's currently WIP, so expect bugs.
## ProxyPass
ProxyPass is a tool for intercepting packets between a Bedrock server and client developed by the Cloudburst team. It can be found [here](https://github.com/NukkitX/ProxyPass) and the vanilla Bedrock server can be found [here](https://www.minecraft.net/en-us/download/server/bedrock/).