io.github.spair:byond-dme-parser

Parser to deserialize BYOND object tree.

License	MIT License
GroupId	io.github.spair
ArtifactId	byond-dme-parser
Last Version	0.4
Release Date	Feb 17, 2019
Type	jar
Description	io.github.spair:byond-dme-parser Parser to deserialize BYOND object tree.
Project URL	https://spair.github.io/byond-dme-parser
Source Code Management	https://github.com/SpaiR/byond-dme-parser/tree/master

Download byond-dme-parser

Filename	Size
byond-dme-parser-0.4.pom
byond-dme-parser-0.4.jar	31 KB
byond-dme-parser-0.4-sources.jar	15 KB
byond-dme-parser-0.4-javadoc.jar	45 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.github.spair/byond-dme-parser/ -->
<dependency>
    <groupId>io.github.spair</groupId>
    <artifactId>byond-dme-parser</artifactId>
    <version>0.4</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.github.spair/byond-dme-parser/
implementation 'io.github.spair:byond-dme-parser:0.4'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.github.spair/byond-dme-parser/
implementation ("io.github.spair:byond-dme-parser:0.4")

Apache Buildr

'io.github.spair:byond-dme-parser:jar:0.4'

Apache Ivy

<dependency org="io.github.spair" name="byond-dme-parser" rev="0.4">
  <artifact name="byond-dme-parser" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.github.spair', module='byond-dme-parser', version='0.4')
)

Scala SBT

libraryDependencies += "io.github.spair" % "byond-dme-parser" % "0.4"

Leiningen

[io.github.spair/byond-dme-parser "0.4"]

Dependencies

compile (2)

Group / Artifact	Type	Version
com.udojava : EvalEx	jar	2.0
com.eclipsesource.minimal-json : minimal-json	jar	0.9.4

provided (1)

Group / Artifact	Type	Version
org.projectlombok : lombok	jar	1.18.2

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.12

Project Modules

There are no modules declared in this project.

BYOND Dme Parser

About

Library to parse BYOND project and deserialize whole object tree into Dme.class object.

Installation

Library deployed to Maven Central and JCenter repositories.

pom.xml

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

build.gradle:

compile 'io.github.spair:byond-dme-parser:${last.version}'

How To Use

Project parsing process should be started from the root .dme file.

Dme dme = DmeParser.parse(new File(${path/to/root/dme/file}));

Also Dme object has method to merge himself with provided json.

JSON should have next format:

{
  "macroses": {
    "NUMBER_MACROS": 100,
    "TEXT_MACROS": "{text}one hundred",     << this will result in quoted text
    "RAW_MACROS": "one hundred"
  },
  "definitions": [
    {
      "type": "/obj",
      "parent": "/datum",
      "subtypes": [],
      "vars": {
        "number_var": 100,
        "text_var": "{text}one hundred",    << this will result in quoted text
        "raw_var": "one hundred"
      }
    }
  ]
}

Next fields for object definitions are mandatory: type, parent, subtypes, vars. If you don't wan't provide value to one of these field, it should still exist and have empty value (empty string for type and parent, empty array for subtypes, empty object for vars).

More could be found in JavaDoc.

Credits

The parsing algorithm itself is a pretty straightforward port of @monster860 JS library byond-parser, big thanks to him for that.

Versions

Version
0.4 Feb 17, 2019
0.3.2 Jan 31, 2019
0.3.1 Jan 28, 2019
0.3 Dec 22, 2018
0.2 Aug 24, 2018
0.1.9.1 Aug 12, 2018
0.1.9 Aug 11, 2018
0.1.8.1 Jul 16, 2018
0.1.8 Jun 7, 2018
0.1.7 Jun 5, 2018
0.1.6 May 31, 2018
0.1.5 May 29, 2018
0.1.4 May 12, 2018
0.1.3 May 9, 2018
0.1.2 Apr 28, 2018
0.1.1 Apr 19, 2018
0.1 Apr 17, 2018