├── .gitattributes ├── src ├── main │ ├── resources │ │ ├── assets │ │ │ └── wi_zoom │ │ │ │ ├── lang │ │ │ │ ├── lzh.json │ │ │ │ ├── de_de.json │ │ │ │ ├── et_ee.json │ │ │ │ ├── fr_fr.json │ │ │ │ ├── ko_kr.json │ │ │ │ ├── zh_cn.json │ │ │ │ ├── zh_hk.json │ │ │ │ ├── zh_tw.json │ │ │ │ ├── ku_ku.json │ │ │ │ ├── nl_nl.json │ │ │ │ ├── pt_br.json │ │ │ │ ├── ru_ru.json │ │ │ │ ├── uk_ua.json │ │ │ │ ├── az_az.json │ │ │ │ ├── tr_tr.json │ │ │ │ └── en_us.json │ │ │ │ └── icon.png │ │ ├── intentionally_untranslated.json │ │ ├── wi-zoom.mixins.json │ │ ├── wi-zoom.accesswidener │ │ └── fabric.mod.json │ └── java │ │ └── net │ │ └── wimods │ │ └── zoom │ │ ├── mixin │ │ ├── GameRendererMixin.java │ │ └── MouseMixin.java │ │ ├── WiZoomInitializer.java │ │ └── WiZoom.java └── gametest │ ├── resources │ ├── assets │ │ └── minecraft │ │ │ └── textures │ │ │ └── misc │ │ │ └── vignette.png │ ├── zoom_testmod.mixins.json │ └── fabric.mod.json │ └── java │ └── net │ └── wimods │ └── zoom │ └── gametest │ ├── WiZoomTest.java │ └── WiModsTestHelper.java ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── .github ├── FUNDING.yml ├── dependabot.yml └── workflows │ ├── check_translations.yml │ ├── dependency_graph.yml │ ├── stale.yml │ ├── auto_snapshot_update.yml │ ├── dry_run_snapshot_update.yml │ ├── gradle.yml │ ├── multi_publish.yml │ └── publish.yml ├── settings.gradle ├── codestyle ├── license_header.txt ├── codetemplates.xml ├── cleanup.xml └── formatter.xml ├── .gitignore ├── gradle.properties ├── scripts └── update_version_constants.py ├── gradlew.bat ├── SECURITY.md ├── README.md ├── gradlew └── LICENSE.txt /.gitattributes: -------------------------------------------------------------------------------- 1 | # Disable LF normalization 2 | * -text 3 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/lzh.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "凝" 3 | } 4 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/de_de.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "Zoom" 3 | } 4 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/et_ee.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "Suum" 3 | } 4 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/fr_fr.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "Zoom" 3 | } 4 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/ko_kr.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "확대" 3 | } 4 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/zh_cn.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "缩放" 3 | } 4 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/zh_hk.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "縮放" 3 | } 4 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/zh_tw.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "縮放" 3 | } 4 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/ku_ku.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "Mezinkirin" 3 | } 4 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/nl_nl.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "Inzoomen" 3 | } 4 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/pt_br.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "Ampliação" 3 | } 4 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/ru_ru.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "Приблизить" 3 | } 4 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/uk_ua.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "Збільшити" 3 | } 4 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/az_az.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "Yaxınlaşdırma" 3 | } 4 | -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/tr_tr.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "Yakınlaştır" 3 | } 4 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Wurst-Imperium/WI-Zoom/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Wurst-Imperium/WI-Zoom/HEAD/src/main/resources/assets/wi_zoom/icon.png -------------------------------------------------------------------------------- /src/main/resources/assets/wi_zoom/lang/en_us.json: -------------------------------------------------------------------------------- 1 | { 2 | "key.wi_zoom.zoom": "Zoom", 3 | "key.category.wi_zoom.wi_zoom": "WI Zoom" 4 | } 5 | -------------------------------------------------------------------------------- /src/main/resources/intentionally_untranslated.json: -------------------------------------------------------------------------------- 1 | { 2 | "de_de": [ 3 | "key.wi_zoom.zoom" 4 | ], 5 | "fr_fr": [ 6 | "key.wi_zoom.zoom" 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /src/gametest/resources/assets/minecraft/textures/misc/vignette.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Wurst-Imperium/WI-Zoom/HEAD/src/gametest/resources/assets/minecraft/textures/misc/vignette.png -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | ko_fi: wurst 3 | custom: https://www.wurstclient.net/donate/?utm_source=GitHub&utm_medium=WI+Zoom&utm_campaign=FUNDING.yml 4 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | pluginManagement { 2 | repositories { 3 | maven { 4 | name = 'Fabric' 5 | url = 'https://maven.fabricmc.net/' 6 | } 7 | mavenCentral() 8 | gradlePluginPortal() 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.0-bin.zip 4 | networkTimeout=10000 5 | validateDistributionUrl=true 6 | zipStoreBase=GRADLE_USER_HOME 7 | zipStorePath=wrapper/dists 8 | -------------------------------------------------------------------------------- /codestyle/license_header.txt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2019-$YEAR Wurst-Imperium and contributors. 3 | * 4 | * This source code is subject to the terms of the GNU General Public 5 | * License, version 3. If a copy of the GPL was not distributed with this 6 | * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt 7 | */ 8 | -------------------------------------------------------------------------------- /src/gametest/resources/zoom_testmod.mixins.json: -------------------------------------------------------------------------------- 1 | { 2 | "required": true, 3 | "package": "net.wimods.zoom.gametest.mixin", 4 | "compatibilityLevel": "JAVA_21", 5 | "mixins": [], 6 | "client": [], 7 | "injectors": { 8 | "defaultRequire": 1 9 | }, 10 | "overwrites": { 11 | "requireAnnotations": true 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /src/main/resources/wi-zoom.mixins.json: -------------------------------------------------------------------------------- 1 | { 2 | "required": true, 3 | "package": "net.wimods.zoom.mixin", 4 | "compatibilityLevel": "JAVA_21", 5 | "mixins": [], 6 | "client": [ 7 | "GameRendererMixin", 8 | "MouseMixin" 9 | ], 10 | "injectors": { 11 | "defaultRequire": 1 12 | }, 13 | "overwrites": { 14 | "requireAnnotations": true 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /src/gametest/resources/fabric.mod.json: -------------------------------------------------------------------------------- 1 | { 2 | "schemaVersion": 1, 3 | "id": "zoom_testmod", 4 | "version": "1.0.0", 5 | "name": "WI Zoom Test Mod", 6 | "license": "GPL-3.0-or-later", 7 | "environment": "client", 8 | "entrypoints": { 9 | "fabric-client-gametest": [ 10 | "net.wimods.zoom.gametest.WiZoomTest" 11 | ] 12 | }, 13 | "mixins": [ 14 | "zoom_testmod.mixins.json" 15 | ] 16 | } 17 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # gradle 2 | 3 | .gradle/ 4 | build/ 5 | out/ 6 | classes/ 7 | logs/ 8 | 9 | # idea 10 | 11 | .idea/ 12 | *.iml 13 | *.ipr 14 | *.iws 15 | 16 | # vscode 17 | 18 | .settings/ 19 | .vscode/ 20 | bin/ 21 | .classpath 22 | .project 23 | 24 | # fabric 25 | 26 | run/ 27 | *.launch 28 | 29 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 30 | hs_err_pid* 31 | 32 | # python 33 | *.pyc 34 | 35 | desktop.ini 36 | 37 | # (neo)forge 38 | eclipse 39 | runs/ 40 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # Dependabot version updates, see: 2 | # https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file 3 | 4 | version: 2 5 | updates: 6 | - package-ecosystem: "gradle" 7 | directory: "/" 8 | schedule: 9 | interval: "daily" 10 | time: "06:00" 11 | timezone: "Europe/Berlin" 12 | - package-ecosystem: "github-actions" 13 | # Directory should be `/` instead of `/.github/workflows` according to the docs. 14 | directory: "/" 15 | schedule: 16 | interval: "daily" 17 | time: "06:00" 18 | timezone: "Europe/Berlin" 19 | -------------------------------------------------------------------------------- /codestyle/codetemplates.xml: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.github/workflows/check_translations.yml: -------------------------------------------------------------------------------- 1 | name: Check Translations 2 | 3 | on: 4 | push: 5 | branches-ignore: 6 | - "dependabot/**" 7 | tags-ignore: 8 | - "**" 9 | paths: 10 | - "src/main/resources/assets/wi_zoom/lang/**.json" 11 | - "src/main/resources/intentionally_untranslated.json" 12 | pull_request: 13 | paths: 14 | - "src/main/resources/assets/wi_zoom/lang/**.json" 15 | - "src/main/resources/intentionally_untranslated.json" 16 | workflow_dispatch: 17 | 18 | jobs: 19 | check_translations: 20 | runs-on: ubuntu-latest 21 | steps: 22 | 23 | - name: Checkout repository 24 | uses: actions/checkout@v6 25 | 26 | - name: Check translations 27 | uses: Wurst-Imperium/check-translations@v1 28 | with: 29 | lang-dir: "src/main/resources/assets/wi_zoom/lang" 30 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Done to increase the memory available to gradle. 2 | org.gradle.jvmargs=-Xmx2G 3 | org.gradle.parallel=true 4 | org.gradle.configuration-cache=true 5 | 6 | # Fabric Properties 7 | # check these at https://fabricmc.net/develop/ and 8 | # https://modrinth.com/mod/fabric-api/versions 9 | minecraft_version=1.21.11 10 | yarn_mappings=1.21.11-pre2+build.3 11 | loader_version=0.18.1 12 | loom_version=1.14-SNAPSHOT 13 | 14 | # Fabric API 15 | fabric_version=0.139.4+1.21.11 16 | 17 | # Mod Properties 18 | mod_version=1.7-MC1.21.11 19 | maven_group=net.wimods.zoom 20 | archives_base_name=WI-Zoom 21 | mod_loader=Fabric 22 | 23 | # CurseForge 24 | cf_project_id=349630 25 | cf_game_version=1.21.11-snapshot 26 | 27 | # Modrinth 28 | mr_project_id=o7DitHWP 29 | 30 | # GitHub 31 | gh_repo_id=Wurst-Imperium/WI-Zoom 32 | mcx_repo_id=Wurst-Imperium-MCX/WI-Zoom 33 | 34 | # Dependencies 35 | -------------------------------------------------------------------------------- /src/main/resources/wi-zoom.accesswidener: -------------------------------------------------------------------------------- 1 | accessWidener v1 named 2 | accessible class net/minecraft/client/gui/components/OptionsList$Entry 3 | accessible method net/minecraft/client/KeyboardHandler keyPress (JILnet/minecraft/client/input/KeyEvent;)V 4 | accessible method net/minecraft/client/MouseHandler onScroll (JDD)V 5 | accessible field net/minecraft/client/gui/screens/Screen renderables Ljava/util/List; 6 | accessible field net/minecraft/client/gui/screens/TitleScreen fading Z 7 | accessible field net/minecraft/client/gui/screens/options/controls/KeyBindsList$KeyEntry changeButton Lnet/minecraft/client/gui/components/Button; 8 | accessible field net/minecraft/client/gui/screens/options/controls/KeyBindsList$KeyEntry key Lnet/minecraft/client/KeyMapping; 9 | accessible field net/minecraft/client/gui/components/CycleButton name Lnet/minecraft/network/chat/Component; 10 | accessible field net/minecraft/client/gui/components/OptionsList$Entry children Ljava/util/List; 11 | -------------------------------------------------------------------------------- /src/main/java/net/wimods/zoom/mixin/GameRendererMixin.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2019-2025 Wurst-Imperium and contributors. 3 | * 4 | * This source code is subject to the terms of the GNU General Public 5 | * License, version 3. If a copy of the GPL was not distributed with this 6 | * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt 7 | */ 8 | package net.wimods.zoom.mixin; 9 | 10 | import org.spongepowered.asm.mixin.Mixin; 11 | import org.spongepowered.asm.mixin.injection.At; 12 | 13 | import com.llamalad7.mixinextras.injector.ModifyReturnValue; 14 | import net.minecraft.client.renderer.GameRenderer; 15 | import net.wimods.zoom.WiZoom; 16 | 17 | @Mixin(GameRenderer.class) 18 | public abstract class GameRendererMixin implements AutoCloseable 19 | { 20 | @ModifyReturnValue(at = @At("RETURN"), 21 | method = "getFov(Lnet/minecraft/client/Camera;FZ)F") 22 | private float onGetFov(float original) 23 | { 24 | return WiZoom.INSTANCE.changeFovBasedOnZoom(original); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /src/main/java/net/wimods/zoom/WiZoomInitializer.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2019-2025 Wurst-Imperium and contributors. 3 | * 4 | * This source code is subject to the terms of the GNU General Public 5 | * License, version 3. If a copy of the GPL was not distributed with this 6 | * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt 7 | */ 8 | package net.wimods.zoom; 9 | 10 | import net.fabricmc.api.ModInitializer; 11 | 12 | public final class WiZoomInitializer implements ModInitializer 13 | { 14 | private static boolean initialized; 15 | 16 | @Override 17 | public void onInitialize() 18 | { 19 | // This code runs as soon as Minecraft is in a mod-load-ready state. 20 | // However, some things (like resources) may still be uninitialized. 21 | // Proceed with mild caution. 22 | 23 | if(initialized) 24 | throw new RuntimeException( 25 | "WiZoomInitializer.onInitialize() ran twice!"); 26 | 27 | WiZoom.INSTANCE.initialize(); 28 | initialized = true; 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /.github/workflows/dependency_graph.yml: -------------------------------------------------------------------------------- 1 | name: Update Gradle Dependency Graph 2 | 3 | on: 4 | push: 5 | branches: 6 | # Submitting dependency graph reports on non-default branches does nothing 7 | - "master" 8 | tags-ignore: 9 | - "**" 10 | paths: 11 | - "gradle**" 12 | - "*.gradle" 13 | workflow_dispatch: 14 | 15 | permissions: 16 | # Needed by the dependency-submission action. 17 | contents: write 18 | 19 | jobs: 20 | dependency_graph: 21 | runs-on: ubuntu-latest 22 | steps: 23 | 24 | - name: Checkout repository 25 | uses: actions/checkout@v6 26 | 27 | - name: Set up Java 21 28 | uses: actions/setup-java@v5 29 | with: 30 | java-version: "21" 31 | distribution: "microsoft" 32 | 33 | - name: Grant execute permission for gradlew 34 | run: chmod +x gradlew 35 | 36 | - name: Generate and submit dependency graph 37 | uses: gradle/actions/dependency-submission@v5 38 | with: 39 | build-scan-publish: true 40 | build-scan-terms-of-use-url: "https://gradle.com/help/legal-terms-of-use" 41 | build-scan-terms-of-use-agree: "yes" 42 | cache-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }} 43 | -------------------------------------------------------------------------------- /src/main/java/net/wimods/zoom/mixin/MouseMixin.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2019-2025 Wurst-Imperium and contributors. 3 | * 4 | * This source code is subject to the terms of the GNU General Public 5 | * License, version 3. If a copy of the GPL was not distributed with this 6 | * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt 7 | */ 8 | package net.wimods.zoom.mixin; 9 | 10 | import org.spongepowered.asm.mixin.Mixin; 11 | import org.spongepowered.asm.mixin.injection.At; 12 | import org.spongepowered.asm.mixin.injection.Inject; 13 | import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; 14 | 15 | import com.llamalad7.mixinextras.injector.v2.WrapWithCondition; 16 | import net.minecraft.client.MouseHandler; 17 | import net.minecraft.world.entity.player.Inventory; 18 | import net.wimods.zoom.WiZoom; 19 | 20 | @Mixin(MouseHandler.class) 21 | public class MouseMixin 22 | { 23 | @Inject(at = @At("RETURN"), method = "onScroll(JDD)V") 24 | private void onOnMouseScroll(long window, double horizontal, 25 | double vertical, CallbackInfo ci) 26 | { 27 | WiZoom.INSTANCE.onMouseScroll(vertical); 28 | } 29 | 30 | @WrapWithCondition(at = @At(value = "INVOKE", 31 | target = "Lnet/minecraft/world/entity/player/Inventory;setSelectedSlot(I)V"), 32 | method = "onScroll(JDD)V") 33 | private boolean wrapOnMouseScroll(Inventory inventory, int slot) 34 | { 35 | return !WiZoom.INSTANCE.getZoomKey().isDown(); 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /scripts/update_version_constants.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | 3 | if __name__ == "__main__": 4 | parser = argparse.ArgumentParser() 5 | parser.add_argument("mc_version", help="Minecraft version") 6 | parser.add_argument("fabric_loader", help="Fabric Loader version") 7 | parser.add_argument("fapi_version", help="Fabric API version") 8 | parser.add_argument("cf_game_version", help="CurseForge GameVersion") 9 | args = parser.parse_args() 10 | 11 | # Read gradle.properties 12 | print("Updating gradle.properties...") 13 | with open("gradle.properties", "r") as f: 14 | lines = f.readlines() 15 | 16 | # Define replacements 17 | replacements = { 18 | "minecraft_version": lambda v: args.mc_version, 19 | "loader_version": lambda v: args.fabric_loader, 20 | "fabric_version": lambda v: args.fapi_version, 21 | "mod_version": lambda v: v[: v.index("MC") + 2] + args.mc_version, 22 | "cf_game_version": lambda v: args.cf_game_version, 23 | } 24 | 25 | # Update lines 26 | for i, line in enumerate(lines): 27 | if line.startswith("#"): 28 | continue 29 | parts = line.split("=") 30 | if len(parts) != 2: 31 | continue 32 | key = parts[0] 33 | if key.strip() not in replacements: 34 | continue 35 | old_value = parts[1] 36 | new_value = replacements[key.strip()](old_value) 37 | print(f"{key}={old_value} -> {new_value}") 38 | lines[i] = f"{key}={new_value}\n" 39 | 40 | # Save modified gradle.properties 41 | with open("gradle.properties", "w") as f: 42 | f.writelines(lines) 43 | print("gradle.properties updated.") 44 | -------------------------------------------------------------------------------- /src/main/resources/fabric.mod.json: -------------------------------------------------------------------------------- 1 | { 2 | "schemaVersion": 1, 3 | "id": "wi_zoom", 4 | "version": "${version}", 5 | "name": "WI Zoom", 6 | "description": "The zoom from the Wurst Client as a standalone mod.", 7 | "authors": [ 8 | "Alexander01998" 9 | ], 10 | "contact": { 11 | "homepage": "https://www.wimods.net/wi-zoom/?utm_source=WI+Zoom&utm_medium=ModMenu&utm_content=WI+Zoom+ModMenu+website+link", 12 | "sources": "https://github.com/Wurst-Imperium/WI-Zoom", 13 | "issues": "https://github.com/Wurst-Imperium/WI-Zoom/issues", 14 | "email": "contact.wurstimperium@gmail.com", 15 | "twitter": "https://twitter.com/Wurst_Imperium" 16 | }, 17 | "license": "GPL-3.0-or-later", 18 | "icon": "assets/wi_zoom/icon.png", 19 | "environment": "client", 20 | "entrypoints": { 21 | "main": [ 22 | "net.wimods.zoom.WiZoomInitializer" 23 | ] 24 | }, 25 | "mixins": [ 26 | "wi-zoom.mixins.json" 27 | ], 28 | "accessWidener": "wi-zoom.accesswidener", 29 | "depends": { 30 | "fabricloader": ">=0.17.3", 31 | "fabric-api": ">=0.135.1", 32 | "minecraft": "~1.21.11-alpha.25.41.a", 33 | "java": ">=21" 34 | }, 35 | "suggests": { 36 | "cameranoclip": "*", 37 | "chestesp": "*", 38 | "mo_glass": "*" 39 | }, 40 | "breaks": { 41 | "wurst": "*" 42 | }, 43 | "custom": { 44 | "modmenu": { 45 | "links": { 46 | "Donate": "https://www.wurstclient.net/donate/?utm_source=WI+Zoom&utm_medium=ModMenu&utm_content=WI+Zoom+ModMenu+donate+link" 47 | } 48 | } 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /.github/workflows/stale.yml: -------------------------------------------------------------------------------- 1 | name: Close stale issues and pull requests 2 | 3 | on: 4 | schedule: 5 | - cron: "30 1 * * 1-5" 6 | 7 | permissions: 8 | # Both needed by the stale action. 9 | issues: write 10 | pull-requests: write 11 | 12 | jobs: 13 | stale: 14 | runs-on: ubuntu-latest 15 | steps: 16 | 17 | - name: Run stale action 18 | uses: actions/stale@v10 19 | with: 20 | stale-issue-message: | 21 | This issue has been open for a while with no recent activity. If this issue is still important to you, please add a comment within the next 7 days to keep it open. Otherwise, the issue will be automatically closed to free up time for other tasks. 22 | 23 | Issues should be closed if: 24 | - They are duplicates of other issues 25 | - There is not enough demand 26 | - They are no longer relevant 27 | - There are not enough details 28 | stale-pr-message: | 29 | This pull request has been open for a while with no recent activity. If you're still working on this or waiting for a review, please add a comment or commit within the next 7 days to keep it open. Otherwise, the pull request will be automatically closed to free up time for other tasks. 30 | 31 | Pull requests should be closed if: 32 | - They have been superseded by another pull request 33 | - They are out of scope or don't align with the project 34 | - They have become obsolete due to other changes 35 | - They have bugs or conflicts that won't be resolved 36 | days-before-stale: 60 37 | days-before-close: 7 38 | exempt-issue-labels: "status:never-stale,status:confirmed" 39 | exempt-pr-labels: "status:never-stale,status:confirmed,status:merged" 40 | exempt-all-milestones: true 41 | stale-issue-label: "status:stale" 42 | stale-pr-label: "status:stale" 43 | operations-per-run: 30 44 | enable-statistics: true 45 | -------------------------------------------------------------------------------- /.github/workflows/auto_snapshot_update.yml: -------------------------------------------------------------------------------- 1 | # Experimental workflow to automate updating to a new Minecraft snapshot. 2 | name: Auto Snapshot Update 3 | 4 | on: 5 | workflow_dispatch: 6 | inputs: 7 | mc_version: 8 | description: "Minecraft version to update to" 9 | required: true 10 | yarn_mappings: 11 | description: "Yarn mappings version (no longer used)" 12 | required: false 13 | fabric_loader: 14 | description: "Fabric Loader version" 15 | required: true 16 | fapi_version: 17 | description: "Fabric API version" 18 | required: true 19 | cf_game_version: 20 | description: "CurseForge GameVersion" 21 | required: true 22 | distinct_id: 23 | required: false 24 | 25 | permissions: 26 | # To push changes to the snapshot branch. 27 | contents: write 28 | # To trigger the CI workflow. 29 | actions: write 30 | 31 | jobs: 32 | update: 33 | runs-on: ubuntu-latest 34 | steps: 35 | 36 | - name: Echo distinct ID ${{ inputs.distinct_id }} 37 | run: echo ${{ inputs.distinct_id }} 38 | 39 | - name: Checkout repository 40 | uses: actions/checkout@v6 41 | 42 | - name: Set up Python 3.12 43 | uses: actions/setup-python@v6 44 | with: 45 | python-version: "3.12" 46 | 47 | - name: Update version constants 48 | run: | 49 | python scripts/update_version_constants.py \ 50 | "${{ inputs.mc_version }}" \ 51 | "${{ inputs.fabric_loader }}" \ 52 | "${{ inputs.fapi_version }}" \ 53 | "${{ inputs.cf_game_version }}" 54 | 55 | - name: Commit and push changes 56 | run: | 57 | git config --global user.name "Wurst-Bot" 58 | git config --global user.email "contact.wurstimperium@gmail.com" 59 | git add . 60 | git commit -m "[Wurst-Bot] Update to ${{ inputs.mc_version }}" 61 | git push 62 | 63 | - name: Trigger CI 64 | uses: Wurst-Imperium/dispatch-and-wait@v1 65 | with: 66 | token: ${{ github.token }} 67 | owner: ${{ github.repository_owner }} 68 | repo: ${{ github.event.repository.name }} 69 | ref: ${{ github.ref }} 70 | workflow: gradle.yml 71 | run_timeout_seconds: 600 # 10 minutes 72 | -------------------------------------------------------------------------------- /.github/workflows/dry_run_snapshot_update.yml: -------------------------------------------------------------------------------- 1 | name: Test if old Fabric API works with new Snapshot 2 | 3 | on: 4 | workflow_dispatch: 5 | inputs: 6 | mc_version: 7 | description: "Minecraft version to test" 8 | required: true 9 | yarn_mappings: 10 | description: "Yarn mappings version (no longer used)" 11 | required: false 12 | fabric_loader: 13 | description: "Fabric Loader version" 14 | required: true 15 | fapi_version: 16 | description: "Fabric API version" 17 | required: true 18 | cf_game_version: 19 | description: "CurseForge GameVersion" 20 | required: true 21 | distinct_id: 22 | required: false 23 | 24 | jobs: 25 | test: 26 | runs-on: ubuntu-latest 27 | steps: 28 | 29 | - name: Echo distinct ID ${{ inputs.distinct_id }} 30 | run: echo ${{ inputs.distinct_id }} 31 | 32 | - name: Checkout repository 33 | uses: actions/checkout@v6 34 | 35 | - name: Set up Python 3.12 36 | uses: actions/setup-python@v6 37 | with: 38 | python-version: "3.12" 39 | 40 | - name: Set up Java 21 41 | uses: actions/setup-java@v5 42 | with: 43 | java-version: "21" 44 | distribution: "microsoft" 45 | 46 | - name: Grant execute permission for gradlew 47 | run: chmod +x gradlew 48 | 49 | - name: Setup Gradle 50 | uses: gradle/actions/setup-gradle@v5 51 | with: 52 | build-scan-publish: true 53 | build-scan-terms-of-use-url: "https://gradle.com/help/legal-terms-of-use" 54 | build-scan-terms-of-use-agree: "yes" 55 | cache-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }} 56 | cache-read-only: ${{ github.ref != 'refs/heads/master' && !startsWith(github.ref, 'refs/heads/1.') }} 57 | 58 | - name: Update version constants 59 | run: | 60 | python scripts/update_version_constants.py \ 61 | "${{ inputs.mc_version }}" \ 62 | "${{ inputs.fabric_loader }}" \ 63 | "${{ inputs.fapi_version }}" \ 64 | "${{ inputs.cf_game_version }}" 65 | 66 | - name: Run build 67 | run: ./gradlew build --stacktrace --warning-mode=fail 68 | 69 | - name: Run client gametests 70 | env: 71 | IMGUR_CLIENT_ID: ${{ secrets.IMGUR_CLIENT_ID }} 72 | run: ./gradlew runClientGameTest --stacktrace --warning-mode=fail 73 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | @rem SPDX-License-Identifier: Apache-2.0 17 | @rem 18 | 19 | @if "%DEBUG%"=="" @echo off 20 | @rem ########################################################################## 21 | @rem 22 | @rem Gradle startup script for Windows 23 | @rem 24 | @rem ########################################################################## 25 | 26 | @rem Set local scope for the variables with windows NT shell 27 | if "%OS%"=="Windows_NT" setlocal 28 | 29 | set DIRNAME=%~dp0 30 | if "%DIRNAME%"=="" set DIRNAME=. 31 | @rem This is normally unused 32 | set APP_BASE_NAME=%~n0 33 | set APP_HOME=%DIRNAME% 34 | 35 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 36 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 37 | 38 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 39 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 40 | 41 | @rem Find java.exe 42 | if defined JAVA_HOME goto findJavaFromJavaHome 43 | 44 | set JAVA_EXE=java.exe 45 | %JAVA_EXE% -version >NUL 2>&1 46 | if %ERRORLEVEL% equ 0 goto execute 47 | 48 | echo. 1>&2 49 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 50 | echo. 1>&2 51 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 52 | echo location of your Java installation. 1>&2 53 | 54 | goto fail 55 | 56 | :findJavaFromJavaHome 57 | set JAVA_HOME=%JAVA_HOME:"=% 58 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 59 | 60 | if exist "%JAVA_EXE%" goto execute 61 | 62 | echo. 1>&2 63 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 64 | echo. 1>&2 65 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 66 | echo location of your Java installation. 1>&2 67 | 68 | goto fail 69 | 70 | :execute 71 | @rem Setup the command line 72 | 73 | 74 | 75 | @rem Execute Gradle 76 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* 77 | 78 | :end 79 | @rem End local scope for the variables with windows NT shell 80 | if %ERRORLEVEL% equ 0 goto mainEnd 81 | 82 | :fail 83 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 84 | rem the _cmd.exe /c_ return code! 85 | set EXIT_CODE=%ERRORLEVEL% 86 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 87 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 88 | exit /b %EXIT_CODE% 89 | 90 | :mainEnd 91 | if "%OS%"=="Windows_NT" endlocal 92 | 93 | :omega 94 | -------------------------------------------------------------------------------- /src/main/java/net/wimods/zoom/WiZoom.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2019-2025 Wurst-Imperium and contributors. 3 | * 4 | * This source code is subject to the terms of the GNU General Public 5 | * License, version 3. If a copy of the GPL was not distributed with this 6 | * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt 7 | */ 8 | package net.wimods.zoom; 9 | 10 | import org.lwjgl.glfw.GLFW; 11 | import com.mojang.blaze3d.platform.InputConstants; 12 | import net.fabricmc.fabric.api.client.keybinding.v1.KeyBindingHelper; 13 | import net.fabricmc.loader.api.FabricLoader; 14 | import net.fabricmc.loader.api.ModContainer; 15 | import net.fabricmc.loader.api.Version; 16 | import net.minecraft.client.KeyMapping; 17 | import net.minecraft.client.KeyMapping.Category; 18 | import net.minecraft.client.Minecraft; 19 | import net.minecraft.client.OptionInstance; 20 | import net.minecraft.resources.Identifier; 21 | import net.minecraft.util.Mth; 22 | 23 | public enum WiZoom 24 | { 25 | INSTANCE; 26 | 27 | public static final Minecraft MC = Minecraft.getInstance(); 28 | 29 | private KeyMapping zoomKey; 30 | private final double defaultLevel = 3; 31 | private Double currentLevel; 32 | private Double defaultMouseSensitivity; 33 | 34 | public void initialize() 35 | { 36 | FabricLoader fabricLoader = FabricLoader.getInstance(); 37 | ModContainer modContainer = 38 | fabricLoader.getModContainer("wi_zoom").get(); 39 | Version version = modContainer.getMetadata().getVersion(); 40 | System.out.println("Starting WI Zoom v" + version.getFriendlyString()); 41 | 42 | Category zoomCategory = KeyMapping.Category 43 | .register(Identifier.fromNamespaceAndPath("wi_zoom", "wi_zoom")); 44 | zoomKey = new KeyMapping("key.wi_zoom.zoom", InputConstants.Type.KEYSYM, 45 | GLFW.GLFW_KEY_V, zoomCategory); 46 | KeyBindingHelper.registerKeyBinding(zoomKey); 47 | } 48 | 49 | public float changeFovBasedOnZoom(float fov) 50 | { 51 | OptionInstance mouseSensitivitySetting = 52 | MC.options.sensitivity(); 53 | 54 | if(currentLevel == null) 55 | currentLevel = defaultLevel; 56 | 57 | if(!zoomKey.isDown()) 58 | { 59 | currentLevel = defaultLevel; 60 | 61 | if(defaultMouseSensitivity != null) 62 | { 63 | mouseSensitivitySetting.set(defaultMouseSensitivity); 64 | defaultMouseSensitivity = null; 65 | } 66 | 67 | return fov; 68 | } 69 | 70 | if(defaultMouseSensitivity == null) 71 | defaultMouseSensitivity = mouseSensitivitySetting.get(); 72 | 73 | // Adjust mouse sensitivity in relation to zoom level. 74 | // 1.0 / currentLevel is a value between 0.02 (50x zoom) 75 | // and 1 (no zoom). 76 | mouseSensitivitySetting 77 | .set(defaultMouseSensitivity * (1.0 / currentLevel)); 78 | 79 | return (float)(fov / currentLevel); 80 | } 81 | 82 | public void onMouseScroll(double amount) 83 | { 84 | if(!zoomKey.isDown()) 85 | return; 86 | 87 | if(currentLevel == null) 88 | currentLevel = defaultLevel; 89 | 90 | if(amount > 0) 91 | currentLevel *= 1.1; 92 | else if(amount < 0) 93 | currentLevel *= 0.9; 94 | 95 | currentLevel = Mth.clamp(currentLevel, 1, 50); 96 | } 97 | 98 | public KeyMapping getZoomKey() 99 | { 100 | return zoomKey; 101 | } 102 | } 103 | -------------------------------------------------------------------------------- /.github/workflows/gradle.yml: -------------------------------------------------------------------------------- 1 | name: Java CI with Gradle 2 | 3 | on: 4 | push: 5 | branches-ignore: 6 | - "dependabot/**" 7 | tags-ignore: 8 | - "**" 9 | paths: 10 | - "**.java" 11 | - "**.json" 12 | - "**.yml" 13 | - "gradle**" 14 | - "*.gradle" 15 | - "*.accesswidener" 16 | pull_request: 17 | paths: 18 | - "**.java" 19 | - "**.json" 20 | - "**.yml" 21 | - "gradle**" 22 | - "*.gradle" 23 | - "*.accesswidener" 24 | workflow_dispatch: 25 | inputs: 26 | distinct_id: 27 | required: false 28 | 29 | jobs: 30 | build: 31 | runs-on: ubuntu-latest 32 | steps: 33 | 34 | - name: Echo distinct ID ${{ inputs.distinct_id }} 35 | run: echo ${{ inputs.distinct_id }} 36 | 37 | - name: Checkout repository 38 | uses: actions/checkout@v6 39 | 40 | - name: Set up Java 21 41 | uses: actions/setup-java@v5 42 | with: 43 | java-version: "21" 44 | distribution: "microsoft" 45 | 46 | - name: Grant execute permission for gradlew 47 | run: chmod +x gradlew 48 | 49 | - name: Setup Gradle 50 | uses: gradle/actions/setup-gradle@v5 51 | with: 52 | build-scan-publish: true 53 | build-scan-terms-of-use-url: "https://gradle.com/help/legal-terms-of-use" 54 | build-scan-terms-of-use-agree: "yes" 55 | cache-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }} 56 | cache-read-only: ${{ github.ref != 'refs/heads/master' && !startsWith(github.ref, 'refs/heads/1.') }} 57 | 58 | - name: Build 59 | run: ./gradlew build --stacktrace --warning-mode=fail 60 | 61 | - name: Upload to VirusTotal for analysis 62 | id: virustotal 63 | env: 64 | VIRUSTOTAL_API_KEY: ${{ secrets.VIRUSTOTAL_API_KEY }} 65 | if: ${{ env.VIRUSTOTAL_API_KEY }} 66 | uses: crazy-max/ghaction-virustotal@v4 67 | with: 68 | vt_api_key: ${{ env.VIRUSTOTAL_API_KEY }} 69 | files: | 70 | ./build/libs/*.jar 71 | # An error in this step means that the upload failed, not that a false 72 | # positive was detected. 73 | continue-on-error: true 74 | 75 | - name: Add VirusTotal links to build summary 76 | if: ${{ steps.virustotal.outputs.analysis }} 77 | run: | 78 | echo "
" >> $GITHUB_STEP_SUMMARY 79 | echo "🛡️ VirusTotal Scans" >> $GITHUB_STEP_SUMMARY 80 | echo "" >> $GITHUB_STEP_SUMMARY 81 | IFS=',' read -ra ANALYSIS <<< "${{ steps.virustotal.outputs.analysis }}" 82 | for i in "${ANALYSIS[@]}"; do 83 | filepath=${i%%=*} 84 | url=${i#*=} 85 | filename=$(basename "$filepath") 86 | echo "- [$filename]($url)" >> $GITHUB_STEP_SUMMARY 87 | done 88 | echo "
" >> $GITHUB_STEP_SUMMARY 89 | 90 | - name: Run client gametests 91 | env: 92 | IMGUR_CLIENT_ID: ${{ secrets.IMGUR_CLIENT_ID }} 93 | run: ./gradlew runClientGameTest --stacktrace --warning-mode=fail 94 | 95 | - name: Upload screenshots 96 | uses: actions/upload-artifact@v6 97 | if: ${{ success() || failure() }} 98 | with: 99 | name: screenshots 100 | path: build/run/*/screenshots 101 | compression-level: 0 102 | 103 | - name: Upload logs 104 | uses: actions/upload-artifact@v6 105 | if: ${{ success() || failure() }} 106 | with: 107 | name: logs 108 | path: build/run/*/logs/latest.log 109 | 110 | - name: Upload crash reports 111 | uses: actions/upload-artifact@v6 112 | if: ${{ failure() }} 113 | with: 114 | name: crash-reports 115 | path: build/run/*/crash-reports -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Supported Versions 4 | 5 | Generally, WI Zoom versions for the latest Minecraft release and for the latest Minecraft snapshot are supported. 6 | 7 | Older versions are decided on a case-by-case basis, depending on the severity of the exploit. 8 | 9 | ## Reporting a Vulnerability 10 | 11 | You can report a vulnerability by sending an email to contact.wurstimperium@gmail.com. 12 | 13 | If you want to encrypt your email with PGP (you don't have to), then you can find my public key below: 14 | 15 | ``` 16 | -----BEGIN PGP PUBLIC KEY BLOCK----- 17 | 18 | xsFNBGFfchsBEACOinHGKb+lkWdZvQ2sPmlgPEpUG3uWUUOd4+64zFANbbZN 19 | hw3lNbUty8TtXbjDIPSRU0mTZ51DxBRTnOVNCRvzDEPe0bR1iZ8URpzSVJZQ 20 | x9ER7b8d9HkMI78x+bx1lcjzyzoSGzoN0+3QuBJ8iMkqT5dgfpklQ33DDWh5 21 | 7h13dNNWDfg+UJXt3L04N3wfe78CRQnqmjp4d1blFv1q/LhKz7T6WWBjbk7r 22 | VjlOJUVA811nNA7wiwpykGjIE7k1QI2ExZLIAUhWMqtnrEsz0vgEhGRnUJDw 23 | q0jEz7Ano8SZPfOZeTmy/MC+h9VURCc39ULD5lhAj+t3cIIIsykXvB+YEfHH 24 | tDpeSnVT8oe5n7UlKhPRktDZ1xdviwixyY60Lg5IPU18l4ypibqkFNtoqf82 25 | 3afg2lLZ/sYmh5Wf4qbGewWkqiLbShE/KiFgobHnwP2KUhd7+uGFl+xFfwi9 26 | 5ZNzWvCnONYnctzQeEq+wAN64nSUkymFp7ohJufFaegAA37sFOrZ/FeQEXOL 27 | gMYMEZf7rEX1tuByNuaAgdT8TFkdhwkC/gmlqXIFZ7BlvyNMI3MOh0U8Skk0 28 | iL1PkYOWWVBg2eHGSnaFRz9JTaXFJxk7hpQc7ykXldjOg7Q3Zq61esLKFa+J 29 | zJF27JiBN9W0kmU4mpGsFDbQe3nJbOMlK0dFlQARAQABzTBBbGV4YW5kZXIw 30 | MTk5OCA8Y29udGFjdC53dXJzdGltcGVyaXVtQGdtYWlsLmNvbT7CwXUEEAEI 31 | AB8FAmFfchsGCwkHCAMCBBUICgIDFgIBAhkBAhsDAh4BAAoJEN1/LAg9eYnj 32 | X+UP/jmoBwCp+1V+LIYf8u06OPYaLfjtB3bOhU7NL+bNwdOJyGHWb23d8Ut7 33 | 6G59ZIj/gLGw6Kwyp1qG6h8/KEVpb5dQofSZwwLrldX689p1s/FeFfQH/pb3 34 | XeiNi1xXqmbgnEiJ86em1pWvQoEbcGElSR443513OmGqDUldMhnvUM7Zk5yd 35 | bYOYqW0g1naLequziiXwT/rqvy+lfp/N6+wgiQ7sdxIHpRFjgEu1z4XDDfvF 36 | X9Fy4V/57W+B7xPaJeB3bK94h//nAY1+yV32SZ3nkgqDgJerhdRkVatGWU6i 37 | 12Cyz2J0zQgqiQV158EODHjgZIAzeDVwk0imidrFg7gk0dsjxCwTmEX5TaEa 38 | 7F0gZ3cyYyIbOIRCUnlQ9VpkqW7ulCVks5zW8DiZiKsnhfYh/Ddz1SBnbcK3 39 | 4Hfi+GYQf+dDCRRAjgknyMNTzOjYe4pK7ZJFavSH1svwkyM2e2VxFExp+Z8x 40 | 4Lbq198JClwXjA4+VUp0xYNvJt4AHa2YpbwJr++uNZETWQkuQpcdO6cA2P54 41 | cztjsVRGmGklAFwoh+n7o4wkX32uWuCdN5Sp7TU2vFlGftBvXa2ssupcxuCk 42 | PVGx3VtCqNf2HbTzX47IPrRCiCmhodkFKDL2wlADOaxGuJli6mPxXRnqvhF8 43 | rYO9yoWr3z5Mp9Tx9lIKoyE/wr1WwsF7BBABCAAlBQJjAB44BQkHRYHFBgsJ 44 | BwgDAgQVCAoCAxYCAQIZAQIbAwIeAQAKCRDdfywIPXmJ46C3EACA3SvXuxp6 45 | 3jb3CZsm4HCn2Ao2+WgLMxGUvIoPScEaeUw5o+14O0uRfg2PunB/ADgioLBF 46 | bCwI6a23pSwNYlOvHjJmmA/f0qVhO2kCnOng0GappHFyL3l4mToNJu0z9ELe 47 | 4KikiTD3ce7K7WT8fYSeoVcQyRKcK4Zntr+K5+v9/qRDsYsV9fSqb/erUYPM 48 | ywTLAGB7cVnagAQjw9CcOnpFrQ6cWBMLWE3KpmIhQtB0SoXL9WYkvFtNJL7h 49 | UeAXPI0Ug1/DR2aHYBkUbus/Hq6A+BdBUMoD7eX/5dsiAgTI+WgvNxkfsgbH 50 | 2UztWK9tG3h7T1FeFgmkOj6EDHbOePoW0ZHONYcslKNcuAWtJ6EAFbZzvBeQ 51 | Bn/Y29ZNAJy1parU7WgAc8138kq6bJIXNVKoxya248B5kN0o+necU+cCVZls 52 | Uhc5zMp/98829FEOJ4BwUSTbVtulVUvozdX5P5kZOgemP0ITEG0y/0M+7rfL 53 | wo9HG2wCd0t3xwpbzCpVAWTbm88WIr0z2UwmchGkHhRZV4lCB3VZm+rkvM5N 54 | SM04KiqxfKYgLqQroA+RHjipGjdhlQgeY5Vgm+0Jyk1nhtSlhP9moO9G4GGf 55 | HiI3zwOyAC9MsX4idRtpHzRVIC7zGrSChd0sdorBJgdj4jpkGn+hsIghICD9 56 | eb+Yn7nmCpwmtMLBkAQQAQgARAWCZh/xggWJEKzUxQQLCQcICZDdfywIPXmJ 57 | 4wMVCAoEFgACAQIZAQKbAwIeARYhBOaMq35XTFkJLk6qy91/LAg9eYnjAABo 58 | bhAAgYUsby0c4u3cWT05y+6lgvWA17P1Ij5BFgUG+HSvT6VgdSx9XgYTjSEZ 59 | TiAn2ckpBM3KCfhaRlhvjR+prCIpeGNbbwMD2DfYNsEVm6lv5DuQGTknmWt1 60 | 6OUFfne4EKBlJb35Yqulu4i/8VIEISmCwOdA1pNmZhc0DNWuWtg1H0KkrWm1 61 | NOe4ydRlamXZFUtNGaxYFHXMYikkRIKr8xv6s0agTSwcrs+tHuw8w+BY4Man 62 | ZDKuW9x0FwBwaJDOodEMuvwjbSMZuXdnuteEm3/kKLsjdzrhZ8WZ68vITIQh 63 | 9FASkBklmstxbcqkBtXKZKnT04tJmwrNQ6wS9tVIqkFlnuaN0e8MZ3Ixe6kR 64 | GfPrgHASpzrDw3SmySZwbl6z5y/AnlaMNW76pkpMUDfsMmh4UmlZXBTlppf7 65 | kE19BzAtjc5WLzC/oX7quJZsaEylU8TzcVTTaL05DfLxDKZa8eZ/VdwPLtqa 66 | Z5YJM6Q7FPToC3R8/eYvlG4eYsHqWB0Tqnb3p9SRMLKdVPH4sI7SbJ3jYOR+ 67 | Xwjn+/tzHq+QN8HUWKPS2qY5z1IOxdIqnyUznzxFDKjJesIv+7lixZ+7daM5 68 | HhzhLHznrKSFk+/3P1IBA7LfpeOOP4HCa2ebN6buJ4NQCWsbzI14u9pMmb6q 69 | h5FBIa3BhDeK/D5mlG5iEliR0b7OwU0EYV9yGwEQAPCXe9lYKoiKYLgPgMvo 70 | AMtfqykIwyM/jG+u90Zekt8gm+sP/YrVuLwWT8Q8dH5KqZNK15YcyBQR3iUn 71 | O+VpXFZAvA2toTjMB/1XzB7um1V2MY2I2rzOOS14lVNjvieRuk6YvjPEeiCR 72 | rj/t8goe/gjsyiV9v6qtp7OEJ2DIiV33AYz2fJQHODWbY8IQqunCOxL3PNwX 73 | igiMw4wk8WG6DYVwW87HiPJD8RmTJgTG48knxjxeyEitI0MdfqGaDz6nAPN8 74 | W0gIuGu0TiXuQxZ8FtpEhDrz5RKpjn1i/5PoEePf3gaZhQFh7aQ9gvuMgOeM 75 | ObY7VxFPVLPQ7Y+vwYXVBtJrHw1S0i3VC9M5YsLIEFy9uIZFnVQpF3skul1r 76 | VKz5irqmHZEj2Jlfri/rWUAsUnHAgJoQeydLIHTIZnJwKWpqkF46lncHMIan 77 | +ouY4O84HBcvAGCmwXfiSeEOO4wkOm4OW7SnVD0D74MObEKVNOBYdftmIZ7H 78 | 4gLWd8LFyywyxMctoxqpHjWpMfRYR7u05B0MMbx4bdRWN3EA1mmNV/I/JEMe 79 | agG1HQqkLGHNnVmbux10Tpux0kOokyMDZ0OaxgRACeDeNkHMZLgOxqPJGlbl 80 | 3kX8KV09yVIRIsL/zeV8QPeQGQM4lcR3m2aE3RqJxNPoQR2eV9guBwjNnE4J 81 | 7FERABEBAAHCwXwEGAEIADAFgmYf8YIFiRCs1MUJkN1/LAg9eYnjApsMFiEE 82 | 5oyrfldMWQkuTqrL3X8sCD15ieMAAHaoD/9AtPpXEmmBdK5gNnf+N9c41cSm 83 | shKxmyYtf2HrDECVFstEbI7EWqOouoiuWkA8VajFBHAmCl6XAg2cOxoaWLds 84 | txeAHXl+4VQ4Hh07tE0jEHfwo/AryJ4P+lYCZSfcWKukSnNsf2BPBiSPHJr2 85 | w6b6xqCS354doX9agT3zyukWQvBQMqN4kTEieTCokgytkDssyKqmcLAv2Owj 86 | 8BrpZkASEGvARoBFtY5nd0MC8zgCHIoXiX6s9ld2cP+MCeskULSQsmR0X76X 87 | uFa42Z2a5qrmAr0KCP8RHnby6o1VvV5yOUAkskA9IqPKahLrsusP4owGac/Z 88 | pRI8/T/HsO9Prg9SMQ5IbPjfO5Cc1zaFhVKZYjBTSAptqngE7S48ch9IatU7 89 | zH4ifR3KeMru8XVMI7t0OT1eQLx9U41gCUOCvXnQCJbsdaw3ggt8GW3eBaJU 90 | fkzAMxAXaN1znBke63oDVuatz+XCuIiaWk9LA0k9gB/XGx43e6KfMnfc94Zx 91 | Kkub06h5q2nQpbgDNyjMxZ98G3128HKSRJZx2SfQFOAZo48W9S8yUfsrb0u4 92 | ikTh0kY7gbmgbAFu/HaxCG/amTctx8yFUcwmJchCLs+Bos1MkklXAPD5FELj 93 | uPuP631Zmcw4GdqstRazLV1+qnJWLUCx7sZ3goqe4rc8dC3s1Poyes7xpw== 94 | =8sQI 95 | -----END PGP PUBLIC KEY BLOCK----- 96 | ``` 97 | -------------------------------------------------------------------------------- /.github/workflows/multi_publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish Multiple Releases 2 | run-name: Publish v${{ inputs.mod_version }} build(s) from ${{ inputs.branches }} 3 | 4 | on: 5 | workflow_dispatch: 6 | inputs: 7 | mod_version: 8 | description: "Mod version (without v or -MC)" 9 | type: string 10 | required: true 11 | branches: 12 | description: "Space-separated list of branches to publish from" 13 | type: string 14 | required: true 15 | publish_curseforge: 16 | description: "Publish to CurseForge" 17 | type: boolean 18 | default: true 19 | publish_modrinth: 20 | description: "Publish to Modrinth" 21 | type: boolean 22 | default: true 23 | announce_update: 24 | description: "Announce as an update on WurstForum" 25 | type: boolean 26 | default: false 27 | announce_ports: 28 | description: "Announce as ports on WurstForum" 29 | type: boolean 30 | default: false 31 | dry_run: 32 | description: "Dry-run mode (don't actually publish anything)" 33 | type: boolean 34 | default: false 35 | 36 | permissions: 37 | # Needed to trigger the publish workflow. 38 | actions: write 39 | 40 | jobs: 41 | 42 | prepare: 43 | runs-on: ubuntu-latest 44 | outputs: 45 | branches: ${{ steps.set_branches.outputs.branches }} 46 | steps: 47 | - name: Convert branches input to JSON array 48 | id: set_branches 49 | run: | 50 | branches_array=(${{ inputs.branches }}) 51 | quoted_branches=$(printf '"%s",' "${branches_array[@]}") 52 | JSON_ARRAY="[${quoted_branches%,}]" 53 | echo "branches=$JSON_ARRAY" >> "$GITHUB_OUTPUT" 54 | echo "Branches: $JSON_ARRAY" >> "$GITHUB_STEP_SUMMARY" 55 | - name: Verify mod_version is as expected 56 | run: | 57 | expected_prefix="${{ inputs.mod_version }}-MC" 58 | for branch in ${{ inputs.branches }}; do 59 | url="https://raw.githubusercontent.com/${{ github.repository }}/${branch}/gradle.properties" 60 | actual=$(curl -sf "$url" | grep "^mod_version=" | cut -d'=' -f2) 61 | echo "$branch: $actual" 62 | [[ "$actual" == "$expected_prefix"* ]] || { echo "::error::Expected $expected_prefix*, got $actual"; exit 1; } 63 | done 64 | 65 | publish_each: 66 | runs-on: ubuntu-latest 67 | needs: prepare 68 | if: ${{ !fromJson(inputs.dry_run) }} 69 | strategy: 70 | # Each job pushes an automated commit to wimods.net@master, so running them all in parallel 71 | # would likely cause conflicts. Also, various servers might hit rate limits if we just upload 72 | # all of the files at once. 73 | max-parallel: 1 74 | # If something goes wrong, all published files have to be manually deleted. 75 | # Best to fail as early as possible. 76 | fail-fast: true 77 | matrix: 78 | branch: ${{ fromJson(needs.prepare.outputs.branches) }} 79 | steps: 80 | - name: Trigger publish workflow 81 | uses: Wurst-Imperium/dispatch-and-wait@v1 82 | with: 83 | token: ${{ github.token }} 84 | owner: ${{ github.repository_owner }} 85 | repo: ${{ github.event.repository.name }} 86 | ref: ${{ matrix.branch }} 87 | workflow: publish.yml 88 | workflow_inputs: | 89 | { 90 | "close_milestone": "true", 91 | "upload_backups": "true", 92 | "publish_github": "true", 93 | "publish_curseforge": "${{ inputs.publish_curseforge }}", 94 | "publish_modrinth": "${{ inputs.publish_modrinth }}", 95 | "update_website": "true" 96 | } 97 | run_timeout_seconds: 1800 # 30 minutes 98 | 99 | announce_update: 100 | runs-on: ubuntu-latest 101 | needs: [prepare, publish_each] 102 | if: ${{ !failure() && !cancelled() && inputs.announce_update }} 103 | steps: 104 | - name: Trigger announce workflow 105 | uses: Wurst-Imperium/dispatch-and-wait@v1 106 | with: 107 | token: ${{ secrets.WIMODS_NET_PUBLISH_TOKEN }} 108 | owner: Wurst-Imperium 109 | repo: wimods.net 110 | ref: master 111 | workflow: announce_mod_update.yml 112 | workflow_inputs: | 113 | { 114 | "mod": "wi-zoom", 115 | "mod_version": "${{ inputs.mod_version }}", 116 | "dry_run": "${{ inputs.dry_run }}" 117 | } 118 | run_timeout_seconds: 600 # 10 minutes 119 | 120 | announce_ports: 121 | runs-on: ubuntu-latest 122 | needs: [prepare, publish_each] 123 | if: ${{ !failure() && !cancelled() && inputs.announce_ports }} 124 | steps: 125 | - name: Trigger announce workflow 126 | uses: Wurst-Imperium/dispatch-and-wait@v1 127 | with: 128 | token: ${{ secrets.WIMODS_NET_PUBLISH_TOKEN }} 129 | owner: Wurst-Imperium 130 | repo: wimods.net 131 | ref: master 132 | workflow: announce_mod_ports.yml 133 | workflow_inputs: | 134 | { 135 | "mod": "wi-zoom", 136 | "mod_version": "${{ inputs.mod_version }}", 137 | "branches": "${{ inputs.branches }}", 138 | "dry_run": "${{ inputs.dry_run }}" 139 | } 140 | run_timeout_seconds: 600 # 10 minutes 141 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish Release 2 | run-name: "Publish release from ${{ github.ref_name }} branch" 3 | 4 | on: 5 | workflow_dispatch: 6 | inputs: 7 | close_milestone: 8 | description: "Close milestone" 9 | type: boolean 10 | default: true 11 | upload_backups: 12 | description: "Upload to backups server" 13 | type: boolean 14 | default: true 15 | publish_github: 16 | description: "Publish to GitHub" 17 | type: boolean 18 | default: true 19 | publish_curseforge: 20 | description: "Publish to CurseForge" 21 | type: boolean 22 | default: true 23 | publish_modrinth: 24 | description: "Publish to Modrinth" 25 | type: boolean 26 | default: true 27 | update_website: 28 | description: "Update wimods.net post (only works if there already is one)" 29 | type: boolean 30 | default: false 31 | distinct_id: 32 | type: string 33 | required: false 34 | 35 | permissions: 36 | # Needed to push the tag. 37 | contents: write 38 | # Needed to close the milestone. 39 | issues: write 40 | 41 | jobs: 42 | publish: 43 | runs-on: ubuntu-latest 44 | steps: 45 | 46 | - name: Echo distinct ID ${{ inputs.distinct_id }} 47 | run: echo ${{ inputs.distinct_id }} 48 | 49 | - name: Checkout repository 50 | uses: actions/checkout@v6 51 | with: 52 | # Include all tags in case the new tag already exists. 53 | fetch-tags: true 54 | 55 | - name: Set up Java 21 56 | uses: actions/setup-java@v5 57 | with: 58 | java-version: "21" 59 | distribution: "microsoft" 60 | 61 | - name: Grant execute permission for gradlew 62 | run: chmod +x gradlew 63 | 64 | - name: Setup Gradle 65 | uses: gradle/actions/setup-gradle@v5 66 | with: 67 | build-scan-publish: true 68 | build-scan-terms-of-use-url: "https://gradle.com/help/legal-terms-of-use" 69 | build-scan-terms-of-use-agree: "yes" 70 | cache-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }} 71 | cache-read-only: ${{ github.ref != 'refs/heads/master' && !startsWith(github.ref, 'refs/heads/1.') }} 72 | 73 | - name: Build 74 | run: ./gradlew build --stacktrace --warning-mode=fail 75 | 76 | - name: Create and push tag 77 | if: ${{ github.ref_type != 'tag' }} 78 | run: | 79 | MOD_VERSION=$(grep "^mod_version=" gradle.properties | cut -d'=' -f2 | tr -d ' \r') 80 | git config --global user.name "Wurst-Bot" 81 | git config --global user.email "contact.wurstimperium@gmail.com" 82 | git tag "v$MOD_VERSION" 83 | git push origin "v$MOD_VERSION" 84 | 85 | - name: Close milestone 86 | if: ${{ inputs.close_milestone }} 87 | env: 88 | GITHUB_TOKEN: ${{ github.token }} 89 | run: ./gradlew closeMilestone --stacktrace --no-configuration-cache 90 | 91 | - name: Build website update inputs 92 | id: website_inputs 93 | if: ${{ inputs.update_website }} 94 | run: | 95 | echo "mod_version=$(grep '^mod_version=' gradle.properties | cut -d'=' -f2 | tr -d ' \r' | sed 's/-MC.*$//')" >> "$GITHUB_OUTPUT" 96 | echo "mc_version=$(grep '^minecraft_version=' gradle.properties | cut -d'=' -f2 | tr -d ' \r')" >> "$GITHUB_OUTPUT" 97 | echo "fapi_version=$(grep '^fabric_version=' gradle.properties | cut -d'=' -f2 | tr -d ' \r')" >> "$GITHUB_OUTPUT" 98 | 99 | - name: Upload backups 100 | if: ${{ inputs.upload_backups }} 101 | uses: Wurst-Imperium/upload-backups@v1 102 | with: 103 | api_key: ${{ secrets.WI_BACKUPS_API_KEY }} 104 | project: WI-Zoom 105 | version: ${{ steps.website_inputs.outputs.mod_version }} 106 | path: build/libs/*.jar 107 | 108 | - name: Publish to GitHub 109 | if: ${{ inputs.publish_github }} 110 | env: 111 | GITHUB_TOKEN: ${{ secrets.MCX_PUBLISH_TOKEN }} 112 | run: ./gradlew github --stacktrace --no-configuration-cache 113 | 114 | - name: Publish to CurseForge 115 | if: ${{ inputs.publish_curseforge }} 116 | env: 117 | CURSEFORGE_API_KEY: ${{ secrets.CURSEFORGE_API_KEY }} 118 | run: ./gradlew publishCurseforge --stacktrace --no-configuration-cache 119 | 120 | - name: Get CurseForge file ID 121 | id: cf_file_id 122 | if: ${{ inputs.publish_curseforge }} 123 | run: | 124 | file_id=$(./gradlew getCurseforgeId -x publishCurseforge --no-configuration-cache --warning-mode none | grep -o 'CURSEFORGE_FILE_ID=[0-9]*' | grep -o '[0-9]*') 125 | echo "file_id=$file_id" >> "$GITHUB_OUTPUT" 126 | echo "CurseForge file ID: \`$file_id\`" >> $GITHUB_STEP_SUMMARY 127 | 128 | - name: Publish to Modrinth 129 | if: ${{ inputs.publish_modrinth }} 130 | env: 131 | MODRINTH_TOKEN: ${{ secrets.MODRINTH_TOKEN }} 132 | run: ./gradlew publishModrinth --stacktrace --no-configuration-cache 133 | 134 | - name: Trigger website update 135 | if: ${{ inputs.update_website }} 136 | uses: Wurst-Imperium/dispatch-and-wait@v1 137 | with: 138 | token: ${{ secrets.WIMODS_NET_PUBLISH_TOKEN }} 139 | owner: Wurst-Imperium 140 | repo: wimods.net 141 | ref: master 142 | workflow: add_mod_port.yml 143 | workflow_inputs: | 144 | { 145 | "mod": "wi-zoom", 146 | "modloader": "fabric", 147 | "mod_version": "${{ steps.website_inputs.outputs.mod_version }}", 148 | "mc_version": "${{ steps.website_inputs.outputs.mc_version }}", 149 | "fapi_version": "${{ steps.website_inputs.outputs.fapi_version }}", 150 | "file_id": "${{ steps.cf_file_id.outputs.file_id }}", 151 | "modrinth": "${{ inputs.publish_modrinth }}" 152 | } 153 | run_timeout_seconds: 600 # 10 minutes 154 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # WI Zoom (Wurst-Imperium Zoom) 2 | 3 | WI Zoom is the zoom from the [Wurst Client](https://go.wimods.net/from/github.com/Wurst-Imperium/WI-Zoom?to=https://www.wurstclient.net/) as a standalone Minecraft mod, letting you zoom in and out with the mouse wheel and providing up to 50x magnification without the need for a spyglass. This mod is fully compatible with OptiFine and Sodium, but unlike OptiFine's zoom, WI Zoom lets the camera move in a logical way, without making it wobble around. WI Zoom supports all of the latest Minecraft versions, including snapshots. 4 | 5 | ![comparison of no zoom, 3x zoom, and 50x zoom](https://img.wimods.net/github.com/Wurst-Imperium/WI-Zoom?to=https://user-images.githubusercontent.com/10100202/67816432-973d2400-fab2-11e9-8699-e05eb5ba6551.jpg) 6 | 7 | ## Downloads 8 | 9 | [![Download WI Zoom](https://user-images.githubusercontent.com/10100202/214881367-956f0bc9-4dbe-43cb-850a-04d73e00b344.png)](https://go.wimods.net/from/github.com/Wurst-Imperium/WI-Zoom?to=https://www.wimods.net/wi-zoom/download/?utm_source=GitHub&utm_medium=WI+Zoom&utm_campaign=README.md&utm_content=WI+Zoom+GitHub+repo+download+button) 10 | 11 | ## Installation 12 | 13 | > [!IMPORTANT] 14 | > Always make sure that your modloader and all of your mods are made for the same Minecraft version. Your game will crash if you mix different versions. 15 | 16 | ### Installation using Fabric 17 | 18 | 1. Install [Fabric Loader](https://go.wimods.net/from/github.com/Wurst-Imperium/WI-Zoom?to=https://fabricmc.net/use/installer/). 19 | 2. Add [Fabric API](https://go.wimods.net/from/github.com/Wurst-Imperium/WI-Zoom?to=https://modrinth.com/mod/fabric-api) to your mods folder. 20 | 3. Add WI Zoom to your mods folder. 21 | 22 | ### Installation using NeoForge 23 | 24 | 1. Install [NeoForge](https://go.wimods.net/from/github.com/Wurst-Imperium/WI-Zoom?to=https://neoforged.net/). 25 | 2. Add WI Zoom to your mods folder. 26 | 27 | ## Features 28 | 29 | - Up to 50x zoom! 30 | - No spyglass needed! 31 | - Zoom in and out with the mouse wheel! 32 | - No wobbly camera nonsense! 33 | - Dynamic mouse sensitivity! (since v1.1) 34 | - Fully compatible with OptiFine / Sodium! 35 | 36 | ## How to zoom 37 | 38 | Hold down the V key to activate the zoom (this keybind can be changed). 39 | While zooming, you can use the mouse wheel to zoom in further. 40 | 41 | ## Changing the zoom keybind 42 | 43 |
44 | How to change the keybind (click to expand) 45 | 46 | In the pause menu, click on "Options...". 47 | 48 | ![screenshot of the Game Menu with the Options button highlighted](https://user-images.githubusercontent.com/10100202/67876632-e0d45000-fb40-11e9-88a5-6d5d22cdb33a.png) 49 | 50 | In the Options menu, click on "Controls...". 51 | 52 | ![screenshot of the Options menu with the Controls button highlighted](https://user-images.githubusercontent.com/10100202/67876634-e0d45000-fb40-11e9-8e81-ef677755e1c3.png) 53 | 54 | In the Controls menu, scroll down to the "WI Zoom" section. If you don't have any other mods installed, you will find this section at the very bottom. 55 | 56 | ![screenshot of the Controls menu with the WI Zoom keybind highlighted at the bottom](https://user-images.githubusercontent.com/10100202/67876636-e16ce680-fb40-11e9-8934-ad65580dc91a.png) 57 |
58 | 59 | ## Supported languages 60 | 61 | - Azerbaijani (Azerbaijan) (since v1.5) 62 | - Chinese (Simplified/Mainland) (since v1.4) 63 | - Chinese (Traditional/Taiwan) (since v1.4) 64 | - Cantonese (Hong Kong) (since v1.4) 65 | - Classical Chinese (since v1.4) 66 | - Dutch (Netherlands) (since v1.5) 67 | - English (US) 68 | - Estonian (Estonia) (since v1.4) 69 | - French (France) (since v1.4) 70 | - German (Germany) 71 | - Kurdish (since v1.5) 72 | - Portuguese (Brazil) (since v1.5) 73 | - Russian (Russia) (since v1.3) 74 | - Turkish (Turkey) (since v1.5) 75 | - Ukrainian (Ukraine) (since v1.5) 76 | 77 | ## Development Setup 78 | 79 | > [!IMPORTANT] 80 | > Make sure you have [Java Development Kit 21](https://go.wimods.net/from/github.com/Wurst-Imperium/WI-Zoom?to=https://adoptium.net/?variant=openjdk21&jvmVariant=hotspot) installed. It won't work with other versions. 81 | 82 | ### Development using Eclipse 83 | 84 | 1. Clone the repository: 85 | 86 | ```pwsh 87 | git clone https://github.com/Wurst-Imperium/WI-Zoom.git 88 | cd WI-Zoom 89 | ``` 90 | 91 | 2. Generate the sources: 92 | 93 | In Fabric versions: 94 | ```pwsh 95 | ./gradlew genSources eclipse 96 | ``` 97 | 98 | In NeoForge versions: 99 | ```pwsh 100 | ./gradlew eclipse 101 | ``` 102 | 103 | 3. In Eclipse, go to `Import...` > `Existing Projects into Workspace` and select this project. 104 | 105 | 4. **Optional:** Right-click on the project and select `Properties` > `Java Code Style`. Then under `Clean Up`, `Code Templates`, `Formatter`, import the respective files in the `codestyle` folder. 106 | 107 | ### Development using VSCode / Cursor 108 | 109 | > [!TIP] 110 | > You'll probably want to install the [Extension Pack for Java](https://go.wimods.net/from/github.com/Wurst-Imperium/WI-Zoom?to=https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack) to make development easier. 111 | 112 | 1. Clone the repository: 113 | 114 | ```pwsh 115 | git clone https://github.com/Wurst-Imperium/WI-Zoom.git 116 | cd WI-Zoom 117 | ``` 118 | 119 | 2. Generate the sources: 120 | 121 | In Fabric versions: 122 | ```pwsh 123 | ./gradlew genSources vscode 124 | ``` 125 | 126 | In NeoForge versions: 127 | ```pwsh 128 | ./gradlew eclipse 129 | ``` 130 | (That's not a typo. NeoForge doesn't have `vscode`, but `eclipse` works fine.) 131 | 132 | 3. Open the `WI-Zoom` folder in VSCode / Cursor. 133 | 134 | 4. **Optional:** In the VSCode settings, set `java.format.settings.url` to `https://raw.githubusercontent.com/Wurst-Imperium/WI-Zoom/master/codestyle/formatter.xml` and `java.format.settings.profile` to `Wurst-Imperium`. 135 | 136 | ### Development using IntelliJ IDEA 137 | 138 | I don't use or recommend IntelliJ, but the commands to run would be: 139 | 140 | ```pwsh 141 | git clone https://github.com/Wurst-Imperium/WI-Zoom.git 142 | cd WI-Zoom 143 | ./gradlew genSources idea --no-configuration-cache 144 | ``` 145 | 146 | **Note:** IntelliJ IDEA is [not yet compatible](https://github.com/FabricMC/fabric-loom/issues/1349) with Gradle's configuration cache. You will run into issues. 147 | 148 | Possible workarounds: 149 | - Turn off args files ([this setting](https://i.imgur.com/zHqIOYg.png)). Won't work for some users because of a command length limit. 150 | - Add `--no-configuration-cache` to all of your Gradle commands. 151 | -------------------------------------------------------------------------------- /src/gametest/java/net/wimods/zoom/gametest/WiZoomTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2019-2025 Wurst-Imperium and contributors. 3 | * 4 | * This source code is subject to the terms of the GNU General Public 5 | * License, version 3. If a copy of the GPL was not distributed with this 6 | * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt 7 | */ 8 | package net.wimods.zoom.gametest; 9 | 10 | import static net.wimods.zoom.gametest.WiModsTestHelper.*; 11 | 12 | import java.util.List; 13 | 14 | import org.lwjgl.glfw.GLFW; 15 | import org.slf4j.Logger; 16 | import org.slf4j.LoggerFactory; 17 | import org.spongepowered.asm.mixin.MixinEnvironment; 18 | 19 | import net.fabricmc.fabric.api.client.gametest.v1.FabricClientGameTest; 20 | import net.fabricmc.fabric.api.client.gametest.v1.TestInput; 21 | import net.fabricmc.fabric.api.client.gametest.v1.context.ClientGameTestContext; 22 | import net.fabricmc.fabric.api.client.gametest.v1.context.TestClientWorldContext; 23 | import net.fabricmc.fabric.api.client.gametest.v1.context.TestServerContext; 24 | import net.fabricmc.fabric.api.client.gametest.v1.context.TestSingleplayerContext; 25 | import net.fabricmc.fabric.api.client.gametest.v1.world.TestWorldBuilder; 26 | import net.fabricmc.fabric.impl.client.gametest.TestSystemProperties; 27 | import net.minecraft.SharedConstants; 28 | import net.minecraft.client.gui.screens.worldselection.WorldCreationUiState; 29 | import net.minecraft.util.Mth; 30 | import net.minecraft.world.level.block.Blocks; 31 | import net.minecraft.world.level.gamerules.GameRules; 32 | import net.minecraft.world.level.levelgen.FlatLevelSource; 33 | import net.minecraft.world.level.levelgen.flat.FlatLayerInfo; 34 | import net.minecraft.world.level.levelgen.flat.FlatLevelGeneratorSettings; 35 | 36 | public final class WiZoomTest implements FabricClientGameTest 37 | { 38 | public static final Logger LOGGER = LoggerFactory.getLogger("WI Zoom Test"); 39 | 40 | @Override 41 | public void runTest(ClientGameTestContext context) 42 | { 43 | if(!TestSystemProperties.DISABLE_NETWORK_SYNCHRONIZER) 44 | throw new RuntimeException("Network synchronizer is not disabled"); 45 | 46 | LOGGER.info("Starting WI Zoom Client GameTest"); 47 | hideSplashTexts(context); 48 | waitForTitleScreenFade(context); 49 | 50 | LOGGER.info("Reached title screen"); 51 | context.takeScreenshot("title_screen"); 52 | 53 | LOGGER.info("Creating test world"); 54 | TestWorldBuilder worldBuilder = context.worldBuilder(); 55 | worldBuilder.adjustSettings(creator -> { 56 | String mcVersion = SharedConstants.getCurrentVersion().name(); 57 | creator.setName("E2E Test " + mcVersion); 58 | creator.setGameMode(WorldCreationUiState.SelectedGameMode.CREATIVE); 59 | creator.getGameRules().set(GameRules.SEND_COMMAND_FEEDBACK, false, 60 | null); 61 | applyFlatPresetWithSmoothStone(creator); 62 | }); 63 | 64 | try(TestSingleplayerContext spContext = worldBuilder.create()) 65 | { 66 | testInWorld(context, spContext); 67 | LOGGER.info("Exiting test world"); 68 | } 69 | 70 | LOGGER.info("Test complete"); 71 | } 72 | 73 | private void testInWorld(ClientGameTestContext context, 74 | TestSingleplayerContext spContext) 75 | { 76 | TestInput input = context.getInput(); 77 | TestClientWorldContext world = spContext.getClientWorld(); 78 | TestServerContext server = spContext.getServer(); 79 | 80 | // Disable anisotropic filtering 81 | context.runOnClient(mc -> mc.options.maxAnisotropyBit().set(0)); 82 | 83 | // Disable chunk fade 84 | context.runOnClient(mc -> mc.options.chunkSectionFadeInTime().set(0.0)); 85 | 86 | runCommand(server, "time set noon"); 87 | runCommand(server, "tp 0 -57 0"); 88 | runCommand(server, "fill ~ ~-3 ~ ~ ~-1 ~ smooth_stone"); 89 | runCommand(server, "fill ~-12 ~-3 ~10 ~12 ~9 ~10 smooth_stone"); 90 | 91 | LOGGER.info("Loading chunks"); 92 | context.waitTicks(2); 93 | world.waitForChunksRender(); 94 | 95 | assertScreenshotEquals(context, "in_game", 96 | "https://i.imgur.com/i2Nr9is.png"); 97 | 98 | LOGGER.info("Recording debug menu"); 99 | input.pressKey(GLFW.GLFW_KEY_F3); 100 | context.takeScreenshot("debug_menu"); 101 | input.pressKey(GLFW.GLFW_KEY_F3); 102 | 103 | LOGGER.info("Checking for broken mixins"); 104 | MixinEnvironment.getCurrentEnvironment().audit(); 105 | 106 | LOGGER.info("Opening inventory"); 107 | input.pressKey(GLFW.GLFW_KEY_E); 108 | String invTemplate = "https://i.imgur.com/GP74ZNS.png"; 109 | assertScreenshotEquals(context, "inventory", invTemplate); 110 | // Try to zoom in inventory to confirm it does nothing 111 | input.holdKey(GLFW.GLFW_KEY_V); 112 | context.waitTick(); 113 | assertScreenshotEquals(context, "trying_to_zoom_in_inventory", 114 | invTemplate); 115 | input.releaseKey(GLFW.GLFW_KEY_V); 116 | context.waitTick(); 117 | input.pressKey(GLFW.GLFW_KEY_ESCAPE); 118 | 119 | testZoomInWorld(context); 120 | 121 | LOGGER.info("Opening game menu"); 122 | input.pressKey(GLFW.GLFW_KEY_ESCAPE); 123 | context.takeScreenshot("game_menu"); 124 | 125 | LOGGER.info("Clicking Options button"); 126 | for(int i = 0; i < 6; i++) 127 | input.pressKey(GLFW.GLFW_KEY_TAB); 128 | input.pressKey(GLFW.GLFW_KEY_ENTER); 129 | context.takeScreenshot("options_screen"); 130 | 131 | LOGGER.info("Clicking Controls button"); 132 | for(int i = 0; i < 6; i++) 133 | input.pressKey(GLFW.GLFW_KEY_TAB); 134 | input.pressKey(GLFW.GLFW_KEY_ENTER); 135 | context.takeScreenshot("controls_screen"); 136 | 137 | LOGGER.info("Clicking Key Binds button"); 138 | input.pressKey(GLFW.GLFW_KEY_TAB); 139 | input.pressKey(GLFW.GLFW_KEY_ENTER); 140 | // Select the last keybind in the list 141 | for(int i = 0; i < 2; i++) 142 | pressKeyWithModifiers(context, GLFW.GLFW_KEY_TAB, 143 | GLFW.GLFW_MOD_SHIFT); 144 | assertScreenshotEquals(context, "zoom_keybind_default", 145 | "https://i.imgur.com/y7Uk7E0.png"); 146 | 147 | LOGGER.info("Changing zoom keybind to B"); 148 | input.pressKey(GLFW.GLFW_KEY_ENTER); 149 | input.pressKey(GLFW.GLFW_KEY_B); 150 | assertScreenshotEquals(context, "zoom_keybind_changed", 151 | "https://i.imgur.com/pjri9O8.png"); 152 | 153 | LOGGER.info("Closing screens"); 154 | for(int i = 0; i < 4; i++) 155 | input.pressKey(GLFW.GLFW_KEY_ESCAPE); 156 | 157 | testZoomWithChangedKeybind(context); 158 | } 159 | 160 | private void testZoomInWorld(ClientGameTestContext context) 161 | { 162 | TestInput input = context.getInput(); 163 | 164 | // Press V to enable zoom 165 | input.holdKey(GLFW.GLFW_KEY_V); 166 | context.waitTick(); 167 | assertScreenshotEquals(context, "3x_zoom", 168 | "https://i.imgur.com/Xy0VdFE.png"); 169 | 170 | scrollUpToMaxZoom(context); 171 | assertScreenshotEquals(context, "50x_zoom", 172 | "https://i.imgur.com/DF5Tr8F.png"); 173 | assertSelectedSlotIsZero(context); 174 | 175 | // Release V to disable zoom 176 | input.releaseKey(GLFW.GLFW_KEY_V); 177 | context.waitTick(); 178 | } 179 | 180 | private void testZoomWithChangedKeybind(ClientGameTestContext context) 181 | { 182 | TestInput input = context.getInput(); 183 | 184 | input.holdKey(GLFW.GLFW_KEY_B); 185 | context.waitTick(); 186 | assertScreenshotEquals(context, "custom_keybind_3x_zoom", 187 | "https://i.imgur.com/Xy0VdFE.png"); 188 | 189 | scrollUpToMaxZoom(context); 190 | assertScreenshotEquals(context, "custom_keybind_50x_zoom", 191 | "https://i.imgur.com/DF5Tr8F.png"); 192 | assertSelectedSlotIsZero(context); 193 | 194 | input.releaseKey(GLFW.GLFW_KEY_B); 195 | context.waitTick(); 196 | } 197 | 198 | private void scrollUpToMaxZoom(ClientGameTestContext context) 199 | { 200 | TestInput input = context.getInput(); 201 | int scrollsNeededFor50x = Mth.ceil(Math.log(50 / 3) / Math.log(1.1)); 202 | for(int i = 0; i < scrollsNeededFor50x; i++) 203 | input.scroll(0, 1); 204 | context.waitTick(); 205 | } 206 | 207 | private void assertSelectedSlotIsZero(ClientGameTestContext context) 208 | { 209 | if(context.computeOnClient( 210 | mc -> mc.player.getInventory().getSelectedSlot()) != 0) 211 | throw new RuntimeException( 212 | "Scrolling up while zooming changed the selected slot"); 213 | } 214 | 215 | // because the grass texture is randomized and smooth stone isn't 216 | private void applyFlatPresetWithSmoothStone(WorldCreationUiState creator) 217 | { 218 | FlatLevelGeneratorSettings config = ((FlatLevelSource)creator 219 | .getSettings().selectedDimensions().overworld()).settings(); 220 | 221 | List layers = 222 | List.of(new FlatLayerInfo(1, Blocks.BEDROCK), 223 | new FlatLayerInfo(2, Blocks.DIRT), 224 | new FlatLayerInfo(1, Blocks.SMOOTH_STONE)); 225 | 226 | creator.updateDimensions( 227 | (drm, dorHolder) -> dorHolder.replaceOverworldGenerator(drm, 228 | new FlatLevelSource(config.withBiomeAndLayers(layers, 229 | config.structureOverrides(), config.getBiome())))); 230 | } 231 | } 232 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | # SPDX-License-Identifier: Apache-2.0 19 | # 20 | 21 | ############################################################################## 22 | # 23 | # Gradle start up script for POSIX generated by Gradle. 24 | # 25 | # Important for running: 26 | # 27 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 28 | # noncompliant, but you have some other compliant shell such as ksh or 29 | # bash, then to run this script, type that shell name before the whole 30 | # command line, like: 31 | # 32 | # ksh Gradle 33 | # 34 | # Busybox and similar reduced shells will NOT work, because this script 35 | # requires all of these POSIX shell features: 36 | # * functions; 37 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 38 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 39 | # * compound commands having a testable exit status, especially «case»; 40 | # * various built-in commands including «command», «set», and «ulimit». 41 | # 42 | # Important for patching: 43 | # 44 | # (2) This script targets any POSIX shell, so it avoids extensions provided 45 | # by Bash, Ksh, etc; in particular arrays are avoided. 46 | # 47 | # The "traditional" practice of packing multiple parameters into a 48 | # space-separated string is a well documented source of bugs and security 49 | # problems, so this is (mostly) avoided, by progressively accumulating 50 | # options in "$@", and eventually passing that to Java. 51 | # 52 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 53 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 54 | # see the in-line comments for details. 55 | # 56 | # There are tweaks for specific operating systems such as AIX, CygWin, 57 | # Darwin, MinGW, and NonStop. 58 | # 59 | # (3) This script is generated from the Groovy template 60 | # https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 61 | # within the Gradle project. 62 | # 63 | # You can find Gradle at https://github.com/gradle/gradle/. 64 | # 65 | ############################################################################## 66 | 67 | # Attempt to set APP_HOME 68 | 69 | # Resolve links: $0 may be a link 70 | app_path=$0 71 | 72 | # Need this for daisy-chained symlinks. 73 | while 74 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 75 | [ -h "$app_path" ] 76 | do 77 | ls=$( ls -ld "$app_path" ) 78 | link=${ls#*' -> '} 79 | case $link in #( 80 | /*) app_path=$link ;; #( 81 | *) app_path=$APP_HOME$link ;; 82 | esac 83 | done 84 | 85 | # This is normally unused 86 | # shellcheck disable=SC2034 87 | APP_BASE_NAME=${0##*/} 88 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 89 | APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | 118 | 119 | # Determine the Java command to use to start the JVM. 120 | if [ -n "$JAVA_HOME" ] ; then 121 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 122 | # IBM's JDK on AIX uses strange locations for the executables 123 | JAVACMD=$JAVA_HOME/jre/sh/java 124 | else 125 | JAVACMD=$JAVA_HOME/bin/java 126 | fi 127 | if [ ! -x "$JAVACMD" ] ; then 128 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 129 | 130 | Please set the JAVA_HOME variable in your environment to match the 131 | location of your Java installation." 132 | fi 133 | else 134 | JAVACMD=java 135 | if ! command -v java >/dev/null 2>&1 136 | then 137 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 138 | 139 | Please set the JAVA_HOME variable in your environment to match the 140 | location of your Java installation." 141 | fi 142 | fi 143 | 144 | # Increase the maximum file descriptors if we can. 145 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 146 | case $MAX_FD in #( 147 | max*) 148 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 149 | # shellcheck disable=SC2039,SC3045 150 | MAX_FD=$( ulimit -H -n ) || 151 | warn "Could not query maximum file descriptor limit" 152 | esac 153 | case $MAX_FD in #( 154 | '' | soft) :;; #( 155 | *) 156 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 157 | # shellcheck disable=SC2039,SC3045 158 | ulimit -n "$MAX_FD" || 159 | warn "Could not set maximum file descriptor limit to $MAX_FD" 160 | esac 161 | fi 162 | 163 | # Collect all arguments for the java command, stacking in reverse order: 164 | # * args from the command line 165 | # * the main class name 166 | # * -classpath 167 | # * -D...appname settings 168 | # * --module-path (only if needed) 169 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 170 | 171 | # For Cygwin or MSYS, switch paths to Windows format before running java 172 | if "$cygwin" || "$msys" ; then 173 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 174 | 175 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 176 | 177 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 178 | for arg do 179 | if 180 | case $arg in #( 181 | -*) false ;; # don't mess with options #( 182 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 183 | [ -e "$t" ] ;; #( 184 | *) false ;; 185 | esac 186 | then 187 | arg=$( cygpath --path --ignore --mixed "$arg" ) 188 | fi 189 | # Roll the args list around exactly as many times as the number of 190 | # args, so each arg winds up back in the position where it started, but 191 | # possibly modified. 192 | # 193 | # NB: a `for` loop captures its iteration list before it begins, so 194 | # changing the positional parameters here affects neither the number of 195 | # iterations, nor the values presented in `arg`. 196 | shift # remove old arg 197 | set -- "$@" "$arg" # push replacement arg 198 | done 199 | fi 200 | 201 | 202 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 203 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 204 | 205 | # Collect all arguments for the java command: 206 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 207 | # and any embedded shellness will be escaped. 208 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 209 | # treated as '${Hostname}' itself on the command line. 210 | 211 | set -- \ 212 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 213 | -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ 214 | "$@" 215 | 216 | # Stop when "xargs" is not available. 217 | if ! command -v xargs >/dev/null 2>&1 218 | then 219 | die "xargs is not available" 220 | fi 221 | 222 | # Use "xargs" to parse quoted args. 223 | # 224 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 225 | # 226 | # In Bash we could simply go: 227 | # 228 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 229 | # set -- "${ARGS[@]}" "$@" 230 | # 231 | # but POSIX shell has neither arrays nor command substitution, so instead we 232 | # post-process each arg (as a line of input to sed) to backslash-escape any 233 | # character that might be a shell metacharacter, then use eval to reverse 234 | # that process (while maintaining the separation between arguments), and wrap 235 | # the whole thing up as a single "set" statement. 236 | # 237 | # This will of course break if any of these variables contains a newline or 238 | # an unmatched quote. 239 | # 240 | 241 | eval "set -- $( 242 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 243 | xargs -n1 | 244 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 245 | tr '\n' ' ' 246 | )" '"$@"' 247 | 248 | exec "$JAVACMD" "$@" 249 | -------------------------------------------------------------------------------- /codestyle/cleanup.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | -------------------------------------------------------------------------------- /src/gametest/java/net/wimods/zoom/gametest/WiModsTestHelper.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2019-2025 Wurst-Imperium and contributors. 3 | * 4 | * This source code is subject to the terms of the GNU General Public 5 | * License, version 3. If a copy of the GPL was not distributed with this 6 | * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt 7 | */ 8 | package net.wimods.zoom.gametest; 9 | 10 | import java.io.IOException; 11 | import java.io.InputStream; 12 | import java.net.URI; 13 | import java.net.http.HttpClient; 14 | import java.net.http.HttpRequest; 15 | import java.net.http.HttpResponse; 16 | import java.nio.file.Files; 17 | import java.nio.file.Path; 18 | import java.nio.file.Paths; 19 | import java.nio.file.StandardOpenOption; 20 | import java.util.Base64; 21 | import java.util.UUID; 22 | 23 | import org.joml.Vector2i; 24 | import org.lwjgl.glfw.GLFW; 25 | import org.lwjgl.system.MemoryUtil; 26 | import com.mojang.blaze3d.platform.InputConstants; 27 | import com.mojang.blaze3d.platform.InputConstants.Key; 28 | import com.mojang.blaze3d.platform.NativeImage; 29 | import com.mojang.brigadier.ParseResults; 30 | import com.mojang.brigadier.exceptions.CommandSyntaxException; 31 | 32 | import net.fabricmc.fabric.api.client.gametest.v1.context.ClientGameTestContext; 33 | import net.fabricmc.fabric.api.client.gametest.v1.context.TestServerContext; 34 | import net.fabricmc.fabric.api.client.gametest.v1.screenshot.TestScreenshotComparisonAlgorithm; 35 | import net.fabricmc.fabric.api.client.gametest.v1.screenshot.TestScreenshotComparisonAlgorithm.RawImage; 36 | import net.fabricmc.fabric.impl.client.gametest.screenshot.TestScreenshotComparisonAlgorithms.RawImageImpl; 37 | import net.fabricmc.fabric.impl.client.gametest.threading.ThreadingImpl; 38 | import net.fabricmc.fabric.mixin.client.gametest.input.KeyboardHandlerAccessor; 39 | import net.minecraft.client.gui.screens.TitleScreen; 40 | import net.minecraft.client.input.KeyEvent; 41 | import net.minecraft.commands.CommandSourceStack; 42 | 43 | public enum WiModsTestHelper 44 | { 45 | ; 46 | 47 | /** 48 | * Takes a screenshot, matches it against the template image, and throws if 49 | * it doesn't match. This method allows the template image to have 50 | * an alpha channel and ignores any pixels that are >50% transparent. This 51 | * way, you can precisely control which parts of the screenshot to assert 52 | * against the template and which parts to ignore. 53 | */ 54 | public static void assertScreenshotEquals(ClientGameTestContext context, 55 | String fileName, String templateUrl) 56 | { 57 | ThreadingImpl.checkOnGametestThread("assertScreenshotEquals"); 58 | 59 | NativeImage nativeTemplateImage = downloadImage(templateUrl); 60 | boolean[][] mask = alphaChannelToMask(nativeTemplateImage); 61 | RawImage rawTemplateImage = 62 | RawImageImpl.fromColorNativeImage(nativeTemplateImage); 63 | RawImage maskedTemplateImage = applyMask(rawTemplateImage, mask); 64 | 65 | Path screenshotPath = context.takeScreenshot(fileName); 66 | RawImage rawScreenshotImage = 67 | RawImageImpl.fromColorNativeImage(loadImageFile(screenshotPath)); 68 | RawImage maskedScreenshotImage = 69 | applyMask(rawScreenshotImage, mask); 70 | 71 | if(maskedScreenshotImage.width() != maskedTemplateImage.width() 72 | || maskedScreenshotImage.height() != maskedTemplateImage.height()) 73 | throw new AssertionError( 74 | "Screenshot and template dimensions do not match"); 75 | 76 | TestScreenshotComparisonAlgorithm algo = 77 | TestScreenshotComparisonAlgorithm.meanSquaredDifference(3e-4F); 78 | 79 | Vector2i result = 80 | algo.findColor(maskedScreenshotImage, maskedTemplateImage); 81 | if(result != null) 82 | return; 83 | 84 | ghSummary("### Screenshot " + fileName + " does not match template"); 85 | ghSummary("Expected:"); 86 | ghSummary("![" + fileName + "_template](" + templateUrl + ")"); 87 | ghSummary("Actual:"); 88 | String url = tryUploadToImgur(screenshotPath); 89 | if(url != null) 90 | ghSummary("![" + fileName + "](" + url + ")"); 91 | else 92 | ghSummary("Couldn't upload " + fileName 93 | + ".png to Imgur. Check the Test Screenshots.zip artifact."); 94 | 95 | throw new AssertionError("Screenshot '" + fileName 96 | + "' does not match template '" + templateUrl + "'"); 97 | } 98 | 99 | private static boolean[][] alphaChannelToMask(NativeImage template) 100 | { 101 | if(!template.format().hasAlpha()) 102 | { 103 | int width = template.getWidth(); 104 | int height = template.getHeight(); 105 | boolean[][] mask = new boolean[width][height]; 106 | for(int y = 0; y < height; y++) 107 | for(int x = 0; x < width; x++) 108 | mask[x][y] = false; 109 | return mask; 110 | } 111 | 112 | int width = template.getWidth(); 113 | int height = template.getHeight(); 114 | boolean[][] mask = new boolean[width][height]; 115 | 116 | int size = width * height; 117 | int alphaOffset = template.format().alphaOffset() / 8; 118 | int channelCount = template.format().components(); 119 | 120 | for(int i = 0; i < size; i++) 121 | { 122 | int x = i % width; 123 | int y = i / width; 124 | int alpha = MemoryUtil.memGetByte( 125 | template.getPointer() + i * channelCount + alphaOffset) & 0xff; 126 | mask[x][y] = alpha > 127; 127 | } 128 | 129 | return mask; 130 | } 131 | 132 | private static RawImage applyMask(RawImage image, 133 | boolean[][] mask) 134 | { 135 | int width = image.width(); 136 | int height = image.height(); 137 | int[] inData = image.data(); 138 | int[] outData = new int[width * height]; 139 | 140 | for(int y = 0; y < height; y++) 141 | for(int x = 0; x < width; x++) 142 | outData[y * width + x] = mask[x][y] ? inData[y * width + x] : 0; 143 | 144 | return new RawImageImpl<>(width, height, outData); 145 | } 146 | 147 | public static NativeImage loadImageFile(Path path) 148 | { 149 | try(InputStream inputStream = Files.newInputStream(path)) 150 | { 151 | return NativeImage.read(inputStream); 152 | 153 | }catch(IOException e) 154 | { 155 | throw new RuntimeException(e); 156 | } 157 | } 158 | 159 | public static NativeImage downloadImage(String url) 160 | { 161 | try(InputStream inputStream = URI.create(url).toURL().openStream()) 162 | { 163 | return NativeImage.read(inputStream); 164 | 165 | }catch(IOException e) 166 | { 167 | throw new RuntimeException(e); 168 | } 169 | } 170 | 171 | public static void hideSplashTexts(ClientGameTestContext context) 172 | { 173 | context.runOnClient(mc -> { 174 | mc.options.hideSplashTexts().set(true); 175 | }); 176 | } 177 | 178 | /** 179 | * Waits for the fading animation of the title screen to finish, or fails 180 | * after 10 seconds. 181 | */ 182 | public static void waitForTitleScreenFade(ClientGameTestContext context) 183 | { 184 | context.waitFor(mc -> { 185 | if(!(mc.screen instanceof TitleScreen titleScreen)) 186 | return false; 187 | 188 | return !titleScreen.fading; 189 | }); 190 | } 191 | 192 | public static void runCommand(TestServerContext server, String command) 193 | { 194 | String commandWithPlayer = "execute as @p at @s run " + command; 195 | server.runOnServer(mc -> { 196 | ParseResults results = 197 | mc.getCommands().getDispatcher().parse(commandWithPlayer, 198 | mc.createCommandSourceStack()); 199 | 200 | if(!results.getExceptions().isEmpty()) 201 | { 202 | StringBuilder errors = 203 | new StringBuilder("Invalid command: /" + commandWithPlayer); 204 | for(CommandSyntaxException e : results.getExceptions().values()) 205 | errors.append("\n").append(e.getMessage()); 206 | 207 | throw new RuntimeException(errors.toString()); 208 | } 209 | 210 | mc.getCommands().performCommand(results, commandWithPlayer); 211 | }); 212 | } 213 | 214 | public static void ghSummary(String s) 215 | { 216 | String summaryPath = System.getenv("GITHUB_STEP_SUMMARY"); 217 | System.out.println(s); 218 | if(summaryPath == null) 219 | return; 220 | 221 | try 222 | { 223 | Files.write(Paths.get(summaryPath), (s + "\n").getBytes(), 224 | StandardOpenOption.APPEND); 225 | 226 | }catch(IOException e) 227 | { 228 | System.err.println("Couldn't write to GitHub step summary"); 229 | e.printStackTrace(); 230 | } 231 | } 232 | 233 | public static String tryUploadToImgur(Path imagePath) 234 | { 235 | String imgurClientId = System.getenv("IMGUR_CLIENT_ID"); 236 | if(imgurClientId == null) 237 | return null; 238 | 239 | try 240 | { 241 | HttpClient client = HttpClient.newHttpClient(); 242 | 243 | String boundary = UUID.randomUUID().toString(); 244 | byte[] imageBytes = Files.readAllBytes(imagePath); 245 | String imageBase64 = Base64.getEncoder().encodeToString(imageBytes); 246 | 247 | String data = "--" + boundary + "\r\n" 248 | + "Content-Disposition: form-data; name=\"image\"\r\n\r\n" 249 | + imageBase64 + "\r\n" + "--" + boundary + "--\r\n"; 250 | 251 | HttpRequest request = HttpRequest.newBuilder() 252 | .uri(URI.create("https://api.imgur.com/3/image")) 253 | .header("Authorization", "Client-ID " + imgurClientId) 254 | .header("Content-Type", 255 | "multipart/form-data; boundary=" + boundary) 256 | .POST(HttpRequest.BodyPublishers.ofString(data)).build(); 257 | 258 | HttpResponse response = 259 | client.send(request, HttpResponse.BodyHandlers.ofString()); 260 | 261 | if(response.statusCode() == 200) 262 | { 263 | String body = response.body(); 264 | int linkStart = body.indexOf("\"link\":\"") + 8; 265 | int linkEnd = body.indexOf("\"", linkStart); 266 | return body.substring(linkStart, linkEnd); 267 | } 268 | 269 | return null; 270 | 271 | }catch(IOException | InterruptedException e) 272 | { 273 | e.printStackTrace(); 274 | return null; 275 | } 276 | } 277 | 278 | public static void pressKeyWithModifiers(ClientGameTestContext context, 279 | int keyCode, int modifiers) 280 | { 281 | Key key = InputConstants.Type.KEYSYM.getOrCreate(keyCode); 282 | context.runOnClient(mc -> { 283 | KeyboardHandlerAccessor kb = 284 | (KeyboardHandlerAccessor)mc.keyboardHandler; 285 | long handle = mc.getWindow().handle(); 286 | kb.invokeOnKey(handle, GLFW.GLFW_PRESS, 287 | new KeyEvent(key.getValue(), 0, modifiers)); 288 | kb.invokeOnKey(handle, GLFW.GLFW_RELEASE, 289 | new KeyEvent(key.getValue(), 0, modifiers)); 290 | }); 291 | } 292 | } 293 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /codestyle/formatter.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | 187 | 188 | 189 | 190 | 191 | 192 | 193 | 194 | 195 | 196 | 197 | 198 | 199 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | 212 | 213 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | 221 | 222 | 223 | 224 | 225 | 226 | 227 | 228 | 229 | 230 | 231 | 232 | 233 | 234 | 235 | 236 | 237 | 238 | 239 | 240 | 241 | 242 | 243 | 244 | 245 | 246 | 247 | 248 | 249 | 250 | 251 | 252 | 253 | 254 | 255 | 256 | 257 | 258 | 259 | 260 | 261 | 262 | 263 | 264 | 265 | 266 | 267 | 268 | 269 | 270 | 271 | 272 | 273 | 274 | 275 | 276 | 277 | 278 | 279 | 280 | 281 | 282 | 283 | 284 | 285 | 286 | 287 | 288 | 289 | 290 | 291 | 292 | 293 | 294 | 295 | 296 | 297 | 298 | 299 | 300 | 301 | 302 | 303 | 304 | 305 | 306 | 307 | 308 | 309 | 310 | 311 | 312 | 313 | 314 | 315 | 316 | 317 | 318 | 319 | 320 | 321 | 322 | 323 | 324 | 325 | 326 | 327 | 328 | 329 | 330 | 331 | 332 | 333 | 334 | 335 | 336 | 337 | 338 | 339 | 340 | 341 | 342 | 343 | 344 | 345 | 346 | 347 | 348 | 349 | 350 | 351 | 352 | 353 | 354 | 355 | 356 | 357 | 358 | 359 | 360 | 361 | 362 | 363 | 364 | 365 | 366 | 367 | 368 | 369 | 370 | 371 | 372 | 373 | 374 | 375 | 376 | 377 | 378 | 379 | 380 | 381 | 382 | 383 | 384 | 385 | 386 | 387 | 388 | 389 | 390 | 391 | 392 | 393 | 394 | 395 | 396 | 397 | 398 | 399 | 400 | 401 | 402 | --------------------------------------------------------------------------------