Cobblestone

Server-side navigation for Minecraft.

📖 Documentation · 📊 Stats

Quickstart

1. Place the jar in plugins/ (Paper) or mods/ (Sponge).
2. Start the server.
3. Try it:

/stone location set home     # save the current position
/nav home                    # navigate back to it

Cobblestone runs an A* search over the live world and renders the route as a particle trail.

For admins

• Core: Personal and global saved locations, death locations, players, worlds, and learned nether and End portal links.
• Towny: Towns, outposts, and plots as destinations; /town spawn and /nation spawn as route steps; build protection.
• EssentialsX: Homes and spawn as destinations; /home and /spawn as route steps.
• Citizens, BetonQuest, BeautyQuests, Quests, Typewriter: NPCs and quest objectives as destinations, with optional automatic trips.

Integrations are distributed as separate plugins.

Player permissions default to allow; admin permissions default to op.

Each destination also has a node derived from its address:

/lp group default permission set cobblestone.navigate.towny.town.riverwood.* false

→ Admin documentation

For players

/nav home                       # saved location
/nav death                      # death location
/nav player Steve               # player
/nav town riverwood home        # Towny town
/nav npc Blacksmith             # Citizens NPC

/stone location set home        # save the current position
/stone location set spawn -global
/stone location unset home
/stone location list

/stone trips                    # list active trips
/stone cancel all               # cancel all trips

Flags: -no-<mode>, -no-world <world>, -no-dimension <dimension>, -live, -no-live, -navigator <id>.

→ Player documentation

For developers

repositories { mavenCentral() }

dependencies {
    // Paper
    compileOnly("org.cobblestonemc:paper-plugin-api:0.1.0")
    // Sponge
    // compileOnly("org.cobblestonemc:sponge-12-plugin-api:0.1.0")
}

Register destinations under your plugin's name:

CobblestonePaperApi.registrar().registerDestinations(this, player ->
    DestinationTree.builder()
        .leaf("market", () -> Destination.at(marketLocation(), "Market"))
        .build());

Start a trip:

CobblestonePaperApi.tripService()
    .navigate(player, objective, NavigatorSettings.defaults(), "Lost Lantern");

Add transitions and restrict breaking:

CobblestoneCoreApi.registrar().register(this, new SearchModificationService() {
  @Override
  public CompletableFuture<List<Transition>> computeTransitions(Player player) {
    return CompletableFuture.completedFuture(
        List.of(Transition.command(player, market, 3.0, "/warp market")));
  }

  @Override
  public BreakChecker computeBreakChecker(Player player) {
    return (p, location, block) ->
        CompletableFuture.completedFuture(claims.mayBreak(p, location));
  }
});

Custom navigators and direct searches are also supported. See project/examples/paper-warps for a complete example.

→ Developer documentation