1.21.5 -> 1.21.7

Author: Sollace

gradle.properties

@@ -3,10 +3,10 @@ org.gradle.daemon=false
 
 # Fabric Properties
   # check these on https://fabricmc.net/develop
-  minecraft_version=1.21.5-rc1
-  yarn_mappings=1.21.5-rc1+build.2
-  loader_version=0.16.10
-  fabric_version=0.119.2+1.21.5
+  minecraft_version=1.21.7
+  yarn_mappings=1.21.7+build.8
+  loader_version=0.16.14
+  fabric_version=0.128.2+1.21.7
 
 # Mod Properties
   group=com.presencefootsteps
@@ -16,15 +16,15 @@ org.gradle.daemon=false
   url=http://presencefootsteps.ha3.eu
 
 # Publishing
-  minecraft_version_range=>=1.21.5
+  minecraft_version_range=>=1.21.6
   modrinth_loader_type=fabric
   modrinth_project_id=rcTfTZr3
 
 # Testing
   use_minelp=1
 
 # Dependencies
-  modmenu_version=14.0.0-beta.1
-  minelp_version=4.13.3+1.21.5
-  kirin_version=1.20.5+1.21.5
+  modmenu_version=15.0.0-beta.3
+  minelp_version=4.14.0-beta.2+1.21.7
+  kirin_version=1.21.0+1.21.7
   pehkui_version=3.7.2

src/main/java/eu/ha3/presencefootsteps/PFConfig.java

@@ -1,63 +1,110 @@
 package eu.ha3.presencefootsteps;
 
 import java.nio.file.Path;
+import java.util.HashSet;
+import java.util.Set;
+
+import com.minelittlepony.common.util.settings.Config;
+import com.minelittlepony.common.util.settings.Setting;
 
 import eu.ha3.presencefootsteps.config.EntitySelector;
-import eu.ha3.presencefootsteps.config.JsonFile;
 import eu.ha3.presencefootsteps.config.VolumeOption;
 import eu.ha3.presencefootsteps.sound.generator.Locomotion;
+import net.minecraft.entity.EntityType;
+import net.minecraft.registry.Registries;
+import net.minecraft.util.Identifier;
 import net.minecraft.util.crash.CrashReportSection;
 import net.minecraft.util.math.MathHelper;
 
-public class PFConfig extends JsonFile {
-
-    private int volume = 70;
-
-    public VolumeOption clientPlayerVolume = new VolumeOption(this, 100);
-    public VolumeOption otherPlayerVolume = new VolumeOption(this, 100);
-    public VolumeOption hostileEntitiesVolume = new VolumeOption(this, 100);
-    public VolumeOption passiveEntitiesVolume = new VolumeOption(this, 100);
-    public int runningVolumeIncrease = 0;
-    public VolumeOption wetSoundsVolume = new VolumeOption(this, 50);
-    public VolumeOption foliageSoundsVolume = new VolumeOption(this, 100);
-
-    private int maxSteppingEntities = 50;
-
-    private boolean disabled = false;
-    private boolean multiplayer = true;
-    private boolean global = true;
-    private boolean footwear = true;
-    private boolean visualiser = false;
-    private boolean exclusive = false;
+public class PFConfig extends Config {
+
+    private final Setting<Boolean> disabled = value("client", "disabled", false)
+            .addComment("Disables all functionality of the mod");
+
+    private final Setting<Integer> volume = value("volume", "volume", 70)
+            .addComment("Sets the global footsteps volume on a value between 0% and 100%")
+            .addComment("Default: 70");
+    public final Setting<Integer> runningVolumeIncrease = value("volume", "runningVolumeIncrease", 0)
+            .addComment("Controls how much the footsteps sound changes when running on a percentage range between -100% to +100%")
+            .addComment("Default: 0");
+
+    public VolumeOption clientPlayerVolume = new VolumeOption(this, value("volume", "clientPlayerVolume", 100)
+            .addComment("Sets the volume of your own footsteps on a value between 0% and 100%")
+            .addComment("Default: 100"));
+    public VolumeOption otherPlayerVolume = new VolumeOption(this, value("volume", "otherPlayerVolume", 100)
+            .addComment("Sets the volume of other players' footsteps on a value between 0% and 100%")
+            .addComment("Default: 100"));
+    public VolumeOption hostileEntitiesVolume = new VolumeOption(this, value("volume", "hostileEntitiesVolume", 100)
+            .addComment("Sets the volume of hostile mob's footsteps on a value between 0% and 100%")
+            .addComment("Default: 100"));
+    public VolumeOption passiveEntitiesVolume = new VolumeOption(this, value("volume", "passiveEntitiesVolume", 100)
+            .addComment("Sets the volume of passive and friendly mob's footsteps on a value between 0% and 100%")
+            .addComment("Default: 100"));
+
+    public VolumeOption wetSoundsVolume = new VolumeOption(this, value("volume", "wetSoundsVolume", 50)
+            .addComment("Sets the volume of sounds generated by walking on wet surfaces during rain or thunderstorms")
+            .addComment("Default: 50"));
+    public VolumeOption foliageSoundsVolume = new VolumeOption(this, value("volume", "foliageSoundsVolume", 100)
+            .addComment("Sets the volume of sounds generated due to walking through foliage and brush")
+            .addComment("Default: 50"));
+
+
+    private final Setting<Integer> maxSteppingEntities = value("performance", "maxSteppingEntities", 50)
+            .addComment("Controls the maximum number of entities the mod can generate footsteps for in a single frame")
+            .addComment("Default: 50");
+
+    private final Setting<Boolean> multiplayer = value("sound", "multiplayer", true)
+            .addComment("Sets whether footsteps should be generated for other players when in multiplayer");
+    private final Setting<Boolean> global = value("sound", "global", true)
+            .addComment("Sets whether footsteps should be generated for other (non-player) mobs");
+    private final Setting<Boolean> footwear = value("sound", "footwear", true)
+            .addComment("When enabled, special footstep sounds will be generated matching the boots you are wearing.")
+            .addComment("Note not all types of boots are supported. Modded boots may sound strange or not work.");
+    private final Setting<Boolean> visualiser = value("debug", "visualiser", false)
+            .addComment("Enables a visualiser to show where sound/material checks are occuring");
+    private final Setting<Boolean> exclusive = value("sound", "exclusive", false)
+            .addComment("Sets whether to block vanilla footstep sounds when generating sounds for other entities or players");
+
+    private final Setting<Locomotion> stance = value("client", "stance", Locomotion.NONE);
+    private final Setting<EntitySelector> targetEntities = value("client", "targetEntities", EntitySelector.ALL);
+
+    public final Setting<Set<Identifier>> ignoredEntityTypes = this.<Identifier, Set<Identifier>>value("compatibility", "ignoredEntityTypes", () -> new HashSet<Identifier>(Set.of(
+                Identifier.ofVanilla("ghast"),
+                Identifier.ofVanilla("happy_ghast"),
+                Identifier.ofVanilla("phantom")
+            )), Identifier.class)
+            .addComment("A list of dimensions ids that do not have an atmosphere, and thus shouldn't allow pegasi to fly.");
 
-    private Locomotion stance = Locomotion.NONE;
-    private EntitySelector targetEntities = EntitySelector.ALL;
 
     private transient final PresenceFootsteps pf;
 
     public PFConfig(Path file, PresenceFootsteps pf) {
-        super(file);
+        super(HEIRARCHICAL_JSON_ADAPTER, file);
         this.pf = pf;
     }
 
     public boolean toggleMultiplayer() {
-        multiplayer = !multiplayer;
+        multiplayer.set(!multiplayer.get());
         save();
 
-        return multiplayer;
+        return multiplayer.get();
+    }
+
+    public boolean isIgnoredForFootsteps(EntityType<?> type) {
+        return this.ignoredEntityTypes.get().contains(Registries.ENTITY_TYPE.getId(type));
     }
 
     public EntitySelector cycleTargetSelector() {
-        targetEntities = EntitySelector.VALUES[(getEntitySelector().ordinal() + 1) % EntitySelector.VALUES.length];
+        targetEntities.set(EntitySelector.VALUES[(getEntitySelector().ordinal() + 1) % EntitySelector.VALUES.length]);
 
         save();
 
-        return targetEntities;
+        return targetEntities.get();
     }
 
     public Locomotion setLocomotion(Locomotion loco) {
         if (loco != getLocomotion()) {
-            stance = loco;
+            stance.set(loco);
             save();
 
             pf.getEngine().reload();
@@ -67,82 +114,82 @@ public Locomotion setLocomotion(Locomotion loco) {
     }
 
     public boolean isVisualiserRunning() {
-        return visualiser;
+        return visualiser.get();
     }
 
     public Locomotion getLocomotion() {
-        return stance == null ? Locomotion.NONE : stance;
+        return stance.get() == null ? Locomotion.NONE : stance.get();
     }
 
     public EntitySelector getEntitySelector() {
-        return targetEntities == null ? EntitySelector.ALL : targetEntities;
+        return targetEntities.get() == null ? EntitySelector.ALL : targetEntities.get();
     }
 
     public boolean getEnabledFootwear() {
-        return footwear;
+        return footwear.get();
     }
 
     public boolean toggleFootwear() {
-        footwear = !footwear;
+        footwear.set(!footwear.get());
         save();
-        return footwear;
+        return footwear.get();
     }
 
     public boolean isExclusiveMode() {
-        return exclusive;
+        return exclusive.get();
     }
 
     public boolean toggleExclusiveMode() {
-        exclusive = !exclusive;
+        exclusive.set(!exclusive.get());
         save();
-        return exclusive;
+        return exclusive.get();
     }
 
     public boolean getEnabledMP() {
-        return multiplayer;
+        return multiplayer.get();
     }
 
     public int getMaxSteppingEntities() {
-        return Math.max(1, maxSteppingEntities);
+        return Math.max(1, maxSteppingEntities.get());
     }
 
     public boolean toggleDisabled() {
-        disabled = !disabled;
+        disabled.set(!disabled.get());
         save();
-        pf.onEnabledStateChange(!disabled);
-        return disabled;
+        pf.onEnabledStateChange(!disabled.get());
+        return disabled.get();
     }
 
     public boolean setDisabled(boolean disabled) {
-        if (disabled != this.disabled) {
+        if (disabled != this.disabled.get()) {
             toggleDisabled();
         }
         return disabled;
     }
 
     public boolean getDisabled() {
-        return disabled;
+        return disabled.get();
     }
 
     public boolean getEnabled() {
-        return !disabled && getGlobalVolume() > 0;
+        return !disabled.get() && getGlobalVolume() > 0;
     }
 
     public int getGlobalVolume() {
-        return MathHelper.clamp(volume, 0, 100);
+        return MathHelper.clamp(volume.get(), 0, 100);
     }
 
     public int getRunningVolumeIncrease() {
-        return MathHelper.clamp(runningVolumeIncrease, -100, 100);
+        return MathHelper.clamp(runningVolumeIncrease.get(), -100, 100);
     }
 
     public float setGlobalVolume(float volume) {
-        volume = volumeScaleToInt(volume);
+        int vvolume = volumeScaleToInt(volume);
 
-        if (this.volume != volume) {
+        if (this.volume.get() != vvolume) {
             boolean wasEnabled = getEnabled();
 
-            this.volume = (int)volume;
+            this.volume.set(vvolume);
             save();
 
             if (getEnabled() != wasEnabled) {
@@ -154,18 +201,18 @@ public float setGlobalVolume(float volume) {
     }
 
     public float setRunningVolumeIncrease(float volume) {
-        runningVolumeIncrease = volume > 97 ? 100 : volume < -97 ? -100 : (int)volume;
+        runningVolumeIncrease.set(volume > 97 ? 100 : volume < -97 ? -100 : (int)volume);
         save();
         return getRunningVolumeIncrease();
     }
 
     public void populateCrashReport(CrashReportSection section) {
         section.add("Disabled", getDisabled());
-        section.add("Global Volume", volume);
+        section.add("Global Volume", volume.get());
         section.add("User's Selected Stance", getLocomotion());
         section.add("Target Selector", getEntitySelector());
-        section.add("Enabled Global", global);
-        section.add("Enabled Multiplayer", multiplayer);
+        section.add("Enabled Global", global.get());
+        section.add("Enabled Multiplayer", multiplayer.get());
     }
 
     private static int volumeScaleToInt(float volume) {

src/main/java/eu/ha3/presencefootsteps/config/JsonFile.java

@@ -20,7 +20,6 @@
 public abstract class JsonFile {
     private transient final Gson gson = new GsonBuilder()
             .registerTypeAdapter(getClass(), (InstanceCreator<JsonFile>)t -> this)
-            .registerTypeAdapter(VolumeOption.class, new VolumeOption.Adapter(this))
             .setPrettyPrinting()
             .create();
 

src/main/java/eu/ha3/presencefootsteps/config/VolumeOption.java

@@ -1,38 +1,31 @@
 package eu.ha3.presencefootsteps.config;
 
-import java.lang.reflect.Type;
-
-import com.google.gson.JsonDeserializationContext;
-import com.google.gson.JsonDeserializer;
-import com.google.gson.JsonElement;
-import com.google.gson.JsonParseException;
-import com.google.gson.JsonSerializationContext;
-import com.google.gson.JsonSerializer;
 import com.minelittlepony.common.client.gui.IField.IChangeCallback;
+import com.minelittlepony.common.util.settings.Config;
+import com.minelittlepony.common.util.settings.Setting;
 
 import net.minecraft.util.math.MathHelper;
 
 public class VolumeOption implements IChangeCallback<Float> {
 
-    private transient final JsonFile config;
-
-    private int value;
+    private final Config config;
+    private final Setting<Integer> value;
 
-    public VolumeOption(JsonFile config, int value) {
+    public VolumeOption(Config config, Setting<Integer> value) {
         this.config = config;
         this.value = value;
     }
 
     public int get() {
-        return MathHelper.clamp(value, 0, 100);
+        return MathHelper.clamp(value.get(), 0, 100);
     }
 
     public float getPercentage() {
         return get() / 100F;
     }
 
     public float set(float volume) {
-        value = volumeScaleToInt(volume);
+        value.set(volumeScaleToInt(volume));
         config.save();
         return get();
     }
@@ -50,21 +43,4 @@ public String toString() {
     private static int volumeScaleToInt(float volume) {
         return volume > 97 ? 100 : volume < 3 ? 0 : (int)volume;
     }
-
-    static class Adapter implements JsonSerializer<VolumeOption>, JsonDeserializer<VolumeOption> {
-        private final JsonFile file;
-        Adapter(JsonFile file) {
-            this.file = file;
-        }
-        @Override
-        public JsonElement serialize(VolumeOption src, Type typeOfSrc, JsonSerializationContext context) {
-            return context.serialize(src.get());
-        }
-
-        @Override
-        public VolumeOption deserialize(JsonElement json, Type type, JsonDeserializationContext context) throws JsonParseException {
-            return new VolumeOption(file, context.deserialize(json, int.class));
-        }
-    }
-
 }

src/main/java/eu/ha3/presencefootsteps/mixins/MSoundSystem.java

@@ -14,13 +14,13 @@
 
 @Mixin(SoundSystem.class)
 abstract class MSoundSystem {
-    @Shadow
-    abstract float getSoundVolume(@Nullable SoundCategory category);
+    @Shadow(aliases = {"getSoundVolume", "method_72233"})
+    abstract float method_72233(@Nullable SoundCategory category);
 
     @Inject(method = "getAdjustedVolume(Lnet/minecraft/client/sound/SoundInstance;)F", at = @At("HEAD"), cancellable = true)
     private void onGetAdjustedVolume(SoundInstance sound, CallbackInfoReturnable<Float> info) {
         if (sound instanceof ImmediateSoundPlayer.UncappedSoundInstance t) {
-            info.setReturnValue(MathHelper.clamp(t.getVolume() * getSoundVolume(t.getCategory()), 0, t.getMaxVolume()));
+            info.setReturnValue(MathHelper.clamp(t.getVolume() * method_72233(t.getCategory()), 0, t.getMaxVolume()));
         }
     }
 }