Create Pipes n Physics

A Create mod addon for pipes and physics. Built with Java and NeoForge 1.21.1.

For developers — depending on the API

Pipes'n Physics exposes a small public API under de.devin.pipesnphysics.api so other mods can define how their fluids behave in the network (centrifuge separations, handler roles, pumps).

1. Add the dependency (compile-time)

The API is resolvable from JitPack — no CurseForge/Modrinth release needed:

repositories {
    maven { url 'https://jitpack.io' }
}
dependencies {
    // any tag, branch, or commit as the version
    compileOnly 'com.github.StaticFX:create-pipes-n-physics:v2.3.0'
}

2. Declare the dependency (runtime)

Add an entry to your src/main/resources/META-INF/neoforge.mods.toml so the loader knows Pipes'n Physics must be present. Use required if your integration is essential, or optional if it is a bonus:

[[dependencies.yourmodid]]
    modId = "pipesnphysics"
    type = "required"          # or "optional"
    versionRange = "[2.3.0,)"
    ordering = "AFTER"          # load Pipes'n Physics before you
    side = "BOTH"

If you declare it optional, guard your API calls so the classes only load when the mod is present — otherwise a missing dependency throws NoClassDefFoundError:

if (ModList.get().isLoaded("pipesnphysics")) {
    PnpCompat.register(); // a SEPARATE class; only it references de.devin.pipesnphysics.api.*
}

3. Use the API (from your mod's setup)

Centrifuge — dynamic separation (CentrifugeApi): a hook that reads the fluid (including its data components) and returns the components it splits into.

CentrifugeApi.registerSeparator(input -> {
    if (input.getFluid() != MyFluids.MIXED.get()) return null;
    return new CentrifugeRecipe(
        new FluidStack(MyFluids.MIXED.get(), 20),                       // consumed per operation
        List.of(new FluidStack(MyFluids.PART_A.get(), 10),              // outputs, densest first
                new FluidStack(MyFluids.PART_B.get(), 10)),
        3.0);                                                           // min spin (rad/s), 0 for none
});

Centrifuge — static separation (datapack): drop a file in data/<namespace>/centrifuging/*.json — no code required:

{
  "input":   { "id": "yourmod:mixed", "amount": 20 },
  "outputs": [ { "id": "yourmod:part_a", "amount": 10 },
               { "id": "yourmod:part_b", "amount": 10 } ],
  "min_angular_speed": 3.0
}

min_angular_speed (radians/second) is optional and defaults to 0. It is a per-recipe spin floor on top of the global centrifugeMinAngularSpeed config, so a stubborn mixture can demand a faster spin than the default. From code, new CentrifugeRecipe(input, outputs, minAngularSpeed) sets it; the two-argument form leaves it at 0.

Handler roles (FluidHandlerApi): tell the engine how to treat your fluid-holding block — RESERVOIR (a tank), RELAY, CONDUIT, SINK_ONLY, or IGNORE. Call after your blocks are registered.

FluidHandlerApi.setRole(MyBlocks.FLUID_DRUM.get(), FluidHandlerRole.RESERVOIR);

Pumps from other mods (PumpApi / FluidPump): the engine drives any pump that moves fluid through Create's pipes, not just the Mechanical Pump. A pump that extends Create's own is picked up automatically; anything else is named once, either by a datapack tag or in code:

// data/pipesnphysics/tags/block/pumps.json — in your mod or any datapack
{ "replace": false, "values": [ { "id": "yourmod:electric_pump", "required": false } ] }

PumpApi.declarePump(MyBlocks.ELECTRIC_PUMP.get());

How hard it pumps is then read from the pressure it already publishes to Create's pipe network — the same scale as a Mechanical Pump's RPM, so an electric pump twice Create's pressure lifts twice as high. Implement FluidPump on your pump's block entity instead if you want to state its strength and push side outright. Pack authors can scale every foreign pump with foreignPumpStrengthScale.

Turbines (TurbineApi / TurbineAdapter): the other direction — the engine takes head out of the line at your block and hands you the fluid that fell through it, and you turn that into whatever power your mod deals in. This one needs an adapter (a pump publishes its strength in a currency Create already understands; power going out does not), but nothing else: the hydraulics, including refusing to pass fluid until the fall clears the rated head, are the engine's.

TurbineApi.registerTurbine(MyBlocks.WATER_TURBINE.get(), (level, pos, flowMb) -> {
    if (level.getBlockEntity(pos) instanceof MyTurbineBlockEntity be) be.spin(flowMb);
});

The rated fall, the flow it swallows and the side it discharges through default to the engine's config and the block's own facing; override ratedHead, swallowMb or pushSide on the adapter to state your own. Driving Create rotation from it? Debounce the start/stop yourself — Create destroys a generator whose speed flickers.

License

This template is provided under the MIT License. Your mod built from this template can use any license you choose.