Dreadball Model API

Model API library for the game Dreadball, part of the Tabletop project.

License

License

GroupId

GroupId

com.bernardomg.tabletop.dreadball
ArtifactId

ArtifactId

dreadball-model-api
Last Version

Last Version

0.9.1
Release Date

Release Date

Type

Type

jar
Description

Description

Dreadball Model API
Model API library for the game Dreadball, part of the Tabletop project.
Project URL

Project URL

https://github.com/Bernardo-MG/dreadball-model-api
Project Organization

Project Organization

Bernardo Martínez Garrido
Source Code Management

Source Code Management

https://github.com/bernardo-mg/dreadball-model-api

Download dreadball-model-api

How to add to project

<!-- https://jarcasting.com/artifacts/com.bernardomg.tabletop.dreadball/dreadball-model-api/ -->
<dependency>
    <groupId>com.bernardomg.tabletop.dreadball</groupId>
    <artifactId>dreadball-model-api</artifactId>
    <version>0.9.1</version>
</dependency>
// https://jarcasting.com/artifacts/com.bernardomg.tabletop.dreadball/dreadball-model-api/
implementation 'com.bernardomg.tabletop.dreadball:dreadball-model-api:0.9.1'
// https://jarcasting.com/artifacts/com.bernardomg.tabletop.dreadball/dreadball-model-api/
implementation ("com.bernardomg.tabletop.dreadball:dreadball-model-api:0.9.1")
'com.bernardomg.tabletop.dreadball:dreadball-model-api:jar:0.9.1'
<dependency org="com.bernardomg.tabletop.dreadball" name="dreadball-model-api" rev="0.9.1">
  <artifact name="dreadball-model-api" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.bernardomg.tabletop.dreadball', module='dreadball-model-api', version='0.9.1')
)
libraryDependencies += "com.bernardomg.tabletop.dreadball" % "dreadball-model-api" % "0.9.1"
[com.bernardomg.tabletop.dreadball/dreadball-model-api "0.9.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

Dreadball Model API

API library for creating a data model for the tabletop game Dreadball.

This covers both the original Dreadball and Dreadball Xtreme, and includes teams, units and the availabilities during team creation.

Maven Central Bintray

Release docs Development docs

Release javadocs Development javadocs

Features

The API allows modelling the following aspects of both Dreadball and Dreadball Xtreme:

  • Teams (both DBO teams and DBX sponsor-based teams)
  • Team players, including advancement-capable players
  • Miscellany data such as abilities and affinity groups

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 is actually a Maven site, and its sources are included in the project. If required it can be generated by using the following Maven command:

$ mvn verify site

The verify phase is required, otherwise some of the reports won't be generated.

Usage

The application is coded in Java, using Maven to manage the project.

It is a Java library, meant to be included as a dependency on any project which may want to make use of it.

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 it up as a dependency. To get the configuration information for this check the Bintray repository, or the Maven Central Repository.

It is always possible installing it by using the usual 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.

Versions

Version
0.9.1
0.9.0
0.8.3
0.8.2
0.8.1
0.8.0