getSmoothZoomDurationMillisError(long millis) {
+ if (millis < ConfigUtil.MIN_SMOOTH_ZOOM_DURATION_MILLIS) {
+ return Optional.of(Text.translatable(ConfigUtil.ERROR_SMOOTH_ZOOM_DURATION_MILLIS_TOO_SMALL));
+ } else if (millis > ConfigUtil.MAX_SMOOTH_ZOOM_DURATION_MILLIS) {
+ return Optional.of(Text.translatable(ConfigUtil.ERROR_SMOOTH_ZOOM_DURATION_MILLIS_TOO_LARGE));
+ }
+
+ return Optional.empty();
+ }
+
+ private void loadProperties() {
+ if (!CONFIG_FILE.exists()) {
+ loadDefaultProperties();
+ return;
+ }
+
+ try (InputStream is = new FileInputStream(CONFIG_FILE)) {
+ this.properties.load(is);
+ } catch (IOException e) {
+ LOG.error("Could not read from config file!", e);
+ loadDefaultProperties();
+ }
+ }
+
+ private void loadDefaultProperties() {
+ // don't synchronize since this method is called only by loadProperties() which
+ // already has a lock on this.properties at this point!
+ properties.put(ConfigUtil.OPTION_ENABLE_SMOOTH_ZOOM, ConfigUtil.DEFAULT_ENABLE_SMOOTH_ZOOM);
+ properties.put(ConfigUtil.OPTION_ZOOM_FACTOR, ConfigUtil.DEFAULT_ZOOM_FACTOR);
+
+ // since the default properties are only loaded if the properties file does not
+ // exist or cannot be accessed for whatever reason, let's create/overwrite the
+ // file.
+ saveProperties();
+ }
+
+ void saveProperties() {
+ try (OutputStream out = new FileOutputStream(CONFIG_FILE)) {
+ this.properties.store(out, null);
+ } catch (IOException e) {
+ LOG.error("Could not write to config file!", e);
+ }
+ }
+}
diff --git a/src/main/java/com/logicalgeekboy/logical_zoom/config/ConfigScreen.java b/src/main/java/com/logicalgeekboy/logical_zoom/config/ConfigScreen.java
new file mode 100644
index 0000000..ade4608
--- /dev/null
+++ b/src/main/java/com/logicalgeekboy/logical_zoom/config/ConfigScreen.java
@@ -0,0 +1,66 @@
+package com.logicalgeekboy.logical_zoom.config;
+
+import com.terraformersmc.modmenu.api.ConfigScreenFactory;
+import com.terraformersmc.modmenu.api.ModMenuApi;
+
+import me.shedaniel.clothconfig2.api.ConfigBuilder;
+import me.shedaniel.clothconfig2.api.ConfigCategory;
+import net.minecraft.client.gui.screen.Screen;
+import net.minecraft.text.Text;
+
+/**
+ * Builds and registers the Logical Zoom configuration screen and registers it
+ * with Mod Menu (if installed).
+ *
+ * @author marcelbpunkt
+ *
+ */
+public class ConfigScreen implements ModMenuApi {
+
+ private static final ConfigHandler HANDLER = ConfigHandler.getInstance();
+
+ /**
+ * Builds and returns the Logical Zoom configuration screen.
+ *
+ * @param parent the screen from which this screen is opened
+ * @return the Logical Zoom configuration screen
+ */
+ public static Screen createConfigScreen(Screen parent) {
+ ConfigBuilder builder = ConfigBuilder.create().setParentScreen(parent)
+ .setTitle(Text.translatable(ConfigUtil.MENU_TITLE)).setSavingRunnable(HANDLER::saveProperties);
+
+ ConfigCategory general = builder.getOrCreateCategory(Text.translatable(ConfigUtil.CATEGORY_GENERAL));
+
+ // add zoom factor field (double value)
+ general.addEntry(builder.entryBuilder()
+ .startDoubleField(Text.translatable(ConfigUtil.OPTION_ZOOM_FACTOR), HANDLER.getZoomFactor())
+ .setDefaultValue(ConfigUtil.getDefaultZoomFactor()).setSaveConsumer(HANDLER::setZoomFactor)
+ .setMin(ConfigUtil.MIN_ZOOM_FACTOR).setMax(ConfigUtil.MAX_ZOOM_FACTOR)
+ .setTooltip(Text.translatable(ConfigUtil.TOOLTIP_ZOOM_FACTOR))
+ .setErrorSupplier(HANDLER::getZoomFactorError).build());
+
+ // add enable smooth zoom button
+ general.addEntry(builder.entryBuilder()
+ .startBooleanToggle(Text.translatable(ConfigUtil.OPTION_ENABLE_SMOOTH_ZOOM),
+ HANDLER.isSmoothZoomEnabled())
+ .setDefaultValue(ConfigUtil.getDefaultEnableSmoothZoom()).setSaveConsumer(HANDLER::setSmoothZoomEnabled)
+ .setTooltip(Text.translatable(ConfigUtil.TOOLTIP_ENABLE_SMOOTH_ZOOM)).build());
+
+ // add smooth zoom duration field (long value)
+ general.addEntry(builder.entryBuilder()
+ .startLongField(Text.translatable(ConfigUtil.OPTION_SMOOTH_ZOOM_DURATION_MILLIS),
+ HANDLER.getSmoothZoomDurationMillis())
+ .setDefaultValue(ConfigUtil.getDefaultSmoothZoomDurationMillis())
+ .setSaveConsumer(HANDLER::setSmoothZoomDurationMillis)
+ .setMin(ConfigUtil.MIN_SMOOTH_ZOOM_DURATION_MILLIS).setMax(ConfigUtil.MAX_SMOOTH_ZOOM_DURATION_MILLIS)
+ .setTooltip(Text.translatable(ConfigUtil.TOOLTIP_SMOOTH_ZOOM_DURATION_MILLIS))
+ .setErrorSupplier(HANDLER::getSmoothZoomDurationMillisError).build());
+
+ return builder.build();
+ }
+
+ @Override
+ public ConfigScreenFactory getModConfigScreenFactory() {
+ return ConfigScreen::createConfigScreen;
+ }
+}
diff --git a/src/main/java/com/logicalgeekboy/logical_zoom/config/ConfigUtil.java b/src/main/java/com/logicalgeekboy/logical_zoom/config/ConfigUtil.java
new file mode 100644
index 0000000..b655489
--- /dev/null
+++ b/src/main/java/com/logicalgeekboy/logical_zoom/config/ConfigUtil.java
@@ -0,0 +1,146 @@
+package com.logicalgeekboy.logical_zoom.config;
+
+import com.logicalgeekboy.logical_zoom.LogicalZoom;
+
+/**
+ * Contains constants for all translation keys and default values except for the
+ * zoom key bind which is defined in {@link LogicalZoom}. All properties stored
+ * in the config file are String values in order to make use of
+ * {@code Properties.load} and {@code Properties.store}.
+ *
+ * The default values can also be retrieved in their correct data type via the
+ * respective getter methods.
+ *
+ * @author marcelbpunkt
+ *
+ */
+public class ConfigUtil {
+
+ /**
+ * The namespace of this mod
+ */
+ public static final String NAMESPACE = "logical_zoom";
+
+ private static final String CATEGORY_PREFIX = NAMESPACE + ".category";
+ private static final String OPTION_PREFIX = NAMESPACE + ".option";
+ private static final String TOOLTIP_PREFIX = NAMESPACE + ".tooltip";
+ private static final String ERROR_PREFIX = NAMESPACE + ".error";
+
+ /**
+ * The title displayed when this mod is configured via the Mod Menu screen
+ */
+ public static final String MENU_TITLE = NAMESPACE + ".menu_title";
+
+ /**
+ * The "General" settings category
+ */
+ public static final String CATEGORY_GENERAL = CATEGORY_PREFIX + ".general";
+
+ /**
+ * The translation key for the zoom factor setting
+ */
+ public static final String OPTION_ZOOM_FACTOR = OPTION_PREFIX + ".zoom_factor";
+ /**
+ * The translation key for the "Enable Smooth Zoom" setting
+ */
+ public static final String OPTION_ENABLE_SMOOTH_ZOOM = OPTION_PREFIX + ".enable_smooth_zoom";
+ /**
+ * The translation key for the smooth zoom duration setting
+ */
+ public static final String OPTION_SMOOTH_ZOOM_DURATION_MILLIS = OPTION_PREFIX + ".smooth_zoom_duration_millis";
+
+ /**
+ * The default value for the zoom factor setting
+ */
+ public static final String DEFAULT_ZOOM_FACTOR = "3.0";
+ /**
+ * The smallest possible zoom factor setting
+ */
+ public static final double MIN_ZOOM_FACTOR = 1.0;
+ /**
+ * The greatest possible zoom factor setting
+ */
+ public static final double MAX_ZOOM_FACTOR = 5.0;
+ /**
+ * The default "Enable Smooth Zoom" setting
+ */
+ public static final String DEFAULT_ENABLE_SMOOTH_ZOOM = "true";
+ /**
+ * The default smooth zoom duration setting in milliseconds
+ */
+ public static final String DEFAULT_SMOOTH_ZOOM_DURATION_MILLIS = "120";
+ /**
+ * The smallest possible smooth zoom duration setting.
+ *
+ * The smooth zoom duration value must not be zero or it will lead to a division
+ * by zero!
+ */
+ public static final long MIN_SMOOTH_ZOOM_DURATION_MILLIS = 1L;
+ /**
+ * The greatest possible smooth zoom duration setting
+ */
+ public static final long MAX_SMOOTH_ZOOM_DURATION_MILLIS = 10000L;
+
+ /**
+ * The translation key for the zoom factor tooltip
+ */
+ public static final String TOOLTIP_ZOOM_FACTOR = TOOLTIP_PREFIX + ".zoom_factor";
+ /**
+ * The translation key for the "Enable Smooth Zoom" tooltip
+ */
+ public static final String TOOLTIP_ENABLE_SMOOTH_ZOOM = TOOLTIP_PREFIX + ".enable_smooth_zoom";
+ /**
+ * The translation key for the smooth zoom duration tooltip
+ */
+ public static final String TOOLTIP_SMOOTH_ZOOM_DURATION_MILLIS = TOOLTIP_PREFIX + ".smooth_zoom_duration_millis";
+
+ /**
+ * The file name of the properties file to which all settings are written
+ */
+ public static final String CONFIG_FILE_NAME = "config/logical_zoom.properties";
+ /**
+ * The translation key for the "zoom factor too small" error message
+ */
+ public static final String ERROR_ZOOM_FACTOR_TOO_SMALL = ERROR_PREFIX + ".zoom_factor_too_small";
+ /**
+ * The translation key for the "zoom factor too large" error message
+ */
+ public static final String ERROR_ZOOM_FACTOR_TOO_LARGE = ERROR_PREFIX + ".zoom_factor_too_large";
+ /**
+ * The translation key for the "smooth zoom duration too small" error message
+ */
+ public static final String ERROR_SMOOTH_ZOOM_DURATION_MILLIS_TOO_SMALL = ERROR_PREFIX
+ + ".smooth_zoom_duration_millis_too_small";
+ /**
+ * The translation key for the "smooth zoom duration too large" error message
+ */
+ public static final String ERROR_SMOOTH_ZOOM_DURATION_MILLIS_TOO_LARGE = ERROR_PREFIX
+ + ".smooth_zoom_duration_millis_too_large";
+
+ /**
+ * Returns the default zoom factor setting.
+ *
+ * @return the default zoom factor setting
+ */
+ public static double getDefaultZoomFactor() {
+ return Double.parseDouble(DEFAULT_ZOOM_FACTOR);
+ }
+
+ /**
+ * Returns the default "Enable Smooth Zoom" setting.
+ *
+ * @return the default "Enable Smooth Zoom" setting
+ */
+ public static boolean getDefaultEnableSmoothZoom() {
+ return Boolean.parseBoolean(DEFAULT_ENABLE_SMOOTH_ZOOM);
+ }
+
+ /**
+ * Returns the default smooth zoom duration setting in milliseconds.
+ *
+ * @return the default smooth zoom duration setting in milliseconds
+ */
+ public static long getDefaultSmoothZoomDurationMillis() {
+ return Long.parseLong(DEFAULT_SMOOTH_ZOOM_DURATION_MILLIS);
+ }
+}
diff --git a/src/main/java/com/logicalgeekboy/logical_zoom/mixin/LogicalZoomMixin.java b/src/main/java/com/logicalgeekboy/logical_zoom/mixin/LogicalZoomMixin.java
index f1293b9..9a621a3 100644
--- a/src/main/java/com/logicalgeekboy/logical_zoom/mixin/LogicalZoomMixin.java
+++ b/src/main/java/com/logicalgeekboy/logical_zoom/mixin/LogicalZoomMixin.java
@@ -1,28 +1,23 @@
package com.logicalgeekboy.logical_zoom.mixin;
-import com.logicalgeekboy.logical_zoom.LogicalZoom;
-
import org.spongepowered.asm.mixin.Mixin;
import org.spongepowered.asm.mixin.injection.At;
import org.spongepowered.asm.mixin.injection.Inject;
import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable;
+import com.logicalgeekboy.logical_zoom.LogicalZoom;
+
import net.fabricmc.api.EnvType;
import net.fabricmc.api.Environment;
-
import net.minecraft.client.render.GameRenderer;
@Environment(EnvType.CLIENT)
@Mixin(GameRenderer.class)
public class LogicalZoomMixin {
- @Inject(method = "getFov(Lnet/minecraft/client/render/Camera;FZ)D", at = @At("RETURN"), cancellable = true)
- public void getZoomLevel(CallbackInfoReturnable callbackInfo) {
- if(LogicalZoom.isZooming()) {
- double fov = callbackInfo.getReturnValue();
- callbackInfo.setReturnValue(fov * LogicalZoom.zoomLevel);
- }
-
- LogicalZoom.manageSmoothCamera();
- }
+ @Inject(method = "getFov(Lnet/minecraft/client/render/Camera;FZ)D", at = @At("RETURN"), cancellable = true)
+ public void getZoomLevel(CallbackInfoReturnable callbackInfo) {
+ double fov = callbackInfo.getReturnValue();
+ callbackInfo.setReturnValue(fov * LogicalZoom.getCurrentFOVMultiplier());
+ }
}
diff --git a/src/main/resources/assets/logical_zoom/lang/en_us.json b/src/main/resources/assets/logical_zoom/lang/en_us.json
index e288eb9..7b29558 100644
--- a/src/main/resources/assets/logical_zoom/lang/en_us.json
+++ b/src/main/resources/assets/logical_zoom/lang/en_us.json
@@ -1,4 +1,22 @@
{
- "key.logical_zoom.zoom": "Toggle Zoom",
- "category.logical_zoom.zoom": "Logical Zoom"
+ "key.logical_zoom.zoom": "Zoom",
+ "category.logical_zoom.zoom": "Logical Zoom",
+
+ "logical_zoom.menu_title": "Logical Zoom Settings",
+ "logical_zoom.category.general": "General",
+
+
+ "logical_zoom.option.zoom_factor": "Zoom Factor",
+ "logical_zoom.tooltip.zoom_factor": "Defines how much the picture is zoomed when pressing the zoom key.",
+
+ "logical_zoom.option.enable_smooth_zoom": "Enable Smooth Zoom",
+ "logical_zoom.tooltip.enable_smooth_zoom": "Enables/disables zoom-in/-out animations.",
+
+ "logical_zoom.option.smooth_zoom_duration_millis": "Smooth Zoom Duration (in ms)",
+ "logical_zoom.tooltip.smooth_zoom_duration_millis": "Defines how long the animations take (higher value = slower).",
+
+ "logical_zoom.error.zoom_factor_too_small": "Zoom factor too small (min. 1.0)!",
+ "logical_zoom.error.zoom_factor_too_large": "Zoom factor too large (max. 5.0)!",
+ "logical_zoom.error.smooth_zoom_duration_millis_too_small": "Duration must be positive!",
+ "logical_zoom.error.smooth_zoom_duration_millis_too_large": "Duration too large (max. 10000)!"
}
diff --git a/src/main/resources/fabric.mod.json b/src/main/resources/fabric.mod.json
index 084e444..77f1d34 100644
--- a/src/main/resources/fabric.mod.json
+++ b/src/main/resources/fabric.mod.json
@@ -1,7 +1,7 @@
{
"schemaVersion": 1,
"id": "logical_zoom",
- "version": "${version}",
+ "version": "${project.version}",
"name": "Logical Zoom",
"description": "A simple zoom",
@@ -12,6 +12,17 @@
"homepage": "https://logicalgeekboy.com",
"sources": "https://github.com/logicalgeekboy/logical_zoom"
},
+ "contributors": [
+ {
+ "name": "marcelbpunkt",
+ "contact": {
+ "homepage": "https://github.com/marcelbpunkt",
+ "sources": "https://github.com/marcelbpunkt/logical_zoom",
+ "issues": "https://github.com/marcelbpunkt/logical_zoom/issues",
+ "discord": "https://discordapp.com/users/marcelbpunkt#8899"
+ }
+ }
+ ],
"license": "MIT",
"icon": "assets/logical_zoom/icon.png",
@@ -20,6 +31,9 @@
"entrypoints": {
"client": [
"com.logicalgeekboy.logical_zoom.LogicalZoom"
+ ],
+ "modmenu": [
+ "com.logicalgeekboy.logical_zoom.config.ConfigScreen"
]
},
"mixins": [
@@ -30,11 +44,13 @@
],
"depends": {
- "fabricloader": ">=0.14.9",
- "fabric": "*",
- "minecraft": "1.19.2"
+ "fabricloader": ">=${project.loader_version}",
+ "fabric-api": "*",
+ "minecraft": ">=1.19 <1.20",
+ "cloth-config": ">=${project.cloth_config_version}"
},
"suggests": {
- "flamingo": "*"
+ "flamingo": "*",
+ "modmenu": ">=${project.modmenu_version}"
}
}