For mod developers

Charted has four public APIs, all in the package com.charted.api and all on the client. A modpack can also ship waypoints without any code.

The rules every call follows #

• Every call is a static method taking and returning plain JDK types, so a mod can call it by reflection without compiling against Charted.
• Client side, client thread only (marks may be set from any thread). Call isAvailable() first; when it is false every call does nothing and returns empty, null or false. Nothing throws.
• Whatever a mod adds goes under an owner, its own mod id. ChartedMap.release(owner) takes all of it away again. Code you hand in that throws is logged once and left out.
• The player stays in charge: waypoints a mod adds are theirs to edit and delete, listed under the mod's name.

Keep Charted optional #

Charted 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("charted"), or on NeoForge ModList.get().isLoaded("charted"), and keep the calls in a class of their own, so Charted's classes only load when it is there.
• Or call it by reflection. Every call takes only JDK types, so there is nothing to compile against. See the example.

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

// A class of its own: Charted's classes only load when Charted is there.
final class ChartedCompat {
    static void init() {
        ChartedMarkers.point("mymod", "spawn", "minecraft:overworld", 0, 0, 0x3080FF, "Spawn");
    }
}

Questions #

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