Skip to content

Developer Guide

Camotoy edited this page May 22, 2020 · 28 revisions

Compiling

  1. Clone the repo to your computer (EG: git clone https://github.com/GeyserMC/Geyser.git)
  2. Install Maven
  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 bootstrap, then your desired Geyser version, then target folder.

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.

wiki.vg

For a full rundown of the Java Edition protocol, see here.

ProxyPass

ProxyPass is a tool for intercepting packets between a Bedrock server and client developed by the NukkitX team. It can be found here and the vanilla Bedrock server can be found here.

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.

Pakkit

Pakkit is a GUI based tool for intercepting packets between a Java edition server and client developed by our own circuit10/Heath123 built using Electron. You can download it from here under releases. Its currently WIP, so expect bugs.