Skip to main content

umu-commander is an interactive CLI tool to help you manage umu.

Project description

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 or Nero-umu for something more akin to a games launcher, and umu-wrapper for templating functionality.

Proton versions can track and untrack directories, with the intention of safely removing them once no game depends on one.

Vanilla umu config files currently (06/2025) do not support setting environmental variables. 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.
UMU_CONFIG_NAME 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 current directory with the selected Proton version.
Also removes it from any other tracking lists.
untrack Removes the current directory from all tracking lists.
users Lists which directories the selected Proton version is tracking.
delete Interactively deletes Proton versions that are currently tracking nothing.
Will not remove the latest UMU-Proton and Proton versions that haven't been used for tracking before.
umu-commander will never delete anything without invoking this verb and confirming.
create Creates an augmented umu config in the current directory.
These configs are compatible with vanilla umu-launcher, although the DLL override functionality won't work.
run Runs a program using the umu config in the current directory.

Installation/Usage

Add umu-run to your PATH and then install with pipx by running pipx install umu-commander. After that you can use umu-commander by running umu-commander <verb>.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

umu_commander-1.7.0.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

umu_commander-1.7.0-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file umu_commander-1.7.0.tar.gz.

File metadata

  • Download URL: umu_commander-1.7.0.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for umu_commander-1.7.0.tar.gz
Algorithm Hash digest
SHA256 991f818a424b5b785ad0d1f6f68ddfc8a15e0a9335424d67f1430f0e4bfbf3a4
MD5 608c989fdd4a06a62d56de6258740a41
BLAKE2b-256 9fb14f2d9549d2a1eef8ae500a638231a193d918a6d060ecb21241f8a1c72081

See more details on using hashes here.

File details

Details for the file umu_commander-1.7.0-py3-none-any.whl.

File metadata

  • Download URL: umu_commander-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for umu_commander-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9e8509b62322a93d2738bd4a48b89646267e21569d798650a8c9e2752d55a654
MD5 3505da7a5ba74879d1ad0439d123abc2
BLAKE2b-256 58bcb767e9434adf04098f03b2ea1604c517b02d42a86dc58adda8d519817488

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page