-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from djey47/tduf-2.0.x
Tduf 2.0.x
- Loading branch information
Showing
465 changed files
with
23,814 additions
and
2,623 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,77 +1,82 @@ | ||
# TDUF(orever) # | ||
|
||
[](https://app.codeship.com/projects/292761) | ||
|
||
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 | ||
* **gui-installer** : Mod installer | ||
* **gui-savegame** : Savegame Editor | ||
* **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 ### | ||
|
||
* 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 *markNextVersionTask -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 either *packFull* or *packInstallerKit* tasks from Gradle. | ||
|
||
...it will: | ||
|
||
* Create release packages in zip archive, into *releases* directory. | ||
|
||
### Contributing to project ### | ||
|
||
* Later! | ||
|
||
### Licensing ### | ||
|
||
* GUI applications use *34aL Volume 3.1* icon pack from [IconJoy](http://icojam.com) | ||
* 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](https://github.com/google/guava) under Apache License version 2.0 | ||
* See LICENSE.md license into this directory. | ||
|
||
### Contact & useful links ### | ||
|
||
* [Project homepage @ TurboDuck community](https://forum.turboduck.net/forums/tdu-mod-tools-support.57/) | ||
# TDUF(orever) # | ||
|
||
[](https://app.codeship.com/projects/292761) | ||
[Unit test report of latest build failure](http://codeship-ci.s3-website-eu-west-1.amazonaws.com/tduf/index.html) | ||
|
||
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](http://icojam.com) | ||
* 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](https://github.com/google/guava) under Apache License version 2.0 | ||
* See LICENSE.md license into this directory. | ||
|
||
### Contact & useful links ### | ||
|
||
* [Project homepage @ TurboDuck community](https://forum.turboduck.net/forums/tdu-mod-tools-support.57/) |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.