WeiDU Install Tool

A graphical front end for WeiDU Mods.

WeiDU Install Tool is a graphical front end for the WeiDU command line tool to install modifications for Infinity Engine games, such as Baldur's Gate, Icewind Dale or Planescape Torment. The front end is written in Java and uses the JavaFX framework to provide a modern UI.

The tool offers all the functionality of the WeiDU command line interpreter as well as many usability improvements and convenience features to help with the mod installation task. It is not intended to be a full-fledged mod manager like Project Infinity.

Features

Tp2 Mod File Association

The installed version of WeiDU Install Tool is automatically associated^* with tp2 mod files which allows you to quickly and conveniently install mods from the file manager without having to deal with setup executables or the command line.

^* Not available on macOS.

Drag and Drop Support

This feature allows you to drop tp2 files or the mod folders themselves onto an open WeiDU Install Tool instance to initiate the mod installation process if no other mod is currently being installed.

Detailed Mod Information

The application provides information about the currently installed mod to get a detailed overview about the purpose of the mod and available installation options. Available mod components are presented in a tree-like structure. They can be shown in any of the available mod languages and optionally filtered by component groups. A separate section provides more general information about the mod which includes the mod name and author, a short summary of the mod content, as well as links to the mod's homepage, readme and download location, and optional dependencies.

Customization

Customization of the WeiDU Install Tool includes:

Displaying UI text and messages in the language native to the user if available
Toggling between a light and dark user interface on-the-fly
Specifying output text size and character encoding
Displaying visual hints about the installation state
Warnings about potential mod conflicts
and more…

Installation

Installation builds are available as installers and portable packages for Windows, GNU/Linux and macOS. They can be downloaded from the Releases section of the project.

Note: It is possible that some antivirus or security tools are overly sensitive and block download or installation of the file because of problematic executables. These are false positives if you downloaded the file from the official GitHub Releases page. Most antivirus tools provide options to whitelist the problematic files or mark them as safe and allow you to continue with the process.

Building from Source

Required tools:

Note: JDK 21 is automatically provided if an older Java installation is found on the system.

The following commands will build the application and create packages in the format native to the current platform.

Windows (installer):

cd WeiduInstallTool
gradlew.bat jpackage

Windows (portable zip):

cd WeiduInstallTool
gradlew.bat portableZip

Linux and macOS (installer):

cd WeiduInstallTool
chmod +x gradlew
./gradlew jpackage

Linux and macOS (portable tarball):

cd WeiduInstallTool
chmod +x gradlew
./gradlew portableTar

The resulting package(s) can be found in the ./build/distribution folder. Start menu entries and file type associations are only set up by the installer version of the tool.

The jpackage task requires the following software to be installed on the system:

Windows: WiX 3.0 or later is required.
macOS: Xcode command line tools are required when the --mac-sign option is used to request that the package be signed.
Linux:
- For Red Hat Linux, the rpm-build package is required.
- For Ubuntu Linux, the fakeroot package is required.

More details can be found in Oracle's Packaging Tool User's Guide.

Credits

Translations

English: Argent77

German: Argent77 (Proofreading: Shai Hulud)

French: JohnBob

Brazilian Portuguese: Felipe

Russian translation: abalabokhin

License

WeiDU Install Tool is licensed under the Apache License, Version 2.0.

infinitytools / weiduinstalltool Goto Github PK