mirror of
https://github.com/FabricMC/fabric.git
synced 2025-04-05 19:47:00 -04:00
Allow Built in Resource Packs to have custom names (#1827)
* TooltipComponent API (#1695) * TooltipComponent API * Add warning * Fix handling of orphaned registry entries (#1759) * Fix handling of orphaned registry entries * Fix handling of orphaned registry entries in RegistrySyncManager * Transfer API: bugfixes and improvements (#1762) * Fix SingleVariantItemStorage extraction bug * Inventory wrappers: reuse the original stack more aggressively * Add some filtered overloads to StorageUtil methods * Override PlayerInventoryStorage#insert to call #offer * Add small comment regarding predicates * Bump version * Fix refamp generation for gametest API. Fixes #1722 * Bump version. * Add two more sleep events (#1755) * Add event for setting bed occupation state * Add wake up pos event and update tests * Bump version Just in case. I have a bad feeling that this could become a patch version otherwise. * Add code tags for true/false/null in EntitySleepEvents jd * Add Dynamic annotations for lambda body mixins * Update class javadoc to contain the new events * Bump version * Fix Registry.GAME_EVENT not being synced. * Updated mappings to yarn 1.17.1+build.63 (#1786) * Updated mappings to yarn 1.17.1+build.63 * Forgot some bits. * Forgot to reeable * Make biome & dimension api stable. And change usage around @Deprecated (#1783) * Make biome & dimension api stable (for 1.17). Remove the usage of @Deprecated for other experimental modules. The @Deprecated should be used for experimental/volatile APIs that are highly likely to change. * Apply suggestions from code review Co-authored-by: Juuxel <6596629+Juuxel@users.noreply.github.com> Co-authored-by: Juuxel <6596629+Juuxel@users.noreply.github.com> * ItemGroup API: Remove return and call super so all others ItemStack's get appended (#1617) * Remove return and call super so all others ItemStack's get appended * Add method to FabricItemGroupBuilder to pass ItemGroup with appendItems and change stacksForDisplay to a BiConsumer * Update ItemGroupBuilder javadoc and add example to testmod * Remove leftover aw * Update fabric-item-groups-v0/src/main/java/net/fabricmc/fabric/api/client/itemgroup/FabricItemGroupBuilder.java Co-authored-by: liach <7806504+liach@users.noreply.github.com> * Update fabric-item-groups-v0/src/testmod/java/net/fabricmc/fabric/test/item/group/ItemGroupTest.java Co-authored-by: Technici4n <13494793+Technici4n@users.noreply.github.com> * Remove used import in ItemGroupTest * Clean up * Fix damn checkstyle * Change version to 0.3.0 Co-authored-by: liach <7806504+liach@users.noreply.github.com> Co-authored-by: Technici4n <13494793+Technici4n@users.noreply.github.com> * Bump version * Add tag-based mining level API, fix and deprecate FabricBlockSettings.breakByTool (#1629) * Mining Level API, part 1 * Fix incorrect netherite mining level in MiningLevelManager docs * Add some format checks in dynamic mining level tag checking * Add mining level API test mod * Grammar * Add cursed basic support for the tool attribute api * Fix tool attribute JD * Add proper compat for tool attribute api Also fixes the remaining bugs in it! * Update license headers * stuff * better comments * more test mod work * more * Fix test mod * i'm done with this module * Address some code review things * Use Reference2IntMap (basically IdentityHashMap for int values) * Prefix mixin handlers with fabric$ * Add missing license header * Update fabric-object-builder-api-v1/src/main/java/net/fabricmc/fabric/api/object/builder/v1/block/FabricBlockSettings.java * Resolve liach's comment * Update to use TagFactory * Add event phases (#1669) * Proof of concept * Simplify and document * Allow events to be registered with default phases * Use modified Kosaraju for the toposort, and add test for cyclic dependency graphs * Separate phase-related functionality in an EventPhase class * Revert "Separate phase-related functionality in an EventPhase class" This reverts commite433f348f4. * Ensure that the phase order is deterministic * Add pretty graphs * Add a test, fix a bug, only do one sort for every constraint registration * Environmental renderers (#1727) * Environmental Renderers * Remove defunt hideClouds and hideWeather * Pushed missing License * Push checkstyle fixes * remove unused * Unwrapped the test mod sky rendering. * Added a first attempt at javadoc. * Forgot a blank line * Moved Environment references out of class * Moved Lamda functions for fog override, thick fog usage and fog color adjustment to their own interfaces and gave them proper javadoc. * Made FabricSkyProperties private * PURGE THE H...I mean FabricSkyPropertyBuilder and FabricSkyProperties. - Reverted unintentional mixin changes - Fix various typo errors that were pointed out. - Added missing javadocs and added the ability to override. * Forgot some pluggin in some overrides. * Added missing javadoc suggestion * Changed api a bit so that it fires a exception if renderer not being overridden and one already exists. * Split Implemtnation and Interface * Forgot a license * Added WorldRenderContext to Renderers * Added logging * Added missing javadocs and removed the override option. * Removed INSTANCE * Environmental Renderers * Remove defunt hideClouds and hideWeather * Pushed missing License * Push checkstyle fixes * remove unused * Unwrapped the test mod sky rendering. * Added a first attempt at javadoc. * Forgot a blank line * Moved Environment references out of class * Moved Lamda functions for fog override, thick fog usage and fog color adjustment to their own interfaces and gave them proper javadoc. * Made FabricSkyProperties private * PURGE THE H...I mean FabricSkyPropertyBuilder and FabricSkyProperties. - Reverted unintentional mixin changes - Fix various typo errors that were pointed out. - Added missing javadocs and added the ability to override. * Forgot some pluggin in some overrides. * Added missing javadoc suggestion * Changed api a bit so that it fires a exception if renderer not being overridden and one already exists. * Split Implemtnation and Interface * Forgot a license * Added WorldRenderContext to Renderers * Added logging * Added missing javadocs and removed the override option. * Removed INSTANCE * Fixed Issues * Fixed formatting issue. * completed Juuxl's suggestions and removed null check on adding skyproperties. Changed SkyProperties registering to take an Identifier. Registration turns out to be only adding new options to the "effects" entry of dimension type jsonjson. * Forgot to reenable this. * Just did suggested tweaks * Changed SkyProperties to DimensionEffects * Pushed suggestions of Haykam and apple502j * Added missing changes from sky properties to dimension effects. * Corrected me being inconsistent. * Forgot to remove import. * Impliments https://github.com/FabricMC/fabric/pull/1727#discussion_r734988305 https://github.com/FabricMC/fabric/pull/1727#discussion_r734988265 * Implements https://github.com/FabricMC/fabric/pull/1727#discussion_r730429748 * Last minute tweak. Runnable that controls fog runs right before dimension spefific rendering is done. Based on more subtle issues discovered while working api with twilight forest. Co-authored-by: AlphaMode <AlphaModeYT@gmail.com> * Another wave of transfer API improvements (#1801) * Another wave of transfer API improvements * Cleaner implementation of FilteringStorage#...Of * Undo colored name for water and lava variants * Custom fluid renderers and enhanced vanilla fluid renderer customization (#1687) * Implement custom fluid rendering * Move custom renderers in FluidRenderer mixin and add overlay sprite support to FluidRenderHandlers * Add vanilla-like fluid renderer. Maybe very unnecessary, might remove. * Optimize imports * Allow custom fluid renderers to call the default renderer. Re-add DEFAULT. * Add interface to implement by blocks that enforces overlay texture on fluids * Some comments * Simplify API and remove DefaultLikeFluidRenderer * Make simple renderer overlay texture nullable Co-authored-by: Technici4n <13494793+Technici4n@users.noreply.github.com> * Expand test mod * Checkstyle and licenses * Easy shortcut for custom colored vanilla water fluids * Easy way to register a renderer for two (still+flowing) fluids * Update fabric-rendering-fluids-v1/src/main/java/net/fabricmc/fabric/api/client/render/fluid/v1/FluidRenderHandlerRegistry.java Co-authored-by: Juuxel <6596629+Juuxel@users.noreply.github.com> * Update fabric-rendering-fluids-v1/src/main/java/net/fabricmc/fabric/mixin/client/rendering/fluid/MixinFluidRenderer.java Co-authored-by: Juuxel <6596629+Juuxel@users.noreply.github.com> Co-authored-by: Technici4n <13494793+Technici4n@users.noreply.github.com> Co-authored-by: modmuss50 <modmuss50@gmail.com> Co-authored-by: Juuxel <6596629+Juuxel@users.noreply.github.com> * Bump versions All of the version need to be bumped due to fabric-api-base being updated, this highlights the need for a better solution. * Target the void world in the DimensionalRenderingTest It's a bit too obnoxious for the overworld. * Fix shears being the ultimate mining tool (#1809) * Add detail about default value to MiningLevelManager jd * Fix shears being the ultimate mining tool In more technical terms, fix an invalid comparison in TaggedToolsModdedBlocksToolHandler. The code was supposed to check if the tool's mining level was at least the block's minimum mining level. Instead, the check succeeded whenever the block required a tool (min level >= 0). * WIP fixing tool attribute api bugs * Fix mostly everything * Simplify to (== 0) with explanation * A less breaking workaround for https://github.com/FabricMC/fabric/issues/1806 (#1811) * A less breaking workaround for https://github.com/FabricMC/fabric/issues/1806 * Checkstyle * Bump version * Update Loom and Loader. Cleanup/improve buildscript. (#1802) Co-authored-by: shartte <shartte@users.noreply.github.com> * Fix missing some chunk unloads events leading to a possible memory leak. (#1820) * Fix crash when loading resources from a UNC (windows) network share. See: https://bugs.openjdk.java.net/browse/JDK-8178726 * Update ResourceManagerHelper.java * Update ResourceManagerHelperImpl.java * Update ResourceManagerHelperImpl.java * attempt to get rid of trailing whitespace * works * Update the test mod * Split TestPack to check if unnamed packs still load and display correctly * update javadoc * bump testmod version * Update fabric-resource-loader-v0/src/main/java/net/fabricmc/fabric/api/resource/ResourceManagerHelper.java Co-authored-by: LambdAurora <aurora42lambda@gmail.com> * Use modid in description * Add lang Co-Authored-By: LambdAurora <email@lambdaurora.dev> * Update fabric-resource-loader-v0/src/main/java/net/fabricmc/fabric/impl/resource/loader/ResourceManagerHelperImpl.java Co-authored-by: Juuxel <6596629+Juuxel@users.noreply.github.com> * Fix optional server resource loading * small changes and adhere to checkstyle * Remove ResourcePackProfileAccessor from mixin json * bump pack_format Co-authored-by: Technici4n <13494793+Technici4n@users.noreply.github.com> Co-authored-by: BasiqueEvangelist <basiqueevangelist@yandex.ru> Co-authored-by: modmuss50 <modmuss50@gmail.com> Co-authored-by: Juuxel <6596629+Juuxel@users.noreply.github.com> Co-authored-by: Waterpicker <Waterpickerenternity@gmail.com> Co-authored-by: AlphaMode <AlphaModeYT@gmail.com> Co-authored-by: liach <7806504+liach@users.noreply.github.com> Co-authored-by: Shadew <11669132+FoxShadew@users.noreply.github.com> Co-authored-by: shartte <shartte@users.noreply.github.com> Co-authored-by: LambdAurora <aurora42lambda@gmail.com> Co-authored-by: LambdAurora <email@lambdaurora.dev> Co-authored-by: deirn <deirn@bai.lol> (cherry picked from commit2afceb2962)
This commit is contained in:
Jab125
modmuss50
parent
3572ae8d5f
commit
4a05de7fe1
13 changed files with 81 additions and 20 deletions
fabric-resource-loader-v0/src
main
java/net/fabricmc/fabric
api/resource
impl/resource/loader
mixin/resource/loader
resources
assets/fabric-resource-loader-v0/lang
fabric-resource-loader-v0.mixins.jsontestmod
java/net/fabricmc/fabric/test/resource/loader
resources/resourcepacks
|
|
@ -75,6 +75,27 @@ public interface ResourceManagerHelper {
|
|||
return ResourceManagerHelperImpl.registerBuiltinResourcePack(id, "resourcepacks/" + id.getPath(), container, activationType);
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a built-in resource pack.
|
||||
*
|
||||
* <p>A built-in resource pack is an extra resource pack provided by your mod which is not always active, it's similar to the "Programmer Art" resource pack.
|
||||
*
|
||||
* <p>Why and when to use it? A built-in resource pack should be used to provide extra assets/data that should be optional with your mod but still directly provided by it.
|
||||
* For example it could provide textures of your mod in another resolution, or could allow to provide different styles of your assets.
|
||||
*
|
||||
* <p>The path in which the resource pack is located is in the mod JAR file under the {@code "resourcepacks/<id path>"} directory. {@code id path} being the path specified
|
||||
* in the identifier of this built-in resource pack.
|
||||
*
|
||||
* @param id the identifier of the resource pack
|
||||
* @param container the mod container
|
||||
* @param displayName the display name of the resource pack, should include mod name for clarity
|
||||
* @param activationType the activation type of the resource pack
|
||||
* @return {@code true} if successfully registered the resource pack, else {@code false}
|
||||
*/
|
||||
static boolean registerBuiltinResourcePack(Identifier id, ModContainer container, String displayName, ResourcePackActivationType activationType) {
|
||||
return ResourceManagerHelperImpl.registerBuiltinResourcePack(id, "resourcepacks/" + id.getPath(), container, displayName, activationType);
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a built-in resource pack.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -14,16 +14,21 @@
|
|||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package net.fabricmc.fabric.mixin.resource.loader;
|
||||
package net.fabricmc.fabric.impl.resource.loader;
|
||||
|
||||
import org.spongepowered.asm.mixin.Mixin;
|
||||
import org.spongepowered.asm.mixin.gen.Accessor;
|
||||
|
||||
import net.minecraft.resource.ResourcePackProfile;
|
||||
import net.minecraft.resource.ResourcePackSource;
|
||||
import net.minecraft.text.Text;
|
||||
import net.minecraft.util.Formatting;
|
||||
|
||||
@Mixin(ResourcePackProfile.class)
|
||||
public interface ResourcePackProfileAccessor {
|
||||
@Accessor("source")
|
||||
ResourcePackSource getResourcePackSource();
|
||||
public class BuiltinModResourcePackSource implements ResourcePackSource {
|
||||
private final String modId;
|
||||
|
||||
public BuiltinModResourcePackSource(String modId) {
|
||||
this.modId = modId;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Text decorate(Text packName) {
|
||||
return Text.translatable("pack.nameAndSource", packName, Text.translatable("pack.source.builtinMod", modId)).formatted(Formatting.GRAY);
|
||||
}
|
||||
}
|
||||
|
|
@ -32,7 +32,6 @@ import org.slf4j.Logger;
|
|||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import net.minecraft.resource.ResourcePackProfile;
|
||||
import net.minecraft.resource.ResourcePackSource;
|
||||
import net.minecraft.resource.ResourceReloader;
|
||||
import net.minecraft.resource.ResourceType;
|
||||
import net.minecraft.util.Identifier;
|
||||
|
|
@ -61,13 +60,17 @@ public class ResourceManagerHelperImpl implements ResourceManagerHelper {
|
|||
* @param id the identifier of the resource pack
|
||||
* @param subPath the sub path in the mod resources
|
||||
* @param container the mod container
|
||||
* @param displayName the display name of the resource pack
|
||||
* @param activationType the activation type of the resource pack
|
||||
* @return {@code true} if successfully registered the resource pack, else {@code false}
|
||||
* @see ResourceManagerHelper#registerBuiltinResourcePack(Identifier, ModContainer, String, ResourcePackActivationType)
|
||||
* @see ResourceManagerHelper#registerBuiltinResourcePack(Identifier, ModContainer, ResourcePackActivationType)
|
||||
* @see ResourceManagerHelper#registerBuiltinResourcePack(Identifier, String, ModContainer, boolean)
|
||||
*/
|
||||
public static boolean registerBuiltinResourcePack(Identifier id, String subPath, ModContainer container, ResourcePackActivationType activationType) {
|
||||
String name = id.getNamespace() + "/" + id.getPath();
|
||||
public static boolean registerBuiltinResourcePack(Identifier id, String subPath, ModContainer container, String displayName, ResourcePackActivationType activationType) {
|
||||
String separator = container.getRootPath().getFileSystem().getSeparator();
|
||||
subPath = subPath.replace("/", separator);
|
||||
String name = displayName;
|
||||
ModNioResourcePack resourcePack = ModNioResourcePack.create(name, container, subPath, ResourceType.CLIENT_RESOURCES, activationType);
|
||||
ModNioResourcePack dataPack = ModNioResourcePack.create(name, container, subPath, ResourceType.SERVER_DATA, activationType);
|
||||
if (resourcePack == null && dataPack == null) return false;
|
||||
|
|
@ -83,6 +86,22 @@ public class ResourceManagerHelperImpl implements ResourceManagerHelper {
|
|||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a built-in resource pack. Internal implementation.
|
||||
*
|
||||
* @param id the identifier of the resource pack
|
||||
* @param subPath the sub path in the mod resources
|
||||
* @param container the mod container
|
||||
* @param activationType the activation type of the resource pack
|
||||
* @return {@code true} if successfully registered the resource pack, else {@code false}
|
||||
* @see ResourceManagerHelper#registerBuiltinResourcePack(Identifier, ModContainer, ResourcePackActivationType)
|
||||
* @see ResourceManagerHelper#registerBuiltinResourcePack(Identifier, ModContainer, String, ResourcePackActivationType)
|
||||
* @see ResourceManagerHelper#registerBuiltinResourcePack(Identifier, String, ModContainer, boolean)
|
||||
*/
|
||||
public static boolean registerBuiltinResourcePack(Identifier id, String subPath, ModContainer container, ResourcePackActivationType activationType) {
|
||||
return registerBuiltinResourcePack(id, subPath, container, id.getNamespace() + "/" + id.getPath(), activationType);
|
||||
}
|
||||
|
||||
public static void registerBuiltinResourcePacks(ResourceType resourceType, Consumer<ResourcePackProfile> consumer, ResourcePackProfile.Factory factory) {
|
||||
// Loop through each registered built-in resource packs and add them if valid.
|
||||
for (Pair<String, ModNioResourcePack> entry : builtinResourcePacks) {
|
||||
|
|
@ -93,7 +112,7 @@ public class ResourceManagerHelperImpl implements ResourceManagerHelper {
|
|||
// Make the resource pack profile for built-in pack, should never be always enabled.
|
||||
ResourcePackProfile profile = ResourcePackProfile.of(entry.getLeft(),
|
||||
pack.getActivationType() == ResourcePackActivationType.ALWAYS_ENABLED,
|
||||
entry::getRight, factory, ResourcePackProfile.InsertionPosition.TOP, ResourcePackSource.PACK_SOURCE_BUILTIN);
|
||||
entry::getRight, factory, ResourcePackProfile.InsertionPosition.TOP, new BuiltinModResourcePackSource(pack.getFabricModMetadata().getId()));
|
||||
if (profile != null) {
|
||||
consumer.accept(profile);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -25,9 +25,9 @@ import org.spongepowered.asm.mixin.injection.Redirect;
|
|||
import net.minecraft.resource.ResourcePack;
|
||||
import net.minecraft.resource.ResourcePackManager;
|
||||
import net.minecraft.resource.ResourcePackProfile;
|
||||
import net.minecraft.resource.ResourcePackSource;
|
||||
import net.minecraft.server.MinecraftServer;
|
||||
|
||||
import net.fabricmc.fabric.impl.resource.loader.BuiltinModResourcePackSource;
|
||||
import net.fabricmc.fabric.impl.resource.loader.ModNioResourcePack;
|
||||
|
||||
@Mixin(MinecraftServer.class)
|
||||
|
|
@ -43,10 +43,10 @@ public class MinecraftServerMixin {
|
|||
|
||||
ResourcePackProfile profile = resourcePackManager.getProfile(profileName);
|
||||
|
||||
if (((ResourcePackProfileAccessor) profile).getResourcePackSource() == ResourcePackSource.PACK_SOURCE_BUILTIN && !profileName.equals("vanilla")) {
|
||||
if (profile.getSource() instanceof BuiltinModResourcePackSource) {
|
||||
ResourcePack pack = profile.createResourcePack();
|
||||
// Prevents automatic load for built-in data packs provided by mods.
|
||||
return pack instanceof ModNioResourcePack && !((ModNioResourcePack) pack).getActivationType().isEnabledByDefault();
|
||||
return pack instanceof ModNioResourcePack modPack && !modPack.getActivationType().isEnabledByDefault();
|
||||
}
|
||||
|
||||
return false;
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
{
|
||||
"pack.source.fabricmod": "Fabric mod"
|
||||
}
|
||||
"pack.source.fabricmod": "Fabric mod",
|
||||
"pack.source.builtinMod": "built-in: %s"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pack.source.builtinMod": "intégré: %s"
|
||||
}
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pack.source.builtinMod": "intégré: %s"
|
||||
}
|
||||
|
|
@ -13,7 +13,6 @@
|
|||
"ReloadableResourceManagerImplMixin",
|
||||
"ResourcePackManagerMixin",
|
||||
"ResourcePackManagerAccessor",
|
||||
"ResourcePackProfileAccessor",
|
||||
"SimpleResourceReloadMixin"
|
||||
],
|
||||
"client": [
|
||||
|
|
|
|||
|
|
@ -36,6 +36,10 @@ public class BuiltinResourcePackTestMod implements ModInitializer {
|
|||
// Should always be present as it's **this** mod.
|
||||
FabricLoader.getInstance().getModContainer(MODID)
|
||||
.map(container -> ResourceManagerHelper.registerBuiltinResourcePack(new Identifier(MODID, "test"),
|
||||
container, "Fabric Resource Loader Test Pack", ResourcePackActivationType.NORMAL))
|
||||
.filter(success -> !success).ifPresent(success -> LOGGER.warn("Could not register built-in resource pack with custom name."));
|
||||
FabricLoader.getInstance().getModContainer(MODID)
|
||||
.map(container -> ResourceManagerHelper.registerBuiltinResourcePack(new Identifier(MODID, "test2"),
|
||||
container, ResourcePackActivationType.NORMAL))
|
||||
.filter(success -> !success).ifPresent(success -> LOGGER.warn("Could not register built-in resource pack."));
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"pack": {
|
||||
"pack_format": 7,
|
||||
"pack_format": 8,
|
||||
"description": "Fabric Resource Loader Test Builtin Pack."
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,6 @@
|
|||
{
|
||||
"pack": {
|
||||
"pack_format": 9,
|
||||
"description": "Fabric Resource Loader Test Builtin Pack."
|
||||
}
|
||||
}
|
||||
Binary file not shown.
|
After 
(image error) Size: 1.5 KiB |
Loading…
Add table
Reference in a new issue