Merge remote-tracking branch 'upstream'

Author: cev-api

.github/workflows/multi_publish.yml

@@ -59,13 +59,7 @@ jobs:
     needs: prepare
     if: ${{ !fromJson(inputs.dry_run) }}
     strategy:
-      # Each job pushes an automated commit to WurstClient.net@master, so running them all in parallel
-      # would likely cause conflicts. Also, various servers might hit rate limits if we just upload
-      # all of the files at once.
-      max-parallel: 1
-      # If something goes wrong, all published files have to be manually deleted.
-      # Best to fail as early as possible.
-      fail-fast: true
+      fail-fast: false
       matrix:
         branch: ${{ fromJson(needs.prepare.outputs.branches) }}
     steps:

CONTRIBUTING.md

@@ -1,55 +1,57 @@
-# Contributing Guidelines
-Thank you for considering to contribute! Here are some guidelines to help you get started. ![](https://img.wimods.net/github.com/Wurst-Imperium/Wurst7/CONTRIBUTING.md)
+# Contributing to Wurst
+
+This guide exists to save both sides time. ![](https://img.wimods.net/github.com/Wurst-Imperium/Wurst7/CONTRIBUTING.md)
+
+## Priorities
+
+1. **Maintainers first:** architecture, gametests, release workflows, review burden.
+2. **Users second:** features, bugfixes, compatibility, documentation.
+3. **Sponsors third:** advertising, donation perks, monetization.
+
+Happy maintainers ensure happy users, happy users ensure happy sponsors. In that order.
+
+## Issues
+
+- **Search before posting:** Both GitHub issues and [WurstForum](https://wurstforum.net/) might have a post about your bug or feature request already. Find and read that first. Remember that posting duplicates makes it harder for the next person to find the original with all the answers.
+
+- **State the bug or request clearly:** For requests, explain what it is, how it works, and why it matters. For bugs, include repro steps. "idk it's weird sometimes" is not actionable.
+
+- **Include the crash report file:** If the game is crashing and/or it's unclear which versions you're using, I _need_ that file to diagnose the issue. No crash? Hold down <kbd>F3</kbd> + <kbd>C</kbd> for 10 seconds to force one.
+  - Windows: `%APPDATA%/.minecraft/crash-reports/crash-<timestamp>-client.txt`
+  - Linux: `~/.minecraft/crash-reports/crash-<timestamp>-client.txt`
+  - macOS: `~/Library/Application Support/minecraft/crash-reports/crash-<timestamp>-client.txt`
+
+- **If you want to implement the change yourself, say so.**
 
 ## Pull Requests
 
-### 1. Keep Pull Requests Small and Focused
-- **1 PR = 1 change**: Each pull request should address a single issue or add a single feature.
-- **Avoid Bloat**: Aim to keep the diff small and digestible. Don't stuff PRs with unrelated changes.
-
-### 2. Respect the Project's Scope and Vision
-- **Communicate Before Coding**: Open an issue to discuss any major changes before you start working on them. This can save you a lot of time and effort in case your idea is rejected. When in doubt, ask first.
-- **Avoid Breaking Changes**: When modifying existing features, it's usually better to make your changes optional. Your version may work better for you, but other people will often have different use cases that rely on the original behavior.
-
-### 3. Ensure Quality and Completeness
-- **Finish the Code**: Submit a PR only when it's complete, tested, and ready for review. Don't use pull requests as a dumping ground for half-baked prototypes.
-- If you need early feedback on a larger change, clearly mark the PR as a draft. You should have already started a discussion and gotten the go-ahead for your idea at this point.
-- **Watch the Checks**: Make sure that all automated checks are passing and that there aren't any merge conflicts. Fix such issues before asking for a review.
-
-### 4. Follow the Code Style
-- Run Eclipse's Clean Up and Format tools with the settings from the [codestyle folder](codestyle).
-- If you don't use Eclipse, you can run `./gradlew spotlessApply` instead. However, be aware that this isn't as thorough as Eclipse's tools.
-- For anything that these automated tools don't cover, please try to match the existing code style as closely as possible.
-
-## Other Ways To Help
-
-- fixing a typo
-  - in the Wurst Client itself (look for the pen icon at the top right)
-  - on WurstClient.net (scroll all the way down and click "edit this page")
-  - on the Wurst Wiki (login and click "Edit this page")
-- improving an existing bug report
-  - figuring out which Minecraft versions are affected by the bug
-  - Can you figure out how to make the bug happen every time? If so, please let me know.
-    - The ["could not reproduce"](https://github.com/Wurst-Imperium/Wurst7/labels/could%20not%20reproduce) label lists bug reports where I haven't been able to figure this out.
-- reporting a new dupe/exploit in Minecraft that could be added to Wurst
-- helping with a feature request
-  - Can you explain how the feature works?
-  - Can you add the feature in a Pull Request?
-  - Do you know anything else about the feature that hasn't been mentioned?
-- helping with the [Wurst Wiki](https://wurst.wiki/)
-  - translating Wurst Wiki articles to another language
-  - adding screenshots of features where appropriate
-  - making sure that changes from recent Wurst updates are documented
-  - digging through old Wurst updates to find out when exactly a feature was added
-- helping people who can't figure out how to install Wurst
-- making tutorials / how-to videos
-  - how to make [AutoBuild templates](https://wurst.wiki/autobuild#creating_templates)
-  - how to use the [profile system](https://www.wurstclient.net/updates/wurst-7-1/)
-- creating more backups/archives of Wurst
-  - [creating a fork](https://github.com/Wurst-Imperium/Wurst7/fork) / mirror of this repository
-  - adding [WurstClient.net](https://www.wurstclient.net/) pages to the Internet Archive
-  - adding [Wurst Wiki](https://wurst.wiki/) articles to the Internet Archive
-  - archiving old [Wurst releases](https://www.wurstclient.net/download/) & source code in case they are ever taken down
-  - archiving [WiZARDHAX Wurst videos](https://www.youtube.com/c/wizardhax/videos) in case the channel is ever taken down
-- just spreading the word, telling people about Wurst, etc.
-- expanding this list with more things that people can do to help (This is all I could think of for now.)
+- **Communicate first:** Please talk to me before opening a PR. I don't like receiving PRs out of the blue. This is supposed to be a collaborative process.
+
+- **1 PR = 1 change:** Each pull request should address a single issue or add a single feature. Don't stuff PRs with unrelated changes.
+
+- **Make it easy to review:** Keep the diff small and the code readable. Include any `/give` commands or whatever I need to test your change in the PR description. Remember that review is the bottleneck.
+
+- **Follow the code style:** Run `./gradlew spotlessApply` or Eclipse settings from the [codestyle folder](codestyle). For anything that this doesn't cover, please try to match the existing style as closely as possible.
+
+- **Run tests:** `./gradlew check runClientGameTest runClientGameTestWithMods` must pass. Consider adding a gametest for your change. It's not easy, but it helps a lot.
+
+- **Sign the CLA:** <https://cla-assistant.io/Wurst-Imperium/Wurst7>. See below for why.
+
+### Why we have a CLA
+
+The CLA basically just restates the important bits of the GPLv3 license:
+
+- Copyright exists. You can't just submit code that you don't have the rights to.
+- You can't request to have your PR "un-merged" later. No takesies-backsies.
+- Anyone can use Wurst, even if it includes your code, to do things you don't like.
+- Anyone can sell or make money from Wurst, even if it includes your code, without having to pay you.
+
+The GPL already enforces these rules. The CLA is just there to draw attention to them, because "I didn't read the license" has happened enough times already.
+
+## Wurst Wiki
+
+Anyone can contribute to the wiki. You don't need permission. You only need an email address to create an account.
+
+See: <https://wurst.wiki/how_to_help>
+
+Note: The wiki has a Cloudflare captcha on the login/registration page to lock out spam bots. Sorry if this is blocked in your country. It's necessary.

build.gradle

@@ -6,7 +6,8 @@ buildscript {
 
 plugins {
 	id "net.fabricmc.fabric-loom" version "${loom_version}"
-	id "com.diffplug.spotless" version "8.5.1"
+	id "com.diffplug.spotless" version "8.6.0"
+	id "net.wimods.github-compile-summary" version "0.1.1"
 }
 
 def ENV = System.getenv()
@@ -67,8 +68,6 @@ dependencies {
 	// To change the versions see the gradle.properties file
 	minecraft "com.mojang:minecraft:${project.minecraft_version}"
 	implementation "net.fabricmc:fabric-loader:${project.loader_version}"
-	testImplementation "org.junit.jupiter:junit-jupiter:5.13.4"
-	testRuntimeOnly "org.junit.platform:junit-platform-launcher:1.13.4"
 
 	// Fabric API. This is technically optional, but you probably want it anyway.
 	implementation "net.fabricmc.fabric-api:fabric-api:${project.fabric_api_version}"
@@ -123,10 +122,32 @@ configurations {
 	}
 }
 
+def optionalCompatMods = [
+	sodium: [artifact: "sodium", property: "sodium_version"],
+	better_block_entities: [
+		artifact: "better-block-entities",
+		property: "better_block_entities_version"
+	],
+	badoptimizations: [
+		artifact: "badoptimizations",
+		property: "badoptimizations_version"
+	]
+]
+
+def compatModVersions = optionalCompatMods.collectEntries { id, mod ->
+	[(id): providers.gradleProperty(mod.property).orElse("")]
+}
+
 dependencies {
-	testMods "maven.modrinth:sodium:${project.sodium_version}"
-	// Ensure gametest source set has Fabric JUnit engine
-	gametestImplementation "net.fabricmc:fabric-loader-junit:${project.loader_version}"
+	optionalCompatMods.each { id, mod ->
+		def version = compatModVersions[id].get().trim()
+		if(!version.isEmpty())
+			testMods "maven.modrinth:${mod.artifact}:${version}"
+	}
+}
+
+def hasCompatMods = providers.provider {
+	compatModVersions.values().any { !it.get().trim().isEmpty() }
 }
 
 def cleanClientWithMods = tasks.register("cleanClientWithMods", Delete) {
@@ -139,6 +160,7 @@ def prepareClientWithMods = tasks.register("prepareClientWithMods", Sync) {
 }
 
 tasks.named("runClientWithMods") {
+	onlyIf { hasCompatMods.get() }
 	dependsOn prepareClientWithMods
 	finalizedBy cleanClientWithMods
 }
@@ -153,9 +175,8 @@ def prepareClientGameTestWithMods = tasks.register("prepareClientGameTestWithMod
 	into layout.buildDirectory.dir("run/clientGameTestWithMods/mods")
 }
 
-def doModCompatTest = providers.gradleProperty("do_mod_compat_test").map { it.toBoolean() }.orElse(false)
 tasks.named("runClientGameTestWithMods") {
-	onlyIf { doModCompatTest.get() }
+	onlyIf { hasCompatMods.get() }
 	dependsOn prepareClientGameTestWithMods
 }
 
@@ -285,10 +306,6 @@ spotless {
 	}
 }
 
-test {
-	useJUnitPlatform()
-}
-
 def getGhVersion() {
 	return version.substring(0, version.indexOf("-MC"))
 }

gradle.properties

@@ -4,17 +4,17 @@ org.gradle.parallel=true
 org.gradle.configuration-cache=true
 
 # Fabric Properties
-# check these at https://fabricmc.net/develop/ and
+# Check these at https://fabricmc.net/develop/ and
 # https://modrinth.com/mod/fabric-api/versions
 minecraft_version=26.1.2
 loader_version=0.19.2
 loom_version=1.16-SNAPSHOT
 
 # Fabric API
-fabric_api_version=0.149.1+26.1.2
+fabric_api_version=0.150.0+26.1.2
 
 # Mod Properties
-mod_version=v7.53.1-CevAPI-MC26.1.2
+mod_version=v7.54-CevAPI-MC26.1.2
 fork_release_version=0.55
 maven_group=net.wurstclient
 archives_base_name=Wurst-Client
@@ -23,7 +23,12 @@ mod_loader=Fabric
 # GitHub
 gh_repo_id=cev-api/Wurst7-CevAPI
 
-# Dependencies
-# check at https://modrinth.com/mod/sodium/versions?l=fabric&g=26.1.2
+# Mod versions for automated compatibility tests:
+# Check at https://modrinth.com/mod/sodium/versions?l=fabric&g=26.1.2
 sodium_version=mc26.1.2-0.8.12-fabric
-do_mod_compat_test=true
+
+# For manual testing (uncomment as needed):
+# Check at https://modrinth.com/mod/better-block-entities/versions?g=26.1.2
+#better_block_entities_version=1.3.4+mc26.1.2
+# Check at https://modrinth.com/mod/badoptimizations/versions?g=26.1.2
+#badoptimizations_version=gjIvugXc

modrinth_deps.json

@@ -1,4 +1,5 @@
 {
+  "better_block_entities_version": "better-block-entities",
   "fabric_api_version": "fabric-api",
   "sodium_version": "sodium"
 }

settings.gradle

@@ -6,5 +6,16 @@ pluginManagement {
         }
         mavenCentral()
         gradlePluginPortal()
+        exclusiveContent {
+            forRepository {
+                maven {
+                    name = 'WIMods'
+                    url = 'https://maven.wimods.net/releases'
+                }
+            }
+            filter {
+                includeGroupByRegex 'net\\.wimods(\\..*)?'
+            }
+        }
     }
 }

src/gametest/java/net/wurstclient/gametest/SingleplayerTest.java

@@ -46,9 +46,19 @@ public SingleplayerTest(ClientGameTestContext context,
 	public final void run()
 	{
 		runImpl();
-		waitForScreenshotMatch(
-			getClass().getSimpleName().toLowerCase() + "_cleanup",
-			"https://i.imgur.com/XF1SILt.png");
+		
+		String testName = getClass().getSimpleName();
+		int retries =
+			waitForScreenshotMatch(testName.toLowerCase() + "_cleanup",
+				"https://i.imgur.com/XF1SILt.png");
+		
+		if(retries > 0)
+			logger.warn(testName + " needed " + retries
+				+ " retries to get a valid cleanup screenshot. First view ALL"
+				+ " screenshots from " + testName + " to understand what"
+				+ " happened, then optionally retest. If this keeps happening,"
+				+ " your timings are probably wrong. Otherwise it's likely a"
+				+ " fluke, especially if you didn't change any gametest code.");
 	}
 
 	/**
@@ -131,10 +141,10 @@ protected final void assertScreenshotEquals(String fileName,
 			templateUrl);
 	}
 
-	protected final void waitForScreenshotMatch(String fileName,
+	protected final int waitForScreenshotMatch(String fileName,
 		String templateUrl)
 	{
-		WurstClientTestHelper.waitForScreenshotMatch(context, fileName,
+		return WurstClientTestHelper.waitForScreenshotMatch(context, fileName,
 			templateUrl);
 	}
 

src/gametest/java/net/wurstclient/gametest/WurstClientTestHelper.java

@@ -66,18 +66,19 @@ public static void assertScreenshotEquals(ClientGameTestContext context,
 	 * get the timing right. Not useful for anything that's still in motion,
 	 * where delaying the screenshot would only cause it to drift further away
 	 * from the expected image.
+	 *
+	 * @return The number of retries it took to get a matching screenshot.
 	 */
-	public static void waitForScreenshotMatch(ClientGameTestContext context,
+	public static int waitForScreenshotMatch(ClientGameTestContext context,
 		String fileName, String templateUrl)
 	{
 		ThreadingImpl.checkOnGametestThread("waitForScreenshotMatch");
-		waitForScreenshotMatchImpl(context, fileName, templateUrl,
+		return waitForScreenshotMatchImpl(context, fileName, templateUrl,
 			ClientGameTestContext.DEFAULT_TIMEOUT);
 	}
 
-	private static void waitForScreenshotMatchImpl(
-		ClientGameTestContext context, String fileName, String templateUrl,
-		int maxAttempts)
+	private static int waitForScreenshotMatchImpl(ClientGameTestContext context,
+		String fileName, String templateUrl, int maxAttempts)
 	{
 		NativeImage nativeImageTemplate = downloadImage(templateUrl);
 		boolean[][] mask = alphaChannelToMask(nativeImageTemplate);
@@ -106,7 +107,7 @@ private static void waitForScreenshotMatchImpl(
 
 			Vector2i result = algo.findColor(maskedScreenshot, maskedTemplate);
 			if(result != null)
-				return;
+				return i;
 		}
 
 		ghSummary("### Screenshot " + fileName + " does not match template");

src/gametest/java/net/wurstclient/gametest/WurstTest.java

@@ -24,6 +24,7 @@
 import net.fabricmc.fabric.api.client.gametest.v1.context.TestSingleplayerContext;
 import net.fabricmc.fabric.api.client.gametest.v1.world.TestWorldBuilder;
 import net.fabricmc.fabric.impl.client.gametest.TestSystemProperties;
+import net.fabricmc.loader.api.FabricLoader;
 import net.minecraft.SharedConstants;
 import net.minecraft.client.gui.screens.worldselection.WorldCreationUiState;
 import net.minecraft.world.level.block.Blocks;
@@ -32,13 +33,16 @@
 import net.minecraft.world.level.levelgen.flat.FlatLayerInfo;
 import net.minecraft.world.level.levelgen.flat.FlatLevelGeneratorSettings;
 import net.wurstclient.gametest.tests.*;
+import net.wurstclient.gametest.tests.filters.FilterBabiesTest;
+import net.wurstclient.gametest.tests.filters.FilterPassiveWaterTest;
+import net.wurstclient.gametest.tests.filters.FilterPetsTest;
 
 public class WurstTest implements FabricClientGameTest
 {
 	public static final Logger LOGGER = LoggerFactory.getLogger("Wurst Test");
 
-	public static final boolean IS_MOD_COMPAT_TEST =
-		System.getProperty("wurst.test.withMods") != null;
+	public static final boolean IS_SODIUM_INSTALLED =
+		FabricLoader.getInstance().isModLoaded("sodium");
 
 	@Override
 	public void runTest(ClientGameTestContext context)
@@ -118,12 +122,18 @@ private void testInWorld(ClientGameTestContext context,
 
 		new InGameMenuTest(context, spContext).run();
 
+		// Test entity filters
+		new FilterBabiesTest(context, spContext).run();
+		new FilterPassiveWaterTest(context, spContext).run();
+		new FilterPetsTest(context, spContext).run();
+		
 		// TODO: Open ClickGUI and Navigator
 
 		// Test Wurst hacks
 		new AutoMineHackTest(context, spContext).run();
 		new FreecamHackTest(context, spContext).run();
 		new NoFallHackTest(context, spContext).run();
+		new NoShieldOverlayHackTest(context, spContext).run();
 		new NoWeatherHackTest(context, spContext).run();
 		new XRayHackTest(context, spContext).run();
 
@@ -135,6 +145,7 @@ private void testInWorld(ClientGameTestContext context,
 		// TODO: Test more Wurst features
 
 		// Test special cases
+		new AttributeSwapMechanicTest(context, spContext).run();
 		new PistonTest(context, spContext).run();
 	}