Dreadball Default Model Implementation
Implementation of the Dreadball Model API for JSON messages.
This covers both the original Dreadball and Dreadball Xtreme, and includes teams, units and the availabilities during team creation.
Documentation
Documentation is always generated for the latest release, kept in the 'master' branch:
Documentation is also generated from the latest snapshot, taken from the 'develop' branch:
The documentation site sources come along the source code (as it is a Maven site), so it is always possible to generate them using the following Maven command:
$ mvn verify site
The verify phase is required, as otherwise some of the reports won't be created.
Usage
The application is coded in Java, using Maven to manage the project.
Prerequisites
The project has been tested on the following Java versions:
- JDK 7
- JDK 8
- OpenJDK 7
All other dependencies are handled through Maven, and noted in the included POM file.
Installing
The recommended way to install the project is by setting up your preferred dependencies manager. To get the configuration information for this check the Bintray repository, or the Maven Central Repository.
If for some reason manual installation is necessary, just use the following Maven command:
$ mvn install
Collaborate
Any kind of help with the project will be well received, and there are two main ways to give such help:
- Reporting errors and asking for extensions through the issues management
- or forking the repository and extending the project
Issues management
Issues are managed at the GitHub project issues tracker, where any Github user may report bugs or ask for new features.
Getting the code
If you wish to fork or modify the code, visit the GitHub project page, where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.
License
The project has been released under version 2.0 of the Apache License.