PolarPaper

PolarPaper

Polar world format for Paper

Polar is a world format very similar to Slime, with the same advantages:

• Small file sizes
• Single file world
• Immutable (Worlds do not save until explicitly requested)
• Store worlds wherever (Whether as a file or in a database)

Polar is also a single plugin without requiring classloaders or a Paper fork

Polar was originally developed for Minestom, see the Minestom loader here

Permissions

Permission nodes are simply polarpaper.<subcommand>, for example: polarpaper.info for /polar info

API

Add to Gradle:

repositories {
    maven("https://repo.minehub.live/releases")
}
dependencies {
    implementation("live.minehub:polarpaper:<latest version>")
}

Get the PolarWorld that a player is in

PolarWorld polarWorld = PolarWorld.fromWorld(player.getWorld());
// (returns null if the world is not from PolarPaper)

Load a polar world

// Manually
Path path = Path.of("path/to/world.polar");
String worldName = path.getFileName().toString().split("\\.polar")[0];
byte[] bytes;
try {
    // This example shows reading a world from a file, however
    // as long as you can read and write a byte array, you can read it
    // from wherever you want - including databases like mysql and redis!
    bytes = Files.readAllBytes(path);
} catch (IOException e) {
    throw new RuntimeException(e);
}
PolarWorld polarWorld = PolarReader.read(bytes);
Polar.loadWorld(polarWorld, worldName);

// or by using config
Polar.loadWorldConfigSource("gamingworld", null, null);

Save a polar world

// Manually
World bukkitWorld = player.getWorld();
PolarWorld polarWorld = PolarWorld.fromWorld(player.getWorld());
if (polarWorld == null) return;
byte[] bytes = PolarWriter.write(polarWorld);
// again, feel free to write the bytes wherever you like

// or by using config
Polar.saveWorldConfigSource("gamingworld", null, null);