Difference between revisions of "Plugin channels"

From wiki.vg
Jump to navigation Jump to search
m (rename field of game_test_add_marker)
 
(95 intermediate revisions by 11 users not shown)
Line 1: Line 1:
 
'''Plugin channels''' allow client mods and server plugins to communicate without cluttering up chat. [http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ This post by Dinnerbone] is a good introduction and basic documentation.
 
'''Plugin channels''' allow client mods and server plugins to communicate without cluttering up chat. [http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ This post by Dinnerbone] is a good introduction and basic documentation.
 
{{anchor|Internal}}
 
{{anchor|Internal}}
 +
== Definitions ==
 +
=== Data Types ===
 +
 +
==== PathEntity ====
 +
 +
Represents calculated path of entity.
 +
 +
{| class="wikitable"
 +
! Name
 +
! Type
 +
! Notes
 +
|-
 +
| Current path index
 +
| Int
 +
| Index in the points array that the entity is currently targeting.
 +
|-
 +
| Target
 +
| PathPoint
 +
|
 +
|-
 +
| Number of points
 +
| Int
 +
| Number of elements in the following array
 +
|-
 +
| Points array
 +
| Array of PathPoint
 +
| The actual points on the path
 +
|-
 +
| Open set length
 +
| Int
 +
| Number of elements in the following array
 +
|-
 +
| Open set
 +
| Array of PathPoint
 +
|
 +
|-
 +
| Closed set length
 +
| Int
 +
| Number of elements in the following array
 +
|-
 +
| Closed set
 +
| Array of PathPoint
 +
|
 +
|}
 +
 +
You can read more here[https://en.wikipedia.org/wiki/A*_search_algorithm].
 +
 +
 +
==== PathPoint ====
 +
 +
Represents single point in path
 +
 +
{| class="wikitable"
 +
! Name
 +
! Type
 +
! Notes
 +
|-
 +
| X
 +
| Int
 +
|
 +
|-
 +
| Y
 +
| Int
 +
|
 +
|-
 +
| Z
 +
| Int
 +
|
 +
|-
 +
| Distance from origin
 +
| Float
 +
|
 +
|-
 +
| Cost
 +
| Float
 +
|
 +
|-
 +
| Cost malus
 +
| Float
 +
| Number that is rendered
 +
|-
 +
| Has been visited
 +
| Boolean
 +
|
 +
|-
 +
| Node type
 +
| Int enum
 +
| See below
 +
|-
 +
| Distance to target
 +
| Float
 +
|
 +
|}
 +
 +
Values for node type:
 +
 +
* 0: BLOCKED
 +
* 1: OPEN
 +
* 2: WALKABLE
 +
* 3: TRAPDOOR
 +
* 4: FENCE
 +
* 5: LAVA
 +
* 6: WATER
 +
* 7: WATER_BORDER
 +
* 8: RAIL
 +
* 9: DANGER_FIRE
 +
* 10: DAMAGE_FIRE
 +
* 11: DANGER_CACTUS
 +
* 12: DAMAGE_CACTUS
 +
* 13: DANGER_OTHER
 +
* 14: DAMAGE_OTHER
 +
* 15: DOOR_OPEN
 +
* 16: DOOR_WOOD_CLOSED
 +
* 17: DOOR_IRON_CLOSED
 +
* 18: BREACH
 +
* 19: LEAVES
 +
* 20: STICKY_HONEY
 +
* 21: COCOA
 +
 
== Reserved channels ==
 
== Reserved channels ==
=== <code>REGISTER</code> ===
+
=== <code>minecraft:register</code> ===
 
''Two-way''
 
''Two-way''
  
 
Allows the client or server to register for one or more custom channels, indicating that data should be sent on those channels if the receiving end supports it too. Payload is a null (<code>0x00</code>) separated list of strings.
 
Allows the client or server to register for one or more custom channels, indicating that data should be sent on those channels if the receiving end supports it too. Payload is a null (<code>0x00</code>) separated list of strings.
  
=== <code>UNREGISTER</code> ===
+
This channel was [https://twitter.com/Dinnerbone/status/1012052979250319360 renamed] from <code>REGISTER</code> in 1.13.
 +
 
 +
=== <code>minecraft:unregister</code> ===
 
''Two-way''
 
''Two-way''
  
 
Allows the client or server to unregister from one or more custom channels, indicating that the receiving end should stop sending data on those channels. Payload is a null-separated list of strings. This is only useful if plugins are disabled/unloaded while the client is connected.
 
Allows the client or server to unregister from one or more custom channels, indicating that the receiving end should stop sending data on those channels. Payload is a null-separated list of strings. This is only useful if plugins are disabled/unloaded while the client is connected.
 +
 +
This channel was [https://twitter.com/Dinnerbone/status/1012052979250319360 renamed] from <code>UNREGISTER</code> in 1.13.
  
 
== Channels internal to Minecraft ==
 
== Channels internal to Minecraft ==
As of 1.3, Minecraft itself started using plugin channels to implement new features. These internal channel names are prefixed by <code>MC|</code>. They are not formally registered using the REGISTER channel. The vanilla Minecraft server will send these packets regardless, and the vanilla client will accept them.
+
Since 1.3, Minecraft itself uses several plugin channels to implement new features. These internal channels use the <code>minecraft</code> namespace. They are '''not''' formally registered using the register channel. The vanilla Minecraft server will send these packets regardless, and the vanilla client will accept them.
 +
 
 +
Note that there were originally more channels included, but most of these were removed in 1.13.  See [https://wiki.vg/index.php?title=Plugin_channels&oldid=14089 this revision of the article] for the original list.  As of 1.14, the only remaining channels other than the brand one are debugging-related channels, which are not normally sent.
 +
 
 +
=== <code>minecraft:brand</code> ===
 +
''Two-way''
 +
 
 +
''For version 1.12.2(protocol version 340) and below, channel name is: <code>MC|Brand</code>''
 +
 
 +
Announces the server and client implementation name right after a player has logged in. For the Notchian client and server, this is "vanilla" (which is chosen using the Function <code>net.minecraft.client.ClientBrandRetriever.getClientModName()</code>) (encoded as a UTF-8 string).
 +
 
 +
These brands are used in crash reports and a few other locations. It's recommended that custom clients and servers use their own brand names for the purpose of identification (for the Notchian client, the class used to get the brand is one of the few non-obfuscated classes).  The brand is not processed in any other way, and Notchian clients will connect to servers with different brands with no issue (the brand is not used to validate).
 +
 
 +
The Notchian server sends a <code>minecraft:brand</code> packet right after it sends a [[Protocol#Join_Game|Join Game]] packet, and the Notchian client sends it right after receiving a Join Game packet.  However, some modified clients and servers will not send this packet (or will take longer to send it than normal), so it is important to not crash if the brand has not been sent.  Additionally, the brand may change at any time (for instance, if connected through a BungeeCord instance, you may switch from a server with one brand to a server with another brand without receiving a Join Game packet).
  
=== <code>MC|AdvCdm</code> ===
+
=== <code>minecraft:debug/paths</code> ===
''Client to Server''
+
''Server to client''
  
Adventure mode command block.  
+
[[File:MC-DebugPath_in_16w14a.png|thumb|What appears to be the purpose of <code><nowiki>minecraft:debug/paths</nowiki></code> as seen in the [https://web.archive.org/web/20161224194609/http://mojang.com/2016/04/minecraft-snapshot-16w14a/ snapshot 16w14a announcement].  This is ''not'' found in the normal game.]]
 +
 
 +
Never sent, but does something with pathfinding debugging.  The client reads the data and stores it, but its renderer cannot be enabled without modifications.
 +
 
 +
{|class="wikitable"
 +
! Name
 +
! Type
 +
! Notes
 +
|-
 +
| Unknown 1
 +
| Int
 +
| Used as a key in the mapping that stores this data; might be an entity ID?
 +
|-
 +
| Unknown 2
 +
| Float
 +
| Appears to be the "radius" of the squares for each pathpoint
 +
|-
 +
| Entity
 +
| PathEntity
 +
| See Data Types above
 +
|}
 +
 
 +
PathEntity's index point is rendered red; the others are rendered blue. PathEntity's target PathPoint is rendered as a green cube. PathPoint's closed set is rendered red, and open set is rendered green.
 +
 
 +
=== <code>minecraft:debug/neighbors_update</code> ===
 +
''Server to client''
 +
 
 +
Never sent, but used to debug block updates.  Does not render without modifying the client.
 +
 
 +
{|class="wikitable"
 +
! Name
 +
! Type
 +
! Notes
 +
|-
 +
| Time
 +
| VarLong
 +
| World timestamp at which the update occurred.  200 ticks after this timestamp, the given update stops rendering.
 +
|-
 +
| Location
 +
| Position
 +
| Location of the block that updated.
 +
|}
 +
 
 +
=== <code>minecraft:debug/caves</code> ===
 +
''Server to client''
 +
 
 +
Never sent, but (presumably) used to debug caves.  Does not render without modifying the client.
  
The first byte is ''type'' which is followed by either:
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Type !! Field Name !! Field Type !! Notes
+
!colspan="2"| Field name
|-
+
!colspan="2"| Field type
| rowspan=5 | 0x00
+
! Notes
| X || Int ||  
+
|-
|-
+
|colspan="2"| Cave position
| Y || Int ||
+
|colspan="2"| Position
|-
+
| Rendered as a white cube; also used to determine the color of the other parts.
| Z || Int ||  
+
|-
|-
+
|colspan="2"| Count
| Command || String ||
+
|colspan="2"| Int
|-
+
| Number of elements in the following array
| Track Output || Boolean ||
+
|-
|}
+
|rowspan="2"| Data
 +
| Sub position
 +
|rowspan="2"| Array
 +
| Position
 +
|
 +
|-
 +
| Radius
 +
| Float
 +
| Size of the area, as half of the side-length
 +
|}
 +
 
 +
=== <code>minecraft:debug/structures</code> ===
 +
''Server to client''
 +
 
 +
Never sent, but (presumably) used to debug structures.  Does not render without modifying the client.
 +
 
 +
Adds a single new structure, which will always be rendered if the player is in the same dimension.
  
or
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Type !! Field Name !! Field Type !! Notes
+
!colspan="2"| Field name
|-
+
!colspan="2"| Field type
| rowspan=5 | 0x01
+
! Notes
| Entity ID || Int ||   
+
|-
|-
+
|colspan="2"| Dimension
| Command || String ||
+
|colspan="2"| Int
|-
+
| The dimension the structure is in.
| Track Output || Boolean ||
+
|-
|}
+
|colspan="2"| Bounding box minX
 +
|colspan="2"| Int
 +
|rowspan="6"| Main box for the structure (rendered in white).  min must be less than max
 +
|-
 +
|colspan="2"| Bounding box minY
 +
|colspan="2"| Int
 +
|-
 +
|colspan="2"| Bounding box minZ
 +
|colspan="2"| Int
 +
|-
 +
|colspan="2"| Bounding box maxX
 +
|colspan="2"| Int
 +
|-
 +
|colspan="2"| Bounding box maxY
 +
|colspan="2"| Int
 +
|-
 +
|colspan="2"| Bounding box maxZ
 +
|colspan="2"| Int
 +
|-
 +
|colspan="2"| Count
 +
|colspan="2"| Int
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="7"| Sub-boxes
 +
| Bounding box minX
 +
|rowspan="7"| Array
 +
| Int
 +
|rowspan="6"| min must be less than max
 +
|-
 +
| Bounding box minY
 +
| Int
 +
|-
 +
| Bounding box minZ
 +
  | Int
 +
|-
 +
| Bounding box maxX
 +
| Int
 +
|-
 +
| Bounding box maxY
 +
| Int
 +
|-
 +
| Bounding box maxZ
 +
| Int
 +
|-
 +
| Flag
 +
| Boolean
 +
| If true, the sub-box is rendered in green, otherwise in blue.
 +
|}
 +
 
 +
 
 +
=== <code>minecraft:debug/worldgen_attempt</code> ===
 +
''Server to client''
  
depending on the ''mode''
+
Never sent, but (presumably) used to debug something with world generation.  Does not render without modifying the client.
  
=== <code>MC|Beacon</code> ===
+
Adds a colored cube of the list of things to render.  This cube is never removed.
''Client to server''
+
 
 +
{| class="wikitable"
 +
! Field name
 +
! Field type
 +
! Notes
 +
|-
 +
| Location
 +
| Position
 +
| The center of the location to render.
 +
|-
 +
| Size
 +
| Float
 +
| Diameter/side length of a cube to render.
 +
|-
 +
| Red
 +
| Float
 +
| Red value to render, from 0.0 to 1.0.
 +
|-
 +
| Green
 +
| Float
 +
| Green value to render, from 0.0 to 1.0.
 +
|-
 +
| Blue
 +
| Float
 +
| Blue value to render, from 0.0 to 1.0.
 +
|-
 +
| Alpha
 +
| Float
 +
| Alpha value to render, from 0.0 to 1.0.
 +
|}
 +
 
 +
=== <code>minecraft:debug/poi_ticket_count</code> ===
 +
''Server to client''
 +
 
 +
Never sent, but used to set amount of free tickets for POI[https://wiki.vg/POI]
 +
 
 +
{| class="wikitable"
 +
! Field name
 +
! Field type
 +
|-
 +
| Location of POI
 +
| Position
 +
|-
 +
| Num of tickets
 +
| VarInt
 +
|}
  
Two integers corresponding to the 2 effects a user wishes to have active.
+
=== <code>minecraft:debug/poi_added</code> ===
 +
''Server to client''
  
=== <code>MC|BEdit</code> ===
+
Never sent, but used to add debugging POI[https://wiki.vg/POI].  Does not render without modifying the client.
''Client to server''
 
  
When a player edits an unsigned book.
+
{| class="wikitable"
 +
! Field name
 +
! Field type
 +
! Notes
 +
|-
 +
| Location
 +
| Positon
 +
| Location of POI
 +
|-
 +
| POI Type
 +
| String(x)
 +
| Type of POI, you can read more here[https://wiki.vg/POI]
 +
|-
 +
| Tickets
 +
| VarInt
 +
| Amount of free tickets
 +
|}
  
This payload is simply a set of bytes corresponding to a [[Slot Data|Slot]].
+
=== <code>minecraft:debug/poi_removed</code> ===
 +
''Server to client''
  
The [[NBT]] section of the Slot contains
+
Never sent, but used to remove debugging POI[https://wiki.vg/POI].  Does not render without modifying the client.
<code>
 
  TAG_Compound(<nowiki>''</nowiki>): 1 entry
 
  {
 
    TAG_List('pages'): 2 entries
 
    {
 
      TAG_String(0): 'Something on Page 1'
 
      TAG_String(1): 'Something on Page 2'
 
    }
 
  }
 
</code>
 
  
=== <code>MC|BSign</code> ===
+
{| class="wikitable"
''Client to server''
+
! Field name
 +
! Field type
 +
! Notes
 +
|-
 +
| Location
 +
| Positon
 +
| Location of POI
 +
|}
  
When a player signs a book.
+
=== <code>minecraft:debug/village_sections</code> ===
 +
''Server to client''
  
This payload is simply a set of bytes corresponding to a [[Slot Data|Slot]].
+
Never sent, but used to add/remove debugging VilliageSections.  Does not render without modifying the client.
  
The Item ID in the Slot should be a Written Book
+
{| class="wikitable"
 +
! Field name
 +
! Field type
 +
! Notes
 +
|-
 +
| Num of VillageSection locations to be added
 +
| VarInt
 +
| Number of VillageSection locations in following fields.
 +
|-
 +
| Location of VillageSection
 +
| Array of Position
 +
| Locations of VillageSections
 +
|-
 +
| Num of VillageSection locations to be removed
 +
| VarInt
 +
| Number of VillageSection locations in following fields.
 +
|-
 +
| Location of VillageSection
 +
| Array of Position
 +
| Locations of VillageSections
 +
|}
  
The [[NBT]] section of the Slot contains
+
=== <code>minecraft:debug/goal_selector</code> ===
<code>
+
{{Need Info|Unknown channel}}
  TAG_Compound(<nowiki>''</nowiki>): 3 entires
+
=== <code>minecraft:debug/brain</code> ===
  {
+
''Server to client''
    TAG_String('author'): 'Steve'
+
 
    TAG_String('title'): 'A Wonderful Book'
+
Never sent. Used to debug villager's brain. Doesn't render without modifying the client.
    TAG_List('pages'): 2 entries
+
 
    {
+
{| class="wikitable"
      TAG_String(0): 'Something on Page 1'
+
! Field name
      TAG_String(1): 'Something on Page 2'
+
! Field type
    }
+
! Notes
  }
+
|-
</code>
+
| X
 +
| Double
 +
| X coordinate of villager's position
 +
|-
 +
| Y
 +
| Double
 +
| Y coordinate of villager's position
 +
|-
 +
| Z
 +
| Double
 +
| Z coordinate of villager's position
 +
|-
 +
| Unique ID
 +
| UUID
 +
| Villager's Unique ID
 +
|-
 +
| Entity ID
 +
| EID
 +
| Villager's Entity ID
 +
|-
 +
| Name
 +
| String(x)
 +
| Villager's name
 +
|-
 +
| Profession
 +
| String(x)
 +
| Villager's profession[https://minecraft.gamepedia.com/Villager#Professions]
 +
|-
 +
| XP
 +
| VarInt
 +
| Villager's experience points
 +
|-
 +
| Inventory
 +
| String(x)
 +
| Villager's inventory (need more research on that)
 +
|-
 +
| Has path
 +
| Boolean
 +
| Indicates whether the next field is Path
 +
|-
 +
| Path
 +
| PathEntity
 +
| Movement path
 +
|-
 +
| Wants golem
 +
| Boolean
 +
| Indicates whether the villager in need of Golem.
 +
|}
  
=== <code>MC|BOpen</code> ===
+
=== <code>minecraft:debug/bee</code> ===
 
''Server to client''
 
''Server to client''
  
When a player right clicks with a signed book. This tells the client to open the book GUI.
+
Never sent, but (presumably) used to debug bee pathfinding to hives and flowers. Does not render without modifying the client.
This payload is empty.
 
  
=== <code>MC|ItemName</code> ===
+
{| class="wikitable"
''Two-way''
+
! Field name
 +
! Field type
 +
! Notes
 +
|-
 +
| X
 +
| Double
 +
| X coordinate of rendering location
 +
|-
 +
| Y
 +
| Double
 +
| Y coordinate of rendering location
 +
|-
 +
| Z
 +
| Double
 +
| Z coordinate of rendering location
 +
|-
 +
| Unique ID
 +
| UUID
 +
| Bee's unique ID
 +
|-
 +
| EID
 +
| VarInt
 +
| EID of the Bee
 +
|-
 +
| Has hive position
 +
| Boolean
 +
| True if following field value is location of bee hive.
 +
|-
 +
| Location of hive
 +
| Position
 +
| Optional position of bee hive.
 +
|-
 +
| Has flower position
 +
| Boolean
 +
| True if following field value is location of flower.
 +
|-
 +
| Location of flower
 +
| Position
 +
| Optional position of flower.
 +
|-
 +
| Travel ticks
 +
| VarInt
 +
| Purpose unknown.
 +
|-
 +
| Has path
 +
| Boolean
 +
| True if following field value is path.
 +
|-
 +
| Path
 +
| PathEntity
 +
| Serialized path.
 +
|-
 +
| Num of goals
 +
| VarInt
 +
| Number of goals in following fields.
 +
|-
 +
| Goal
 +
| Array of String(x)
 +
| Probably string name of goal
 +
|-
 +
| Num of blacklisted hives
 +
| VarInt
 +
| Number of blacklisted hives in following fields.
 +
|-
 +
| Blacklisted hive
 +
| Array of Position
 +
| Position of blacklisted hive.
 +
|}
 +
 
 +
=== <code>minecraft:debug/hive</code> ===
 +
''Server to client''
 +
 
 +
Never sent, but (presumably) used to debug hives. Does not render without modifying the client.
  
When a player uses an anvil to name an item. The payload is just a string: the item's new name.
+
{| class="wikitable"
 +
! Field name
 +
! Field type
 +
! Notes
 +
|-
 +
| Location
 +
| Position
 +
| Rendering location. If a player is more than 30 blocks away, rendering is skipped.
 +
|-
 +
| Hive type
 +
| String
 +
| Name of hive type
 +
|-
 +
| Occupant count
 +
| VarInt
 +
| Number of bees inside this hive
 +
|-
 +
| Honey level
 +
| VarInt
 +
| Level of honey inside this hive
 +
|-
 +
| Sedated
 +
| Boolean
 +
| True if bees are sedated, false otherwise
 +
|-
 +
| Last seen
 +
| VarLong
 +
| Never used in debug renderer?
 +
|}
  
=== <code>MC|RPack</code> ===
+
=== <code>minecraft:debug/game_test_add_marker</code> ===
 
''Server to client''
 
''Server to client''
  
Remote resource packs. This contains a string representing the url to get the resource pack from. This channel has been replaced by the [[Protocol#Resource Pack Send|Resource Pack Send]] ([[Protocol#Play|Play]], 0x48, clientbound) and [[Protocol#Resource Pack Status|Resource Pack Status]] ([[Protocol#Play|Play]], 0x19, serverbound) packets.
+
Never sent, but used to set different debug markers in the world.  
 +
Does not render for vanilla clients below version 1.16.5.
 +
 
 +
{| class="wikitable"
 +
! Field name
 +
! Field type
 +
! Notes
 +
|-
 +
| Location
 +
| Position
 +
| Location of the marker.
 +
|-
 +
| Color
 +
| VarInt
 +
| Encoded ARGB color (Read below about encoding). 
 +
|-
 +
| Name
 +
| String(x)
 +
| Name of marker
 +
|-
 +
| Lifetime
 +
| VarInt
 +
| Time in milliseconds, after which the marker will be destroyed
 +
|}
 +
 
 +
Color can be encoded as following:
 +
 
 +
<code>
 +
int encoded = 0;<br>
 +
encoded = encoded | ((int) blueChannel);<br>
 +
encoded = encoded | ((int) greenChannel << 8);<br>
 +
encoded = encoded | ((int) redChannel << 16);<br>
 +
encoded = encoded | ((int) alphaChannel << 24);<br>
 +
return encoded;
 +
</code>
 +
 
 +
Note that color is normalized by client. Normalizing the color yourself will result in different color than expected.
 +
 
 +
=== <code>minecraft:debug/game_test_clear</code> ===
 +
 
 +
Clears all debug markers.
  
=== <code>MC|TrList</code> ===
+
=== <code>minecraft:debug/raids</code> ===
 
''Server to client''
 
''Server to client''
  
The list of trades a villager NPC is offering.
+
Never sent, but used to set debug raid centers. Does not render without modifying the client.
  
=== <code>MC|TrSel</code> ===
+
{| class="wikitable"
''Client to server''
+
! Field name
+
! Field type
When a player selects a specific trade offered by a villager NPC.
+
! Notes
It contains a single int id corresponding to the selected slot int the players current (trading) inventory.
+
|-
 +
| Num of locations
 +
| VarInt
 +
| Number of locations provided by following array
 +
|-
 +
| Locations
 +
| Array of Position
 +
| Locations of raid centers
 +
|}
  
 
=== <code>MC|PingHost</code> ===
 
=== <code>MC|PingHost</code> ===
Line 131: Line 652:
 
Sent ''after'' a Server list ping in Minecraft 1.6. More information on [[Server List Ping#1.6]]. In 1.7 and above, the [[Protocol#Request|Request]] ([[Protocol#Status|Status]], 0x00, serverbound) packet is instead sent ''before'' the ping.
 
Sent ''after'' a Server list ping in Minecraft 1.6. More information on [[Server List Ping#1.6]]. In 1.7 and above, the [[Protocol#Request|Request]] ([[Protocol#Status|Status]], 0x00, serverbound) packet is instead sent ''before'' the ping.
  
=== <code>MC|Brand</code> ===
+
{{Warning|Since this plugin channel is only sent for the legacy server list ping, it uses the older packet structure.}}
''Two-way''
 
  
Announces the server and client implementation name right after a player has logged in. For Minecraft and the standard Minecraft server, this is "vanilla" (encoded as a UTF-8 string).
+
== Notable community plugin channels ==
 +
Channels listed in this section are not used by the vanilla Minecraft client or server. This is just a likely-incomplete list of channels used by mods/plugins popular within the Minecraft community.
  
== Notable community plugin channels ==
+
=== <code>bungeecord:main</code> ===
Channels listed in this section are not Mojang-sanctioned. This is just a likely-incomplete list of channels used by mods/plugins popular within the Minecraft community.
 
  
=== <code>BungeeCord</code> ===
+
Formerly <code>BungeeCord</code>; additionally, note that the channel name is remapped by spigot so that the old name can still be used in plugins.
  
 
[http://www.spigotmc.org/wiki/bukkit-bungee-plugin-messaging-channel/ See here]
 
[http://www.spigotmc.org/wiki/bukkit-bungee-plugin-messaging-channel/ See here]
  
=== <code>FML|HS</code>, <code>FML</code> ===
+
=== <code>fml:handshake</code>, <code>fml:play</code> ===
''Two-way''
+
 
 +
{{Main|Minecraft Forge Handshake}}
 +
 
 +
Previously <code>FML|HS</code>, <code>FML</code>
  
 
Used by [http://www.minecraftforge.net/forum/index.php Minecraft Forge] to negotiate required mods, among other things.
 
Used by [http://www.minecraftforge.net/forum/index.php Minecraft Forge] to negotiate required mods, among other things.
[https://github.com/MinecraftForge/MinecraftForge/blob/master/src/main/java/net/minecraftforge/fml/common/network/handshake/FMLHandshakeMessage.java <code>FML|HS</code>]
+
[https://github.com/MinecraftForge/MinecraftForge/blob/1.15.x/src/main/java/net/minecraftforge/fml/network/NetworkInitialization.java <code>fml:handshake</code> and <code>fml:play</code>]
[https://github.com/MinecraftForge/MinecraftForge/blob/master/src/main/java/net/minecraftforge/fml/common/network/internal/FMLNetworkHandler.java <code>FML</code>]
 
 
 
For more information, see [[Minecraft Forge Handshake]].
 
  
 
=== <code>ML|OpenTE</code> ===
 
=== <code>ML|OpenTE</code> ===
Line 158: Line 678:
  
 
=== <code>WECUI</code> ===
 
=== <code>WECUI</code> ===
''Two-way''
+
{{Main|/WorldEditCUI}}
  
 
Used by the server-side [http://www.enginehub.org/worldedit/ WorldEdit] and the client-side [http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/1292886-worldeditcui/ WorldEditCUI] to coordinate selections.
 
Used by the server-side [http://www.enginehub.org/worldedit/ WorldEdit] and the client-side [http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/1292886-worldeditcui/ WorldEditCUI] to coordinate selections.
 +
 +
=== <code>wdl:init</code>, <code>wdl:control</code>, <code>wdl:request</code> ===
 +
 +
{{Main|/World downloader}}
 +
 +
Used by the client-side [http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/2520465 World Downloader mod] to get permission information and perform permission requests.
 +
 +
[[Category:Minecraft Modern]]

Latest revision as of 11:47, 1 September 2021

Plugin channels allow client mods and server plugins to communicate without cluttering up chat. This post by Dinnerbone is a good introduction and basic documentation.

Definitions

Data Types

PathEntity

Represents calculated path of entity.

Name Type Notes
Current path index Int Index in the points array that the entity is currently targeting.
Target PathPoint
Number of points Int Number of elements in the following array
Points array Array of PathPoint The actual points on the path
Open set length Int Number of elements in the following array
Open set Array of PathPoint
Closed set length Int Number of elements in the following array
Closed set Array of PathPoint

You can read more here[1].


PathPoint

Represents single point in path

Name Type Notes
X Int
Y Int
Z Int
Distance from origin Float
Cost Float
Cost malus Float Number that is rendered
Has been visited Boolean
Node type Int enum See below
Distance to target Float

Values for node type:

  • 0: BLOCKED
  • 1: OPEN
  • 2: WALKABLE
  • 3: TRAPDOOR
  • 4: FENCE
  • 5: LAVA
  • 6: WATER
  • 7: WATER_BORDER
  • 8: RAIL
  • 9: DANGER_FIRE
  • 10: DAMAGE_FIRE
  • 11: DANGER_CACTUS
  • 12: DAMAGE_CACTUS
  • 13: DANGER_OTHER
  • 14: DAMAGE_OTHER
  • 15: DOOR_OPEN
  • 16: DOOR_WOOD_CLOSED
  • 17: DOOR_IRON_CLOSED
  • 18: BREACH
  • 19: LEAVES
  • 20: STICKY_HONEY
  • 21: COCOA

Reserved channels

minecraft:register

Two-way

Allows the client or server to register for one or more custom channels, indicating that data should be sent on those channels if the receiving end supports it too. Payload is a null (0x00) separated list of strings.

This channel was renamed from REGISTER in 1.13.

minecraft:unregister

Two-way

Allows the client or server to unregister from one or more custom channels, indicating that the receiving end should stop sending data on those channels. Payload is a null-separated list of strings. This is only useful if plugins are disabled/unloaded while the client is connected.

This channel was renamed from UNREGISTER in 1.13.

Channels internal to Minecraft

Since 1.3, Minecraft itself uses several plugin channels to implement new features. These internal channels use the minecraft namespace. They are not formally registered using the register channel. The vanilla Minecraft server will send these packets regardless, and the vanilla client will accept them.

Note that there were originally more channels included, but most of these were removed in 1.13. See this revision of the article for the original list. As of 1.14, the only remaining channels other than the brand one are debugging-related channels, which are not normally sent.

minecraft:brand

Two-way

For version 1.12.2(protocol version 340) and below, channel name is: MC|Brand

Announces the server and client implementation name right after a player has logged in. For the Notchian client and server, this is "vanilla" (which is chosen using the Function net.minecraft.client.ClientBrandRetriever.getClientModName()) (encoded as a UTF-8 string).

These brands are used in crash reports and a few other locations. It's recommended that custom clients and servers use their own brand names for the purpose of identification (for the Notchian client, the class used to get the brand is one of the few non-obfuscated classes). The brand is not processed in any other way, and Notchian clients will connect to servers with different brands with no issue (the brand is not used to validate).

The Notchian server sends a minecraft:brand packet right after it sends a Join Game packet, and the Notchian client sends it right after receiving a Join Game packet. However, some modified clients and servers will not send this packet (or will take longer to send it than normal), so it is important to not crash if the brand has not been sent. Additionally, the brand may change at any time (for instance, if connected through a BungeeCord instance, you may switch from a server with one brand to a server with another brand without receiving a Join Game packet).

minecraft:debug/paths

Server to client

What appears to be the purpose of minecraft:debug/paths as seen in the snapshot 16w14a announcement. This is not found in the normal game.

Never sent, but does something with pathfinding debugging. The client reads the data and stores it, but its renderer cannot be enabled without modifications.

Name Type Notes
Unknown 1 Int Used as a key in the mapping that stores this data; might be an entity ID?
Unknown 2 Float Appears to be the "radius" of the squares for each pathpoint
Entity PathEntity See Data Types above

PathEntity's index point is rendered red; the others are rendered blue. PathEntity's target PathPoint is rendered as a green cube. PathPoint's closed set is rendered red, and open set is rendered green.

minecraft:debug/neighbors_update

Server to client

Never sent, but used to debug block updates. Does not render without modifying the client.

Name Type Notes
Time VarLong World timestamp at which the update occurred. 200 ticks after this timestamp, the given update stops rendering.
Location Position Location of the block that updated.

minecraft:debug/caves

Server to client

Never sent, but (presumably) used to debug caves. Does not render without modifying the client.


Field name Field type Notes
Cave position Position Rendered as a white cube; also used to determine the color of the other parts.
Count Int Number of elements in the following array
Data Sub position Array Position
Radius Float Size of the area, as half of the side-length

minecraft:debug/structures

Server to client

Never sent, but (presumably) used to debug structures. Does not render without modifying the client.

Adds a single new structure, which will always be rendered if the player is in the same dimension.


Field name Field type Notes
Dimension Int The dimension the structure is in.
Bounding box minX Int Main box for the structure (rendered in white). min must be less than max
Bounding box minY Int
Bounding box minZ Int
Bounding box maxX Int
Bounding box maxY Int
Bounding box maxZ Int
Count Int Number of elements in the following array
Sub-boxes Bounding box minX Array Int min must be less than max
Bounding box minY Int
Bounding box minZ Int
Bounding box maxX Int
Bounding box maxY Int
Bounding box maxZ Int
Flag Boolean If true, the sub-box is rendered in green, otherwise in blue.


minecraft:debug/worldgen_attempt

Server to client

Never sent, but (presumably) used to debug something with world generation. Does not render without modifying the client.

Adds a colored cube of the list of things to render. This cube is never removed.

Field name Field type Notes
Location Position The center of the location to render.
Size Float Diameter/side length of a cube to render.
Red Float Red value to render, from 0.0 to 1.0.
Green Float Green value to render, from 0.0 to 1.0.
Blue Float Blue value to render, from 0.0 to 1.0.
Alpha Float Alpha value to render, from 0.0 to 1.0.

minecraft:debug/poi_ticket_count

Server to client

Never sent, but used to set amount of free tickets for POI[2]

Field name Field type
Location of POI Position
Num of tickets VarInt

minecraft:debug/poi_added

Server to client

Never sent, but used to add debugging POI[3]. Does not render without modifying the client.

Field name Field type Notes
Location Positon Location of POI
POI Type String(x) Type of POI, you can read more here[4]
Tickets VarInt Amount of free tickets

minecraft:debug/poi_removed

Server to client

Never sent, but used to remove debugging POI[5]. Does not render without modifying the client.

Field name Field type Notes
Location Positon Location of POI

minecraft:debug/village_sections

Server to client

Never sent, but used to add/remove debugging VilliageSections. Does not render without modifying the client.

Field name Field type Notes
Num of VillageSection locations to be added VarInt Number of VillageSection locations in following fields.
Location of VillageSection Array of Position Locations of VillageSections
Num of VillageSection locations to be removed VarInt Number of VillageSection locations in following fields.
Location of VillageSection Array of Position Locations of VillageSections

minecraft:debug/goal_selector

Huh.png The following information needs to be added to this page:
Unknown channel

minecraft:debug/brain

Server to client

Never sent. Used to debug villager's brain. Doesn't render without modifying the client.

Field name Field type Notes
X Double X coordinate of villager's position
Y Double Y coordinate of villager's position
Z Double Z coordinate of villager's position
Unique ID UUID Villager's Unique ID
Entity ID EID Villager's Entity ID
Name String(x) Villager's name
Profession String(x) Villager's profession[6]
XP VarInt Villager's experience points
Inventory String(x) Villager's inventory (need more research on that)
Has path Boolean Indicates whether the next field is Path
Path PathEntity Movement path
Wants golem Boolean Indicates whether the villager in need of Golem.

minecraft:debug/bee

Server to client

Never sent, but (presumably) used to debug bee pathfinding to hives and flowers. Does not render without modifying the client.

Field name Field type Notes
X Double X coordinate of rendering location
Y Double Y coordinate of rendering location
Z Double Z coordinate of rendering location
Unique ID UUID Bee's unique ID
EID VarInt EID of the Bee
Has hive position Boolean True if following field value is location of bee hive.
Location of hive Position Optional position of bee hive.
Has flower position Boolean True if following field value is location of flower.
Location of flower Position Optional position of flower.
Travel ticks VarInt Purpose unknown.
Has path Boolean True if following field value is path.
Path PathEntity Serialized path.
Num of goals VarInt Number of goals in following fields.
Goal Array of String(x) Probably string name of goal
Num of blacklisted hives VarInt Number of blacklisted hives in following fields.
Blacklisted hive Array of Position Position of blacklisted hive.

minecraft:debug/hive

Server to client

Never sent, but (presumably) used to debug hives. Does not render without modifying the client.

Field name Field type Notes
Location Position Rendering location. If a player is more than 30 blocks away, rendering is skipped.
Hive type String Name of hive type
Occupant count VarInt Number of bees inside this hive
Honey level VarInt Level of honey inside this hive
Sedated Boolean True if bees are sedated, false otherwise
Last seen VarLong Never used in debug renderer?

minecraft:debug/game_test_add_marker

Server to client

Never sent, but used to set different debug markers in the world. Does not render for vanilla clients below version 1.16.5.

Field name Field type Notes
Location Position Location of the marker.
Color VarInt Encoded ARGB color (Read below about encoding).
Name String(x) Name of marker
Lifetime VarInt Time in milliseconds, after which the marker will be destroyed

Color can be encoded as following:

int encoded = 0;
encoded = encoded | ((int) blueChannel);
encoded = encoded | ((int) greenChannel << 8);
encoded = encoded | ((int) redChannel << 16);
encoded = encoded | ((int) alphaChannel << 24);
return encoded;

Note that color is normalized by client. Normalizing the color yourself will result in different color than expected.

minecraft:debug/game_test_clear

Clears all debug markers.

minecraft:debug/raids

Server to client

Never sent, but used to set debug raid centers. Does not render without modifying the client.

Field name Field type Notes
Num of locations VarInt Number of locations provided by following array
Locations Array of Position Locations of raid centers

MC|PingHost

Client to server

Sent after a Server list ping in Minecraft 1.6. More information on Server List Ping#1.6. In 1.7 and above, the Request (Status, 0x00, serverbound) packet is instead sent before the ping.

Warning.png Since this plugin channel is only sent for the legacy server list ping, it uses the older packet structure.

Notable community plugin channels

Channels listed in this section are not used by the vanilla Minecraft client or server. This is just a likely-incomplete list of channels used by mods/plugins popular within the Minecraft community.

bungeecord:main

Formerly BungeeCord; additionally, note that the channel name is remapped by spigot so that the old name can still be used in plugins.

See here

fml:handshake, fml:play

Main article: Minecraft Forge Handshake

Previously FML|HS, FML

Used by Minecraft Forge to negotiate required mods, among other things. fml:handshake and fml:play

ML|OpenTE

Server to client

Used by ModLoader to support custom GUI windows. Does not use the REGISTER channel.

WECUI

Main article: /WorldEditCUI

Used by the server-side WorldEdit and the client-side WorldEditCUI to coordinate selections.

wdl:init, wdl:control, wdl:request

Main article: /World downloader

Used by the client-side World Downloader mod to get permission information and perform permission requests.