# TDUF(orever)

TDUF is an effort at making Test Drive Unlmited modding easier:

- Providing base modding features to save time in a command line interface (aka. CLI)
- Making database and cameras editing less harmful with a new Database Editor (aka. GUI)
- Helping with reverse-engineering
- Bringing new desktop applications for end-users, in the future
- ...

### Database Editor Main features

- Opens and saves a database from/to either regular BNK or JSON form
- Provides user interface profiles to address different modding use cases (car editing, tuning kits, rims ...)
- Checks database and proposes to fix errors (advanced feature)
- CONTENTS
  - Displays all fields within a topic, in an ordered manner
  - Displays missing reference errors
  - Displays shared data among topics (paintjobs, tuning kits, rims)
  - Makes changes easier for special values (resources, percent, bitfields, links etc.)
  - Enables navigation over entries in same or different topics
  - Searches/Clones/Deletes particular entry
  - Adds new content entry
- RESOURCES
  - Displays all resources within a topic, for all game languages
  - Displays missing reference errors
  - Searches particular entry given its REF
  - Deletes/edits particular entry
  - Adds new resource entry
- IMPORT/EXPORT WIKI
  - From TDUF (.json mini-patch file) with additional properties file
  - From TDUPE (.tdupk Performance Pack)
  - From TDUMT (.pch patches)
  - To following forms: EDEN-classic/TDUPE, TDUMT, TDUF mini-patch
- CAMERAS WIKI
  - Opens and saves cameras.bin file in above database directory
  - Displays available camera sets and views
  - Detects and displays reference errors
  - Changes some camera view settings
  - Duplicates existing camera set
  - Imports/exports camera set settings with additional properties file
- IKS
  - Displays available IK sets
  - Detects and displays reference errors
- FILE MAPPING WIKI
  - Displays mapping state and file availability
  - Allows to change names for assets BNK files
  - Displays files into default file browser
  - Allows to fix BNK file mappings in Bnk1.map
- AND MORE!

### What's in this version ? (1.12.0)

- (Editor) Brings misc. UI changes (shorter, clearer labels...)
- (Editor) All plugins (cameras, iks, mapping,...) can be disabled at once via manual ops. See WIKI
- (Editor/Cameras) Adds support for new view setting (ComplementaryView for front/rear switch)
- (Editor/Mapping) Adds feature as plugin to track BNK file mapping. See WIKI

- (CamerasTool/remove-sets) New operation to delete all views from selected camera sets. See WIKI

- (Library/Cameras) Huge parts of cameras parsing and writing have been refactored

- (Library/Cameras) Added support for complementary view setting
- (Library/Files) Added support for new field type: CONSTANT. See WIKI
- (Library/Files) Updated structures to take benefit of CONSTANT field type
- (Library/Mapping) Added support operations (load/save)
- (Library/Game) Added new domain Objects and Helpers (Vehicle Slots...)

### Fixed issues

- (Editor) Wrong profile name in configuration would prevent database to be loaded
- (Editor) Tuning options (car packs) were not displayed from current vehicle slot
- (Editor/Cameras) 'SteeringWheelTilt' view parameter changes now work properly
- (Editor/Cameras) Changing cockpit view settings would break rear view

- (Library/Files) Incorrect reading of signed integer values was resolved

### Known bugs

- (Editor/Mapping) Mapping errors are not properly described. Will be enhanced later.
- You tell me!

### What you will need to run TDUF

- Make sure Java apps can be run:
  - Please uninstall any Java Runtime < 8
  - Update / Install Java 8 Runtime Environment
  - Linux users with OpenJDK8: you'll need to get openjfx package.
- Make sure .net apps can be run, as well (if TDUMT/TDUPE actually run, you're fine):
  - Windows: check if .net Framework 2.0 is installed
  - Linux: check if Mono 2.0 is installed, otherwise you will have to get mono-complete package.

### Running Database Editor!

- Launch TDUF-database-gui.cmd from Windows explorer / TDUF-database-gui.sh from Linux
- From 1.12.0 version, at first launch, select real TDU game path when asked
- In DatabaseEditor, browse location of TDU database BNK or JSON files. Load (may take a while)
- Make your changes. Save (may take a while)
- Database is repacked automatically.

### Running Advanced tools!

- Launch TDUF-cli.cmd from Windows explorer / TDUF-cli.sh from Linux
- Follow instructions.

### Troubleshooting

If you encounter some issues to run tools under Windows, launch -noadmin.cmd files instead.

### Using JAR library and/or CLI Tools in your projects

It's for free, but you ought to put a mention (kinda 'Powered By TDUF project') and give a link to thread @ TurboDuck

### And especially...

Have fun! As much as I had with developing those tools !

If you wish to donate, please head to this

#### Contact & useful links

- Project homepage @ TurboDuck community
- Tools Reference: TDUCP WIKI @ GitHub

### Licenses

- TDU application icon: Creative Commons - unmodified

-Djey, core tools developer-