umu-commander 2.1.5
umu-commander is an interactive CLI tool to help you manage umu.
Requires Python: >=3.12
Keywords: umu, umu-launcher

## umu-commander
### umu-commander is a CLI tool to augment umu-launcher as well as help you manage its Proton versions.

This tool does not provide a centralised way of managing your games or utilise template umu-configs. See [faugus-launcher](https://github.com/Faugus/faugus-launcher) or [Nero-umu](https://github.com/SeongGino/Nero-umu) for something more akin to a games launcher, and [umu-wrapper](https://github.com/korewaChino/umu-wrapper) for templating functionality. 

Proton versions can track and untrack game configs, with the intention of safely removing them once no config (and subsequently application) depends on one.

Vanilla umu config files currently (06/2025) do not support setting environmental variables or runners. This tool adds such functionality with an extra TOML table within said configs, see `example_config.toml` for an example.

### Config
The configuration file lives at `~/.config/umu-commander.toml`, which cannot be changed as of now. You can generate one by running the app by itself.

The config schema is as follows:

| Name                       | Description                                                        |
|:---------------------------|:-------------------------------------------------------------------|
| `DB_DIR`                   | Directory where the Tracking DB is stored.                         |
| `DB_NAME`                  | Tracking DB filename.                                              |
| `DEFAULT_PREFIX_DIR`       | Directory where umu-commander will search for WINE prefixes.       |
| `PROTON_PATHS`             | List of directories umu-commander will search for Proton versions. |
| `DEFAULT_UMU_CONFIG_NAME`  | Default name of the umu config created using umu-commander create. |
| `UMU_PROTON_PATH`          | Directory where umu-launcher downloads its UMU-Proton versions.    |
| `[DLL_OVERRIDES_OPTIONS]`  | TOML table where all possible DLL overrides are listed.            |
| `[LANG_OVERRIDES_OPTIONS]` | TOML table where all possible LANG overrides are listed.           |

To add an extra DLL override option, add a line below the table in the form "`Label`" = "`WINE DLL override string`". Use the winhttp example as an example. You can add LANG overrides in a similar way.

### Verbs
umu-commander needs one of the following verbs specified after the executable name:

| Name      | Description                                                                                                                                                                                                                                                                  |
|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `track`   | Tracks selected config with the selected Proton version.<br/>Also removes it from any other tracking lists.                                                                                                                                                                  |
| `untrack` | Removes the selected config from all tracking lists.                                                                                                                                                                                                                         |
| `users`   | Lists which configs the selected Proton version is tracking.                                                                                                                                                                                                                 |
| `delete`  | Interactively deletes Proton versions that are currently tracking nothing.<br/>Will not remove the latest UMU-Proton and Proton versions that haven't been used for tracking before.<br/>umu-commander will never delete anything without invoking this verb and confirming. |
| `create`  | Creates an augmented umu config in the current directory.<br/>These configs are compatible with vanilla umu-launcher, although the DLL override functionality won't work.                                                                                                    |
| `run`     | Runs a program using the umu config selected.                                                                                                                                                                                                                                |
| `fix`     | Attempts to fix invalid paths created from moving configs around.                                                                                                                                                                                                            |

### Installation/Usage
Add umu-run to your PATH and then install with pipx by running `pipx install umu-commander`. \
After that you can run `umu-commander -h` for an explanation of the options, and `umu-commander <verb> [<options>]` for using the app's functionality.  

### Return codes
| Number | Name                | Description                                                     |
|:-------|:--------------------|:----------------------------------------------------------------|
| 0      | `SUCCESS`           | Program executed as intended.                                   |
| 1      | `DECODING_ERROR`    | Failed to parse a file.                                         |
| 2      | `INVALID_SELECTION` | User selected an invalid verb or there are no valid selections. |