Add terrain noise debug features (xpple#101)

* Add terrain noise debug features

* Fix DLL name

* Add debug ls command

* Fix DLL location

* Update Cubiomes

* Update Windows build script to use MSYS2

* [ci skip] Add windows-latest to step name

* Update README

* Add dimension checks

Author: xpple

.github/workflows/build.yml

@@ -14,8 +14,6 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
-    env:
-      SRC_FILES: noise.c biomes.c layers.c biomenoise.c generator.c finders.c util.c quadbase.c loot/items.c loot/loot_functions.c loot/loot_tables.c loot/loot_table_context.c loot/loot_table_parser.c loot/loot_tables/bastion_bridge_1_16_1.c loot/loot_tables/bastion_bridge_1_16_5.c loot/loot_tables/bastion_bridge_1_20.c loot/loot_tables/bastion_other_1_16_1.c loot/loot_tables/bastion_other_1_16_5.c loot/loot_tables/bastion_other_1_20.c loot/loot_tables/bastion_other_1_21_1.c loot/loot_tables/bastion_other_1_21_9.c loot/loot_tables/buried_treasure_1_13.c loot/loot_tables/buried_treasure_1_18.c loot/loot_tables/desert_pyramid_1_13.c loot/loot_tables/desert_pyramid_1_20.c loot/loot_tables/desert_pyramid_1_21_6.c loot/loot_tables/desert_pyramid_1_21_9.c loot/loot_tables/end_city_treasure_1_13.c loot/loot_tables/end_city_treasure_1_20.c loot/loot_tables/end_city_treasure_1_21_9.c loot/loot_tables/igloo_chest_1_13.c loot/loot_tables/jungle_temple_1_13.c loot/loot_tables/jungle_temple_1_14.c loot/loot_tables/jungle_temple_1_20.c loot/loot_tables/jungle_temple_1_21_6.c loot/loot_tables/jungle_temple_1_21_9.c loot/loot_tables/jungle_temple_dispenser_1_13.c loot/loot_tables/nether_bridge_1_13.c loot/loot_tables/nether_bridge_1_20.c loot/loot_tables/nether_bridge_1_21_9.c loot/loot_tables/pillager_outpost_1_14.c loot/loot_tables/pillager_outpost_1_19_2.c loot/loot_tables/pillager_outpost_1_20.c loot/loot_tables/ruined_portal_1_16_1.c loot/loot_tables/ruined_portal_1_21_5.c loot/loot_tables/shipwreck_map_1_13.c loot/loot_tables/shipwreck_map_1_18.c loot/loot_tables/shipwreck_map_1_20.c loot/loot_tables/shipwreck_supply_1_13.c loot/loot_tables/shipwreck_supply_1_14.c loot/loot_tables/shipwreck_supply_1_17.c loot/loot_tables/shipwreck_supply_1_20.c loot/loot_tables/shipwreck_treasure_1_13.c loot/loot_tables/shipwreck_treasure_1_20.c loot/cjson/cJSON.c
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -25,20 +23,35 @@ jobs:
       - name: Compile shared library (ubuntu-latest)
         if: matrix.os == 'ubuntu-latest'
         working-directory: src/main/c/cubiomes
-        run: gcc -shared -o ../../resources/libcubiomes.so $SRC_FILES -O3 -fPIC
+        run: |
+          cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
+          cmake --build build --config Release
+          cp build/libcubiomes.so ../../resources/libcubiomes.so
       - name: Compile shared library (macos-latest)
         if: matrix.os == 'macos-latest'
         working-directory: src/main/c/cubiomes
         run: |
-          gcc -shared -o ../../resources/libcubiomes_arm64.dylib -arch arm64 $SRC_FILES -O3 -fPIC
-          gcc -shared -o ../../resources/libcubiomes_x86_64.dylib -arch x86_64 $SRC_FILES -O3 -fPIC
-          lipo -create -output ../../resources/libcubiomes.dylib ../../resources/libcubiomes_arm64.dylib ../../resources/libcubiomes_x86_64.dylib
+          cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64"
+          cmake --build build --config Release
+          cp build/libcubiomes.dylib ../../resources/libcubiomes.dylib
+      - name: Set up MSYS2 (windows-latest)
+        if: matrix.os == 'windows-latest'
+        uses: msys2/setup-msys2@v2
+        with:
+          update: true
+          install: >
+            base-devel
+            mingw-w64-x86_64-toolchain
+            mingw-w64-x86_64-cmake
+            mingw-w64-x86_64-ninja
       - name: Compile shared library (windows-latest)
         if: matrix.os == 'windows-latest'
         working-directory: src/main/c/cubiomes
+        shell: msys2 {0}
         run: |
-          $src = $env:SRC_FILES.Split(" ")
-          gcc -shared -o ../../resources/cubiomes.dll $src -O3
+          cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
+          cmake --build build --config Release
+          cp build/cubiomes.dll ../../resources/cubiomes.dll
 
       - name: Compute SHA256 hash (ubuntu-latest)
         if: matrix.os == 'ubuntu-latest'

.gitignore

@@ -16,6 +16,9 @@ classes/
 *.ipr
 *.iws
 
+!.idea/scopes/
+!.idea/icon.png
+
 # vscode
 
 .settings/

README.md

@@ -82,9 +82,13 @@ To build the mod locally, follow these steps:
    git clone --recurse-submodules https://github.com/xpple/SeedMapper
    cd SeedMapper
    ```
-2. Compile cubiomes to a shared library. The following is for Windows:
+2. Compile cubiomes to a shared library. MSVC cannot be used to build the project! The following is for Windows:
    ```shell
-   gcc -shared -o src/main/resources/cubiomes.dll [...] -O3
+   cd src/main/c/cubiomes
+   cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
+   cmake --build build --config Release
+   cp build/cubiomes.dll ../../resources/cubiomes.dll
+   cd ../../../../
    ```
 3. Install LLVM (version 13.0.0 is recommended) and set the environment variable `LLVM_HOME` to the directory where LLVM was installed.
 4. Compile jextract. Again, the following is for Windows:

buildSrc/src/main/java/dev/xpple/seedmapper/buildscript/CreateJavaBindingsTask.java

@@ -13,6 +13,6 @@ public abstract class CreateJavaBindingsTask extends Exec {
 
         this.setWorkingDir(this.getProject().getRootDir());
         this.setStandardOutput(System.out);
-        this.commandLine("./jextract/build/jextract/bin/jextract" + EXTENSION, "--include-dir", "src/main/c/cubiomes", "--output", "src/main/java", "--use-system-load-library", "--target-package", "com.github.cubiomes", "--header-class-name", "Cubiomes", "@includes.txt", "biomenoise.h", "biomes.h", "finders.h", "generator.h", "layers.h", "noise.h", "quadbase.h", "rng.h", "util.h", "loot/items.h", "loot/logging.h", "loot/loot_functions.h", "loot/loot_table_context.h", "loot/loot_table_parser.h", "loot/loot_tables.h", "loot/mc_loot.h");
+        this.commandLine("./jextract/build/jextract/bin/jextract" + EXTENSION, "--include-dir", "src/main/c/cubiomes", "--output", "src/main/java", "--use-system-load-library", "--target-package", "com.github.cubiomes", "--header-class-name", "Cubiomes", "@includes.txt", "biomenoise.h", "biomes.h", "finders.h", "generator.h", "layers.h", "biomenoise.h", "biomes.h", "noise.h", "rng.h", "util.h", "quadbase.h", "xrms.h", "loot/items.h", "loot/logging.h", "loot/loot_functions.h", "loot/loot_table_context.h", "loot/loot_table_parser.h", "loot/loot_tables.h", "loot/mc_loot.h");
     }
 }

gradle.properties

@@ -14,10 +14,10 @@ minecraft_version_dependency=>=1.21.10 <1.22
 # Fabric Properties
 # check these on https://fabricmc.net/develop
 # https://maven.parchmentmc.org/org/parchmentmc/data/
-fabric_api_version=0.135.0+1.21.10
+fabric_api_version=0.138.3+1.21.10
 parchment_mappings=parchment-1.21.9:2025.10.05@zip
 fabric_loader_version=0.17.3
-fabric_loom_version=1.11-SNAPSHOT
+fabric_loom_version=1.13-SNAPSHOT
 
 # Library dependencies
 betterconfig_version=2.5.0

includes.txt

@@ -1,6 +1,7 @@
 --include-struct BiomeNoise
 --include-struct BiomeNoiseBeta
 --include-struct BiomeTree
+--include-struct BlendedNoise
 --include-struct EndNoise
 --include-struct FixSpline
 --include-struct NetherNoise
@@ -10,6 +11,7 @@
 --include-struct SplineStack
 --include-struct SurfaceNoise
 --include-struct SurfaceNoiseBeta
+--include-struct TerrainNoiseParameters
 --include-function approxSurfaceBeta
 --include-function climateToBiome
 --include-function genBiomeNoiseBetaScaled
@@ -23,18 +25,35 @@
 --include-function getOldBetaBiome
 --include-function getVoronoiSrcRange
 --include-function initBiomeNoise
+--include-function initBlendedNoise
 --include-function initSurfaceNoise
 --include-function initSurfaceNoiseBeta
+--include-function initTerrainNoise
 --include-function mapEnd
 --include-function mapEndBiome
 --include-function mapEndSurfaceHeight
 --include-function mapNether2D
 --include-function mapNether3D
+--include-function sampleBase3dNoise
 --include-function sampleBiomeNoise
 --include-function sampleBiomeNoiseBeta
+--include-function sampleCaveCheese
+--include-function sampleCaveEntrance
+--include-function sampleCaveLayer
 --include-function sampleClimatePara
+--include-function sampleEntrances
+--include-function sampleFinalDensity
+--include-function sampleNoodle
+--include-function samplePillars
+--include-function samplePreliminarySurfaceLevel
+--include-function sampleSlopedCheese
+--include-function sampleSpaghetti2d
+--include-function sampleSpaghetti3d
+--include-function sampleSpaghetti2dThicknessModulator
+--include-function sampleSpaghettiRoughness
 --include-function sampleSurfaceNoise
 --include-function sampleSurfaceNoiseBetween
+--include-function sampleUnderground
 --include-function setBetaBiomeSeed
 --include-function setBiomeSeed
 --include-function setClimateParaSeed
@@ -907,6 +926,7 @@
 --include-function sampleSimplex2D
 --include-function xDoublePerlinInit
 --include-function xOctaveInit
+--include-function xOctaveLegacyInit
 --include-function xPerlinInit
 
 --include-function getOptimalAfk

src/main/c/cubiomes

@@ -11,6 +11,7 @@
 import dev.xpple.seedmapper.command.commands.DiscordCommand;
 import dev.xpple.seedmapper.command.commands.HighlightCommand;
 import dev.xpple.seedmapper.command.commands.LocateCommand;
+import dev.xpple.seedmapper.command.commands.SampleCommand;
 import dev.xpple.seedmapper.command.commands.SeedMapCommand;
 import dev.xpple.seedmapper.command.commands.SourceCommand;
 import dev.xpple.seedmapper.command.commands.StopTaskCommand;
@@ -96,5 +97,6 @@ private static void registerCommands(CommandDispatcher<FabricClientCommandSource
         StopTaskCommand.register(dispatcher);
         SeedMapCommand.register(dispatcher);
         DiscordCommand.register(dispatcher);
+        SampleCommand.register(dispatcher);
     }
 }

src/main/java/dev/xpple/seedmapper/SeedMapper.java

@@ -23,6 +23,7 @@ private CommandExceptions() {
     public static final DynamicCommandExceptionType UNKNOWN_ENCHANTMENT_EXCEPTION = new DynamicCommandExceptionType(arg -> Component.translatable("commands.exceptions.unknownEnchantment", arg));
     public static final DynamicCommandExceptionType UNKNOWN_CANYON_CARVER_EXCEPTION = new DynamicCommandExceptionType(arg -> Component.translatable("commands.exceptions.unknownCanyonCarver", arg));
     public static final DynamicCommandExceptionType UNKNOWN_CAVE_CARVER_EXCEPTION = new DynamicCommandExceptionType(arg -> Component.translatable("commands.exceptions.unknownCaveCarver", arg));
+    public static final DynamicCommandExceptionType UNKNOWN_DENSITY_FUNCTION_EXCEPTION = new DynamicCommandExceptionType(arg -> Component.translatable("commands.exceptions.unknownDensityFunction", arg));
     public static final DynamicCommandExceptionType UNKNOWN_MAP_FEATURE_EXCEPTION = new DynamicCommandExceptionType(arg -> Component.translatable("commands.exceptions.unknownMapFeature", arg));
     public static final SimpleCommandExceptionType NO_SEED_AVAILABLE_EXCEPTION = new SimpleCommandExceptionType(Component.translatable("commands.exceptions.noSeedAvailable"));
     public static final DynamicCommandExceptionType NO_BIOME_FOUND_EXCEPTION = new DynamicCommandExceptionType(arg -> Component.translatable("commands.exceptions.noBiomeFound", arg));

src/main/java/dev/xpple/seedmapper/command/CommandExceptions.java

@@ -0,0 +1,84 @@
+package dev.xpple.seedmapper.command.arguments;
+
+import com.github.cubiomes.Cubiomes;
+import com.github.cubiomes.TerrainNoiseParameters;
+import com.google.common.collect.ImmutableMap;
+import com.mojang.brigadier.StringReader;
+import com.mojang.brigadier.arguments.ArgumentType;
+import com.mojang.brigadier.context.CommandContext;
+import com.mojang.brigadier.exceptions.CommandSyntaxException;
+import com.mojang.brigadier.suggestion.Suggestions;
+import com.mojang.brigadier.suggestion.SuggestionsBuilder;
+import dev.xpple.seedmapper.command.CommandExceptions;
+import net.fabricmc.fabric.api.client.command.v2.FabricClientCommandSource;
+import net.minecraft.commands.SharedSuggestionProvider;
+
+import java.lang.foreign.MemorySegment;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+
+public class DensityFunctionArgument implements ArgumentType<DensityFunctionArgument.DensityFunction> {
+
+    private static final Collection<String> EXAMPLES = Arrays.asList("overworld", "the_nether", "the_end");
+
+    public static final Map<String, DensityFunction> DENSITY_FUNCTIONS = ImmutableMap.<String, DensityFunction>builder()
+        .put("overworld.base_3d_noise", (params, x, y, z) -> Cubiomes.sampleBase3dNoise(TerrainNoiseParameters.bln(params), x, y, z))
+        .put("overworld.caves.spaghetti_roughness_function", Cubiomes::sampleSpaghettiRoughness)
+        .put("overworld.caves.spaghetti_2d_thickness_modulator", Cubiomes::sampleSpaghetti2dThicknessModulator)
+        .put("overworld.caves.spaghetti_2d", Cubiomes::sampleSpaghetti2d)
+        .put("spaghetti_3d", Cubiomes::sampleSpaghetti3d)
+        .put("cave_entrance", Cubiomes::sampleCaveEntrance)
+        .put("overworld.caves.entrances", (params, x, y, z) -> Cubiomes.sampleEntrances(params, x, y, z, Cubiomes.sampleSpaghettiRoughness(params, x, y, z)))
+        .put("cave_layer", Cubiomes::sampleCaveLayer)
+        .put("overworld.sloped_cheese", Cubiomes::sampleSlopedCheese)
+        .put("cave_cheese", (params, x, y, z) -> Cubiomes.sampleCaveCheese(params, x, y, z, Cubiomes.sampleSlopedCheese(params, x, y, z)))
+        .put("overworld.caves.pillars", Cubiomes::samplePillars)
+        .put("overworld.caves.noodle", Cubiomes::sampleNoodle)
+        .put("underground", (params, x, y, z) -> {
+            double spaghettiRoughness = Cubiomes.sampleSpaghettiRoughness(params, x, y, z);
+            return Cubiomes.sampleUnderground(params, x, y, z, spaghettiRoughness, Cubiomes.sampleEntrances(params, x, y, z, spaghettiRoughness), Cubiomes.sampleSlopedCheese(params, x, y, z));
+        })
+        .put("final_density", (params, x, y, z) -> {
+            double spaghettiRoughness = Cubiomes.sampleSpaghettiRoughness(params, x, y, z);
+            return Cubiomes.sampleFinalDensity(params, x, y, z, spaghettiRoughness, Cubiomes.sampleEntrances(params, x, y, z, spaghettiRoughness), Cubiomes.sampleSlopedCheese(params, x, y, z));
+        })
+        .put("preliminary_surface_level", (params, x, _, z) -> Cubiomes.samplePreliminarySurfaceLevel(params, x, z))
+        .build();
+
+    public static DensityFunctionArgument densityFunction() {
+        return new DensityFunctionArgument();
+    }
+
+    public static DensityFunction getDensityFunction(CommandContext<FabricClientCommandSource> context, String name) {
+        return context.getArgument(name, DensityFunction.class);
+    }
+
+    @Override
+    public DensityFunction parse(StringReader reader) throws CommandSyntaxException {
+        int cursor = reader.getCursor();
+        String densityFunctionString = reader.readUnquotedString();
+        DensityFunction densityFunction = DENSITY_FUNCTIONS.get(densityFunctionString);
+        if (densityFunction == null) {
+            reader.setCursor(cursor);
+            throw CommandExceptions.UNKNOWN_DENSITY_FUNCTION_EXCEPTION.create(densityFunctionString);
+        }
+        return densityFunction;
+    }
+
+    @Override
+    public <S> CompletableFuture<Suggestions> listSuggestions(CommandContext<S> context, SuggestionsBuilder builder) {
+        return SharedSuggestionProvider.suggest(DENSITY_FUNCTIONS.keySet(), builder);
+    }
+
+    @Override
+    public Collection<String> getExamples() {
+        return EXAMPLES;
+    }
+
+    @FunctionalInterface
+    public interface DensityFunction {
+        double compute(MemorySegment terrainNoiseParameters, int x, int y, int z);
+    }
+}