Support pack overlay system. Closes #9818

This commit is contained in:
LexManos committed 2023-12-13 14:42:49 -08:00
1 parent 6d7fda6a9b
commit d44d0b8edc
11 files changed
+265 -365

No files matched your search

@@ -8,62 +8,97 @@ package net.minecraftforge.resource;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import com.mojang.datafixers.util.Pair;
import it.unimi.dsi.fastutil.objects.Object2IntMap;
import it.unimi.dsi.fastutil.objects.Object2IntOpenHashMap;
import net.minecraft.server.packs.repository.RepositorySource;
import net.minecraft.server.packs.repository.Pack.Info;
import net.minecraft.SharedConstants;
import net.minecraft.network.chat.Component;
import net.minecraft.server.packs.CompositePackResources;
import net.minecraft.server.packs.PackResources;
import net.minecraft.server.packs.PackType;
import net.minecraft.server.packs.metadata.pack.PackMetadataSection;
import net.minecraft.server.packs.repository.Pack;
import net.minecraft.server.packs.repository.PackRepository;
import net.minecraft.server.packs.repository.PackSource;
import net.minecraftforge.fml.Logging;
import net.minecraftforge.fml.ModList;
import net.minecraftforge.fml.ModLoader;
import net.minecraftforge.fml.ModLoadingStage;
import net.minecraftforge.fml.ModLoadingWarning;
import net.minecraftforge.forgespi.language.IModFileInfo;
import net.minecraftforge.forgespi.locating.IModFile;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
@ApiStatus.Internal
public class ResourcePackLoader {
private static Map<IModFile, PathPackResources> modResourcePacks;
private static final Logger LOGGER = LogManager.getLogger();
public static Optional<PathPackResources> getPackFor(String modId) {
return Optional.ofNullable(ModList.get().getModFileById(modId)).
map(IModFileInfo::getFile).map(mf->modResourcePacks.get(mf));
}
@Deprecated
public static void loadResourcePacks(PackRepository resourcePacks, BiFunction<Map<IModFile, ? extends PathPackResources>, BiConsumer<? super PathPackResources, Pack>, ? extends RepositorySource> packFinder) {
loadResourcePacks(resourcePacks, (map) -> packFinder.apply(map, (rp,p) -> {}));
}
public static void loadResourcePacks(PackRepository resourcePacks, Function<Map<IModFile, ? extends PathPackResources>, ? extends RepositorySource> packFinder) {
modResourcePacks = ModList.get().getModFiles().stream()
.filter(mf->mf.requiredLanguageLoaders().stream().noneMatch(ls->ls.languageName().equals("minecraft")))
.map(mf -> Pair.of(mf, createPackForMod(mf)))
.collect(Collectors.toMap(p -> p.getFirst().getFile(), Pair::getSecond, (u,v) -> { throw new IllegalStateException(String.format(Locale.ENGLISH, "Duplicate key %s", u)); }, LinkedHashMap::new));
resourcePacks.addPackFinder(packFinder.apply(modResourcePacks));
public static void loadResourcePacks(PackRepository resourcePacks, boolean client) {
resourcePacks.addPackFinder(repo -> findPacks(repo, client));
}
@NotNull
public static PathPackResources createPackForMod(IModFileInfo mf)
{
return new PathPackResources(mf.getFile().getFileName(), true, mf.getFile().getFilePath())
{
private final IModFile modFile = mf.getFile();
public static PathPackResources createPackForMod(IModFileInfo mf) {
return new ModPathPackResources(mf.getFile());
}
@NotNull
@Override
protected Path resolve(@NotNull String... paths)
{
return this.modFile.findResource(paths);
private static class ModPathPackResources extends PathPackResources {
private final IModFile mod;
private final String[] prefix;
private ModPathPackResources(IModFile mod, String... prefix) {
super(mod.getFileName(), true, mod.getFilePath());
this.mod = mod;
this.prefix = prefix;
}
@NotNull
@Override
protected Path resolve(@NotNull String... paths) {
if (prefix != null && prefix.length > 0) {
var tmp = new String[prefix.length + paths.length];
System.arraycopy(prefix, 0, tmp, 0, prefix.length);
System.arraycopy(paths, 0, tmp, prefix.length, paths.length);
return this.mod.findResource(tmp);
}
};
return this.mod.findResource(paths);
}
private static class Supplier implements Pack.ResourcesSupplier {
private final IModFile mod;
private Supplier(IModFile mod) {
this.mod = mod;
}
@Override
public PackResources openPrimary(String packId) {
return new ModPathPackResources(mod);
}
@Override
public PackResources openFull(String packId, Info info) {
var primary = openPrimary(packId);
if (info.overlays().isEmpty())
return primary;
var lst = new ArrayList<PackResources>(info.overlays().size());
for (var overlay : info.overlays())
lst.add(new ModPathPackResources(mod, overlay));
return new CompositePackResources(primary, lst);
}
}
}
public static List<String> getPackNames() {
@@ -99,4 +134,55 @@ public class ResourcePackLoader {
};
}
private static void findPacks(Consumer<Pack> packAcceptor, boolean client) {
var type = client ? PackType.CLIENT_RESOURCES : PackType.SERVER_DATA;
var version = SharedConstants.getCurrentVersion().getPackVersion(type);
var hiddenPacks = new ArrayList<PackResources>();
for (var mod : ModList.get().getModFiles()) {
if (mod.requiredLanguageLoaders().stream().anyMatch(ls -> ls.languageName().equals("minecraft")))
continue;
var file = mod.getFile();
var supplier = new ModPathPackResources.Supplier(file);
var modinfo = file.getModInfos().get(0);
var name = "mod:" + modinfo.getModId();
var meta = Pack.readPackInfo(name, supplier, version);
Pack pack = null;
if (meta != null)
pack = Pack.create(name, Component.literal(file.getFileName()), false, supplier, meta, Pack.Position.BOTTOM, false, PackSource.DEFAULT);
if (pack == null) {
// Vanilla only logs an error, instead of propagating, so handle null and warn that something went wrong
ModLoader.get().addWarning(new ModLoadingWarning(modinfo, ModLoadingStage.ERROR, "fml.modloading.brokenresources", file));
continue;
}
LOGGER.debug(Logging.CORE, "Generating PackInfo named {} for mod file {}", name, file.getFilePath());
if (!client || mod.showAsResourcePack())
packAcceptor.accept(pack);
else
hiddenPacks.add(pack.open());
}
if (!hiddenPacks.isEmpty()) {
@SuppressWarnings("resource")
var delegating = new DelegatingPackResources("mod_resources", false,
new PackMetadataSection(
Component.translatable("fml.resources.modresources", hiddenPacks.size()),
version,
Optional.empty()
),
hiddenPacks
);
var supplier = delegating.supplier();
// Create a resource pack merging all mod resources that should be hidden
var modResourcesPack = Pack.readMetaAndCreate("mod_resources", Component.literal("Mod Resources"), true, supplier, type, Pack.Position.BOTTOM, PackSource.DEFAULT);
packAcceptor.accept(modResourcesPack);
}
}
}