umu-commander 1.5.5__py3-none-any.whl → 1.5.6__py3-none-any.whl

umu_commander/__init__.py

@@ -0,0 +1 @@
+VERSION = "v1.5.6"

umu_commander/__main__.py

@@ -0,0 +1,71 @@
+import os
+import sys
+from collections.abc import Callable
+from json import JSONDecodeError
+
+from umu_commander import configuration as config
+from umu_commander import database as db
+from umu_commander import tracking, umu_config
+from umu_commander.classes import ExitCode
+from umu_commander.configuration import CONFIG_DIR, CONFIG_NAME
+from umu_commander.util import print_help
+
+
+def main() -> ExitCode:
+    try:
+        config.load()
+    except (JSONDecodeError, KeyError):
+        config_path: str = os.path.join(CONFIG_DIR, CONFIG_NAME)
+        old_config_path: str = os.path.join(CONFIG_DIR, CONFIG_NAME + ".old")
+
+        print(f"Config file at {config_path} could not be read.")
+
+        if not os.path.exists(old_config_path):
+            print(f"Config file renamed to {old_config_path}.")
+            os.rename(config_path, old_config_path)
+
+    except FileNotFoundError:
+        config.dump()
+
+    try:
+        db.load()
+    except JSONDecodeError:
+        db_path: str = os.path.join(config.DB_DIR, config.DB_NAME)
+        old_db_path: str = os.path.join(config.DB_DIR, config.DB_NAME + ".old")
+
+        print(f"Tracking file at {db_path} could not be read.")
+
+        if not os.path.exists(old_db_path):
+            print(f"DB file renamed to {old_db_path}.")
+            os.rename(db_path, old_db_path)
+
+    except FileNotFoundError:
+        pass
+
+    dispatch: dict[str, Callable] = {
+        "track": tracking.track,
+        "untrack": tracking.untrack,
+        "users": tracking.users,
+        "delete": tracking.delete,
+        "create": umu_config.create,
+        "run": umu_config.run,
+    }
+
+    if len(sys.argv) == 1:
+        print_help()
+        return ExitCode.SUCCESS.value
+    elif sys.argv[1] not in dispatch:
+        print("Invalid verb.")
+        print_help()
+        return ExitCode.INVALID_SELECTION.value
+
+    dispatch[sys.argv[1]]()
+
+    tracking.untrack_unlinked()
+    db.dump()
+
+    return ExitCode.SUCCESS.value
+
+
+if __name__ == "__main__":
+    exit(main())

umu_commander/classes.py

@@ -77,5 +77,5 @@ class ProtonDir(Group):
 
 class ExitCode(Enum):
     SUCCESS = 0
-    READING_ERROR = 1
+    DECODING_ERROR = 1
     INVALID_SELECTION = 2

umu_commander/configuration.py

@@ -29,11 +29,7 @@ DLL_OVERRIDES_OPTIONS: tuple[DLLOverride, ...] = (
 
 
 def load():
-    config_path: str = os.path.join(CONFIG_DIR, CONFIG_NAME)
-    if not os.path.exists(config_path):
-        return
-
-    with open(config_path, "rb") as conf_file:
+    with open(os.path.join(CONFIG_DIR, CONFIG_NAME), "rb") as conf_file:
         toml_conf = tomllib.load(conf_file)
         if "DLL_OVERRIDES_OPTIONS" in toml_conf:
             toml_conf["DLL_OVERRIDES_OPTIONS"] = tuple(

umu_commander/database.py

@@ -15,11 +15,9 @@ def load():
     if not os.path.exists(config.DB_DIR):
         os.mkdir(config.DB_DIR)
 
-    db_path: str = os.path.join(config.DB_DIR, config.DB_NAME)
-    if not os.path.exists(db_path):
-        return
-
-    with open(os.path.join(db_path), "rt") as db_file:
+    with open(
+        os.path.join(os.path.join(config.DB_DIR, config.DB_NAME)), "rt"
+    ) as db_file:
         _db.update(json.load(db_file))
 
 

umu_commander/proton.py

@@ -25,9 +25,9 @@ def refresh_proton_versions():
         if "PROTONPATH" in line and "/" in line:
             try:
                 left: int = line.rfind("/") + 1
-                print(f":Latest umu Proton: {line[left:len(line) - 1]}.")
+                print(f":Latest UMU-Proton: {line[left:len(line) - 1]}.")
             except ValueError:
-                print("Could not fetch latest umu Proton.")
+                print("Could not fetch latest UMU-Proton.")
 
             break
 

umu_commander/tracking.py

@@ -57,10 +57,15 @@ def users():
     if proton_ver.dir in db.get() and proton_ver.version_num in db.get(proton_ver.dir):
         version_users: list[str] = db.get(proton_ver.dir, proton_ver.version_num)
         if len(version_users) > 0:
-            print(f"Directories tracked by {proton_ver.version_num} of {proton_ver.dir}:")
-            print(*version_users, sep="\n")
+            print(
+                f"Directories tracked by {proton_ver.version_num} of {proton_ver.dir}:",
+                *version_users,
+                sep="\n\t",
+            )
+
         else:
             print("This version is tracking no directories.")
+
     else:
         print("This version hasn't been used by umu before.")
 

umu_commander/umu_config.py

@@ -141,4 +141,3 @@ def run():
             args=["umu-run", "--config", config.UMU_CONFIG_NAME],
             env=os.environ,
         )
-

umu_commander/util.py

@@ -1,3 +1,4 @@
+from umu_commander import VERSION
 from umu_commander.classes import Element, ExitCode, Group, Value
 
 
@@ -91,3 +92,13 @@ def get_selection(
     return _translate_index_to_selection(
         selection_index, selection_elements, selection_groups
     )
+
+
+def print_help():
+    print(
+        f"umu-commander {VERSION}",
+        "Interactive CLI tool to augment umu-launcher as well as help you manage its Proton versions.",
+        "",
+        "For details, usage, and more, see the README.md file, or visit https://github.com/Mpaxlamitsounas/umu-commander.",
+        sep="\n",
+    )

umu_commander-1.5.6.dist-info/METADATA

@@ -0,0 +1,61 @@
+Metadata-Version: 2.4
+Name: umu-commander
+Version: 1.5.6
+Summary: umu-commander is an interactive CLI tool to help you manage umu.
+Project-URL: Homepage, https://github.com/Mpaxlamitsounas/umu-commander
+Project-URL: Issues, https://github.com/Mpaxlamitsounas/umu-commander/issues
+Author-email: Mpaxlamitsounas <worldstudy123@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Keywords: umu,umu-launcher
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Requires-Dist: tomli-w
+Description-Content-Type: text/markdown
+
+## umu-commander
+### umu-commander is an interactive CLI tool to augment umu-launcher as well as help you manage its Proton versions.
+
+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                                                        |
+|:--------------------------|:-------------------------------------------------------------------|
+| `PROTON_PATHS`            | List of directories umu-commander will search for Proton versions. |
+| `UMU_PROTON_PATH`         | Directory where umu-launcher downloads its UMU-Proton versions.    |
+| `DB_NAME`                 | Tracking DB filename.                                              |
+| `DB_DIR`                  | Directory where the Tracking DB is stored.                         |
+| `UMU_CONFIG_NAME`         | Name of the umu config created using umu-commander create.         |
+| `DEFAULT_PREFIX_DIR`      | Directory where umu-commander will search for WINE prefixes.       |
+| `[DLL_OVERRIDES_OPTIONS]` | TOML table where all possible DLL overrides are listed.            |
+
+To add an extra DLL override option, add a line below the table in the form "`Label`" = "`WINE override string`". Use the winhttp example as a template.
+
+### 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.<br/>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.<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 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. |

umu_commander-1.5.6.dist-info/RECORD

@@ -0,0 +1,14 @@
+umu_commander/__init__.py,sha256=THBINIkksJ2OSZ2kpSzyYakqjPzjkKhk4d1XC_2D0NU,19
+umu_commander/__main__.py,sha256=Zo5NbQ8lYsmNo7oN3ekeJ5VPyiETcbasEYkfBMkFZ-A,1994
+umu_commander/classes.py,sha256=3vEC7Iq3buEUaIIJKO1ze57hs9yQ_-9pnkazHkSfcLk,1655
+umu_commander/configuration.py,sha256=bF_1n_8PQ04GmJZpC1scQ5OBZbsVXPstJ9RGfKE-D5k,2277
+umu_commander/database.py,sha256=mkBX0e6YEv2dWU2hCMaZwhSD02f_XefW0qbErcVHHYo,1183
+umu_commander/proton.py,sha256=g2skvgM4d8mnL9MA3rmYxJOCpODPYyRfIdh4KakNWU8,2553
+umu_commander/tracking.py,sha256=WfWeQWnNNK_q-1rFt0HPFNDD8z7VcTCYKI5A_W8xNIg,3113
+umu_commander/umu_config.py,sha256=gJsK4g33vtBpfvfSJcQBCoM3zzuWQ9kGX5IUSOFw6ow,4191
+umu_commander/util.py,sha256=hTNGK6HN5nHGH5HEA8mUxOM5f2S_IpawHmbhpw2H4ig,3013
+umu_commander-1.5.6.dist-info/METADATA,sha256=9CHWg8ULk_UIP71HtnR5dPfG9E2tNkROP9VfShg-I9Q,5365
+umu_commander-1.5.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+umu_commander-1.5.6.dist-info/entry_points.txt,sha256=ljyUmDmgCCMm7mQgB1syoWbf_5AiemyrS6YN7eTn9CI,62
+umu_commander-1.5.6.dist-info/licenses/LICENSE.txt,sha256=yipFXBRmVZ2Q44x1q18HccPUAECBQLXAOAr21aS57uY,1071
+umu_commander-1.5.6.dist-info/RECORD,,

umu_commander-1.5.6.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+umu-commander = umu_commander.__main__:main

umu_commander/main.py

@@ -1,68 +0,0 @@
-#!/usr/bin/python3
-import os
-import sys
-from json import JSONDecodeError
-
-import umu_commander.configuration as config
-import umu_commander.database as db
-from umu_commander import tracking, umu_config
-from umu_commander.classes import ExitCode
-from umu_commander.configuration import CONFIG_DIR, CONFIG_NAME
-
-
-def print_help():
-    print(
-        "umu-commander is an interactive CLI tool to help you manage Proton versions used by umu, as well as create enhanced launch configs.",
-        "",
-        "For details, explanations, and more, see the README.md file, or visit https://github.com/Mpaxlamitsounas/umu-commander.",
-        sep="\n",
-    )
-
-
-def main() -> ExitCode:
-    try:
-        config.load()
-    except (JSONDecodeError, KeyError):
-        config_path: str = os.path.join(CONFIG_DIR, CONFIG_NAME)
-        print(f"Config file at {config_path} could not be read.")
-        os.rename(config_path, os.path.join(CONFIG_DIR, CONFIG_NAME + ".old"))
-
-    try:
-        db.load()
-    except JSONDecodeError:
-        db_path: str = os.path.join(config.DB_DIR, config.DB_NAME)
-        print(f"Tracking file at {db_path} could not be read.")
-        os.rename(db_path, os.path.join(config.DB_DIR, config.DB_NAME + ".old"))
-
-    if len(sys.argv) == 1:
-        print_help()
-        return ExitCode.SUCCESS.value
-
-    verb: str = sys.argv[1]
-    match verb:
-        case "track":
-            tracking.track()
-        case "untrack":
-            tracking.untrack()
-        case "users":
-            tracking.users()
-        case "delete":
-            tracking.delete()
-        case "create":
-            umu_config.create()
-        case "run":
-            umu_config.run()
-        case _:
-            print("Invalid verb.")
-            print_help()
-            return ExitCode.INVALID_SELECTION.value
-
-    tracking.untrack_unlinked()
-    db.dump()
-    config.dump()
-
-    return ExitCode.SUCCESS.value
-
-
-if __name__ == "__main__":
-    exit(main())

umu_commander-1.5.5.dist-info/METADATA

@@ -1,59 +0,0 @@
-Metadata-Version: 2.4
-Name: umu-commander
-Version: 1.5.5
-Summary: umu-commander is an interactive CLI tool to help you manage umu.
-Project-URL: Homepage, https://github.com/Mpaxlamitsounas/umu-commander
-Project-URL: Issues, https://github.com/Mpaxlamitsounas/umu-commander/issues
-Author-email: Mpaxlamitsounas <worldstudy123@gmail.com>
-License-Expression: MIT
-License-File: LICENSE.txt
-Keywords: umu,umu-launcher
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.12
-Requires-Dist: tomli-w
-Description-Content-Type: text/markdown
-
-## umu-commander
-### umu-commander is an interactive CLI tool to help you manage Proton versions used by umu, as well as create enhanced launch configs.
-
-Proton versions can be tracked and untracked, with the intention of being safely removable once no game depends on a specific one.\
-What directories each Proton version is being used by is tracked within `tracking.json` inside your umu Proton directory by default.
-
-Vanilla umu configuration files currently do not support setting environmental variables, this tool adds such functionality by adding an extra TOML table in the umu config itself. An example config is available under the name `example_config.toml`.
-
-### Config
-The configuration file lives at `~/.config/umu-commander.toml`. Within it, you can edit the following:
-* PROTON_PATHS: List of directories umu-commander will search for Proton versions.
-* UMU_PROTON_PATH: Directory where umu itself downloads its umu Proton versions.
-* DB_NAME: Tracking DB filename.
-* DB_DIR: Directory where the Tracking DB is stored.
-* UMU_CONFIG_NAME: Name of the umu config created using umu-commander run.
-* DEFAULT_PREFIX_DIR: Directory where WINE prefixes are scanned.
-* [DLL_OVERRIDES_OPTIONS]: Category to list possible DLL overrides in "Label" = "Override string" format.
-
-### Verbs
-umu-commander needs one of the following verbs specified after the executable name:
-* track: Adds the current directory to a specified Proton version's list of users.
-  * If the directory is already in another list, it will be removed from it.
-  * The create verb will automatically track the current directory.
-  * This will not update any existing configs.
-* untrack:  Removes the current directory from all tracking lists.
-* users: Lists each Proton version's users.
-* delete: Interactively deletes any Proton version in the tracking database with no users.
-  * This will actually remove the Proton directories, use at your own risk.
-  * If a Proton version has not been tracked before, it will not be removed, neither will the latest umu Proton.
-  * umu-commander will not delete anything without invoking this verb and receiving confirmation.
-* create: Creates a custom configuration file in the current directory.
-* run: Uses the config in the current directory to run the program.
-  * This is NOT equivalent to `umu-run --config <config_name>`, as vanilla umu configs do not support setting environment variables as of 07/2025.
-  
-### Installation/Usage
-Add umu-run to your PATH and then install with pipx by running `pipx install umu-commander`. After that you can invoke umu-commander by running `umu-commander <verb>`. 
-
-### Return codes
-| Number | Name              | Description                                                     |
-|:-------|:------------------|:----------------------------------------------------------------|
-| 0      | SUCCESS           | Program executed as intended.                                   |
-| 1      | READING_ERROR     | Failed to parse a file and could not recover.                   |
-| 2      | INVALID_SELECTION | User selected an invalid verb or there are no valid selections. |

umu_commander-1.5.5.dist-info/RECORD

@@ -1,14 +0,0 @@
-umu_commander/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-umu_commander/classes.py,sha256=SW8k4TrP4-W4DdaQC_P88wBIgeJ3TIaV7lyt32IfVD8,1654
-umu_commander/configuration.py,sha256=VmOmlXQS08OFlptu04P0zLgCsiToJMgKBXx35aRpnfU,2368
-umu_commander/database.py,sha256=_8FVW-gctDsR6K2LiHQy6Mr_yR0JTY-taIvqBb9Hr0E,1248
-umu_commander/main.py,sha256=-EghV73K7XlV_JXnYgLAc6Qt1svp3vT8s8TUVo6nIXQ,1945
-umu_commander/proton.py,sha256=ZJ3y8sjxTIKm5mUH32eXBGxGuJH_2gWXi_EoqJyOxko,2553
-umu_commander/tracking.py,sha256=V38nWlOZu0BUyPWssX6i0JoXOkd8NkKAdJ0hPauXlMM,3064
-umu_commander/umu_config.py,sha256=ilxWhiT2XhPn9qeJf-i2YWZIhVktPuMkNxpEfdnMF_A,4192
-umu_commander/util.py,sha256=e4IqnxT0K2lLsUUgqnK0Z60MJRasvGCzo90ZX-gVBOE,2648
-umu_commander-1.5.5.dist-info/METADATA,sha256=H7XhadfLpQZeVa8hUfP66Gm0oeTMsHdRM6oI_B4M_6o,3720
-umu_commander-1.5.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-umu_commander-1.5.5.dist-info/entry_points.txt,sha256=7RGP35zAHeEojZ-sv7JIITuMeH_VVNuG2g2_SUrUnbM,58
-umu_commander-1.5.5.dist-info/licenses/LICENSE.txt,sha256=yipFXBRmVZ2Q44x1q18HccPUAECBQLXAOAr21aS57uY,1071
-umu_commander-1.5.5.dist-info/RECORD,,

umu_commander-1.5.5.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-umu-commander = umu_commander.main:main