Update with latest wiki changes

This commit is contained in:
Luke committed 2024-06-18 12:51:15 +01:00
1 parent 58b3bf4959
commit 29870726ab
6 files changed
+54 -31

No files matched your search

+14 -7
View File
@@ -15,23 +15,28 @@ The following things cannot be fixed without changes to Bedrock or the Java prot
- Custom heads in inventories
- Clickable links in chat
- Glowing effect
- Crafting in the 2x2 menu while in creative mode
- Crafting in the 2x2 menu while in creative mode - with the GeyserOptionalPack, this grid is hidden as it does not exist on Java.
- Distinguishing between left and right clicks in inventories
- Redstone dot blockstates
- "Can be placed on/destroyed" tag for *some* blocks - for example, different colors of clay/wool that don't exist as separate blocks
- "Can be placed on/destroyed" tag for *some* blocks - for example, different slab variants that aren't yet split up into separate blocks.
- Potion colors implemented using NBT
- Various command arguments for any command that doesn't use the Minecraft Brigadier library
- Anything that relies on tab complete or typing in the chat UI (related to the above) - Bedrock sends no packet that indicates they are in this menu
- Unable to see banner layers past 6
- Movement issues around bamboo due to offset differences between Java and Bedrock: [Hurricane](/other/hurricane) can work around it.
- Can't move mounted entities with carrot/warped fungus on a stick. Hurricane also works around this.
- Custom anvil recipes
- Heights lower than -64 or higher than 320 in the overworld with extended height enabled, and heights lower than 0 or higher than 256 in other dimensions
- Custom anvil recipes or custom smithing table ingredients/patterns (https://github.com/GeyserMC/Geyser/issues/4706)
- Heights lower than -64 or higher than 320 in the overworld with extended height enabled, and heights lower than 0 or higher than 256 in other dimensions (https://github.com/GeyserMC/Geyser/issues/3804)
- Dolphin's Grace potion effect visuals (effects should still work correctly)
- Invisible item frames
- Blocks (excluding jack-o-lantern) on entity heads (E.G. armor stands, players)
- Saddled camels unmoveable/unrideable on bedrock.
- Bedrock edition players cannot see the changes to fence block states made by the Java Debug Stick.
Some block state changes are controlled client side, and are not influenced by the debug stick - fences for example. (https://github.com/GeyserMC/Geyser/issues/3125)
- Custom beacon base blocks (https://github.com/GeyserMC/Geyser/issues/2301) - these are hardcoded on Bedrock edition.
- Climbable blocks changed by datapacks (https://github.com/GeyserMC/Geyser/issues/4051)
- Custom enchantments/sweeping edge (https://github.com/GeyserMC/Geyser/issues/3121)
- "Bordure Indented" pattern shape not appearing on the Bedrock side in the loom (https://github.com/GeyserMC/Geyser/issues/3183)
- Gliding without elytras/custom elytras (https://github.com/GeyserMC/Geyser/issues/3255, https://github.com/GeyserMC/Geyser/issues/3299)
- Custom furnace cook times (https://github.com/GeyserMC/Geyser/issues/4104)
- Maximum sign length different on Java/Bedrock edition (https://github.com/GeyserMC/Geyser/issues/4130)
## Fixable With GeyserOptionalPack {#fixable-with-geyseroptionalpack}
@@ -42,3 +47,5 @@ The following changes **are supported** with the [GeyserOptionalPack](/other/gey
- Offhand animations
- Shulker invisibility
- Spectral arrow texture
- Scoreboard width that matches Java
- Inventory UI changes to match Java
+31 -20
View File
@@ -3,57 +3,68 @@ title: Developer Guide
description: A guide for developers who want to contribute to GeyserMC projects.
---
## Compiling {#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 {#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 {#project-layout}
# Project layout {#project-layout}
Geyser's code is divided into different modules. For example:
* `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 Tools
# Compiler/IDE Tools
## Lombok {#lombok}
### Minecraft Development (IntelliJ IDEA plugin) {#minecraft-development}
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 {#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 {#wikivg}
### wiki.vg {#wikivg}
For a full rundown of the Java Edition protocol, see [here](https://wiki.vg/Protocol).
## wiki.vg (Bedrock) {#wikivg-bedrock}
### wiki.vg (Bedrock) {#wikivg-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 {#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 {#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 {#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 {#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 {#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 {#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}
### 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"`
+1 -1
View File
@@ -66,7 +66,7 @@
"message": "Find the plugin in the control panel under the 'VG Recommended' category and restart your server. IP and port are the same as Java."
},
"providers.provider.wisehosting.description": {
"message": "Both auto and manual installation available. Find the GeyserMC presets from the `Properties` tab in the Game Panel. There, click `Install` and restart your server. See [Crossplay FAQ](https://wisehosting.com/knowledgebase/how-to-install-geysermc-java-bedrock-crossplay-to-your-server) for additional details."
"message": "Both auto and manual installation available. Find the GeyserMC presets from the `Properties` tab in the Game Panel. There, click `Install` and restart your server. See [Crossplay FAQ](https://help.wisehosting.com/en/articles/13-how-to-install-geysermc-java-bedrock-crossplay-to-your-server) for additional details."
},
"providers.provider.zaphosting.description": {
"message": "Find the plugin in the control panel and restart your server. IP and port are the same as Java."
+1 -1
View File
@@ -66,7 +66,7 @@
"message": "Find the plugin in the control panel under the 'VG Recommended' category and restart your server. IP and port are the same as Java."
},
"providers.provider.wisehosting.description": {
"message": "Both auto and manual installation available. Find the GeyserMC presets from the `Properties` tab in the Game Panel. There, click `Install` and restart your server. See [Crossplay FAQ](https://wisehosting.com/knowledgebase/how-to-install-geysermc-java-bedrock-crossplay-to-your-server) for additional details."
"message": "Both auto and manual installation available. Find the GeyserMC presets from the `Properties` tab in the Game Panel. There, click `Install` and restart your server. See [Crossplay FAQ](https://help.wisehosting.com/en/articles/13-how-to-install-geysermc-java-bedrock-crossplay-to-your-server) for additional details."
},
"providers.provider.zaphosting.description": {
"message": "Find the plugin in the control panel and restart your server. IP and port are the same as Java."
+6 -1
View File
@@ -170,7 +170,7 @@ export const providersData: Providers = {
url: 'https://wisehosting.com',
description: translate({
id: 'providers.provider.wisehosting.description',
message: "Both auto and manual installation available. Find the GeyserMC presets from the `Properties` tab in the Game Panel. There, click `Install` and restart your server. See [Crossplay FAQ](https://wisehosting.com/knowledgebase/how-to-install-geysermc-java-bedrock-crossplay-to-your-server) for additional details."
message: "Both auto and manual installation available. Find the GeyserMC presets from the `Properties` tab in the Game Panel. There, click `Install` and restart your server. See [Crossplay FAQ](https://help.wisehosting.com/en/articles/13-how-to-install-geysermc-java-bedrock-crossplay-to-your-server) for additional details."
})
},
{
@@ -609,6 +609,11 @@ export const providersData: Providers = {
message: "Set the `bedrock port` to the Java server's port, or request an additional port. The additional port can be `19132` if you buy a dedicated IP."
})
},
{
name: "Wepwawet",
url: "https://wepwawet.net/",
description: "Add a new port in the Network tab. Use this new port as the bedrock port."
},
{
name: 'WinterNode',
url: 'https://winternode.com',
+1 -1
View File
@@ -1,4 +1,4 @@
{
"bedrock": "1.20.40-1.20.81",
"bedrock": "1.20.80-1.21.0",
"java": "1.20.5/1.20.6"
}