miniatures's Introduction

Miniatures

Miniature library for Spigot(or anything based on SpigotAPI - PaperMC, SSSpigot).

What is miniature?

Miniature is a world area that is instead of blocks, represented on heads of armorstands.

For devs

Usage:

World world = /*world*/;
Vector mostPos = new Vector(10f, 10f, 10f); // most high position in world 
Vector leastPos = mostPos.clone().multiply(0.5f);   // least high position in world
boolean small = false; // 

Miniature.Builder builder = MiniatureAPI.areaToMiniature(world, mostPos, leastPos, small);
Miniature built = builder.get();

Vector offset = new Vector(1, 1, 1);
// list all part positions, and put them to world
built.getPositions().forEach((index, part) -> {
    part.setOffset(offset);
    Vector relPos = part.getRelativePos(); // get relative pos in world
    Vector realPos  = mostPos.clone().add(relPos); // add origin to relative pos
    
    // todo vector to location
    //      get block and set its type to `part.getMaterial();`
    
});

Maven dependency

Repository:

<repository>
    <id>nexus@ethernal</id>
    <url>https://nexus.ethernal.cz/repository/maven/</url>
</repository>

Dependency:

<!-- Source -->
<dependency>
    <groupId>xyz.rgnt</groupId>
    <artifactId>miniatures</artifactId>
    <version>1.0-release</version>
</dependency>

<!-- JavaDocs -->
<dependency>
<groupId>xyz.rgnt</groupId>
    <artifactId>miniatures</artifactId>
    <version>1.0-release</version>
    <classifier>javadoc</classifier>
    <scope>provided</scope>
</dependency>

Compiling

This project requires lombok plugin for getter/setter code generation and is compiled via Apache Maven. We use Jetbrains annotations for javadoc code documentation & inspection. Project can be compiled with shell script ./miniatures-build. Resulting JAR file can be found in directory target/miniatures-{VERSION}-{BUILD TYPE}.jar