Fix: Make the developer guide less outdated (#279)

* dev guide info * Update developer-guide.md Co-authored-by: Olivia <[email protected]> * Update developer-guide.md * add mcdev plugin * address review --------- Co-authored-by: Olivia <[email protected]>
GeyserMC · Jun 14, 2024 · d648988 · d648988
1 parent fcc51e3
commit d648988
Showing 1 changed file with 33 additions and 20 deletions.
diff --git a/_docs/other/developer-guide.md b/_docs/other/developer-guide.md
@@ -2,57 +2,70 @@
 title: Developer Guide
 ---
 
-## Compiling
-1. Clone the repo to your computer (EG: `git clone https://github.com/GeyserMC/Geyser.git`)
-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 `bootstrap`, then your desired Geyser version, then `target` folder.
+# Compiling
+1. Clone the repo to your computer.
+2. Make sure that you have Java 21 installed.
+3. Navigate to the Geyser root directory and run `git submodule update --init --recursive`. This command downloads all the needed submodules for Geyser and is a crucial step in this process.
+4. Run `./gradlew build` and locate to `bootstrap/<platform>/build/` folder.
+
+# Project layout
+
+Geyser's code is divided into different modules. For example:
 
-## Project layout
 * `bootstrap` is where we hold the specific platform code. So if you're porting Geyser to a new platform, or working with platform-specific code, you likely want to be in here.
-* `core` is where connections are handled and the data conversion is done. The majority of Geyser work is held here.
+* `core` is where connections are handled and the data/packet conversion is done. The majority of Geyser work is held here.
+* `api` is where the Geyser API is found.
+* `build-logic` is where the Kotlin Gradle plugins used to build Geyser are.
+
+# Compiler/IDE Tools
+
+### Minecraft Development (IntelliJ IDEA plugin)
 
-# Compiler Tools
+The [Minecraft Development](https://github.com/minecraft-dev/MinecraftDev) IntelliJ IDEA plugin is an awesome tool that can
+be very helpful when working on Geyser. It allows you to view `.nbt` files, easily link mixins to the source they modify, and much 
+more. While not strictly needed, it is definitely recommended.
 
-## Lombok
+### Lombok
 
 *Note that the latest version of IntelliJ IDEA does not require additional setup in order to develop with Geyser.*
 
-If you're using an IDE for editing any of the GeyserMC projects you will most likely need to install the 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).
+If you're using an IDE for editing any of the GeyserMC projects you will most likely need to install the 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
 [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
+### wiki.vg
 For a full rundown of the Java Edition protocol, see [here](https://wiki.vg/Protocol).
 
-## wiki.vg (Bedrock)
+### 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.
 
 # Programs
 
-## debuginfo-be
+### debuginfo-be
 [debuginfo-be](https://github.com/Heath123/debuginfo-be) is a Spigot plugin that displays an overlay to Geyser clients with useful debug information, similar to the F3 screen in Java Edition.
 
-## pakkit
+### pakkit
 pakkit is a GUI-based tool for intercepting packets between a server and client developed by Geyser contributor [circuit10/Heath123](https://github.com/Heath123/) built using Electron. It works for both Java Edition (using node-minecraft-protocol) and Bedrock (as a GUI wrapper for ProxyPass adding extra features). It supports features such as viewing packet data in JSON format, Edit and Resend and a hex view for raw packet data. You can download it from [here](https://github.com/Heath123/pakkit/releases/). It's currently WIP, so expect bugs.
 
-## Gadget
+### Gadget
 Gadget is a fabric client mod to inspect & log, amongst other things, packets sent between a java server and a java client. It can be useful to determine java behavior.
 You can download it from [here](https://modrinth.com/mod/gadget).
 
-## ProxyPass
+### 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/CloudburstMC/ProxyPass) and the vanilla Bedrock server can be found [here](https://www.minecraft.net/download/server/bedrock/).
+There is a ProxyPass fork that supports online-mode (allowing you to join Geyser servers and see sent packets): [Kastle's proxypass fork](https://github.com/Kas-tle/ProxyPass/).
 
-## MCC Toolchest
+### 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](https://mcctoolchest.weebly.com/).
 
-## NBTExplorer
+### 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).
 
-## Windows 10 Multi-Version Launcher
+### Windows 10 Multi-Version Launcher
 The Windows 10 Multi-Version launcher allows you to switch between release and beta versions of Minecraft Bedrock. Its GitHub repository can be viewed [here](https://github.com/MCMrARM/mc-w10-version-launcher/).
 Alternatively, use FoxyNoTail's Version Switcher, found [here](https://foxynotail.com/software/mcbe-switcher).
 Note: To apply the [loopback fix](/geyser/fixing-unable-to-connect-to-world/#windows-1011) for Minecraft Preview, use the following loopback restriction lifting command with the different app ID: `CheckNetIsolation LoopbackExempt -a -n="Microsoft.MinecraftWindowsBeta_8wekyb3d8bbwe"`