For mod developers

BuildPrint has these public APIs, all in the package com.buildprint.api and all on the client. The examples use the Mojang names of Minecraft 26.x.

Only that package is kept stable. Everything else in BuildPrint can change in any release, so a mixin into those classes will break sooner or later.

Every call has a @since with the version it arrived in. Look each method up on its own and treat a missing one as an older BuildPrint. When BuildPrint is not ready, for example before a world is loaded, a call does nothing and returns empty, false, -1 or null. It does not throw.

Keep BuildPrint optional #

BuildPrint is client-side, and most players of your mod will not have it. Two ways to call it without making it a requirement:

• Check FabricLoader.getInstance().isModLoaded("buildprint") on Fabric, or ModList.get().isLoaded("buildprint") on NeoForge, and keep the calls in a class of their own, so BuildPrint's classes only load when it is there.
• Or call it by reflection. BuildprintBlueprints, BuildprintPlacements, BuildprintPreviews, BuildprintLibrary, BuildprintSelection, BuildprintRules, BuildprintHud and BuildprintActions take only Java types (String, int, arrays, Map, java.util.function), so there is nothing to compile against. See the example.

The editor and format APIs have you implement BuildPrint's interfaces, so they need the jar to compile. An editor add-on is declared, not called: a Fabric entrypoint, an annotation on NeoForge, or a services file. BuildPrint only loads it when it is installed, so your mod still runs without it.

public final class MyModClient implements ClientModInitializer {
    @Override
    public void onInitializeClient() {
        if (FabricLoader.getInstance().isModLoaded("buildprint")) {
            BuildprintCompat.init();
        }
    }
}

// A class of its own: BuildPrint's classes only load when it is there.
final class BuildprintCompat {
    static void init() {
        BuildprintHud.hideWhile("mymod", MyTool::isOpen);
    }
}

Compiling against it #

BuildPrint is on Modrinth, so the Modrinth Maven works. Modrinth has one file per Minecraft version and loader. Use the version number Modrinth shows for the one you build against, such as 0.1.34+26.3, or that version's id from its page, which points at exactly one file. On Fabric use modCompileOnly, on NeoForge compileOnly.

repositories {
    maven {
        url = "https://api.modrinth.com/maven"
        content { includeGroup "maven.modrinth" }
    }
}

dependencies {
    // The version for your Minecraft version and loader, as Modrinth lists it.
    modCompileOnly "maven.modrinth:buildprint:0.1.34+26.3"
}

Questions #

Something the API should do, or something that does not work: ask on Discord.