dark0dave/mod_installer

Infinity Engine Mod Installer, auto install mods from your backed up weidu log file

Infinity Engine Mod Installer

  /\/\   ___   __| | (_)_ __  ___| |_ __ _| | | ___ _ __
 /    \ / _ \ / _` | | | '_ \/ __| __/ _` | | |/ _ \ '__|
/ /\/\ \ (_) | (_| | | | | | \__ \ || (_| | | |  __/ |
\/    \/\___/ \__,_| |_|_| |_|___/\__\__,_|_|_|\___|_|

Automatically install mods from a prepopulated weidu.log file.

Demo

mod_installer.webm

Usage

Usage: mod_installer [OPTIONS] --log-file <LOG_FILE> \
  --game-directory <GAME_DIRECTORY> \
  --weidu-binary <WEIDU_BINARY> \
  --mod-directories <MOD_DIRECTORIES>

Options:
  --log-file <LOG_FILE>
      Full path to target log [env: LOG_FILE=]
  -g, --game-directory <GAME_DIRECTORY>
      Full path to game directory [env: GAME_DIRECTORY=]
  -w, --weidu-binary <WEIDU_BINARY>
      Full Path to weidu binary [env: WEIDU_BINARY=]
  -m, --mod-directories <MOD_DIRECTORIES>
      Full Path to mod directories [env: MOD_DIRECTORIES=]
  -l, --language <LANGUAGE>
      Game Language [default: en_US]
  -d, --depth <DEPTH>
      Depth to walk folder structure [env: DEPTH=] [default: 3]
  -s, --skip-installed
      Compare against installed weidu log, note this is best effort [env: SKIP_INSTALLED=]
  -a, --abort-on-warnings
      If a warning occurs in the weidu child process exit [env: ABORT_ON_WARNINGS=]
  -t, --timeout <TIMEOUT>
      Timeout time per mod in seconds, default is 1 hour [env: TIMEOUT=] [default: 3600]
  -h, --help
      Print help
  -V, --version
      Print version

Log levels

Additional information can be shown with:

RUST_LOG=INFO mod_installer [OPTIONS]

For line by line debugging:

RUST_LOG=DEBUG mod_installer [OPTIONS]

To print everything including weidu logs:

RUST_LOG=TRACE mod_installer [OPTIONS]

mod_installer's Issues

Support platform-independent directory separators in installation paths

I've got a weidu.log generated on Windows machine which looks like this:

// ...
~BG1UB\SETUP-BG1UB.TP2~ #0 #11 // Scar and the Sashenstar's Daughter: v16.4
// ...

Here, path separator breaks the following code from mod installer:

        let tp_file = install_path
            .split('/')
            .nth(1)
            .expect("Could find tp2 file")
            .to_string();

Make use of Rust's control flow

https://doc.rust-lang.org/std/ops/enum.ControlFlow.html

Enter the full path

BGT and EET require paths, mod installer should allow this.

@MikeX1234

Issue with --skip-installed

Please have a look here:
https://www.gibberlings3.net/forums/topic/37233-mod-installer/#comment-335944

Warnings and Errors do not exit automatically

[2023-11-25T08:04:46Z TRACE mod_installer::weidu_parser] INSTALLED WITH WARNINGS     Additional equipment for Thieves and Bards

[2023-11-25T08:04:46Z TRACE mod_installer::weidu_parser] Press ENTER to exit.


[2023-11-25T08:04:46Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:46Z INFO  mod_installer::weidu] ...

[2023-11-25T08:04:47Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:47Z INFO  mod_installer::weidu] ....

[2023-11-25T08:04:47Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:47Z INFO  mod_installer::weidu] .....

[2023-11-25T08:04:48Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:48Z INFO  mod_installer::weidu] ......

[2023-11-25T08:04:48Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:48Z INFO  mod_installer::weidu] .......

[2023-11-25T08:04:49Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:49Z INFO  mod_installer::weidu] ........

[2023-11-25T08:04:49Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:49Z INFO  mod_installer::weidu] .........

[2023-11-25T08:04:50Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:50Z INFO  mod_installer::weidu]

[2023-11-25T08:04:50Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:50Z INFO  mod_installer::weidu] .

[2023-11-25T08:04:51Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:51Z INFO  mod_installer::weidu] ..

[2023-11-25T08:04:51Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:51Z INFO  mod_installer::weidu] ...

[2023-11-25T08:04:52Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:52Z INFO  mod_installer::weidu] ....

[2023-11-25T08:04:52Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:52Z INFO  mod_installer::weidu] .....

[2023-11-25T08:04:53Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:53Z INFO  mod_installer::weidu] ......

[2023-11-25T08:04:53Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:53Z INFO  mod_installer::weidu] .......

[2023-11-25T08:04:54Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:54Z INFO  mod_installer::weidu] ........

[2023-11-25T08:04:54Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:54Z INFO  mod_installer::weidu] .........

[2023-11-25T08:04:55Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:55Z INFO  mod_installer::weidu]

[2023-11-25T08:04:55Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:55Z INFO  mod_installer::weidu] .

[2023-11-25T08:04:56Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:56Z INFO  mod_installer::weidu] ..

[2023-11-25T08:04:56Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:56Z INFO  mod_installer::weidu] ...

[2023-11-25T08:04:57Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:57Z INFO  mod_installer::weidu] ....

[2023-11-25T08:04:57Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:57Z INFO  mod_installer::weidu] .....

[2023-11-25T08:04:58Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:58Z INFO  mod_installer::weidu] ......

[2023-11-25T08:04:58Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:58Z INFO  mod_installer::weidu] .......

[2023-11-25T08:04:59Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:59Z INFO  mod_installer::weidu] ........

[2023-11-25T08:04:59Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:04:59Z INFO  mod_installer::weidu] .........

[2023-11-25T08:05:00Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:05:00Z INFO  mod_installer::weidu]

[2023-11-25T08:05:00Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:05:00Z INFO  mod_installer::weidu] .

[2023-11-25T08:05:01Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:05:01Z INFO  mod_installer::weidu] ..

[2023-11-25T08:05:01Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:05:01Z INFO  mod_installer::weidu] ...

[2023-11-25T08:05:02Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:05:02Z INFO  mod_installer::weidu] ....

[2023-11-25T08:05:02Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:05:02Z INFO  mod_installer::weidu] .....

[2023-11-25T08:05:03Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:05:03Z INFO  mod_installer::weidu] ......

[2023-11-25T08:05:03Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:05:03Z INFO  mod_installer::weidu] .......

[2023-11-25T08:05:04Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:05:04Z INFO  mod_installer::weidu] ........

[2023-11-25T08:05:04Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:05:04Z INFO  mod_installer::weidu] .........

[2023-11-25T08:05:05Z INFO  mod_installer::weidu] Waiting for child process to end
[2023-11-25T08:05:05Z INFO  mod_installer::weidu]

[2023-11-25T08:05:05Z INFO  mod_installer::weidu] Waiting for child process to end

New build does not work on windows

When running 2.2.0 on windows, mod installer produces Could find tp2 file error on perfectly valid files(even on empty ones).
Linux executable seems to work fine with the same files.

2.1.0 works fine though.

Multi langauge