Separate sable_rapier into its own module

Author: ryanhcode

.github/workflows/build-rust.yml

@@ -2,7 +2,7 @@ name: Build Rust Natives
 on:
   push:
     paths:
-      - 'common/src/main/rust/**'
+      - 'sable_rapier/src/main/rust/**'
       - '.github/workflows/build-rust.yml'
   workflow_dispatch:
 
@@ -33,11 +33,11 @@ jobs:
       - name: Cache cargo
         uses: actions/cache@v4
         with:
-          path: ${{ github.workspace }}/common/build/cargo
-          key: ${{ runner.os }}-node-${{ hashFiles('common/src/main/rust/**/Cargo.lock') }}
+          path: ${{ github.workspace }}/sable_rapier/build/cargo
+          key: ${{ runner.os }}-node-${{ hashFiles('sable_rapier/src/main/rust/**/Cargo.lock') }}
 
       - name: Run Gradle Task
-        run: ./gradlew common:buildImages common:buildRustNatives
+        run: ./gradlew sable_rapier:buildImages sable_rapier:buildRustNatives
 
       - name: Take ownership of the workspace
         run: sudo chown -R $USER:$USER .

.gitignore

@@ -7,8 +7,8 @@
 *.iws
 
 # Rust
-/common/src/main/rust/target
-/common/src/main/rust/flamegraph.svg
+/sable_rapier/src/main/rust/target
+/sable_rapier/src/main/rust/flamegraph.svg
 
 # C# - Sharp
 /common/src/main/csharp/*/bin/

common/build.gradle

@@ -1,212 +1,8 @@
-import org.apache.tools.ant.taskdefs.condition.Os
-import net.jpountz.lz4.LZ4FrameOutputStream
-
-import java.nio.file.Files
-
-buildscript {
-    dependencies {
-        classpath 'at.yawk.lz4:lz4-java:1.11.0'
-    }
-}
-
 plugins {
     id 'multiloader-common'
     id 'net.neoforged.moddev'
 }
 
-def mac(arch) {
-    [triple: "${arch}-apple-darwin", suffix: "", arch: arch, os: "macos", ext: "dylib", lib: true]
-}
-
-def linux(arch) {
-    [triple: "${arch}-unknown-linux-gnu", suffix: ".2.17", arch: arch, os: "linux", ext: "so", lib: true]
-}
-
-def freebsd(arch) {
-    [triple: "${arch}-unknown-freebsd", suffix: "", arch: arch, os: "freebsd", ext: "so", lib: true]
-}
-
-def windows(arch) {
-    [triple: "${arch}-pc-windows-msvc", suffix: "", arch: arch, os: "windows", ext: "dll", lib: false]
-}
-
-def supportedTargets = [
-        mac("x86_64"),
-        mac("aarch64"),
-        linux("x86_64"),
-        linux("aarch64"),
-        windows("x86_64"),
-        windows("aarch64"),
-//        freebsd("x86_64"),
-        // freebsd("aarch64"),
-]
-def pinnedRustVersion = 'nightly-2026-01-29'
-def rustRootDir = file("src/main/rust")
-def rustProjectDir = file("$rustRootDir/rapier")
-def nativesDir = file("src/main/resources/natives/sable_rapier")
-def cargoCacheDir = project.layout.buildDirectory.file("cargo").get().asFile
-def docker = Os.isFamily(Os.FAMILY_MAC) ? "/usr/local/bin/docker" : "docker"
-def xWinImage = 'sable-build-xwin'
-def zigbuildImage = 'sable-build-zigbuild'
-
-def baseDockerCommand = [
-        docker,
-        'run',
-        '--rm',
-        '-v',
-        "$rustRootDir:/io",
-        '-v',
-        "$cargoCacheDir/git:/usr/local/cargo/git",
-        '-v',
-        "$cargoCacheDir/registry:/usr/local/cargo/registry",
-        '-w',
-        '/io/rapier',
-]
-project.ext.zigbuildCargo = [baseDockerCommand, zigbuildImage, 'cargo'].flatten()
-project.ext.xWinCargo = [baseDockerCommand, xWinImage, 'cargo'].flatten()
-
-tasks.register('createContainersDirectory') {
-    doLast {
-        if (!cargoCacheDir.exists()) {
-            cargoCacheDir.mkdirs()
-        }
-    }
-}
-
-
-tasks.register('buildZigbuildImage', Exec) {
-    group = 'rust'
-    workingDir rustRootDir
-    commandLine docker, 'build', '-t', zigbuildImage, 'container/zigbuild', '--build-arg', "RUST_VERSION=${pinnedRustVersion}"
-    dependsOn createContainersDirectory
-}
-tasks.register('buildXWinImage', Exec) {
-    group = 'rust'
-    workingDir rustRootDir
-    commandLine docker, 'build', '-t', xWinImage, 'container/xwin', '--build-arg', "RUST_VERSION=${pinnedRustVersion}"
-    dependsOn createContainersDirectory
-}
-
-tasks.register('buildImages') {
-    group = 'rust'
-    dependsOn buildZigbuildImage, buildXWinImage
-}
-
-tasks.register('cleanRust', Exec) {
-    group = 'rust'
-    workingDir rustProjectDir
-    commandLine project.ext.zigbuildCargo
-    // only need to use zigbuild cargo since both containers share the same target folder
-    args 'clean'
-    dependsOn createContainersDirectory
-}
-
-def compileRustTaskName = { target ->
-    "compileRust-${target.os}-${target.arch}"
-}
-
-def commandLineForTarget(target) {
-    if (target.triple.contains('msvc')) {
-        [project.ext.xWinCargo, 'xwin', 'build', '--target', target.triple + target.suffix].flatten()
-        // support meme platforms, this does nothing by default because the target is disabled
-    } else if (target.triple == 'aarch64-unknown-freebsd') {
-        [project.ext.zigbuildCargo, 'zigbuild', '-Z', 'build-std', '--target', target.triple + target.suffix].flatten()
-    } else {
-        [project.ext.zigbuildCargo, 'zigbuild', '--target', target.triple + target.suffix].flatten()
-    }
-}
-
-def nativesNameForTarget(target) {
-    "sable_rapier_${target.arch}_${target.os}.${target.ext}"
-}
-
-supportedTargets.forEach { target ->
-    tasks.register(compileRustTaskName(target), Exec) {
-        group = 'rust'
-        workingDir rustProjectDir
-        description = "Cross-compiles natives for the ${target.triple} target"
-        def commands= commandLineForTarget(target)
-        commands.add('--release')
-        commandLine = commands
-    }
-}
-
-tasks.register("compileRustDev", Exec) {
-    group = 'rust'
-    workingDir rustProjectDir
-    description = "Compiles debug natives"
-    commandLine = [project.ext.zigbuildCargo, 'zigbuild'].flatten()
-}
-
-tasks.register('buildRustNatives') {
-    group = 'build'
-    description = 'Compiles all Rust natives and moves them to resources.'
-
-    dependsOn = supportedTargets.stream().map(compileRustTaskName).collect()
-    finalizedBy copyRustNatives
-}
-
-tasks.register('buildRustNativesDev') {
-    group = 'build'
-    description = 'Compiles all Rust natives and moves them to resources.'
-
-    dependsOn compileRustDev
-    finalizedBy copyRustNativesDev
-}
-
-tasks.register('copyRustNatives', Copy) {
-    group = 'rust'
-    into nativesDir
-    mustRunAfter(buildRustNatives)
-
-    supportedTargets.forEach { target ->
-        from(file("$rustRootDir/target/${target.triple}/release/${if (target.lib) { "lib" } else { "" }}sable_rapier.${target.ext}")) {
-            rename { nativesNameForTarget(target) }
-        }
-    }
-    finalizedBy packRustNatives
-}
-
-tasks.register('copyRustNativesDev', Copy) {
-    group = 'rust'
-    into nativesDir
-    mustRunAfter(buildRustNativesDev)
-
-    supportedTargets.forEach { target ->
-        var library = file("$rustRootDir/target/debug/${if (target.lib) { "lib" } else { "" }}sable_rapier.${target.ext}")
-        if (!library.exists()) return
-
-        from(library) {
-            rename { nativesNameForTarget(target) }
-        }
-    }
-    finalizedBy packRustNatives
-}
-tasks.register('packRustNatives', Zip) {
-    group = 'rust'
-    archiveFile.set file("${nativesDir}/sable_rapier_binaries.zip.l4z")
-    entryCompression = ZipEntryCompression.STORED
-    into nativesDir
-
-    mustRunAfter copyRustNatives, copyRustNativesDev
-    supportedTargets.forEach { target ->
-        var f = nativesNameForTarget(target)
-        // No, you can't use rename here in case you were wondering.
-        from(file("${nativesDir}/${f}")) { eachFile { setPath f } }
-    }
-    doLast {
-        byte[] bytes = Files.readAllBytes(getArchiveFile().get().asFile.toPath())
-        try (var f = new FileOutputStream(getArchiveFile().get().asFile)) {
-            try (var x = new LZ4FrameOutputStream(f, LZ4FrameOutputStream.BLOCKSIZE.SIZE_4MB, bytes.length, LZ4FrameOutputStream.FLG.Bits.BLOCK_INDEPENDENCE)) {
-                x.write(bytes)
-            }
-        }
-        supportedTargets.forEach { t ->
-            delete(file("${nativesDir}/${nativesNameForTarget(t)}"))
-        }
-    }
-}
-
 neoForge {
     neoFormVersion = neo_form_version
     // Automatically enable AccessTransformers if the file exists
@@ -256,6 +52,6 @@ dependencies {
         transitive = false
     }
 
-    implementation "fuzs.forgeconfigapiport:forgeconfigapiport-common-neoforgeapi:${forgeconfigapiport_version}"
     //source: https://github.com/Fuzss/forgeconfigapiport
+    implementation "fuzs.forgeconfigapiport:forgeconfigapiport-common-neoforgeapi:${forgeconfigapiport_version}"
 }

common/src/main/java/dev/ryanhcode/sable/Sable.java

@@ -1,7 +1,6 @@
 package dev.ryanhcode.sable;
 
 import com.mojang.logging.LogUtils;
-import dev.ryanhcode.sable.api.physics.PhysicsPipeline;
 import dev.ryanhcode.sable.api.physics.force.ForceGroups;
 import dev.ryanhcode.sable.api.sublevel.ServerSubLevelContainer;
 import dev.ryanhcode.sable.api.sublevel.SubLevelContainer;
@@ -11,7 +10,6 @@
 import dev.ryanhcode.sable.network.tcp.SableTCPPackets;
 import dev.ryanhcode.sable.physics.config.block_properties.PhysicsBlockPropertiesDefinitionLoader;
 import dev.ryanhcode.sable.physics.config.block_properties.PhysicsBlockPropertyTypes;
-import dev.ryanhcode.sable.physics.impl.rapier.RapierPhysicsPipeline;
 import dev.ryanhcode.sable.sublevel.system.SubLevelPhysicsSystem;
 import dev.ryanhcode.sable.sublevel.system.SubLevelTrackingSystem;
 import dev.ryanhcode.sable.sublevel.tracking_points.SubLevelTrackingPointObserver;
@@ -45,14 +43,6 @@ public static void init() {
 
         LOGGER.info("{} loaded!", MOD_NAME);
     }
-
-    /**
-     * Creates a physics pipeline with the current configuration.
-     */
-    public static PhysicsPipeline createPhysicsPipeline(final ServerLevel level) {
-        return new RapierPhysicsPipeline(level);
-    }
-
     /**
      * @param path the path to the resource
      * @return a {@link ResourceLocation} with a {@link Sable#MOD_ID} namespace

common/src/main/java/dev/ryanhcode/sable/api/physics/PhysicsPipeline.java

@@ -224,7 +224,15 @@ default Vector3d getAngularVelocity(final PhysicsPipelineBody body, final Vector
     @Nullable
     @Contract("null, null, _ -> fail")
     default <T extends PhysicsConstraintHandle> T addConstraint(@Nullable final PhysicsPipelineBody bodyA, @Nullable final PhysicsPipelineBody bodyB, @NotNull final PhysicsConstraintConfiguration<T> configuration) {
-        throw new UnsupportedOperationException("Not implemented");
+        if (bodyA == null && bodyB == null) {
+            throw new IllegalArgumentException("Cannot add a constraint between the static world and static world");
+        }
+
+        if (bodyA == bodyB) {
+            throw new IllegalArgumentException("Cannot add a constraint between a body and itself");
+        }
+
+        return null;
     }
 
     /**
@@ -234,7 +242,7 @@ default <T extends PhysicsConstraintHandle> T addConstraint(@Nullable final Phys
      */
     @ApiStatus.OverrideOnly
     default void updateConfigFrom(final PhysicsConfigData data) {
-        throw new UnsupportedOperationException("Not implemented");
+
     }
 
     /**

common/src/main/java/dev/ryanhcode/sable/api/physics/PhysicsPipelineProvider.java

@@ -0,0 +1,49 @@
+package dev.ryanhcode.sable.api.physics;
+
+import net.minecraft.server.level.ServerLevel;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.util.Comparator;
+import java.util.ServiceLoader;
+
+/**
+ * A provider of physics pipelines for levels
+ */
+public interface PhysicsPipelineProvider {
+
+    /**
+     * @since 1.0.0
+     */
+    @Retention(RetentionPolicy.RUNTIME)
+    @interface LoadPriority {
+        /**
+         * @return The load priority value. The highest priority available pipeline provider is loaded
+         */
+        int value() default 1000;
+    }
+
+    /**
+     * The physics pipeline provider instance.
+     */
+    PhysicsPipelineProvider INSTANCE = ServiceLoader.load(PhysicsPipelineProvider.class)
+            .stream().max(Comparator.comparingInt(provider -> {
+                Class<? extends PhysicsPipelineProvider> type = provider.type();
+                LoadPriority annotation = type.getAnnotation(LoadPriority.class);
+                return annotation != null ? annotation.value() : 1000;
+            }))
+            .map(ServiceLoader.Provider::get)
+            .orElseThrow(() -> new RuntimeException("Failed to find any physics pipeline providers"));
+
+    /**
+     * Creates a physics pipeline for a given level
+     * @param level the level to create the pipeline for
+     * @return the new physics pipeline
+     */
+    @NotNull
+    @Contract(value = "_ -> new", pure = true)
+    PhysicsPipeline createPipeline(@NotNull final ServerLevel level);
+
+}

common/src/main/java/dev/ryanhcode/sable/physics/impl/none/StaticPhysicsPipeline.java

@@ -73,7 +73,7 @@ public void remove(final KinematicContraption contraption) {
 
     @Override
     public Pose3d readPose(final ServerSubLevel subLevel, final Pose3d dest) {
-        return dest;
+        return dest.set(subLevel.logicalPose());
     }
 
     /**

common/src/main/java/dev/ryanhcode/sable/physics/impl/none/StaticPhysicsPipelineProvider.java

@@ -0,0 +1,16 @@
+package dev.ryanhcode.sable.physics.impl.none;
+
+import dev.ryanhcode.sable.api.physics.PhysicsPipeline;
+import dev.ryanhcode.sable.api.physics.PhysicsPipelineProvider;
+import net.minecraft.server.level.ServerLevel;
+import org.jetbrains.annotations.NotNull;
+
+@PhysicsPipelineProvider.LoadPriority(900)
+public final class StaticPhysicsPipelineProvider implements PhysicsPipelineProvider {
+
+    @Override
+    public @NotNull PhysicsPipeline createPipeline(@NotNull final ServerLevel level) {
+        return new StaticPhysicsPipeline();
+    }
+
+}