[1.18.x] Allow Modders to add custom data-pack registries through RegistryBuilder (#8630)

Co-authored-by: Silverminer007 <[email protected]>
Co-authored-by: Curle <[email protected]>
This commit is contained in:
authored and GitHub committed 2022-06-05 15:27:30 +01:00
1 parent 15bd5f0d30
commit 997d8e0aa2
21 files changed
+525 -10

No files matched your search

@@ -7,17 +7,22 @@ package net.minecraftforge.network;
import com.google.common.collect.Multimap;
import com.mojang.authlib.GameProfile;
import net.minecraft.core.Registry;
import net.minecraft.network.Connection;
import net.minecraft.network.protocol.handshake.ClientIntentionPacket;
import net.minecraft.network.protocol.login.ClientboundCustomQueryPacket;
import net.minecraft.network.protocol.login.ServerboundCustomQueryPacket;
import net.minecraft.resources.ResourceKey;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.network.chat.TextComponent;
import net.minecraft.network.chat.TranslatableComponent;
import net.minecraft.server.network.ServerLoginPacketListenerImpl;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.common.util.LogMessageAdapter;
import net.minecraftforge.event.entity.player.PlayerNegotiationEvent;
import net.minecraftforge.network.simple.SimpleChannel;
import net.minecraftforge.registries.DataPackRegistriesHooks;
import net.minecraftforge.registries.ForgeRegistry;
import net.minecraftforge.registries.GameData;
import org.apache.logging.log4j.LogManager;
@@ -180,6 +185,23 @@ public class HandshakeHandler
c.get().getNetworkManager().disconnect(new TextComponent("Connection closed - mismatched mod channel list"));
return;
}
// Validate synced custom datapack registries, client cannot be missing any present on the server.
List<String> missingDataPackRegistries = new ArrayList<>();
Set<ResourceKey<? extends Registry<?>>> clientDataPackRegistries = DataPackRegistriesHooks.getSyncedCustomRegistries();
for (ResourceKey<? extends Registry<?>> key : serverModList.getCustomDataPackRegistries())
{
if (!clientDataPackRegistries.contains(key))
{
ResourceLocation location = key.location();
LOGGER.error(FMLHSMARKER, "Missing required datapack registry: {}", location);
missingDataPackRegistries.add(key.location().toString());
}
}
if (!missingDataPackRegistries.isEmpty())
{
c.get().getNetworkManager().disconnect(new TranslatableComponent("fml.menu.multiplayer.missingdatapackregistries", String.join(", ", missingDataPackRegistries)));
return;
}
NetworkConstants.handshakeChannel.reply(new HandshakeMessages.C2SModListReply(), c.get());
LOGGER.debug(FMLHSMARKER, "Accepted server connection");
@@ -5,11 +5,14 @@
package net.minecraftforge.network;
import net.minecraft.core.Registry;
import net.minecraft.network.FriendlyByteBuf;
import net.minecraft.resources.ResourceKey;
import net.minecraft.resources.ResourceLocation;
import net.minecraftforge.fml.ModList;
import net.minecraftforge.forgespi.language.IModInfo;
import net.minecraftforge.network.NetworkRegistry;
import net.minecraftforge.registries.DataPackRegistriesHooks;
import net.minecraftforge.registries.ForgeRegistry;
import net.minecraftforge.registries.RegistryManager;
@@ -17,6 +20,7 @@ import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.IntSupplier;
import java.util.stream.Collectors;
@@ -51,19 +55,22 @@ public class HandshakeMessages
private List<String> mods;
private Map<ResourceLocation, String> channels;
private List<ResourceLocation> registries;
private final List<ResourceKey<? extends Registry<?>>> dataPackRegistries;
public S2CModList()
{
this.mods = ModList.get().getMods().stream().map(IModInfo::getModId).collect(Collectors.toList());
this.channels = NetworkRegistry.buildChannelVersions();
this.registries = RegistryManager.getRegistryNamesForSyncToClient();
this.dataPackRegistries = List.copyOf(DataPackRegistriesHooks.getSyncedCustomRegistries());
}
private S2CModList(List<String> mods, Map<ResourceLocation, String> channels, List<ResourceLocation> registries)
private S2CModList(List<String> mods, Map<ResourceLocation, String> channels, List<ResourceLocation> registries, List<ResourceKey<? extends Registry<?>>> dataPackRegistries)
{
this.mods = mods;
this.channels = channels;
this.registries = registries;
this.dataPackRegistries = dataPackRegistries;
}
public static S2CModList decode(FriendlyByteBuf input)
@@ -83,7 +90,12 @@ public class HandshakeMessages
for (int x = 0; x < len; x++)
registries.add(input.readResourceLocation());
return new S2CModList(mods, channels, registries);
// Datapack Registries may or may not be sent in 1.18.2 due to netcode changes.
// TODO 1.19: Remove optionalness of datapack registry list in the mod list packet.
List<ResourceKey<? extends Registry<?>>> dataPackRegistries = input.isReadable()
? input.readCollection(ArrayList::new, buf -> ResourceKey.createRegistryKey(buf.readResourceLocation()))
: List.of();
return new S2CModList(mods, channels, registries, dataPackRegistries);
}
public void encode(FriendlyByteBuf output)
@@ -99,6 +111,14 @@ public class HandshakeMessages
output.writeVarInt(registries.size());
registries.forEach(output::writeResourceLocation);
// The list of synced datapack registry names is not sent in 1.18.2 if the list is empty.
// TODO 1.19: should send an empty list if the list is empty.
Set<ResourceKey<? extends Registry<?>>> dataPackRegistries = DataPackRegistriesHooks.getSyncedCustomRegistries();
if (!dataPackRegistries.isEmpty())
{
output.writeCollection(dataPackRegistries, (buf,key) -> buf.writeResourceLocation(key.location()));
}
}
public List<String> getModList() {
@@ -112,6 +132,13 @@ public class HandshakeMessages
public Map<ResourceLocation, String> getChannels() {
return this.channels;
}
/**
* @return list of ids of non-vanilla syncable datapack registries on the server.
*/
public List<ResourceKey<? extends Registry<?>>> getCustomDataPackRegistries() {
return this.dataPackRegistries;
}
}
public static class C2SModListReply extends LoginIndexedMessage
@@ -8,6 +8,7 @@ package net.minecraftforge.network;
import io.netty.util.AttributeKey;
import net.minecraft.resources.ResourceLocation;
import net.minecraftforge.fml.IExtensionPoint.DisplayTest;
import net.minecraftforge.network.HandshakeMessages.S2CModList;
import net.minecraftforge.network.event.EventNetworkChannel;
import net.minecraftforge.network.simple.SimpleChannel;
import org.apache.logging.log4j.Marker;
@@ -20,7 +21,10 @@ import java.util.List;
public class NetworkConstants
{
public static final String FMLNETMARKER = "FML";
public static final int FMLNETVERSION = 2;
/**
* Netversion 3: {@link S2CModList} packet may include a list of non-vanilla synced datapack registry ids.
*/
public static final int FMLNETVERSION = 3;
public static final String NETVERSION = FMLNETMARKER + FMLNETVERSION;
public static final String NOVERSION = "NONE";
@@ -10,6 +10,8 @@ import net.minecraft.network.FriendlyByteBuf;
import net.minecraft.resources.ResourceLocation;
import net.minecraftforge.network.event.EventNetworkChannel;
import net.minecraftforge.network.simple.SimpleChannel;
import net.minecraftforge.registries.DataPackRegistriesHooks;
import org.apache.commons.lang3.tuple.Pair;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
@@ -80,7 +82,7 @@ public class NetworkRegistry
}
public static boolean acceptsVanillaClientConnections() {
return instances.isEmpty() || getServerNonVanillaNetworkMods().isEmpty();
return (instances.isEmpty() || getServerNonVanillaNetworkMods().isEmpty()) && DataPackRegistriesHooks.getSyncedCustomRegistries().isEmpty();
}
public static boolean canConnectToVanillaServer() {