Skip to content

Fix X-Ray fluid rendering with Sodium #1243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 24, 2025
+40 −12
Merged

Fix X-Ray fluid rendering with Sodium #1243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ddf628a
Fix X-Ray fluid rendering compat with Sodium
ZANX3Y Nov 17, 2025
d22a1a9
Update Sodium X-Ray gametest image templates
ZANX3Y Nov 18, 2025
9647caa
Add explanation comment to new DefaultFluidRenderer injector
Alexander01998 Nov 18, 2025
2c3662c
Make X-Ray fluid rendering even more consistent
Alexander01998 Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions src/gametest/java/net/wurstclient/gametest/tests/XRayHackTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ public static void testXRayHack(ClientGameTestContext context,
input.pressKey(GLFW.GLFW_KEY_X);
waitForChunkReloading(context, world);
assertScreenshotEquals(context, "xray_default",
WurstTest.IS_MOD_COMPAT_TEST ? "https://i.imgur.com/02KZHLm.png"
: "https://i.imgur.com/Dftamqv.png");
"https://i.imgur.com/Dftamqv.png");

// Exposed only
runWurstCommand(context, "setcheckbox X-Ray only_show_exposed on");
Expand All @@ -48,8 +47,7 @@ public static void testXRayHack(ClientGameTestContext context,
input.pressKey(GLFW.GLFW_KEY_X);
waitForChunkReloading(context, world);
assertScreenshotEquals(context, "xray_exposed_only",
WurstTest.IS_MOD_COMPAT_TEST ? "https://i.imgur.com/xplrJwM.png"
: "https://i.imgur.com/QlEpQTu.png");
"https://i.imgur.com/QlEpQTu.png");

// Opacity mode
runWurstCommand(context, "setcheckbox X-Ray only_show_exposed off");
Expand All @@ -58,8 +56,7 @@ public static void testXRayHack(ClientGameTestContext context,
input.pressKey(GLFW.GLFW_KEY_X);
waitForChunkReloading(context, world);
assertScreenshotEquals(context, "xray_opacity",
WurstTest.IS_MOD_COMPAT_TEST ? "https://i.imgur.com/MFc821z.png"
: "https://i.imgur.com/0nLulJn.png");
"https://i.imgur.com/0nLulJn.png");

// Exposed only + opacity
runWurstCommand(context, "setcheckbox X-Ray only_show_exposed on");
Expand All @@ -68,8 +65,7 @@ public static void testXRayHack(ClientGameTestContext context,
input.pressKey(GLFW.GLFW_KEY_X);
waitForChunkReloading(context, world);
assertScreenshotEquals(context, "xray_exposed_only_opacity",
WurstTest.IS_MOD_COMPAT_TEST ? "https://i.imgur.com/GRHgW6P.png"
: "https://i.imgur.com/noPWDUl.png");
"https://i.imgur.com/noPWDUl.png");

// Clean up
runCommand(server, "fill ~-5 ~-2 ~5 ~5 ~5 ~7 air");
Expand Down
1 change: 1 addition & 0 deletions src/main/java/net/wurstclient/mixin/FluidRendererMixin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ private boolean modifyShouldSkipRendering(Direction side, float height,
BlockAndTintGetter world, BlockPos pos, VertexConsumer vertexConsumer,
BlockState blockState, FluidState fluidState)
{
// Note: the null BlockPos is here to skip the "exposed only" check
ShouldDrawSideEvent event = new ShouldDrawSideEvent(blockState, null);
EventManager.fire(event);

Expand Down
39 changes: 35 additions & 4 deletions src/main/java/net/wurstclient/mixin/sodium/DefaultFluidRendererMixin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@
public class DefaultFluidRendererMixin
{
/**
* Hides and shows fluids when using X-Ray with Sodium installed.
* Hides and shows the top side of fluids when using X-Ray with Sodium
* installed.
*/
@Inject(at = @At("HEAD"),
method = "isFullBlockFluidOccluded(Lnet/minecraft/class_1920;Lnet/minecraft/class_2338;Lnet/minecraft/class_2350;Lnet/minecraft/class_2680;Lnet/minecraft/class_3610;)Z",
Expand All @@ -48,21 +49,51 @@ private void onIsFullBlockFluidOccluded(BlockAndTintGetter world,
BlockPos pos, Direction dir, BlockState state, FluidState fluid,
CallbackInfoReturnable<Boolean> cir)
{
ShouldDrawSideEvent event = new ShouldDrawSideEvent(state, pos);
// Note: the null BlockPos is here to skip the "exposed only" check
ShouldDrawSideEvent event = new ShouldDrawSideEvent(state, null);
EventManager.fire(event);

if(event.isRendered() != null)
cir.setReturnValue(!event.isRendered());
}

/**
* Hides and shows all other sides of fluids when using X-Ray with Sodium
* installed.
*/
@Inject(at = @At("HEAD"),
method = "isSideExposed(Lnet/minecraft/class_1920;IIILnet/minecraft/class_2350;F)Z",
cancellable = true,
remap = false,
require = 0)
private void onIsSideExposed(BlockAndTintGetter world, int x, int y, int z,
Direction dir, float height, CallbackInfoReturnable<Boolean> cir)
{
BlockPos pos = new BlockPos(x, y, z);
BlockState state = world.getBlockState(pos);

// Note: the null BlockPos is here to skip the "exposed only" check
ShouldDrawSideEvent event = new ShouldDrawSideEvent(state, null);
EventManager.fire(event);

if(event.isRendered() == null)
return;

BlockPos nPos = pos.offset(dir.getUnitVec3i());
BlockState neighborState = world.getBlockState(nPos);

cir.setReturnValue(!neighborState.getFluidState().getType()
.isSame(state.getFluidState().getType()) && event.isRendered());
}

/**
* Modifies opacity of fluids when using X-Ray with Sodium installed.
*/
@ModifyExpressionValue(at = @At(value = "INVOKE",
target = "Lnet/caffeinemc/mods/sodium/api/util/ColorARGB;toABGR(I)I"),
method = "updateQuad",
require = 0,
remap = false)
remap = false,
require = 0)
private int onUpdateQuad(int original, @Local(argsOnly = true) BlockPos pos,
@Local(argsOnly = true) FluidState state)
{
Expand Down