new: Add Greenlight-backed protected fog controls

Author: FlashyReese

.github/workflows/publish.yml

@@ -44,6 +44,7 @@ jobs:
           loaders: neoforge
           dependencies: |
             sodium
+            greenlight(optional)
             reeses-sodium-options(optional)
             irisshaders(optional)
             iris(optional)
@@ -65,6 +66,7 @@ jobs:
           loaders: fabric
           dependencies: |
             sodium
+            greenlight(optional)
             reeses-sodium-options(optional)
             irisshaders(optional)
             iris(optional)

README.md

@@ -9,6 +9,17 @@
 
 Features that shouldn't be in Sodium.
 
+## Protected gameplay fog
+Protected Gameplay Fog changes blindness, darkness, lava, powder snow, and water fog.
+On normal multiplayer servers it stays vanilla unless the server authorizes it through
+[Greenlight](https://modrinth.com/mod/greenlight) and you have it installed. See
+[Protected Gameplay Fog](https://github.com/FlashyReese/sodium-extra/wiki/Protected-Gameplay-Fog) for the player-facing behavior.
+
+## Server policies
+Server owners can authorize Sodium Extra's protected gameplay fog controls with a
+a server resource pack and the [Greenlight](https://modrinth.com/mod/greenlight) client mod. See
+[Server Policies](https://github.com/FlashyReese/sodium-extra/wiki/Server-Policies) for the policy schema and examples.
+
 ## Building from source
 ### Prerequisites
 - Java Development Kit 17 or above

build.gradle.kts

@@ -13,6 +13,7 @@ val MAVEN_GROUP by extra { "me.flashyreese.mods" }
 val ARCHIVE_NAME by extra { "sodium-extra" }
 val MOD_VERSION by extra { "0.9.1" }
 val SODIUM_VERSION by extra { "0.9.0+mc26.2" }
+val GREENLIGHT_VERSION by extra { "0.1.0+mc26.2" }
 
 allprojects {
     apply(plugin = "java")
@@ -36,6 +37,8 @@ subprojects {
         maven("https://maven.caffeinemc.net/snapshots")
         maven("https://api.modrinth.com/maven")
         maven("https://libraries.minecraft.net")
+        maven("https://maven.flashyreese.me/releases")
+        maven("https://maven.flashyreese.me/snapshots")
     }
 
     base {

common/build.gradle.kts

@@ -12,6 +12,7 @@ val FABRIC_LOADER_VERSION: String by rootProject.extra
 val FABRIC_API_VERSION: String by rootProject.extra
 
 val SODIUM_VERSION: String by rootProject.extra
+val GREENLIGHT_VERSION: String by rootProject.extra
 
 dependencies {
     minecraft("com.mojang:minecraft:$MINECRAFT_VERSION")
@@ -30,6 +31,7 @@ dependencies {
     addDependentFabricModule("fabric-rendering-v1")
 
     implementation("net.caffeinemc:sodium-fabric:$SODIUM_VERSION")
+    compileOnly("me.flashyreese.mods:greenlight-api:$GREENLIGHT_VERSION")
 }
 
 tasks.withType<AbstractRemapJarTask>().forEach {

common/src/main/java/me/flashyreese/mods/sodiumextra/client/config/SodiumExtraGameOptions.java

@@ -397,7 +397,6 @@ public void sanitize() {
             if (this.protectedGameplay == null) {
                 this.protectedGameplay = new ProtectedFogSettings();
             }
-            this.protectedGameplay.sanitize();
         }
 
         public AtmosphericFogSettings getAtmospheric(Identifier dimensionId) {
@@ -448,7 +447,6 @@ public AtmosphericFogSettings() {
         }
 
         public void sanitize() {
-            this.distanceChunks = FogDistanceHelper.normalizeFogDistance(this.distanceChunks);
             this.startPercent = Math.clamp(this.startPercent, 0, 100);
 
             if (this.shapeMode == null) {
@@ -480,14 +478,6 @@ public ProtectedFogSettings() {
             this.powderSnowDistanceBlocks = FogDistanceHelper.FOG_DISTANCE_VANILLA;
             this.waterDistanceBlocks = FogDistanceHelper.FOG_DISTANCE_VANILLA;
         }
-
-        public void sanitize() {
-            this.blindnessDistanceBlocks = FogDistanceHelper.normalizeFogDistance(this.blindnessDistanceBlocks);
-            this.darknessDistanceBlocks = FogDistanceHelper.normalizeFogDistance(this.darknessDistanceBlocks);
-            this.lavaDistanceBlocks = FogDistanceHelper.normalizeFogDistance(this.lavaDistanceBlocks);
-            this.powderSnowDistanceBlocks = FogDistanceHelper.normalizeFogDistance(this.powderSnowDistanceBlocks);
-            this.waterDistanceBlocks = FogDistanceHelper.normalizeFogDistance(this.waterDistanceBlocks);
-        }
     }
 
     public static class ExtraSettings {

common/src/main/java/me/flashyreese/mods/sodiumextra/client/fog/FogDistanceHelper.java

@@ -1,5 +1,8 @@
 package me.flashyreese.mods.sodiumextra.client.fog;
 
+import com.google.gson.JsonObject;
+import me.flashyreese.mods.greenlight.feature.ClientFeature;
+import me.flashyreese.mods.greenlight.feature.Greenlight;
 import me.flashyreese.mods.sodiumextra.client.SodiumExtraClientMod;
 import me.flashyreese.mods.sodiumextra.client.config.SodiumExtraGameOptions;
 import me.flashyreese.mods.sodiumextra.mixin.fog.AccessorIntegratedServer;
@@ -16,28 +19,40 @@
 import net.minecraft.client.multiplayer.ClientLevel;
 import net.minecraft.client.renderer.fog.FogData;
 import net.minecraft.resources.Identifier;
+import net.minecraft.util.GsonHelper;
 
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
+import java.util.EnumMap;
+import java.util.Map;
 
 public final class FogDistanceHelper {
     public static final Identifier SODIUM_RENDER_DISTANCE_OPTION_ID = Identifier.parse("sodium:general.render_distance");
     public static final int FOG_DISTANCE_OFF = -1;
     public static final int FOG_DISTANCE_VANILLA = 0;
-    private static final int LEGACY_FOG_DISTANCE_OFF = 33;
     private static final int VANILLA_MAX_FOG_DISTANCE = 32;
     private static final int PROTECTED_FOG_DISTANCE_MAX_BLOCKS = 256;
     // Shape sentinels decoded by FogShaderTransformer; keep values in sync with its GLSL constants.
     private static final float RADIAL_RENDER_DISTANCE_OFFSET = 1_048_576.0F;
     private static final float PLANAR_RENDER_DISTANCE_OFFSET = 2_097_152.0F;
     private static final float CHUNK_SIZE = 16F;
+    private static final ClientFeature<ProtectedGameplayFogPolicy> PROTECTED_GAMEPLAY_FOG = Greenlight
+            .feature(Identifier.fromNamespaceAndPath("sodium-extra", "protected_gameplay_fog"))
+            .decoder(1, ProtectedGameplayFogPolicy::fromJson)
+            .register();
 
     public enum ProtectedFogType {
-        BLINDNESS,
-        DARKNESS,
-        LAVA,
-        POWDER_SNOW,
-        WATER
+        BLINDNESS("blindness"),
+        DARKNESS("darkness"),
+        LAVA("lava"),
+        POWDER_SNOW("powder_snow"),
+        WATER("water");
+
+        private final String policyKey;
+
+        ProtectedFogType(String policyKey) {
+            this.policyKey = policyKey;
+        }
     }
 
     public static SodiumExtraGameOptions.AtmosphericFogSettings getAtmosphericSettings(ClientLevel level) {
@@ -53,10 +68,6 @@ public static int getFogDistance(ClientLevel level) {
         return getAtmosphericSettings(level).distanceChunks;
     }
 
-    public static int normalizeFogDistance(int fogDistance) {
-        return fogDistance == LEGACY_FOG_DISTANCE_OFF ? FOG_DISTANCE_OFF : fogDistance;
-    }
-
     public static Range getFogDistanceRange(ConfigState state) {
         return new Range(FOG_DISTANCE_OFF, getMaxFogDistance(state), 1);
     }
@@ -89,9 +100,9 @@ public static int getMaxFogDistance(ConfigState state) {
         maxFogDistance = Math.max(maxFogDistance, getSodiumRenderDistanceMax(state, maxFogDistance));
 
         SodiumExtraGameOptions.FogSettings fogSettings = getFogSettings();
-        maxFogDistance = Math.max(maxFogDistance, normalizeFogDistance(fogSettings.atmospheric.distanceChunks));
+        maxFogDistance = Math.max(maxFogDistance, fogSettings.atmospheric.distanceChunks);
         for (SodiumExtraGameOptions.AtmosphericFogSettings settings : fogSettings.dimensionOverrides.values()) {
-            maxFogDistance = Math.max(maxFogDistance, normalizeFogDistance(settings.distanceChunks));
+            maxFogDistance = Math.max(maxFogDistance, settings.distanceChunks);
         }
 
         return maxFogDistance;
@@ -187,11 +198,28 @@ public static boolean isBossFogActive() {
 
     public static boolean shouldModifyProtectedGameplayFog() {
         SodiumExtraGameOptions.FogSettings fogSettings = getFogSettings();
-        return fogSettings.advanced && fogSettings.protectedGameplay.enabledWhenAllowed && isLocalWorldAllowedForProtectedGameplayFog();
+        return fogSettings.advanced
+                && fogSettings.protectedGameplay.enabledWhenAllowed
+                && (isLocalWorldAllowedForProtectedGameplayFog() || PROTECTED_GAMEPLAY_FOG.policy().isPresent());
     }
 
     public static int getProtectedGameplayFogDistance(ProtectedFogType type) {
-        SodiumExtraGameOptions.ProtectedFogSettings settings = getFogSettings().protectedGameplay;
+        SodiumExtraGameOptions.FogSettings fogSettings = getFogSettings();
+        if (!fogSettings.advanced || !fogSettings.protectedGameplay.enabledWhenAllowed) {
+            return FOG_DISTANCE_VANILLA;
+        }
+
+        int distanceBlocks = getConfiguredProtectedGameplayFogDistance(fogSettings.protectedGameplay, type);
+        if (isLocalWorldAllowedForProtectedGameplayFog()) {
+            return distanceBlocks;
+        }
+
+        return PROTECTED_GAMEPLAY_FOG.policy()
+                .map(policy -> policy.clamp(type, distanceBlocks))
+                .orElse(FOG_DISTANCE_VANILLA);
+    }
+
+    private static int getConfiguredProtectedGameplayFogDistance(SodiumExtraGameOptions.ProtectedFogSettings settings, ProtectedFogType type) {
         return switch (type) {
             case BLINDNESS -> settings.blindnessDistanceBlocks;
             case DARKNESS -> settings.darknessDistanceBlocks;
@@ -202,7 +230,6 @@ public static int getProtectedGameplayFogDistance(ProtectedFogType type) {
     }
 
     public static void applyProtectedGameplayFog(FogData fog, int distanceBlocks, float environmentalStartMultiplier, float skyEndMultiplier) {
-        distanceBlocks = normalizeFogDistance(distanceBlocks);
         if (distanceBlocks == FOG_DISTANCE_VANILLA) {
             return;
         }
@@ -256,4 +283,44 @@ private static int getIntAccessor(Object object, String methodName, int fallback
         }
     }
 
+    private record ProtectedGameplayFogPolicy(Map<ProtectedFogType, ProtectedFogRule> rules) {
+        private static ProtectedGameplayFogPolicy fromJson(JsonObject settings) {
+            EnumMap<ProtectedFogType, ProtectedFogRule> rules = new EnumMap<>(ProtectedFogType.class);
+
+            for (ProtectedFogType type : ProtectedFogType.values()) {
+                JsonObject rule = GsonHelper.getAsJsonObject(settings, type.policyKey, new JsonObject());
+                boolean enabled = GsonHelper.getAsBoolean(rule, "enabled", false);
+                int maxDistanceBlocks = Math.clamp(GsonHelper.getAsInt(rule, "max_distance_blocks", FOG_DISTANCE_VANILLA), FOG_DISTANCE_VANILLA, PROTECTED_FOG_DISTANCE_MAX_BLOCKS);
+                boolean allowOff = GsonHelper.getAsBoolean(rule, "allow_off", false);
+
+                rules.put(type, new ProtectedFogRule(enabled, maxDistanceBlocks, allowOff));
+            }
+
+            return new ProtectedGameplayFogPolicy(Map.copyOf(rules));
+        }
+
+        private int clamp(ProtectedFogType type, int distanceBlocks) {
+            ProtectedFogRule rule = this.rules.get(type);
+            return rule != null ? rule.clamp(distanceBlocks) : FOG_DISTANCE_VANILLA;
+        }
+    }
+
+    private record ProtectedFogRule(boolean enabled, int maxDistanceBlocks, boolean allowOff) {
+        private int clamp(int distanceBlocks) {
+            if (!this.enabled) {
+                return FOG_DISTANCE_VANILLA;
+            }
+
+            if (distanceBlocks == FOG_DISTANCE_VANILLA) {
+                return FOG_DISTANCE_VANILLA;
+            }
+
+            if (disablesFog(distanceBlocks)) {
+                return this.allowOff ? FOG_DISTANCE_OFF : this.maxDistanceBlocks;
+            }
+
+            return Math.min(distanceBlocks, this.maxDistanceBlocks);
+        }
+    }
+
 }

common/src/main/resources/assets/sodium-extra/lang/en_us.json

@@ -356,17 +356,17 @@
   "sodium-extra.option.prevent_shaders": "Prevent Shaders",
   "sodium-extra.option.prevent_shaders.tooltip": "Prevents vanilla shader effects from loading (e.g., spider-view distortion while spectating).",
   "sodium-extra.option.protected_gameplay_fog": "Protected Gameplay Fog",
-  "sodium-extra.option.protected_gameplay_fog.tooltip": "Allows advanced fog distance changes for gameplay-affecting fog only in private singleplayer worlds or LAN worlds with cheats enabled. These controls use block distances and have no effect on normal multiplayer servers.",
+  "sodium-extra.option.protected_gameplay_fog.tooltip": "Allows advanced fog distance changes for gameplay-affecting fog in private singleplayer worlds, LAN worlds with cheats enabled, or servers that authorize it through Greenlight. Multiplayer authorization requires Greenlight installed. These controls use block distances.",
   "sodium-extra.option.protected_gameplay_fog.blindness": "Blindness Fog",
-  "sodium-extra.option.protected_gameplay_fog.blindness.tooltip": "Adjusts blindness fog in private singleplayer or LAN worlds with cheats enabled.\n0: Use vanilla fog settings\n1+: Set fog distance in blocks; full vanilla blindness is about 5 blocks\nOff: Disable this fog",
+  "sodium-extra.option.protected_gameplay_fog.blindness.tooltip": "Adjusts blindness fog when local play allows it or the server authorizes it with Greenlight.\n0: Use vanilla fog settings\n1+: Set fog distance in blocks; full vanilla blindness is about 5 blocks\nOff: Disable this fog",
   "sodium-extra.option.protected_gameplay_fog.darkness": "Darkness Fog",
-  "sodium-extra.option.protected_gameplay_fog.darkness.tooltip": "Adjusts darkness fog in private singleplayer or LAN worlds with cheats enabled.\n0: Use vanilla fog settings\n1+: Set fog distance in blocks; vanilla darkness trends toward about 15 blocks\nOff: Disable this fog",
+  "sodium-extra.option.protected_gameplay_fog.darkness.tooltip": "Adjusts darkness fog when local play allows it or the server authorizes it with Greenlight.\n0: Use vanilla fog settings\n1+: Set fog distance in blocks; vanilla darkness trends toward about 15 blocks\nOff: Disable this fog",
   "sodium-extra.option.protected_gameplay_fog.lava": "Lava Fog",
-  "sodium-extra.option.protected_gameplay_fog.lava.tooltip": "Adjusts lava fog in private singleplayer or LAN worlds with cheats enabled.\n0: Use vanilla fog settings\n1+: Set fog distance in blocks; vanilla lava is about 1 block, or 5 blocks with Fire Resistance\nOff: Disable this fog",
+  "sodium-extra.option.protected_gameplay_fog.lava.tooltip": "Adjusts lava fog when local play allows it or the server authorizes it with Greenlight.\n0: Use vanilla fog settings\n1+: Set fog distance in blocks; vanilla lava is about 1 block, or 5 blocks with Fire Resistance\nOff: Disable this fog",
   "sodium-extra.option.protected_gameplay_fog.powder_snow": "Powder Snow Fog",
-  "sodium-extra.option.protected_gameplay_fog.powder_snow.tooltip": "Adjusts powder snow fog in private singleplayer or LAN worlds with cheats enabled.\n0: Use vanilla fog settings\n1+: Set fog distance in blocks; vanilla powder snow is about 2 blocks\nOff: Disable this fog",
+  "sodium-extra.option.protected_gameplay_fog.powder_snow.tooltip": "Adjusts powder snow fog when local play allows it or the server authorizes it with Greenlight.\n0: Use vanilla fog settings\n1+: Set fog distance in blocks; vanilla powder snow is about 2 blocks\nOff: Disable this fog",
   "sodium-extra.option.protected_gameplay_fog.water": "Water Fog",
-  "sodium-extra.option.protected_gameplay_fog.water.tooltip": "Adjusts underwater fog in private singleplayer or LAN worlds with cheats enabled.\n0: Use vanilla fog settings\n1+: Set fog distance in blocks; vanilla water varies by biome and water vision\nOff: Disable this fog",
+  "sodium-extra.option.protected_gameplay_fog.water.tooltip": "Adjusts underwater fog when local play allows it or the server authorizes it with Greenlight.\n0: Use vanilla fog settings\n1+: Set fog distance in blocks; vanilla water varies by biome and water vision\nOff: Disable this fog",
   "sodium-extra.option.rain_snow.tooltip": "Renders rain and snow.",
   "sodium-extra.option.rain_splash.tooltip": "Renders rain splash particles.",
   "sodium-extra.option.recipe_toast": "Recipe Toasts",

docs/examples/lava-fog-policy-pack/assets/sodium-extra/client_features/v1/protected_gameplay_fog.json

@@ -0,0 +1,25 @@
+{
+  "protocol_version": 1,
+  "feature": "sodium-extra:protected_gameplay_fog",
+  "enabled": true,
+  "settings_version": 1,
+  "settings": {
+    "blindness": {
+      "enabled": false
+    },
+    "darkness": {
+      "enabled": false
+    },
+    "lava": {
+      "enabled": true,
+      "max_distance_blocks": 256,
+      "allow_off": true
+    },
+    "powder_snow": {
+      "enabled": false
+    },
+    "water": {
+      "enabled": false
+    }
+  }
+}

docs/examples/lava-fog-policy-pack/pack.mcmeta

@@ -0,0 +1,6 @@
+{
+  "pack": {
+    "pack_format": 22,
+    "description": "Sodium Extra lava fog Greenlight policy"
+  }
+}

docs/examples/protected_gameplay_fog.json

@@ -0,0 +1,25 @@
+{
+  "protocol_version": 1,
+  "feature": "sodium-extra:protected_gameplay_fog",
+  "enabled": true,
+  "settings_version": 1,
+  "settings": {
+    "blindness": {
+      "enabled": false
+    },
+    "darkness": {
+      "enabled": false
+    },
+    "lava": {
+      "enabled": true,
+      "max_distance_blocks": 256,
+      "allow_off": true
+    },
+    "powder_snow": {
+      "enabled": false
+    },
+    "water": {
+      "enabled": false
+    }
+  }
+}