SpaiR / byond-dmm-util

Library to parse and render DMM files.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status Javadocs License

BYOND Dmm Util

About

Library with util methods for dmm files.

Features:

  • able to render dmm files into proper image
  • compare two maps to get difference between them

Installation

Maven Central JCenter

Library deployed to Maven Central and JCenter repositories.

pom.xml

<dependency>
    <groupId>io.github.spair</groupId>
    <artifactId>byond-dmm-util</artifactId>
    <version>${last.version}</version>
</dependency>

build.gradle:

compile 'io.github.spair:byond-dmm-util:${last.version}'

How To Use

The main class you will use is Dmm. To create it you should provide to it constructor DmmData and Dme objects. The info how to get them could be found here and here.

DmmDrawer

Renders Dmm object into BufferedImage. Has ability to render specific region of map or apply object filter to exclude specific types from render result. For example:

DmmDrawer.drawMap(dmm, MapRegion.of(1, 5), FilterMode.IGNORE, "/area", "/turf")

DmmDiffer

Compares two Dmm objects and returns list of DiffPoint or MapRegion with specific area of differences.

More could be found in JavaDoc.

About

Library to parse and render DMM files.

License:MIT License


Languages

Language:Java 83.6%Language:Groovy 16.4%