Merge branch '1.17' into 1.18

# Conflicts:
#	src/main/java/net/coderbot/iris/Iris.java
#	src/main/java/net/coderbot/iris/compat/sodium/SodiumVersionCheck.java

Author: IMS212

docs/changelogs/1.1.3/full.md

@@ -1,11 +1,4 @@
-# Iris 1.1.3 Preliminary Changelog (Full)
-
-WIP, up-to-date as of:
-
-- 1.16.x: https://github.com/IrisShaders/Iris/commit/91ac46ab59e67d8e77e416cc16429473c19f0a36
-- 1.17.x: https://github.com/IrisShaders/Iris/commit/65fc9ce3fd122bcf28400f1811b525240a4ca27d
-
----
+# Iris 1.1.3 Changelog (Full)
 
 This release includes significant changes to the project organization of Iris, as well as fixes for some rendering bugs in the shader packs supported by Iris, especially when using manually-edited shader configuration.
 

docs/changelogs/1.1.3/summary.md

@@ -1,7 +1,3 @@
-**note: Iris 1.1.3 is unreleased, this is just an in-progress summary / changelog**
-
----
-
 Iris version 1.1.3 for Minecraft 1.16.5 and Minecraft 1.17.1 has been released!
 
 This release was jointly developed by coderbot, IMS, and Justsnoopy30, and also contains major contributions from Kroppeb and maximum#8760. It also contains many other smaller (but still important) contributions from many other people!

docs/changelogs/1.1.4/full.md

@@ -1,12 +1,4 @@
-# Iris 1.1.4 Preliminary Changelog (Full)
-
-WIP, up-to-date as of:
-
-- 1.16.x: https://github.com/IrisShaders/Iris/commit/099883f70c5136646f98cd075caf0960e475692c
-- 1.17.x: https://github.com/IrisShaders/Iris/commit/42503308b214093cecae364dcaf5a7c6ed7e76c5
-- 1.18.x: https://github.com/IrisShaders/Iris/commit/b59d8c182d8edf2a8d68127c1835629d0843653f
-
----
+# Iris 1.1.4 Changelog (Full)
 
 This release mainly focuses on bug fixes, and closes over 50 GitHub issues! It resolves a huge number of bugs, and the Iris experience with supported packs should be substantially improved as a result. Thanks to the many contributors that made this release possible!
 

docs/changelogs/1.1.4/summary.md

@@ -1,7 +1,3 @@
-**note: Iris 1.1.4 is unreleased, this is just an in-progress summary / changelog**
-
----
-
 Iris version 1.1.4 for Minecraft 1.16.5, Minecraft 1.17.1, and Minecraft 1.18.1 has been released!
 
 This release was jointly developed by coderbot and IMS, and also contains a number of contributions from maximum#8760 and Justsnoopy30. It also contains many other smaller (but still important) contributions from many other people!

docs/changelogs/1.1.5/summary.md

@@ -0,0 +1,3 @@
+This is a small bug fix release to support Sodium 0.3.4 on 1.17 and Sodium 0.4.0 alpha 6 on 1.18, while we work on the 1.2.0 update to add shader settings, currently in public beta on our Discord!
+
+⬇️ Download the release here: https://irisshaders.net/download.html

docs/changelogs/1.2.0/full.md

@@ -0,0 +1,34 @@
+# Iris 1.2.0 Preliminary Changelog
+
+**note: Iris 1.2.0 is unreleased, this is just an in-progress summary / changelog**
+
+Iris 1.2.0 is here for Minecraft 1.16.5 / 1.17.1 / 1.18.1, bringing the long awaited Shader Configuration GUI!
+
+The shader configuration system and GUI was a massive undertaking, with development of this iteration beginning in June 2021 with development of the previous iteration (as seen in Starline) having started in February 2021.
+
+While shader config might seem like a simple enough request, the reality is that applying option changes while accounting for all the complexity and edge cases but also keeping shader pack loading extremely fast took a ton of work. An intuitive and functional GUI on top of that was also a ton of work. All in all, the following people directly contributed code to shader config:
+
+- coderbot: Shader config backend (loading / applying config files)
+- FoundationGames: Shader configuration GUI (viewing / editing config files) + profile handling
+- IMS: Fixes and tweaks to both the backend and GUI as well as overseeing QA / testing
+- Justsnoopy30: Guidance based on experience with Starline, small fixes
+
+## Other fixes
+
+- Added support for the `prepare` pass (maximum#8760)
+- Use the correct encoding when loading `.properties` files (IMS)
+- Added some more hardcoded uniforms for Complementary while custom uniforms are still in development (IMS)
+- Added support for `shadowTerrain`, `shadowTranslucent`, `shadowEntities`, `shadowBlockEntities` in shaders.properties (IMS)
+- Added support for the `renderStage` uniform, allows SEUS PTGI HRR 3 to load (IMS)
+    - HRR 3 is still not supported and has severe bugs on Iris.
+- Added support for the `blendFunc` uniform (IMS)
+- 1.18.1: Fix log spam related to `u_RegionOffset` (Justsnoopy30)
+
+## Translations
+
+- Updated pt_br.json by @ppblitto in #1202
+- Updated zh_tw.json by @HJ-zhtw in #1173
+- Updated zh_cn translations by @klkq in #1197
+- Updated it_it.json (13 January 2022) by @devpelux in #1191
+- Updated German translation by @Levelowel in #1179
+- Updated zh_tw.json by @HJ-zhtw in #1208

docs/changelogs/1.2.0/summary.md

@@ -0,0 +1,14 @@
+**note: Iris 1.2.0 is unreleased, this is just an in-progress summary / changelog**
+
+---
+
+Iris 1.2.0 is here for Minecraft 1.16.5 / 1.17.1 / 1.18.1, bringing the long awaited Shader Configuration GUI! This release was jointly developed by coderbot, IMS, and FoundationGames, but also contains code contributions from Justsnoopy30 and maximum#8760.
+
+The shader configuration system and GUI was a massive undertaking, with development of this iteration beginning in June 2021 with development of the previous iteration (as seen in Starline) having started in February 2021.  Applying option changes while accounting for all the complexity and edge cases but also keeping shader pack loading extremely fast took a ton of work. An intuitive and functional GUI on top of that was also a ton of work.
+
+But finally, it is ready for release! We've included some smaller issue fixes as well.
+
+**⬇ Download the release here: https://irisshaders.net/download.html**
+
+A more detailed changelog is available for those interested: <https://github.com/IrisShaders/Iris/blob/trunk/docs/changelogs/1.2.0/full.md>
+

src/main/java/net/coderbot/iris/Iris.java

@@ -1,6 +1,7 @@
 package net.coderbot.iris;
 
 import java.io.IOException;
+import java.io.OutputStream;
 import java.nio.file.FileSystem;
 import java.nio.file.FileSystemNotFoundException;
 import java.nio.file.FileSystems;
@@ -22,10 +23,14 @@
 import net.coderbot.iris.pipeline.*;
 import net.coderbot.iris.pipeline.newshader.NewWorldRenderingPipeline;
 import net.coderbot.iris.shaderpack.DimensionId;
+import net.coderbot.iris.shaderpack.OptionalBoolean;
 import net.coderbot.iris.shaderpack.ProgramSet;
 import net.coderbot.iris.shaderpack.ShaderPack;
+import net.coderbot.iris.shaderpack.option.OptionSet;
 import net.coderbot.iris.shaderpack.option.Profile;
 import net.coderbot.iris.shaderpack.discovery.ShaderpackDirectoryManager;
+import net.coderbot.iris.shaderpack.option.values.MutableOptionValues;
+import net.coderbot.iris.shaderpack.option.values.OptionValues;
 import net.fabricmc.loader.api.ModContainer;
 import net.irisshaders.iris.api.v0.IrisApi;
 import net.minecraft.ChatFormatting;
@@ -49,7 +54,6 @@
 public class Iris implements ClientModInitializer {
 	public static final String MODID = "iris";
 	public static final Logger logger = LogManager.getLogger(MODID);
-	public static final String SODIUM_DOWNLOAD_LINK = "https://www.curseforge.com/minecraft/mc-mods/sodium/files/3542074";
 
 	private static Path shaderpacksDirectory;
 	private static ShaderpackDirectoryManager shaderpacksDirectoryManager;
@@ -70,6 +74,9 @@ public class Iris implements ClientModInitializer {
 	private static KeyMapping shaderpackScreenKeybind;
 
 	private static final Map<String, String> shaderPackOptionQueue = new HashMap<>();
+	// Flag variable used when reloading
+	// Used in favor of queueDefaultShaderPackOptionValues() for resetting as the
+	// behavior is more concrete and therefore is more likely to repair a user's issues
 	private static boolean resetShaderPackOptions = false;
 
 	private static String IRIS_VERSION;
@@ -278,7 +285,7 @@ private static boolean loadExternalShaderpack(String name) {
 			return false;
 		}
 
-		Map<String, String> changedConfigs = loadConfigProperties(shaderPackConfigTxt)
+		Map<String, String> changedConfigs = tryReadConfigProperties(shaderPackConfigTxt)
 				.map(properties -> (Map<String, String>) (Map) properties)
 				.orElse(new HashMap<>());
 
@@ -290,12 +297,17 @@ private static boolean loadExternalShaderpack(String name) {
 		}
 		resetShaderPackOptions = false;
 
-		Properties configsToSave = new Properties();
-		configsToSave.putAll(changedConfigs);
-		saveConfigProperties(shaderPackConfigTxt, configsToSave);
-
 		try {
 			currentPack = new ShaderPack(shaderPackPath, changedConfigs);
+
+			MutableOptionValues changedConfigsValues = currentPack.getShaderPackOptions().getOptionValues().mutableCopy();
+
+			// Store changed values from those currently in use by the shader pack
+			Properties configsToSave = new Properties();
+			changedConfigsValues.getBooleanValues().forEach((k, v) -> configsToSave.setProperty(k, Boolean.toString(v)));
+			changedConfigsValues.getStringValues().forEach(configsToSave::setProperty);
+
+			tryUpdateConfigPropertiesFile(shaderPackConfigTxt, configsToSave);
 		} catch (Exception e) {
 			logger.error("Failed to load the shaderpack \"{}\"!", name);
 			logger.catching(e);
@@ -360,24 +372,37 @@ private static void setShadersDisabled() {
 		logger.info("Shaders are disabled");
 	}
 
-	private static Optional<Properties> loadConfigProperties(Path path) {
+	private static Optional<Properties> tryReadConfigProperties(Path path) {
 		Properties properties = new Properties();
 
-		try {
-			// NB: config properties are specified to be encoded with ISO-8859-1 by OptiFine,
-			//     so we don't need to do the UTF-8 workaround here.
-			properties.load(Files.newInputStream(path));
-		} catch (IOException e) {
-			// TODO: Better error handling
-			return Optional.empty();
+		if (Files.exists(path)) {
+			try {
+				// NB: config properties are specified to be encoded with ISO-8859-1 by OptiFine,
+				//     so we don't need to do the UTF-8 workaround here.
+				properties.load(Files.newInputStream(path));
+			} catch (IOException e) {
+				// TODO: Better error handling
+				return Optional.empty();
+			}
 		}
 
 		return Optional.of(properties);
 	}
 
-	private static void saveConfigProperties(Path path, Properties properties) {
+	private static void tryUpdateConfigPropertiesFile(Path path, Properties properties) {
 		try {
-			properties.store(Files.newOutputStream(path), null);
+			if (properties.isEmpty()) {
+				// Delete the file or don't create it if there are no changed configs
+				if (Files.exists(path)) {
+					Files.delete(path);
+				}
+
+				return;
+			}
+
+			try (OutputStream out = Files.newOutputStream(path)) {
+				properties.store(out, null);
+			}
 		} catch (IOException e) {
 			// TODO: Better error handling
 		}
@@ -427,6 +452,34 @@ public static void queueShaderPackOptionsFromProfile(Profile profile) {
 		getShaderPackOptionQueue().putAll(profile.optionValues);
 	}
 
+	public static void queueShaderPackOptionsFromProperties(Properties properties) {
+		queueDefaultShaderPackOptionValues();
+
+		properties.stringPropertyNames().forEach(key ->
+				getShaderPackOptionQueue().put(key, properties.getProperty(key)));
+	}
+
+	// Used in favor of resetShaderPackOptions as the aforementioned requires the pack to be reloaded
+	public static void queueDefaultShaderPackOptionValues() {
+		clearShaderPackOptionQueue();
+
+		getCurrentPack().ifPresent(pack -> {
+			OptionSet options = pack.getShaderPackOptions().getOptionSet();
+			OptionValues values = pack.getShaderPackOptions().getOptionValues();
+
+			options.getStringOptions().forEach((key, mOpt) -> {
+				if (values.getStringValue(key).isPresent()) {
+					getShaderPackOptionQueue().put(key, mOpt.getOption().getDefaultValue());
+				}
+			});
+			options.getBooleanOptions().forEach((key, mOpt) -> {
+				if (values.getBooleanValue(key) != OptionalBoolean.DEFAULT) {
+					getShaderPackOptionQueue().put(key, Boolean.toString(mOpt.getOption().getDefaultValue()));
+				}
+			});
+		});
+	}
+
 	public static void clearShaderPackOptionQueue() {
 		getShaderPackOptionQueue().clear();
 	}

src/main/java/net/coderbot/iris/compat/sodium/AllowedSodiumVersion.java

@@ -1,20 +1,24 @@
 package net.coderbot.iris.compat.sodium;
 
+import java.util.Optional;
+
 public class AllowedSodiumVersion {
 	private final String version;
+	private final String downloadLink;
 	private final boolean prefixMatch;
 
-	public AllowedSodiumVersion(String version, boolean prefixMatch) {
+	public AllowedSodiumVersion(String version, String downloadLink, boolean prefixMatch) {
 		this.version = version;
+		this.downloadLink = downloadLink;
 		this.prefixMatch = prefixMatch;
 	}
 
 	public static AllowedSodiumVersion prefix(String prefix) {
-		return new AllowedSodiumVersion(prefix, true);
+		return new AllowedSodiumVersion(prefix, null, true);
 	}
 
-	public static AllowedSodiumVersion exact(String version) {
-		return new AllowedSodiumVersion(version, false);
+	public static AllowedSodiumVersion exact(String version, String downloadLink) {
+		return new AllowedSodiumVersion(version, downloadLink, false);
 	}
 
 	public boolean matches(String candidate) {
@@ -32,4 +36,8 @@ public String getVersion() {
 	public boolean isPrefixMatch() {
 		return prefixMatch;
 	}
+
+	public Optional<String> getDownloadLink() {
+		return Optional.ofNullable(downloadLink);
+	}
 }

src/main/java/net/coderbot/iris/compat/sodium/SodiumVersionCheck.java

@@ -2,16 +2,28 @@
 
 import com.google.common.collect.ImmutableList;
 
+import java.util.Optional;
+
 public class SodiumVersionCheck {
 	// The allowed versions of Sodium for use with Iris
+	//
+	// Make sure to update the comments / download links when editing this!!!
+	// If you forget to edit the download links you'll cause the support team a bunch
+	// of pain. So don't forget!
 	private static final ImmutableList<AllowedSodiumVersion> ALLOWED_SODIUM_VERSIONS = ImmutableList.of(
 			// Official 0.3.4
-			AllowedSodiumVersion.exact("0.4.0-alpha6+build.14"),
+			AllowedSodiumVersion.exact("0.4.0-alpha6+build.14",
+					"https://www.curseforge.com/minecraft/mc-mods/sodium/files/3605309"),
 
 			// For use by ReplayMod
 			AllowedSodiumVersion.prefix("0.4.0-alpha6+replaymod")
 	);
 
+	public static String getDownloadLink() {
+		return ALLOWED_SODIUM_VERSIONS.stream().map(AllowedSodiumVersion::getDownloadLink)
+				.filter(Optional::isPresent).findFirst().get().get();
+	}
+
 	public static boolean isAllowedVersion(String sodiumVersion) {
 		for (AllowedSodiumVersion allowed : ALLOWED_SODIUM_VERSIONS) {
 			if (allowed.matches(sodiumVersion)) {