Skip to content

How to send data from the server to a player in a Minecraft mod

On 1.20.5 and newer, data goes over the network as a CustomPacketPayload: a record with a Type (its id) and a StreamCodec that writes and reads it. Both sides register it: Fabric API with PayloadTypeRegistry.playS2C() and a receiver in the client, NeoForge with playToClient in RegisterPayloadHandlersEvent. The server sends it with ServerPlayNetworking.send or PacketDistributor.sendToPlayer. Older versions send a hand-written message instead: a FriendlyByteBuf on Fabric, a SimpleChannel (SimpleNetworkWrapper on 1.12.2) on Forge. On 1.21 and newer the receivers run on the game’s main thread, so they may touch the game.

Works on Minecraft 1.20.1 to 26.3 on NeoForge; Minecraft 1.16.5 to 26.3 on Fabric; Minecraft 1.16.5 to 1.20.1 on Forge; Minecraft 1.12.2 on Forge. Each example was compiled against its loader and version before it shipped in Linen.

  1. Make the message class: a payload record with its Type and StreamCodec on 1.20.5 and newer.
  2. Register it for server-to-client, with the client’s handler.
  3. Send it from the server to a player.
  4. Handle it in the client.

The example uses these values. Change them in the code.

Setting In the example What it does
message Hello from the server! What the server sends when a player joins.

The example mod is examplemod in the package com.example.examplemod. Use your own mod id and package.

Uses:

  • FabricPacket
  • PacketType.create
  • ServerPlayNetworking.send
  • ClientPlayNetworking.registerGlobalReceiver

Before 1.20.5 there is no CustomPacketPayload and StreamCodec: Fabric API’s FabricPacket writes to a FriendlyByteBuf and a PacketType reads it back, and nothing needs registering in a PayloadTypeRegistry.

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.fabricmc.fabric.api.networking.v1.FabricPacket;
import net.fabricmc.fabric.api.networking.v1.PacketType;
import net.minecraft.network.FriendlyByteBuf;
import net.minecraft.resources.ResourceLocation;
// What Greeting carries over the network: its type (an id and a reader) and how to write it (Fabric API's FabricPacket, 1.20.2 to 1.20.4).
public record GreetingPayload(String message) implements FabricPacket {
public static final PacketType<GreetingPayload> TYPE = PacketType.create(
new ResourceLocation(ExampleMod.MOD_ID, "greeting"), GreetingPayload::new);
public GreetingPayload(FriendlyByteBuf buf) {
this(buf.readUtf());
}
@Override
public void write(FriendlyByteBuf buf) {
buf.writeUtf(message);
}
@Override
public PacketType<?> getType() {
return TYPE;
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.fabricmc.fabric.api.networking.v1.ServerPlayConnectionEvents;
import net.fabricmc.fabric.api.networking.v1.ServerPlayNetworking;
import net.minecraft.server.level.ServerPlayer;
// The server's side of GreetingPayload: sent to each player who joins.
public final class GreetingNetwork {
private GreetingNetwork() {
}
// Called from the mod's onInitialize.
public static void register() {
ServerPlayConnectionEvents.JOIN.register((handler, sender, server) -> send(handler.getPlayer(), "Hello from the server!"));
}
public static void send(ServerPlayer player, String message) {
ServerPlayNetworking.send(player, new GreetingPayload(message));
}
}

src/main/java/com/example/examplemod/client/GreetingClientNetwork.java

package com.example.examplemod.client;
import com.example.examplemod.network.GreetingPayload;
import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking;
import net.minecraft.network.chat.Component;
// The client's side of GreetingPayload: its receiver runs on the render thread (Fabric API, 1.20.4).
public final class GreetingClientNetwork {
private GreetingClientNetwork() {
}
// Called from the mod's client entrypoint.
public static void register() {
ClientPlayNetworking.registerGlobalReceiver(GreetingPayload.TYPE, (payload, player, sender) -> player.displayClientMessage(
Component.literal(payload.message()), false));
}
}

In your main mod class, inside onInitialize:

GreetingNetwork.register();

In your client setup class, inside onInitializeClient:

GreetingClientNetwork.register();

Uses:

  • CustomPacketPayload
  • StreamCodec.composite
  • PayloadTypeRegistry.playS2C
  • ServerPlayNetworking.send
  • ClientPlayNetworking.registerGlobalReceiver

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.network.codec.ByteBufCodecs;
import net.minecraft.network.codec.StreamCodec;
import net.minecraft.network.protocol.common.custom.CustomPacketPayload;
import net.minecraft.resources.ResourceLocation;
// What Greeting carries over the network: its type (an id) and how to write and read it (a StreamCodec).
public record GreetingPayload(String message) implements CustomPacketPayload {
public static final CustomPacketPayload.Type<GreetingPayload> TYPE = new CustomPacketPayload.Type<>(
new ResourceLocation(ExampleMod.MOD_ID, "greeting"));
public static final StreamCodec<RegistryFriendlyByteBuf, GreetingPayload> STREAM_CODEC = StreamCodec.composite(ByteBufCodecs.STRING_UTF8, GreetingPayload::message,
GreetingPayload::new);
@Override
public CustomPacketPayload.Type<? extends CustomPacketPayload> type() {
return TYPE;
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.fabricmc.fabric.api.networking.v1.PayloadTypeRegistry;
import net.fabricmc.fabric.api.networking.v1.ServerPlayConnectionEvents;
import net.fabricmc.fabric.api.networking.v1.ServerPlayNetworking;
import net.minecraft.server.level.ServerPlayer;
// The server's side of GreetingPayload: registered for server to client, and sent to each player who joins.
public final class GreetingNetwork {
private GreetingNetwork() {
}
// Called from the mod's onInitialize.
public static void register() {
PayloadTypeRegistry.playS2C().register(GreetingPayload.TYPE, GreetingPayload.STREAM_CODEC);
ServerPlayConnectionEvents.JOIN.register((handler, sender, server) -> send(handler.getPlayer(), "Hello from the server!"));
}
public static void send(ServerPlayer player, String message) {
ServerPlayNetworking.send(player, new GreetingPayload(message));
}
}

src/main/java/com/example/examplemod/client/GreetingClientNetwork.java

package com.example.examplemod.client;
import com.example.examplemod.network.GreetingPayload;
import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking;
import net.minecraft.network.chat.Component;
// The client's side of GreetingPayload: its receiver runs on the render thread (Fabric API, 1.21.1).
public final class GreetingClientNetwork {
private GreetingClientNetwork() {
}
// Called from the mod's client entrypoint.
public static void register() {
ClientPlayNetworking.registerGlobalReceiver(GreetingPayload.TYPE, (payload, context) -> context.player().displayClientMessage(
Component.literal(payload.message()), false));
}
}

In your main mod class, inside onInitialize:

GreetingNetwork.register();

In your client setup class, inside onInitializeClient:

GreetingClientNetwork.register();

Fabric 1.21 to 1.21.1, Fabric 1.21.2 to 1.21.10

Section titled “Fabric 1.21 to 1.21.1, Fabric 1.21.2 to 1.21.10”

Uses:

  • CustomPacketPayload
  • StreamCodec.composite
  • PayloadTypeRegistry.playS2C
  • ServerPlayNetworking.send
  • ClientPlayNetworking.registerGlobalReceiver

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.network.codec.ByteBufCodecs;
import net.minecraft.network.codec.StreamCodec;
import net.minecraft.network.protocol.common.custom.CustomPacketPayload;
import net.minecraft.resources.ResourceLocation;
// What Greeting carries over the network: its type (an id) and how to write and read it (a StreamCodec).
public record GreetingPayload(String message) implements CustomPacketPayload {
public static final CustomPacketPayload.Type<GreetingPayload> TYPE = new CustomPacketPayload.Type<>(
ResourceLocation.fromNamespaceAndPath(ExampleMod.MOD_ID, "greeting"));
public static final StreamCodec<RegistryFriendlyByteBuf, GreetingPayload> STREAM_CODEC = StreamCodec.composite(ByteBufCodecs.STRING_UTF8, GreetingPayload::message,
GreetingPayload::new);
@Override
public CustomPacketPayload.Type<? extends CustomPacketPayload> type() {
return TYPE;
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.fabricmc.fabric.api.networking.v1.PayloadTypeRegistry;
import net.fabricmc.fabric.api.networking.v1.ServerPlayConnectionEvents;
import net.fabricmc.fabric.api.networking.v1.ServerPlayNetworking;
import net.minecraft.server.level.ServerPlayer;
// The server's side of GreetingPayload: registered for server to client, and sent to each player who joins.
public final class GreetingNetwork {
private GreetingNetwork() {
}
// Called from the mod's onInitialize.
public static void register() {
PayloadTypeRegistry.playS2C().register(GreetingPayload.TYPE, GreetingPayload.STREAM_CODEC);
ServerPlayConnectionEvents.JOIN.register((handler, sender, server) -> send(handler.getPlayer(), "Hello from the server!"));
}
public static void send(ServerPlayer player, String message) {
ServerPlayNetworking.send(player, new GreetingPayload(message));
}
}

src/main/java/com/example/examplemod/client/GreetingClientNetwork.java

package com.example.examplemod.client;
import com.example.examplemod.network.GreetingPayload;
import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking;
import net.minecraft.network.chat.Component;
// The client's side of GreetingPayload: its receiver runs on the render thread (Fabric API, 1.21.1).
public final class GreetingClientNetwork {
private GreetingClientNetwork() {
}
// Called from the mod's client entrypoint.
public static void register() {
ClientPlayNetworking.registerGlobalReceiver(GreetingPayload.TYPE, (payload, context) -> context.player().displayClientMessage(
Component.literal(payload.message()), false));
}
}

In your main mod class, inside onInitialize:

GreetingNetwork.register();

In your client setup class, inside onInitializeClient:

GreetingClientNetwork.register();

NeoForge 1.21 to 1.21.1, NeoForge 1.21.2 to 1.21.10

Section titled “NeoForge 1.21 to 1.21.1, NeoForge 1.21.2 to 1.21.10”

Uses:

  • CustomPacketPayload
  • StreamCodec.composite
  • RegisterPayloadHandlersEvent
  • PayloadRegistrar.playToClient
  • PacketDistributor.sendToPlayer
  • IPayloadContext.player

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.network.codec.ByteBufCodecs;
import net.minecraft.network.codec.StreamCodec;
import net.minecraft.network.protocol.common.custom.CustomPacketPayload;
import net.minecraft.resources.ResourceLocation;
// What Greeting carries over the network: its type (an id) and how to write and read it (a StreamCodec).
public record GreetingPayload(String message) implements CustomPacketPayload {
public static final CustomPacketPayload.Type<GreetingPayload> TYPE = new CustomPacketPayload.Type<>(
ResourceLocation.fromNamespaceAndPath(ExampleMod.MOD_ID, "greeting"));
public static final StreamCodec<RegistryFriendlyByteBuf, GreetingPayload> STREAM_CODEC = StreamCodec.composite(ByteBufCodecs.STRING_UTF8, GreetingPayload::message,
GreetingPayload::new);
@Override
public CustomPacketPayload.Type<? extends CustomPacketPayload> type() {
return TYPE;
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.minecraft.network.chat.Component;
import net.minecraft.server.level.ServerPlayer;
import net.neoforged.bus.api.IEventBus;
import net.neoforged.neoforge.common.NeoForge;
import net.neoforged.neoforge.event.entity.player.PlayerEvent;
import net.neoforged.neoforge.network.PacketDistributor;
import net.neoforged.neoforge.network.event.RegisterPayloadHandlersEvent;
import net.neoforged.neoforge.network.handling.IPayloadContext;
// GreetingPayload from the server to a player: registered in RegisterPayloadHandlersEvent and sent to each player who logs in.
public final class GreetingNetwork {
private GreetingNetwork() {
}
// Called from the mod's constructor.
public static void register(IEventBus modBus) {
modBus.addListener(GreetingNetwork::registerPayloads);
NeoForge.EVENT_BUS.addListener(GreetingNetwork::onLoggedIn);
}
private static void registerPayloads(RegisterPayloadHandlersEvent event) {
event.registrar("1").playToClient(GreetingPayload.TYPE, GreetingPayload.STREAM_CODEC, GreetingNetwork::handle);
}
// Runs in the client, on the main thread by default.
private static void handle(GreetingPayload payload, IPayloadContext context) {
context.player().displayClientMessage(Component.literal(payload.message()), false);
}
private static void onLoggedIn(PlayerEvent.PlayerLoggedInEvent event) {
if (event.getEntity() instanceof ServerPlayer player) {
send(player, "Hello from the server!");
}
}
public static void send(ServerPlayer player, String message) {
PacketDistributor.sendToPlayer(player, new GreetingPayload(message));
}
}

In your main mod class, inside <init>:

GreetingNetwork.register(modEventBus);

Uses:

  • CustomPacketPayload
  • StreamCodec.composite
  • RegisterPayloadHandlersEvent
  • PayloadRegistrar.playToClient
  • PacketDistributor.sendToPlayer
  • IPayloadContext.player

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.network.codec.ByteBufCodecs;
import net.minecraft.network.codec.StreamCodec;
import net.minecraft.network.protocol.common.custom.CustomPacketPayload;
import net.minecraft.resources.ResourceLocation;
// What Greeting carries over the network: its type (an id) and how to write and read it (a StreamCodec).
public record GreetingPayload(String message) implements CustomPacketPayload {
public static final CustomPacketPayload.Type<GreetingPayload> TYPE = new CustomPacketPayload.Type<>(
new ResourceLocation(ExampleMod.MOD_ID, "greeting"));
public static final StreamCodec<RegistryFriendlyByteBuf, GreetingPayload> STREAM_CODEC = StreamCodec.composite(ByteBufCodecs.STRING_UTF8, GreetingPayload::message,
GreetingPayload::new);
@Override
public CustomPacketPayload.Type<? extends CustomPacketPayload> type() {
return TYPE;
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.minecraft.network.chat.Component;
import net.minecraft.server.level.ServerPlayer;
import net.neoforged.bus.api.IEventBus;
import net.neoforged.neoforge.common.NeoForge;
import net.neoforged.neoforge.event.entity.player.PlayerEvent;
import net.neoforged.neoforge.network.PacketDistributor;
import net.neoforged.neoforge.network.event.RegisterPayloadHandlersEvent;
import net.neoforged.neoforge.network.handling.IPayloadContext;
// GreetingPayload from the server to a player: registered in RegisterPayloadHandlersEvent and sent to each player who logs in.
public final class GreetingNetwork {
private GreetingNetwork() {
}
// Called from the mod's constructor.
public static void register(IEventBus modBus) {
modBus.addListener(GreetingNetwork::registerPayloads);
NeoForge.EVENT_BUS.addListener(GreetingNetwork::onLoggedIn);
}
private static void registerPayloads(RegisterPayloadHandlersEvent event) {
event.registrar("1").playToClient(GreetingPayload.TYPE, GreetingPayload.STREAM_CODEC, GreetingNetwork::handle);
}
// Runs in the client, on the main thread by default.
private static void handle(GreetingPayload payload, IPayloadContext context) {
context.player().displayClientMessage(Component.literal(payload.message()), false);
}
private static void onLoggedIn(PlayerEvent.PlayerLoggedInEvent event) {
if (event.getEntity() instanceof ServerPlayer player) {
send(player, "Hello from the server!");
}
}
public static void send(ServerPlayer player, String message) {
PacketDistributor.sendToPlayer(player, new GreetingPayload(message));
}
}

In your main mod class, inside <init>:

GreetingNetwork.register(modEventBus);

Uses:

  • CustomPacketPayload
  • IPayloadRegistrar.play
  • RegisterPayloadHandlerEvent
  • PacketDistributor.PLAYER
  • PlayPayloadContext.player

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.minecraft.network.FriendlyByteBuf;
import net.minecraft.network.protocol.common.custom.CustomPacketPayload;
import net.minecraft.resources.ResourceLocation;
// What Greeting carries over the network: its id and how to write and read it (a FriendlyByteBuf).
public record GreetingPayload(String message) implements CustomPacketPayload {
public static final ResourceLocation ID = new ResourceLocation(ExampleMod.MOD_ID, "greeting");
public static GreetingPayload read(FriendlyByteBuf buf) {
return new GreetingPayload(buf.readUtf());
}
@Override
public void write(FriendlyByteBuf buf) {
buf.writeUtf(message);
}
@Override
public ResourceLocation id() {
return ID;
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.minecraft.network.chat.Component;
import net.minecraft.server.level.ServerPlayer;
import net.neoforged.bus.api.IEventBus;
import net.neoforged.neoforge.common.NeoForge;
import net.neoforged.neoforge.event.entity.player.PlayerEvent;
import net.neoforged.neoforge.network.PacketDistributor;
import net.neoforged.neoforge.network.event.RegisterPayloadHandlerEvent;
import net.neoforged.neoforge.network.handling.PlayPayloadContext;
// GreetingPayload from the server to a player: registered in RegisterPayloadHandlerEvent and sent to each player who logs in.
public final class GreetingNetwork {
private GreetingNetwork() {
}
// Called from the mod's constructor.
public static void register(IEventBus modBus) {
modBus.addListener(GreetingNetwork::registerPayloads);
NeoForge.EVENT_BUS.addListener(GreetingNetwork::onLoggedIn);
}
private static void registerPayloads(RegisterPayloadHandlerEvent event) {
event.registrar("examplemod").versioned("1").play(GreetingPayload.ID, GreetingPayload::read, handler -> handler.client(GreetingNetwork::handle));
}
// Runs in the client, on the main thread by default.
private static void handle(GreetingPayload payload, PlayPayloadContext context) {
context.player().ifPresent(player -> player.displayClientMessage(Component.literal(payload.message()), false));
}
private static void onLoggedIn(PlayerEvent.PlayerLoggedInEvent event) {
if (event.getEntity() instanceof ServerPlayer player) {
send(player, "Hello from the server!");
}
}
public static void send(ServerPlayer player, String message) {
PacketDistributor.PLAYER.with(player).send(new GreetingPayload(message));
}
}

In your main mod class, inside <init>:

GreetingNetwork.register(modEventBus);

Uses:

  • CustomPacketPayload
  • StreamCodec.composite
  • RegisterPayloadHandlersEvent
  • PayloadRegistrar.playToClient
  • PacketDistributor.sendToPlayer
  • IPayloadContext.player

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.network.codec.ByteBufCodecs;
import net.minecraft.network.codec.StreamCodec;
import net.minecraft.network.protocol.common.custom.CustomPacketPayload;
import net.minecraft.resources.Identifier;
// What Greeting carries over the network: its type (an id) and how to write and read it (a StreamCodec).
public record GreetingPayload(String message) implements CustomPacketPayload {
public static final CustomPacketPayload.Type<GreetingPayload> TYPE = new CustomPacketPayload.Type<>(
Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, "greeting"));
public static final StreamCodec<RegistryFriendlyByteBuf, GreetingPayload> STREAM_CODEC = StreamCodec.composite(ByteBufCodecs.STRING_UTF8, GreetingPayload::message,
GreetingPayload::new);
@Override
public CustomPacketPayload.Type<? extends CustomPacketPayload> type() {
return TYPE;
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.minecraft.network.chat.Component;
import net.minecraft.server.level.ServerPlayer;
import net.neoforged.bus.api.IEventBus;
import net.neoforged.neoforge.common.NeoForge;
import net.neoforged.neoforge.event.entity.player.PlayerEvent;
import net.neoforged.neoforge.network.PacketDistributor;
import net.neoforged.neoforge.network.event.RegisterPayloadHandlersEvent;
import net.neoforged.neoforge.network.handling.IPayloadContext;
// GreetingPayload from the server to a player: registered in RegisterPayloadHandlersEvent and sent to each player who logs in.
public final class GreetingNetwork {
private GreetingNetwork() {
}
// Called from the mod's constructor.
public static void register(IEventBus modBus) {
modBus.addListener(GreetingNetwork::registerPayloads);
NeoForge.EVENT_BUS.addListener(GreetingNetwork::onLoggedIn);
}
private static void registerPayloads(RegisterPayloadHandlersEvent event) {
event.registrar("1").playToClient(GreetingPayload.TYPE, GreetingPayload.STREAM_CODEC, GreetingNetwork::handle);
}
// Runs in the client, on the main thread by default.
private static void handle(GreetingPayload payload, IPayloadContext context) {
context.player().displayClientMessage(Component.literal(payload.message()), false);
}
private static void onLoggedIn(PlayerEvent.PlayerLoggedInEvent event) {
if (event.getEntity() instanceof ServerPlayer player) {
send(player, "Hello from the server!");
}
}
public static void send(ServerPlayer player, String message) {
PacketDistributor.sendToPlayer(player, new GreetingPayload(message));
}
}

In your main mod class, inside <init>:

GreetingNetwork.register(modEventBus);

Uses:

  • CustomPacketPayload
  • StreamCodec.composite
  • PayloadTypeRegistry.playS2C
  • ServerPlayNetworking.send
  • ClientPlayNetworking.registerGlobalReceiver

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.network.codec.ByteBufCodecs;
import net.minecraft.network.codec.StreamCodec;
import net.minecraft.network.protocol.common.custom.CustomPacketPayload;
import net.minecraft.resources.Identifier;
// What Greeting carries over the network: its type (an id) and how to write and read it (a StreamCodec).
public record GreetingPayload(String message) implements CustomPacketPayload {
public static final CustomPacketPayload.Type<GreetingPayload> TYPE = new CustomPacketPayload.Type<>(
Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, "greeting"));
public static final StreamCodec<RegistryFriendlyByteBuf, GreetingPayload> STREAM_CODEC = StreamCodec.composite(ByteBufCodecs.STRING_UTF8, GreetingPayload::message,
GreetingPayload::new);
@Override
public CustomPacketPayload.Type<? extends CustomPacketPayload> type() {
return TYPE;
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.fabricmc.fabric.api.networking.v1.PayloadTypeRegistry;
import net.fabricmc.fabric.api.networking.v1.ServerPlayConnectionEvents;
import net.fabricmc.fabric.api.networking.v1.ServerPlayNetworking;
import net.minecraft.server.level.ServerPlayer;
// The server's side of GreetingPayload: registered for server to client, and sent to each player who joins.
public final class GreetingNetwork {
private GreetingNetwork() {
}
// Called from the mod's onInitialize.
public static void register() {
PayloadTypeRegistry.playS2C().register(GreetingPayload.TYPE, GreetingPayload.STREAM_CODEC);
ServerPlayConnectionEvents.JOIN.register((handler, sender, server) -> send(handler.getPlayer(), "Hello from the server!"));
}
public static void send(ServerPlayer player, String message) {
ServerPlayNetworking.send(player, new GreetingPayload(message));
}
}

src/main/java/com/example/examplemod/client/GreetingClientNetwork.java

package com.example.examplemod.client;
import com.example.examplemod.network.GreetingPayload;
import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking;
import net.minecraft.network.chat.Component;
// The client's side of GreetingPayload: its receiver runs on the render thread (Fabric API, 1.21.1).
public final class GreetingClientNetwork {
private GreetingClientNetwork() {
}
// Called from the mod's client entrypoint.
public static void register() {
ClientPlayNetworking.registerGlobalReceiver(GreetingPayload.TYPE, (payload, context) -> context.player().displayClientMessage(
Component.literal(payload.message()), false));
}
}

In your main mod class, inside onInitialize:

GreetingNetwork.register();

In your client setup class, inside onInitializeClient:

GreetingClientNetwork.register();

Uses:

  • CustomPacketPayload
  • StreamCodec.composite
  • RegisterPayloadHandlersEvent
  • PayloadRegistrar.playToClient
  • PacketDistributor.sendToPlayer
  • IPayloadContext.player

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.network.codec.ByteBufCodecs;
import net.minecraft.network.codec.StreamCodec;
import net.minecraft.network.protocol.common.custom.CustomPacketPayload;
import net.minecraft.resources.Identifier;
// What Greeting carries over the network: its type (an id) and how to write and read it (a StreamCodec).
public record GreetingPayload(String message) implements CustomPacketPayload {
public static final CustomPacketPayload.Type<GreetingPayload> TYPE = new CustomPacketPayload.Type<>(
Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, "greeting"));
public static final StreamCodec<RegistryFriendlyByteBuf, GreetingPayload> STREAM_CODEC = StreamCodec.composite(ByteBufCodecs.STRING_UTF8, GreetingPayload::message,
GreetingPayload::new);
@Override
public CustomPacketPayload.Type<? extends CustomPacketPayload> type() {
return TYPE;
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.minecraft.network.chat.Component;
import net.minecraft.server.level.ServerPlayer;
import net.neoforged.bus.api.IEventBus;
import net.neoforged.neoforge.common.NeoForge;
import net.neoforged.neoforge.event.entity.player.PlayerEvent;
import net.neoforged.neoforge.network.PacketDistributor;
import net.neoforged.neoforge.network.event.RegisterPayloadHandlersEvent;
import net.neoforged.neoforge.network.handling.IPayloadContext;
// GreetingPayload from the server to a player: registered in RegisterPayloadHandlersEvent and sent to each player who logs in.
public final class GreetingNetwork {
private GreetingNetwork() {
}
// Called from the mod's constructor.
public static void register(IEventBus modBus) {
modBus.addListener(GreetingNetwork::registerPayloads);
NeoForge.EVENT_BUS.addListener(GreetingNetwork::onLoggedIn);
}
private static void registerPayloads(RegisterPayloadHandlersEvent event) {
event.registrar("1").playToClient(GreetingPayload.TYPE, GreetingPayload.STREAM_CODEC, GreetingNetwork::handle);
}
// Runs in the client, on the main thread by default.
private static void handle(GreetingPayload payload, IPayloadContext context) {
context.player().sendSystemMessage(Component.literal(payload.message()));
}
private static void onLoggedIn(PlayerEvent.PlayerLoggedInEvent event) {
if (event.getEntity() instanceof ServerPlayer player) {
send(player, "Hello from the server!");
}
}
public static void send(ServerPlayer player, String message) {
PacketDistributor.sendToPlayer(player, new GreetingPayload(message));
}
}

In your main mod class, inside <init>:

GreetingNetwork.register(modEventBus);

Uses:

  • CustomPacketPayload
  • StreamCodec.composite
  • PayloadTypeRegistry.playS2C
  • ServerPlayNetworking.send
  • ClientPlayNetworking.registerGlobalReceiver

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.network.codec.ByteBufCodecs;
import net.minecraft.network.codec.StreamCodec;
import net.minecraft.network.protocol.common.custom.CustomPacketPayload;
import net.minecraft.resources.Identifier;
// What Greeting carries over the network: its type (an id) and how to write and read it (a StreamCodec).
public record GreetingPayload(String message) implements CustomPacketPayload {
public static final CustomPacketPayload.Type<GreetingPayload> TYPE = new CustomPacketPayload.Type<>(
Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, "greeting"));
public static final StreamCodec<RegistryFriendlyByteBuf, GreetingPayload> STREAM_CODEC = StreamCodec.composite(ByteBufCodecs.STRING_UTF8, GreetingPayload::message,
GreetingPayload::new);
@Override
public CustomPacketPayload.Type<? extends CustomPacketPayload> type() {
return TYPE;
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.fabricmc.fabric.api.networking.v1.PayloadTypeRegistry;
import net.fabricmc.fabric.api.networking.v1.ServerPlayConnectionEvents;
import net.fabricmc.fabric.api.networking.v1.ServerPlayNetworking;
import net.minecraft.server.level.ServerPlayer;
// The server's side of GreetingPayload: registered for server to client, and sent to each player who joins.
public final class GreetingNetwork {
private GreetingNetwork() {
}
// Called from the mod's onInitialize.
public static void register() {
PayloadTypeRegistry.clientboundPlay().register(GreetingPayload.TYPE, GreetingPayload.STREAM_CODEC);
ServerPlayConnectionEvents.JOIN.register((handler, sender, server) -> send(handler.getPlayer(), "Hello from the server!"));
}
public static void send(ServerPlayer player, String message) {
ServerPlayNetworking.send(player, new GreetingPayload(message));
}
}

src/main/java/com/example/examplemod/client/GreetingClientNetwork.java

package com.example.examplemod.client;
import com.example.examplemod.network.GreetingPayload;
import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking;
import net.minecraft.network.chat.Component;
// The client's side of GreetingPayload: its receiver runs on the render thread (Fabric API, 1.21.1).
public final class GreetingClientNetwork {
private GreetingClientNetwork() {
}
// Called from the mod's client entrypoint.
public static void register() {
ClientPlayNetworking.registerGlobalReceiver(GreetingPayload.TYPE, (payload, context) -> context.player().sendSystemMessage(
Component.literal(payload.message())));
}
}

In your main mod class, inside onInitialize:

GreetingNetwork.register();

In your client setup class, inside onInitializeClient:

GreetingClientNetwork.register();

Uses:

  • SimpleChannel.registerMessage
  • NetworkRegistry.newSimpleChannel
  • PacketDistributor.PLAYER
  • NetworkEvent.Context.enqueueWork

Forge 1.20.1 sends custom packets through a SimpleChannel: every message class has an encoder and a decoder and is registered with an id.

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import net.minecraft.network.FriendlyByteBuf;
// What Greeting carries over the network, and how to write and read it.
public record GreetingPayload(String message) {
public static void encode(GreetingPayload payload, FriendlyByteBuf buf) {
buf.writeUtf(payload.message());
}
public static GreetingPayload decode(FriendlyByteBuf buf) {
return new GreetingPayload(buf.readUtf());
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.minecraft.network.chat.TextComponent;
import com.example.examplemod.ExampleMod;
import java.util.function.Supplier;
import net.minecraft.client.Minecraft;
import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.server.level.ServerPlayer;
import net.minecraftforge.api.distmarker.Dist;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.entity.player.PlayerEvent;
import net.minecraftforge.fml.DistExecutor;
import net.minecraftforge.fmllegacy.network.NetworkEvent;
import net.minecraftforge.fmllegacy.network.NetworkRegistry;
import net.minecraftforge.fmllegacy.network.PacketDistributor;
import net.minecraftforge.fmllegacy.network.simple.SimpleChannel;
// GreetingPayload from the server to a player: sent through a SimpleChannel to each player who logs in.
public final class GreetingNetwork {
private static final String VERSION = "1";
private static final SimpleChannel CHANNEL = NetworkRegistry.newSimpleChannel(
new ResourceLocation(ExampleMod.MOD_ID, "greeting"), () -> VERSION, VERSION::equals, VERSION::equals);
private GreetingNetwork() {
}
// Called from the mod's constructor.
public static void register() {
CHANNEL.registerMessage(0, GreetingPayload.class, GreetingPayload::encode, GreetingPayload::decode, GreetingNetwork::handle);
MinecraftForge.EVENT_BUS.addListener(GreetingNetwork::onLoggedIn);
}
// Runs in the client, on the main thread once it is queued with enqueueWork.
private static void handle(GreetingPayload payload, Supplier<NetworkEvent.Context> context) {
context.get().enqueueWork(() -> DistExecutor.unsafeRunWhenOn(Dist.CLIENT, () -> () -> ClientHandler.show(payload.message())));
context.get().setPacketHandled(true);
}
private static void onLoggedIn(PlayerEvent.PlayerLoggedInEvent event) {
if (event.getEntity() instanceof ServerPlayer player) {
send(player, "Hello from the server!");
}
}
public static void send(ServerPlayer player, String message) {
CHANNEL.send(PacketDistributor.PLAYER.with(() -> player), new GreetingPayload(message));
}
// Kept in its own class so the server never loads Minecraft's client classes.
private static final class ClientHandler {
static void show(String message) {
Minecraft.getInstance().player.displayClientMessage(new TextComponent(message), false);
}
}
}

In your main mod class, inside <init>:

GreetingNetwork.register();

Uses:

  • SimpleChannel.registerMessage
  • NetworkRegistry.newSimpleChannel
  • PacketDistributor.PLAYER
  • NetworkEvent.Context.enqueueWork

Forge 1.20.1 sends custom packets through a SimpleChannel: every message class has an encoder and a decoder and is registered with an id.

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import net.minecraft.network.FriendlyByteBuf;
// What Greeting carries over the network, and how to write and read it.
public record GreetingPayload(String message) {
public static void encode(GreetingPayload payload, FriendlyByteBuf buf) {
buf.writeUtf(payload.message());
}
public static GreetingPayload decode(FriendlyByteBuf buf) {
return new GreetingPayload(buf.readUtf());
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.minecraft.network.chat.TextComponent;
import com.example.examplemod.ExampleMod;
import java.util.function.Supplier;
import net.minecraft.client.Minecraft;
import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.server.level.ServerPlayer;
import net.minecraftforge.api.distmarker.Dist;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.entity.player.PlayerEvent;
import net.minecraftforge.fml.DistExecutor;
import net.minecraftforge.network.NetworkEvent;
import net.minecraftforge.network.NetworkRegistry;
import net.minecraftforge.network.PacketDistributor;
import net.minecraftforge.network.simple.SimpleChannel;
// GreetingPayload from the server to a player: sent through a SimpleChannel to each player who logs in.
public final class GreetingNetwork {
private static final String VERSION = "1";
private static final SimpleChannel CHANNEL = NetworkRegistry.newSimpleChannel(
new ResourceLocation(ExampleMod.MOD_ID, "greeting"), () -> VERSION, VERSION::equals, VERSION::equals);
private GreetingNetwork() {
}
// Called from the mod's constructor.
public static void register() {
CHANNEL.registerMessage(0, GreetingPayload.class, GreetingPayload::encode, GreetingPayload::decode, GreetingNetwork::handle);
MinecraftForge.EVENT_BUS.addListener(GreetingNetwork::onLoggedIn);
}
// Runs in the client, on the main thread once it is queued with enqueueWork.
private static void handle(GreetingPayload payload, Supplier<NetworkEvent.Context> context) {
context.get().enqueueWork(() -> DistExecutor.unsafeRunWhenOn(Dist.CLIENT, () -> () -> ClientHandler.show(payload.message())));
context.get().setPacketHandled(true);
}
private static void onLoggedIn(PlayerEvent.PlayerLoggedInEvent event) {
if (event.getEntity() instanceof ServerPlayer player) {
send(player, "Hello from the server!");
}
}
public static void send(ServerPlayer player, String message) {
CHANNEL.send(PacketDistributor.PLAYER.with(() -> player), new GreetingPayload(message));
}
// Kept in its own class so the server never loads Minecraft's client classes.
private static final class ClientHandler {
static void show(String message) {
Minecraft.getInstance().player.displayClientMessage(new TextComponent(message), false);
}
}
}

In your main mod class, inside <init>:

GreetingNetwork.register();

Uses:

  • SimpleChannel.registerMessage
  • NetworkRegistry.newSimpleChannel
  • PacketDistributor.PLAYER
  • NetworkEvent.Context.enqueueWork

Forge 1.20.1 sends custom packets through a SimpleChannel: every message class has an encoder and a decoder and is registered with an id.

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import net.minecraft.network.FriendlyByteBuf;
// What Greeting carries over the network, and how to write and read it.
public record GreetingPayload(String message) {
public static void encode(GreetingPayload payload, FriendlyByteBuf buf) {
buf.writeUtf(payload.message());
}
public static GreetingPayload decode(FriendlyByteBuf buf) {
return new GreetingPayload(buf.readUtf());
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import java.util.function.Supplier;
import net.minecraft.client.Minecraft;
import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.server.level.ServerPlayer;
import net.minecraftforge.api.distmarker.Dist;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.entity.player.PlayerEvent;
import net.minecraftforge.fml.DistExecutor;
import net.minecraftforge.network.NetworkEvent;
import net.minecraftforge.network.NetworkRegistry;
import net.minecraftforge.network.PacketDistributor;
import net.minecraftforge.network.simple.SimpleChannel;
// GreetingPayload from the server to a player: sent through a SimpleChannel to each player who logs in.
public final class GreetingNetwork {
private static final String VERSION = "1";
private static final SimpleChannel CHANNEL = NetworkRegistry.newSimpleChannel(
new ResourceLocation(ExampleMod.MOD_ID, "greeting"), () -> VERSION, VERSION::equals, VERSION::equals);
private GreetingNetwork() {
}
// Called from the mod's constructor.
public static void register() {
CHANNEL.registerMessage(0, GreetingPayload.class, GreetingPayload::encode, GreetingPayload::decode, GreetingNetwork::handle);
MinecraftForge.EVENT_BUS.addListener(GreetingNetwork::onLoggedIn);
}
// Runs in the client, on the main thread once it is queued with enqueueWork.
private static void handle(GreetingPayload payload, Supplier<NetworkEvent.Context> context) {
context.get().enqueueWork(() -> DistExecutor.unsafeRunWhenOn(Dist.CLIENT, () -> () -> ClientHandler.show(payload.message())));
context.get().setPacketHandled(true);
}
private static void onLoggedIn(PlayerEvent.PlayerLoggedInEvent event) {
if (event.getEntity() instanceof ServerPlayer player) {
send(player, "Hello from the server!");
}
}
public static void send(ServerPlayer player, String message) {
CHANNEL.send(PacketDistributor.PLAYER.with(() -> player), new GreetingPayload(message));
}
// Kept in its own class so the server never loads Minecraft's client classes.
private static final class ClientHandler {
static void show(String message) {
Minecraft.getInstance().player.displayClientMessage(Component.literal(message), false);
}
}
}

In your main mod class, inside <init>:

GreetingNetwork.register();

Uses:

  • SimpleChannel.registerMessage
  • NetworkRegistry.newSimpleChannel
  • PacketDistributor.PLAYER
  • NetworkEvent.Context.enqueueWork

NeoForge 1.20.1 sends custom packets through a SimpleChannel: every message class has an encoder and a decoder and is registered with an id.

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import net.minecraft.network.FriendlyByteBuf;
// What Greeting carries over the network, and how to write and read it.
public record GreetingPayload(String message) {
public static void encode(GreetingPayload payload, FriendlyByteBuf buf) {
buf.writeUtf(payload.message());
}
public static GreetingPayload decode(FriendlyByteBuf buf) {
return new GreetingPayload(buf.readUtf());
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import java.util.function.Supplier;
import net.minecraft.client.Minecraft;
import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.server.level.ServerPlayer;
import net.minecraftforge.api.distmarker.Dist;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.entity.player.PlayerEvent;
import net.minecraftforge.fml.DistExecutor;
import net.minecraftforge.network.NetworkEvent;
import net.minecraftforge.network.NetworkRegistry;
import net.minecraftforge.network.PacketDistributor;
import net.minecraftforge.network.simple.SimpleChannel;
// GreetingPayload from the server to a player: sent through a SimpleChannel to each player who logs in.
public final class GreetingNetwork {
private static final String VERSION = "1";
private static final SimpleChannel CHANNEL = NetworkRegistry.newSimpleChannel(
new ResourceLocation(ExampleMod.MOD_ID, "greeting"), () -> VERSION, VERSION::equals, VERSION::equals);
private GreetingNetwork() {
}
// Called from the mod's constructor.
public static void register() {
CHANNEL.registerMessage(0, GreetingPayload.class, GreetingPayload::encode, GreetingPayload::decode, GreetingNetwork::handle);
MinecraftForge.EVENT_BUS.addListener(GreetingNetwork::onLoggedIn);
}
// Runs in the client, on the main thread once it is queued with enqueueWork.
private static void handle(GreetingPayload payload, Supplier<NetworkEvent.Context> context) {
context.get().enqueueWork(() -> DistExecutor.unsafeRunWhenOn(Dist.CLIENT, () -> () -> ClientHandler.show(payload.message())));
context.get().setPacketHandled(true);
}
private static void onLoggedIn(PlayerEvent.PlayerLoggedInEvent event) {
if (event.getEntity() instanceof ServerPlayer player) {
send(player, "Hello from the server!");
}
}
public static void send(ServerPlayer player, String message) {
CHANNEL.send(PacketDistributor.PLAYER.with(() -> player), new GreetingPayload(message));
}
// Kept in its own class so the server never loads Minecraft's client classes.
private static final class ClientHandler {
static void show(String message) {
Minecraft.getInstance().player.displayClientMessage(Component.literal(message), false);
}
}
}

In your main mod class, inside <init>:

GreetingNetwork.register();

Uses:

  • SimpleChannel.registerMessage
  • NetworkRegistry.newSimpleChannel
  • PacketDistributor.PLAYER
  • NetworkEvent.Context.enqueueWork

NeoForge 1.20.2 still sends custom packets through a SimpleChannel: every message class has an encoder and a decoder and is registered with an id. The payload registry with CustomPacketPayload came with 1.20.4.

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import net.minecraft.network.FriendlyByteBuf;
// What Greeting carries over the network, and how to write and read it.
public record GreetingPayload(String message) {
public static void encode(GreetingPayload payload, FriendlyByteBuf buf) {
buf.writeUtf(payload.message());
}
public static GreetingPayload decode(FriendlyByteBuf buf) {
return new GreetingPayload(buf.readUtf());
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.minecraft.client.Minecraft;
import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.server.level.ServerPlayer;
import net.neoforged.api.distmarker.Dist;
import net.neoforged.neoforge.common.NeoForge;
import net.neoforged.neoforge.event.entity.player.PlayerEvent;
import net.neoforged.fml.DistExecutor;
import net.neoforged.neoforge.network.NetworkEvent;
import net.neoforged.neoforge.network.NetworkRegistry;
import net.neoforged.neoforge.network.PacketDistributor;
import net.neoforged.neoforge.network.simple.SimpleChannel;
// GreetingPayload from the server to a player: sent through a SimpleChannel to each player who logs in.
public final class GreetingNetwork {
private static final String VERSION = "1";
private static final SimpleChannel CHANNEL = NetworkRegistry.newSimpleChannel(
new ResourceLocation(ExampleMod.MOD_ID, "greeting"), () -> VERSION, VERSION::equals, VERSION::equals);
private GreetingNetwork() {
}
// Called from the mod's constructor.
public static void register() {
CHANNEL.registerMessage(0, GreetingPayload.class, GreetingPayload::encode, GreetingPayload::decode, GreetingNetwork::handle);
NeoForge.EVENT_BUS.addListener(GreetingNetwork::onLoggedIn);
}
// Runs in the client, on the main thread once it is queued with enqueueWork.
private static void handle(GreetingPayload payload, NetworkEvent.Context context) {
context.enqueueWork(() -> DistExecutor.unsafeRunWhenOn(Dist.CLIENT, () -> () -> ClientHandler.show(payload.message())));
context.setPacketHandled(true);
}
private static void onLoggedIn(PlayerEvent.PlayerLoggedInEvent event) {
if (event.getEntity() instanceof ServerPlayer player) {
send(player, "Hello from the server!");
}
}
public static void send(ServerPlayer player, String message) {
CHANNEL.send(PacketDistributor.PLAYER.with(() -> player), new GreetingPayload(message));
}
// Kept in its own class so the server never loads Minecraft's client classes.
private static final class ClientHandler {
static void show(String message) {
Minecraft.getInstance().player.displayClientMessage(Component.literal(message), false);
}
}
}

In your main mod class, inside <init>:

GreetingNetwork.register();

Uses:

  • FriendlyByteBuf
  • PacketByteBufs.create
  • ServerPlayNetworking.send
  • ClientPlayNetworking.registerGlobalReceiver

FabricPacket and PacketType only exist from 1.19.4; before that a message is a channel id and a FriendlyByteBuf you write and read yourself.

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.minecraft.network.FriendlyByteBuf;
import net.minecraft.resources.ResourceLocation;
// What Greeting carries over the network: its channel id and how to write and read it (a FriendlyByteBuf, before 1.19.4's FabricPacket).
public record GreetingPayload(String message) {
public static final ResourceLocation ID = new ResourceLocation(ExampleMod.MOD_ID, "greeting");
public static GreetingPayload read(FriendlyByteBuf buf) {
return new GreetingPayload(buf.readUtf());
}
public void write(FriendlyByteBuf buf) {
buf.writeUtf(message);
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.fabricmc.fabric.api.networking.v1.PacketByteBufs;
import net.fabricmc.fabric.api.networking.v1.ServerPlayConnectionEvents;
import net.fabricmc.fabric.api.networking.v1.ServerPlayNetworking;
import net.minecraft.network.FriendlyByteBuf;
import net.minecraft.server.level.ServerPlayer;
// The server's side of GreetingPayload: sent to each player who joins.
public final class GreetingNetwork {
private GreetingNetwork() {
}
// Called from the mod's onInitialize.
public static void register() {
ServerPlayConnectionEvents.JOIN.register((handler, sender, server) -> send(handler.getPlayer(), "Hello from the server!"));
}
public static void send(ServerPlayer player, String message) {
FriendlyByteBuf buf = PacketByteBufs.create();
new GreetingPayload(message).write(buf);
ServerPlayNetworking.send(player, GreetingPayload.ID, buf);
}
}

src/main/java/com/example/examplemod/client/GreetingClientNetwork.java

package com.example.examplemod.client;
import com.example.examplemod.network.GreetingPayload;
import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking;
import net.minecraft.network.chat.Component;
// The client's side of GreetingPayload: the receiver is called on the network thread, so it hands the work to the client thread (Fabric API).
public final class GreetingClientNetwork {
private GreetingClientNetwork() {
}
// Called from the mod's client entrypoint.
public static void register() {
ClientPlayNetworking.registerGlobalReceiver(GreetingPayload.ID, (client, handler, buf, responseSender) -> {
GreetingPayload payload = GreetingPayload.read(buf);
client.execute(() -> client.player.displayClientMessage(Component.literal(payload.message()), false));
});
}
}

In your main mod class, inside onInitialize:

GreetingNetwork.register();

In your client setup class, inside onInitializeClient:

GreetingClientNetwork.register();

Uses:

  • FriendlyByteBuf
  • PacketByteBufs.create
  • ServerPlayNetworking.send
  • ClientPlayNetworking.registerGlobalReceiver

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.minecraft.network.FriendlyByteBuf;
import net.minecraft.resources.ResourceLocation;
// What Greeting carries over the network: its channel id and how to write and read it (a FriendlyByteBuf, before 1.19.4's FabricPacket).
public record GreetingPayload(String message) {
public static final ResourceLocation ID = new ResourceLocation(ExampleMod.MOD_ID, "greeting");
public static GreetingPayload read(FriendlyByteBuf buf) {
return new GreetingPayload(buf.readUtf());
}
public void write(FriendlyByteBuf buf) {
buf.writeUtf(message);
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.fabricmc.fabric.api.networking.v1.PacketByteBufs;
import net.fabricmc.fabric.api.networking.v1.ServerPlayConnectionEvents;
import net.fabricmc.fabric.api.networking.v1.ServerPlayNetworking;
import net.minecraft.network.FriendlyByteBuf;
import net.minecraft.server.level.ServerPlayer;
// The server's side of GreetingPayload: sent to each player who joins.
public final class GreetingNetwork {
private GreetingNetwork() {
}
// Called from the mod's onInitialize.
public static void register() {
ServerPlayConnectionEvents.JOIN.register((handler, sender, server) -> send(handler.getPlayer(), "Hello from the server!"));
}
public static void send(ServerPlayer player, String message) {
FriendlyByteBuf buf = PacketByteBufs.create();
new GreetingPayload(message).write(buf);
ServerPlayNetworking.send(player, GreetingPayload.ID, buf);
}
}

src/main/java/com/example/examplemod/client/GreetingClientNetwork.java

package com.example.examplemod.client;
import net.minecraft.network.chat.TextComponent;
import com.example.examplemod.network.GreetingPayload;
import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking;
import net.minecraft.network.chat.Component;
// The client's side of GreetingPayload: the receiver is called on the network thread, so it hands the work to the client thread (Fabric API).
public final class GreetingClientNetwork {
private GreetingClientNetwork() {
}
// Called from the mod's client entrypoint.
public static void register() {
ClientPlayNetworking.registerGlobalReceiver(GreetingPayload.ID, (client, handler, buf, responseSender) -> {
GreetingPayload payload = GreetingPayload.read(buf);
client.execute(() -> client.player.displayClientMessage(new TextComponent(payload.message()), false));
});
}
}

In your main mod class, inside onInitialize:

GreetingNetwork.register();

In your client setup class, inside onInitializeClient:

GreetingClientNetwork.register();

Uses:

  • FriendlyByteBuf
  • PacketByteBufs.create
  • ServerPlayNetworking.send
  • ClientPlayNetworking.registerGlobalReceiver

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.minecraft.network.FriendlyByteBuf;
import net.minecraft.resources.ResourceLocation;
// What Greeting carries over the network: its channel id and how to write and read it (a FriendlyByteBuf).
public final class GreetingPayload {
private final String message;
public GreetingPayload(String message) {
this.message = message;
}
public String message() {
return message;
}
public static final ResourceLocation ID = new ResourceLocation(ExampleMod.MOD_ID, "greeting");
public static GreetingPayload read(FriendlyByteBuf buf) {
return new GreetingPayload(buf.readUtf());
}
public void write(FriendlyByteBuf buf) {
buf.writeUtf(message);
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.fabricmc.fabric.api.networking.v1.PacketByteBufs;
import net.fabricmc.fabric.api.networking.v1.ServerPlayConnectionEvents;
import net.fabricmc.fabric.api.networking.v1.ServerPlayNetworking;
import net.minecraft.network.FriendlyByteBuf;
import net.minecraft.server.level.ServerPlayer;
// The server's side of GreetingPayload: sent to each player who joins.
public final class GreetingNetwork {
private GreetingNetwork() {
}
// Called from the mod's onInitialize.
public static void register() {
ServerPlayConnectionEvents.JOIN.register((handler, sender, server) -> send(handler.player, "Hello from the server!"));
}
public static void send(ServerPlayer player, String message) {
FriendlyByteBuf buf = PacketByteBufs.create();
new GreetingPayload(message).write(buf);
ServerPlayNetworking.send(player, GreetingPayload.ID, buf);
}
}

src/main/java/com/example/examplemod/client/GreetingClientNetwork.java

package com.example.examplemod.client;
import net.minecraft.network.chat.TextComponent;
import com.example.examplemod.network.GreetingPayload;
import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking;
import net.minecraft.network.chat.Component;
// The client's side of GreetingPayload: the receiver is called on the network thread, so it hands the work to the client thread (Fabric API).
public final class GreetingClientNetwork {
private GreetingClientNetwork() {
}
// Called from the mod's client entrypoint.
public static void register() {
ClientPlayNetworking.registerGlobalReceiver(GreetingPayload.ID, (client, handler, buf, responseSender) -> {
GreetingPayload payload = GreetingPayload.read(buf);
client.execute(() -> client.player.displayClientMessage(new TextComponent(payload.message()), false));
});
}
}

In your main mod class, inside onInitialize:

GreetingNetwork.register();

In your client setup class, inside onInitializeClient:

GreetingClientNetwork.register();

Uses:

  • SimpleChannel.registerMessage
  • NetworkRegistry.newSimpleChannel
  • PacketDistributor.PLAYER
  • NetworkEvent.Context.enqueueWork

Forge 1.16.5 sends custom packets through a SimpleChannel: every message class has an encoder and a decoder and is registered with an id.

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import net.minecraft.network.PacketBuffer;
// What Greeting carries over the network, and how to write and read it.
public final class GreetingPayload {
private final String message;
public GreetingPayload(String message) {
this.message = message;
}
public String message() {
return message;
}
public static void encode(GreetingPayload payload, PacketBuffer buf) {
buf.writeUtf(payload.message());
}
public static GreetingPayload decode(PacketBuffer buf) {
return new GreetingPayload(buf.readUtf());
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import net.minecraft.util.text.StringTextComponent;
import com.example.examplemod.ExampleMod;
import java.util.function.Supplier;
import net.minecraft.client.Minecraft;
import net.minecraft.util.ResourceLocation;
import net.minecraft.entity.player.ServerPlayerEntity;
import net.minecraftforge.api.distmarker.Dist;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.entity.player.PlayerEvent;
import net.minecraftforge.fml.DistExecutor;
import net.minecraftforge.fml.network.NetworkEvent;
import net.minecraftforge.fml.network.NetworkRegistry;
import net.minecraftforge.fml.network.PacketDistributor;
import net.minecraftforge.fml.network.simple.SimpleChannel;
// GreetingPayload from the server to a player: sent through a SimpleChannel to each player who logs in.
public final class GreetingNetwork {
private static final String VERSION = "1";
private static final SimpleChannel CHANNEL = NetworkRegistry.newSimpleChannel(
new ResourceLocation(ExampleMod.MOD_ID, "greeting"), () -> VERSION, VERSION::equals, VERSION::equals);
private GreetingNetwork() {
}
// Called from the mod's constructor.
public static void register() {
CHANNEL.registerMessage(0, GreetingPayload.class, GreetingPayload::encode, GreetingPayload::decode, GreetingNetwork::handle);
MinecraftForge.EVENT_BUS.addListener(GreetingNetwork::onLoggedIn);
}
// Runs in the client, on the main thread once it is queued with enqueueWork.
private static void handle(GreetingPayload payload, Supplier<NetworkEvent.Context> context) {
context.get().enqueueWork(() -> DistExecutor.unsafeRunWhenOn(Dist.CLIENT, () -> () -> ClientHandler.show(payload.message())));
context.get().setPacketHandled(true);
}
private static void onLoggedIn(PlayerEvent.PlayerLoggedInEvent event) {
if (event.getPlayer() instanceof ServerPlayerEntity) {
ServerPlayerEntity player = (ServerPlayerEntity) event.getPlayer();
send(player, "Hello from the server!");
}
}
public static void send(ServerPlayerEntity player, String message) {
CHANNEL.send(PacketDistributor.PLAYER.with(() -> player), new GreetingPayload(message));
}
// Kept in its own class so the server never loads Minecraft's client classes.
private static final class ClientHandler {
static void show(String message) {
Minecraft.getInstance().player.displayClientMessage(new StringTextComponent(message), false);
}
}
}

In your main mod class, inside <init>:

GreetingNetwork.register();

Uses:

  • SimpleChannel.registerMessage
  • NetworkRegistry.newSimpleChannel
  • PacketDistributor.PLAYER
  • NetworkEvent.Context.enqueueWork

In 1.12.2 the message is an IMessage with toBytes and fromBytes, sent through a SimpleNetworkWrapper, and an IMessageHandler runs on the client.

src/main/java/com/example/examplemod/network/GreetingPayload.java

package com.example.examplemod.network;
import io.netty.buffer.ByteBuf;
import net.minecraftforge.fml.common.network.ByteBufUtils;
import net.minecraftforge.fml.common.network.simpleimpl.IMessage;
// What Greeting carries over the network, and how to write and read it. A 1.12.2 message needs an empty constructor.
public class GreetingPayload implements IMessage {
private String message = "";
public GreetingPayload() {
}
public GreetingPayload(String message) {
this.message = message;
}
public String message() {
return message;
}
@Override
public void fromBytes(ByteBuf buf) {
message = ByteBufUtils.readUTF8String(buf);
}
@Override
public void toBytes(ByteBuf buf) {
ByteBufUtils.writeUTF8String(buf, message);
}
}

src/main/java/com/example/examplemod/network/GreetingNetwork.java

package com.example.examplemod.network;
import com.example.examplemod.ExampleMod;
import net.minecraft.client.Minecraft;
import net.minecraft.entity.player.EntityPlayerMP;
import net.minecraft.util.text.TextComponentString;
import net.minecraftforge.fml.common.Mod;
import net.minecraftforge.fml.common.eventhandler.SubscribeEvent;
import net.minecraftforge.fml.common.gameevent.PlayerEvent;
import net.minecraftforge.fml.common.network.NetworkRegistry;
import net.minecraftforge.fml.common.network.simpleimpl.IMessage;
import net.minecraftforge.fml.common.network.simpleimpl.IMessageHandler;
import net.minecraftforge.fml.common.network.simpleimpl.MessageContext;
import net.minecraftforge.fml.common.network.simpleimpl.SimpleNetworkWrapper;
import net.minecraftforge.fml.relauncher.Side;
// GreetingPayload from the server to a player: sent through a SimpleNetworkWrapper to each player who logs in.
@Mod.EventBusSubscriber(modid = ExampleMod.MOD_ID)
public final class GreetingNetwork {
private static final SimpleNetworkWrapper CHANNEL = NetworkRegistry.INSTANCE.newSimpleChannel(ExampleMod.MOD_ID);
private GreetingNetwork() {
}
// Called from preInit.
public static void register() {
CHANNEL.registerMessage(ClientHandler.class, GreetingPayload.class, 0, Side.CLIENT);
}
@SubscribeEvent
public static void onLoggedIn(PlayerEvent.PlayerLoggedInEvent event) {
if (event.player instanceof EntityPlayerMP) {
send((EntityPlayerMP) event.player, "Hello from the server!");
}
}
public static void send(EntityPlayerMP player, String message) {
CHANNEL.sendTo(new GreetingPayload(message), player);
}
// Runs in the client, on the network thread: addScheduledTask moves the work to the main thread. Kept in its own class so the server never loads Minecraft's client classes.
public static class ClientHandler implements IMessageHandler<GreetingPayload, IMessage> {
@Override
public IMessage onMessage(GreetingPayload payload, MessageContext context) {
Minecraft.getMinecraft().addScheduledTask(() -> Minecraft.getMinecraft().player.sendStatusMessage(new TextComponentString(payload.message()), false));
return null;
}
}
}

In your main mod class, inside preInit:

GreetingNetwork.register();

Linen’s How-tos library has this page too, with the example for your own mod’s loader and Minecraft version. Hover a name in your code and Linen points to the how-tos that explain it. Both are free. Download Linen.