TDUF(orever)

Unit test report of latest build failure

This repository hosts all Java projects linked to TDUForever initiative.

TDUForever aims at making Test Drive Unlmited modding easier:

• Providing base modding features to save time
• Capitalizing about reverse-engineering
• ...

Modules

• cli : Command Line Interface to use lib-unlimited library
• gui-common : Components to be used with any graphical user interface
• gui-database : Database Editor module
• lib-testing : Components to help with unit testing in any module
• lib-unlimited : Stand-alone component providing API for building TDU modding applications.

Setting-up

TDUF development can be made on Windows, Windows-WSL, Linux... your choice!

• Clone this repository
• To set-up Gradle: run gradlew script from command line
• Import build.gradle file into your favourite IDE
• To run tests: execute cleanTest test tasks from Gradle
• To run integration tests: execute cleanTest integTest tasks from Gradle

Running Database Editor GUI in development environment

Copy tools directory into gui-database to make it work properly.

Releasing

• Check tests: see above
• Update and commit dist/version.info file according to desired version
• Make working directory clean (commit/push or stash changes)
• Check version: execute currentVersion task from Gradle
• Execute release task from Gradle to automatically select release tag version, or release -Prelease.forceVersion=[version] to specify a version.

...it will:

• Set local tag tduf-[version]
• Push it to remote.

Preparing next development version

• Execute markNextVersion -Prelease.forceVersion=[version] task from Gradle to specify next dev version.

Packaging

This needs a release tag to be set, see Releasing section above.

• Checkout project from target release tag tduf-[version]
• Execute one ok pack... tasks from Gradle:
  • packCore: minimal set to run CLI with LIB
  • packDatabaseEditor: minimal set to run Database Editor
  • packFull: all TDUF in a single package.

...it will:

• Create release packages in zip archive, into releases directory
• Windows OS is the default target; otherwise you can override using the target parameter, e.g: packFull -Ptarget=linux

Contributing to project

• Feel free to file issues in this repository, or create PRs.

Licensing

• GUI applications use 34aL Volume 3.1 icon pack from IconJoy
• Test resources may include old binary files from game (banks, database files). Copyright Eden Games, Atari. Don't blame please.
• Portions of code (framework) are derivative work from Guava library under Apache License version 2.0
• See LICENSE.md license into this directory.

Contact & useful links

• Project homepage @ TurboDuck community