Minecraft Forge Handshake - Revision history

imported>ORelio: Document the FML2 handshake protocol for Minecraft 1.13+

2020-08-13T19:07:40Z

Document the FML2 handshake protocol for Minecraft 1.13+

imported>Iceiix: add 1.7.10 ModIdData mapping name discriminator bytes

2019-05-15T16:19:55Z

add 1.7.10 ModIdData mapping name discriminator bytes

← Older revision		Revision as of 16:19, 15 May 2019
Line 391:		Line 391:
	\| rowspan="2"\|Array		\| rowspan="2"\|Array
	\| String		\| String
	\| Name of the block/item.		\| Name of the block/item. Prefixed with a [https://github.com/MinecraftForge/MinecraftForge/blob/1.7.10/fml/src/main/java/cpw/mods/fml/common/registry/GameData.java#L763-L766 discriminator byte], 01 = block, 02 = item.
	\|-		\|-
	\| ID		\| ID

imported>Iceiix: update for 1.13.2 new server list ping json

2019-05-12T01:26:49Z

update for 1.13.2 new server list ping json

@@ Line 5: / Line 5: @@
 == Changes to [[Server List Ping]] ==
-When forge is installed, the [[Server List Ping]] changes with an additional <code>modinfo</code>.  Example:
+When forge is installed, the [[Server List Ping]] changes with an additional mod information.  Example for 1.13.2:
 <syntaxhighlight lang="javascript">

imported>TimmyRS: /* Definitions */ Fix dead link

2019-03-17T06:09:16Z

Definitions: Fix dead link

← Older revision		Revision as of 06:09, 17 March 2019
Line 89:		Line 89:
	Minecraft Forge uses an additional type not covered in [[data types]] for some things -- a varshort. This is essentially the same as a regular short, except that if the top byte (what is normally sign) is set, it is followed by an additional byte. This allows forge to retain backwards compatibility but extend the length of certain numbers -- the varshort is only used in places where, in vanilla Minecraft, the sign bit would not have been set. It is implemented in [https://github.com/MinecraftForge/MinecraftForge/blob/ebe9b6d4cbc4a5281c386994f1fbda04df5d2e1f/src/main/java/net/minecraftforge/fml/common/network/ByteBufUtils.java#L58-L89 ByteBufUtils].		Minecraft Forge uses an additional type not covered in [[data types]] for some things -- a varshort. This is essentially the same as a regular short, except that if the top byte (what is normally sign) is set, it is followed by an additional byte. This allows forge to retain backwards compatibility but extend the length of certain numbers -- the varshort is only used in places where, in vanilla Minecraft, the sign bit would not have been set. It is implemented in [https://github.com/MinecraftForge/MinecraftForge/blob/ebe9b6d4cbc4a5281c386994f1fbda04df5d2e1f/src/main/java/net/minecraftforge/fml/common/network/ByteBufUtils.java#L58-L89 ByteBufUtils].

	Discriminator bytes are the way that Minecraft Forge allows sending multiple messages on one [[plugin channel]]. They aren't part of the original specification, but a similar concept is used with the [~~[Plugin channel~~#MC~~\|AdvCdm\|~~<code>MC\|AdvCdm</code> plugin channel]] (used for command blocks). That packet decides whether a block location is being sent or an entity ID (minecart command blocks) is being sent based off of the value of the first byte in the packet.		Discriminator bytes are the way that Minecraft Forge allows sending multiple messages on one [[plugin channel]]. They aren't part of the original specification, but a similar concept is used with the [https://wiki.vg/index.php?title=Plugin_channels&oldid=14089#MC.7CAdvCmd <code>MC\|AdvCdm</code> plugin channel] (used for command blocks). That packet decides whether a block location is being sent or an entity ID (minecart command blocks) is being sent based off of the value of the first byte in the packet.

	In the same way, forge uses the first byte of the plugin message to specify which packet to use. It uses [https://github.com/MinecraftForge/MinecraftForge/blob/ebe9b6d4cbc4a5281c386994f1fbda04df5d2e1f/src/main/java/net/minecraftforge/fml/common/network/FMLIndexedMessageToMessageCodec.java FMLIndexedMessageToMessageCodec] to automatically switch the value.		In the same way, forge uses the first byte of the plugin message to specify which packet to use. It uses [https://github.com/MinecraftForge/MinecraftForge/blob/ebe9b6d4cbc4a5281c386994f1fbda04df5d2e1f/src/main/java/net/minecraftforge/fml/common/network/FMLIndexedMessageToMessageCodec.java FMLIndexedMessageToMessageCodec] to automatically switch the value.

imported>Pokechu22: /* FML|HS Packet structure */ Fix bad rowspans

2017-09-08T23:17:08Z

FML|HS Packet structure: Fix bad rowspans

← Older revision		Revision as of 23:17, 8 September 2017
Line 110:		Line 110:
	! Notes		! Notes
	\|-		\|-
	\|rowspan="6"\| <code>FML\|HS</code>		\|rowspan="3"\| <code>FML\|HS</code>
	\|rowspan="6"\| Client		\|rowspan="3"\| Client
	\| Discriminator		\| Discriminator
	\| Byte		\| Byte
Line 136:		Line 136:
	! Notes		! Notes
	\|-		\|-
	\|rowspan="6"\| <code>FML\|HS</code>		\|rowspan="2"\| <code>FML\|HS</code>
	\|rowspan="6"\| Server		\|rowspan="2"\| Server
	\| Discriminator		\| Discriminator
	\| Byte		\| Byte
Line 248:		Line 248:
	! Notes		! Notes
	\|-		\|-
	\|rowspan="6"\| <code>FML\|HS</code>		\|rowspan="2"\| <code>FML\|HS</code>
	\|rowspan="6"\| Both		\|rowspan="2"\| Both
	\| Discriminator		\| Discriminator
	\| Byte		\| Byte
Line 272:		Line 272:
	! Notes		! Notes
	\|-		\|-
	\|rowspan="6"\| <code>FML\|HS</code>		\|rowspan="1"\| <code>FML\|HS</code>
	\|rowspan="6"\| Client		\|rowspan="1"\| Client
	\| Discriminator		\| Discriminator
	\| Byte		\| Byte

imported>Pokechu22: FML|MP / multipart packets

2017-09-08T23:15:55Z

FML|MP / multipart packets

@@ Line 278: / Line 278: @@
   | Always -2 (254) for HandshakeReset
   |}
 == Differences from Forge 1.7.10 ==

imported>Pokechu22: /* HandshakeReset */ Rephrase + code link

2016-04-20T17:04:41Z

HandshakeReset: Rephrase + code link

← Older revision		Revision as of 17:04, 20 April 2016
Line 263:		Line 263:
	Causes the client to recomplete the entire handshake from the start. There is no payload beyond the discriminator byte.		Causes the client to recomplete the entire handshake from the start. There is no payload beyond the discriminator byte.

	~~This~~ packet is ~~only~~ used when connecting through a BungeeCord instance; when ~~connecting directly~~ to a ~~Forge~~ server ~~it is never used~~.		The normal forge server does not ever use this packet, but it is used [https://github.com/SpigotMC/BungeeCord/blob/aaddc9fcfdcada8d19ab115f2dcc8aed413a9206/proxy/src/main/java/net/md_5/bungee/ServerConnector.java#L126-L138 when connecting through a BungeeCord instance], specifically when transitioning from a vanilla server to a modded one or from a modded server to another modded server.

	{\| class="wikitable"		{\| class="wikitable"

imported>Pokechu22: /* HandshakeReset */ Used with bungeecord

2016-04-20T17:00:23Z

HandshakeReset: Used with bungeecord

← Older revision		Revision as of 17:00, 20 April 2016
Line 261:		Line 261:
	=== [https://github.com/MinecraftForge/MinecraftForge/blob/ebe9b6d4cbc4a5281c386994f1fbda04df5d2e1f/src/main/java/net/minecraftforge/fml/common/network/handshake/FMLHandshakeMessage.java#L265-L267 HandshakeReset] ===		=== [https://github.com/MinecraftForge/MinecraftForge/blob/ebe9b6d4cbc4a5281c386994f1fbda04df5d2e1f/src/main/java/net/minecraftforge/fml/common/network/handshake/FMLHandshakeMessage.java#L265-L267 HandshakeReset] ===

	~~{{Need Info\|Is this ever actually sent?}}~~		Causes the client to recomplete the entire handshake from the start. There is no payload beyond the discriminator byte.

	~~Causes the client to recomplete the entire handshake from the start. Does not appear~~ to ~~be sent. There~~ is ~~no payload beyond the discriminator byte~~.		This packet is only used when connecting through a BungeeCord instance; when connecting directly to a Forge server it is never used.

	{\| class="wikitable"		{\| class="wikitable"

imported>SamboyGaming: Fixed the link to enhanceStatusQuery() - it was off by a few lines.

2016-04-02T14:49:04Z

Fixed the link to enhanceStatusQuery() - it was off by a few lines.

← Older revision		Revision as of 14:49, 2 April 2016
Line 48:		Line 48:
	{{warning\|The key <code>modList</code> has a capital 'L', unlike any other key in the ping result!}}		{{warning\|The key <code>modList</code> has a capital 'L', unlike any other key in the ping result!}}

	This is injected in [https://github.com/MinecraftForge/MinecraftForge/blob/ebe9b6d4cbc4a5281c386994f1fbda04df5d2e1f/patches/minecraft/net/minecraft/network/ServerStatusResponse.java.patch#L45 ServerStatusResponse] by calling [https://github.com/MinecraftForge/MinecraftForge/blob/ebe9b6d4cbc4a5281c386994f1fbda04df5d2e1f/src/main/java/net/minecraftforge/fml/common/network/internal/FMLNetworkHandler.java#~~L192~~-~~L206~~ FMLNetworkHandler.enhanceStatusQuery()].		This is injected in [https://github.com/MinecraftForge/MinecraftForge/blob/ebe9b6d4cbc4a5281c386994f1fbda04df5d2e1f/patches/minecraft/net/minecraft/network/ServerStatusResponse.java.patch#L45 ServerStatusResponse] by calling [https://github.com/MinecraftForge/MinecraftForge/blob/ebe9b6d4cbc4a5281c386994f1fbda04df5d2e1f/src/main/java/net/minecraftforge/fml/common/network/internal/FMLNetworkHandler.java#L197-L211 FMLNetworkHandler.enhanceStatusQuery()].

	== Connection to a forge server ==		== Connection to a forge server ==

imported>Pokechu22: Rewrite intro

2016-03-21T15:47:54Z

Rewrite intro

← Older revision		Revision as of 15:47, 21 March 2016
Line 1:		Line 1:
	~~{{Box\|~~		This page documents the current '''[https://minecraftforge.net/ Minecraft Forge] protocol''', including how to connect to servers running Minecraft Forge and what changes it makes to the vanilla protocol, for Minecraft 1.7.10, 1.8, and 1.9.
	~~BORDER = #FFCC00\|~~
	~~BACKGROUND = #FFFF00\|~~
	~~WIDTH = 100%\|~~
	~~ICON = \|~~
	~~HEADING = Work in progress! \|~~
	~~CONTENT =~~
	This page ~~is a work in progress~~, and ~~may be missing a lot of information or may contain incorrect information. Feel free to edit~~ it to ~~add your own information~~.
	}}

	~~This page will document the changes made in the '''[https://minecraftforge.net/ Minecraft Forge] protocol'''.~~		Largely based off of [https://github.com/ORelio/Minecraft-Console-Client/pull/100 Pokechu22's work on getting Minecraft Console Client to connect to Forge servers].

	Largely based ~~on my own attempts to document the protocol and allow connection to forge servers~~ [https://github.com/ORelio/Minecraft-Console-Client/pull/100 ~~here~~].

	== Changes to [[Server List Ping]] ==		== Changes to [[Server List Ping]] ==