refactor(KTX): ktx section is optional now, and it raises an exception when used, but not installed

Author: danila-schelkov

.gitignore

@@ -14,3 +14,6 @@ system/config.json
 
 # Python compiled files
 *.pyc
+
+# PVRTexToolCLI
+PVRTexToolCLI*

README.md

@@ -32,6 +32,16 @@ Work with Supercell\`s files on **any** os! SC and CSV are supported for all Sup
   - Install loguru using pip;
   - In PyDroid open and execute "main.py" file.
 
+### How to enable KTX section
+
+![KTX section demo](docs/KTX section.png)
+
+**Supercell also uses KTX textures in new versions of the games, so it is advisable to perform this step.**
+
+To enable the KTX module, you need to get the "PVRTexToolCLI" binary from the official site: https://developer.imaginationtech.com/pvrtextool/. 
+
+Then it is necessary to put CLI in "system/bin/" folder in the main script folder.
+
 ### In the plans:
 - CSV updating.
 

docs/KTX section.png

@@ -0,0 +1,2 @@
+class ToolNotFoundException(Exception):
+    pass

system/exceptions/__init__.py

@@ -136,21 +136,23 @@ def refill_menu():
                 convert_ktx_textures_to_png,
                 convert_png_textures_to_ktx,
             )
-
-            ktx_category.add(
-                Menu.Item(
-                    name=locale.ktx_from_png_label,
-                    description=locale.ktx_from_png_description,
-                    handler=convert_png_textures_to_ktx,
+            from system.lib.pvr_tex_tool import can_use_pvr_tex_tool
+
+            if can_use_pvr_tex_tool():
+                ktx_category.add(
+                    Menu.Item(
+                        name=locale.ktx_from_png_label,
+                        description=locale.ktx_from_png_description,
+                        handler=convert_png_textures_to_ktx,
+                    )
                 )
-            )
-            ktx_category.add(
-                Menu.Item(
-                    name=locale.png_from_ktx_label,
-                    description=locale.png_from_ktx_description,
-                    handler=convert_ktx_textures_to_png,
+                ktx_category.add(
+                    Menu.Item(
+                        name=locale.png_from_ktx_label,
+                        description=locale.png_from_ktx_description,
+                        handler=convert_ktx_textures_to_png,
+                    )
                 )
-            )
 
         csv_category.add(
             Menu.Item(

system/exceptions/tool_not_found.py

@@ -5,6 +5,7 @@
 from PIL import Image
 
 from system import run
+from system.exceptions.tool_not_found import ToolNotFoundException
 
 TOOL_DIR = os.path.dirname(os.path.dirname(os.path.dirname(__file__)))
 COLOR_SPACE = "sRGB"
@@ -13,6 +14,15 @@
 CLI_PATH = f"{TOOL_DIR}/system/bin/PVRTexToolCLI"
 
 
+# Note: a solution from
+# https://stackoverflow.com/questions/11210104/check-if-a-program-exists-from-a-python-script
+def can_use_pvr_tex_tool() -> bool:
+    from distutils.spawn import find_executable
+
+    executable_path = find_executable(CLI_PATH)
+    return executable_path is not None
+
+
 def get_image_from_ktx_data(data: bytes) -> Image.Image:
     tmp = tempfile.NamedTemporaryFile(delete=False, suffix=".ktx")
     try:
@@ -36,6 +46,8 @@ def get_image_from_ktx(filepath: Path) -> Image.Image:
 
 
 def convert_ktx_to_png(filepath: Path, output_folder: Path | None = None) -> Path:
+    _ensure_tool_installed()
+
     output_filepath = filepath.with_suffix(".png")
     if output_folder is not None:
         output_filepath = output_folder / output_filepath.name
@@ -46,6 +58,8 @@ def convert_ktx_to_png(filepath: Path, output_folder: Path | None = None) -> Pat
 
 
 def convert_png_to_ktx(filepath: Path, output_folder: Path | None = None) -> Path:
+    _ensure_tool_installed()
+
     output_filepath = filepath.with_suffix(".ktx")
     if output_folder is not None:
         output_filepath = output_folder / output_filepath.name
@@ -56,3 +70,10 @@ def convert_png_to_ktx(filepath: Path, output_folder: Path | None = None) -> Pat
     )
 
     return output_filepath
+
+
+def _ensure_tool_installed():
+    if can_use_pvr_tex_tool():
+        return
+
+    raise ToolNotFoundException("PVRTexTool not found.")