https://github.com/SpaiR/byond-dmi-util

Set of util classes to work with BYOND dmi files. Deserialization and comparison included.
https://github.com/SpaiR/byond-dmi-util

byond comparison-tool deserialization-library dmi ss13

Last synced: about 1 year ago
JSON representation

Set of util classes to work with BYOND dmi files. Deserialization and comparison included.

• Host: GitHub
• URL: https://github.com/SpaiR/byond-dmi-util
• Owner: SpaiR
• License: mit
• Archived: true
• Created: 2018-02-11T21:36:08.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-01-29T18:20:12.000Z (over 7 years ago)
• Last Synced: 2024-10-23T16:05:09.638Z (over 1 year ago)
• Topics: byond, comparison-tool, deserialization-library, dmi, ss13
• Language: Java
• Homepage:
• Size: 467 KB
• Stars: 6
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/SpaiR/byond-dmi-util.svg?branch=master)](https://travis-ci.org/SpaiR/byond-dmi-util)

[![Javadocs](https://www.javadoc.io/badge/io.github.spair/byond-dmi-util.svg)](https://www.javadoc.io/doc/io.github.spair/byond-dmi-util)

[![License](http://img.shields.io/badge/license-MIT-blue.svg)](http://www.opensource.org/licenses/MIT)

# BYOND Dmi Util

## About 

Set of util classes to work with BYOND dmi files.

## Installation

[![Maven Central](https://img.shields.io/maven-central/v/io.github.spair/byond-dmi-util.svg?style=flat)](https://search.maven.org/search?q=a:byond-dmi-util)

[![JCenter](https://img.shields.io/bintray/v/spair/io.github.spair/byond-dmi-util.svg?label=jcenter)](https://bintray.com/spair/io.github.spair/byond-dmi-util/_latestVersion)

Library deployed to Maven Central and JCenter repositories.

#### pom.xml

```

    io.github.spair

    byond-dmi-util

    ${last.version}

```

#### build.gradle:

```

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

```

## How To Use

### DmiSlurper

Class used to deserialize `.dmi` file.

 - `slurpUp(final File dmiFile)` - from file.

 - `slurpUp(final String dmiName, final String base64content)` - from base64.

 - `slurpUp(final String dmiName, final InputStream input)` - from any input stream.

As a result of deserialization `Dmi` object returns.

### DmiComparator

Class used to compare two dmi's and show difference between them.

 - `compare(@Nullable final Dmi oldDmi, @Nullable final Dmi newDmi)`

 

 As a result of comparison `DmiDiff` object returns.

 

 

More could be found in [JavaDoc](https://www.javadoc.io/doc/io.github.spair/byond-dmi-util).