Open DIS for Java

Introduction

This repository contains a Java implementation of the Distributed Interactive Simulation (DIS) IEEE-1278 standard, which is often used in military simulations.

The library consists of classes that represent Protocol Data Units (PDUs). These classes have fields, getters, and setters, and are able to marshal and unmarshal themselves to and from the DIS binary format. Many of the classes were initially generated with XMLPG.

The library also provides supporting classes that read and write PDUs from the network, log PDUs to a file, and more.

Documentation

Javadocs for the current and previous artifact versions can be found on javadoc.io. Or to generate javadocs yourself run mvn javadoc:javadoc.

Example code can be found in the repository.

Using the Java Library

Maven

There are two repositories where Open DIS can be found; JitPack and Maven Central. Read below before making a choice.

JitPack

JitPack is a terrific service that enables you to include any development snapshot of the Open DIS java library as a Maven dependency in your project. A common use case is someone who wants to try the latest code because it contains a fix that was recently merged in. To use this service do the following:

1. Add the jitpack repository to your project pom.xml.

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://www.jitpack.io</url>
    </repository>
</repositories>

2. And this to your <dependencies> section, replacing the <version> value with any SHA1 from this library you wish.

<dependency>
    <groupId>com.github.open-dis</groupId>
    <artifactId>open-dis-java</artifactId>
    <version>d3c2b19aed8e80c5e7ef938dc0982f5ad0282ae6</version> <!-- replace with any git SHA1 -->
</dependency>

Note: When you use the JitPack service for the first time it is common your project build will time out and then fail. This is because your request likely has triggered a new build that no one else has and the JitPack servers are busy doing that for you. If this happens, retry you project build 5-10 minutes later and it should succeed this time. Future builds of your project will be much faster because the library artifact will have been cached on jitpack servers and be stored locally on your disk.

Maven Central

Official releases published by the Open DIS maintainers can be found on Maven Central. These are less frequent, but can be more stable because they are conciously released.

Add the following to your pom.xml.

<dependency>
    <groupId>edu.nps.moves</groupId>
    <artifactId>open-dis</artifactId>
    <version>5.0</version>
</dependency>

Ant

Include the open-dis jar in your project and all it's dependencies (i.e. dis-enums, srm, commons-math3). The exact versions of these jars can easily be identified by viewing the open-dis relase pom.xml on Maven Central and then downloading these jars manually from Maven Central.

License

All code is BSD license. See LICENSE.md.

For Maintainers

See MAINTAINERS.md.