Merge pull request #16 from xcoder-tool/dev

feat(KTX): support for KTX file format and special texture tag

Author: danila-schelkov

.gitignore

@@ -6,10 +6,14 @@
 /updates/
 /logs/
 /CSV/
+/TEX/
 /SC/
 
 # Configuration files
 system/config.json
 
 # Python compiled files
 *.pyc
+
+# PVRTexToolCLI
+PVRTexToolCLI*

.pre-commit-config.yaml

@@ -12,7 +12,7 @@ repos:
     rev: 22.12.0
     hooks:
       - id: black
-        language_version: python3.10
+        language_version: python3.11
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     rev: 'v0.0.261'
     hooks:

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

@@ -34,6 +34,12 @@
     "decompress_csv_description": "Decompresses spreadsheet file",
     "compress_csv_description": "Compresses spreadsheet file",
 
+    "ktx_label": "KTX",
+    "ktx_from_png_label": "PNG2KTX",
+    "png_from_ktx_label": "KTX2PNG",
+    "ktx_from_png_description": "Converts PNG to KTX",
+    "png_from_ktx_description": "Converts KTX to PNG",
+
     "other_features_label": "OTHER",
     "check_update": "Check for updates",
     "check_for_outdated": "Check for outdated packages",

system/exceptions/tool_not_found.py

@@ -34,6 +34,12 @@
     "decompress_csv_description": "Разжимает файл таблиц",
     "compress_csv_description": "Сжимает файл таблиц",
 
+    "ktx_label": "KTX",
+    "ktx_from_png_label": "PNG2KTX",
+    "png_from_ktx_label": "KTX2PNG",
+    "ktx_from_png_description": "Конвертирует PNG в KTX",
+    "png_from_ktx_description": "Конвертирует KTX в PNG",
+
     "other_features_label": "ПРОЧЕЕ",
     "check_update": "Проверить обновления",
     "check_for_outdated": "Проверка устаревших модулей",

system/languages/en-EU.json

@@ -34,6 +34,12 @@
     "decompress_csv_description": "Розпакувати файл таблиці",
     "compress_csv_description": "Запакувати файл таблиці",
 
+    "ktx_label": "KTX",
+    "ktx_from_png_label": "PNG2KTX",
+    "png_from_ktx_label": "KTX2PNG",
+    "ktx_from_png_description": "Конвертує PNG у KTX",
+    "png_from_ktx_description": "Конвертує KTX у PNG",
+
     "other_features_label": "ІНШЕ",
     "check_update": "Шукати оновлення",
     "check_for_outdated": "Шукати застарілі пакети",

system/languages/ru-RU.json

@@ -60,6 +60,16 @@ def check_files_updated():
 def refill_menu():
     menu.categories.clear()
 
+    sc_category = Menu.Category(0, locale.sc_label)
+    ktx_category = Menu.Category(1, locale.ktx_label)
+    csv_category = Menu.Category(2, locale.csv_label)
+    other = Menu.Category(10, locale.other_features_label)
+
+    menu.add_category(sc_category)
+    menu.add_category(ktx_category)
+    menu.add_category(csv_category)
+    menu.add_category(other)
+
     try:
         import sc_compression
 
@@ -86,7 +96,6 @@ def refill_menu():
                 encode_textures_only,
             )
 
-            sc_category = Menu.Category(0, locale.sc_label)
             sc_category.add(
                 Menu.Item(
                     name=locale.decode_sc,
@@ -122,9 +131,29 @@ def refill_menu():
                     handler=lambda: collect_objects_and_encode(True),
                 )
             )
-            menu.add_category(sc_category)
 
-        csv_category = Menu.Category(1, locale.csv_label)
+            from system.lib.features.ktx import (
+                convert_ktx_textures_to_png,
+                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,
+                    )
+                )
+
         csv_category.add(
             Menu.Item(
                 name=locale.decompress_csv,
@@ -139,9 +168,7 @@ def refill_menu():
                 handler=compress_csv,
             )
         )
-        menu.add_category(csv_category)
 
-    other = Menu.Category(10, locale.other_features_label)
     other.add(
         Menu.Item(
             name=locale.check_update,
@@ -181,4 +208,3 @@ def refill_menu():
         )
     )
     other.add(Menu.Item(name=locale.exit, handler=lambda: (clear(), exit())))
-    menu.add_category(other)

system/languages/ua-UA.json

@@ -17,11 +17,9 @@ def compress_csv():
             try:
                 with open(f"{folder}/{file}", "rb") as f:
                     file_data = f.read()
-                    f.close()
 
                 with open(f"{folder_export}/{file}", "wb") as f:
                     f.write(compress(file_data, Signatures.LZMA))
-                    f.close()
             except Exception as exception:
                 logger.exception(
                     locale.error

system/lib/__init__.py

@@ -15,11 +15,9 @@ def decompress_csv():
             try:
                 with open(f"{folder}/{file}", "rb") as f:
                     file_data = f.read()
-                    f.close()
 
                 with open(f"{folder_export}/{file}", "wb") as f:
                     f.write(decompress(file_data)[0])
-                    f.close()
             except Exception as exception:
                 logger.exception(
                     locale.error

system/lib/features/csv/compress.py

@@ -0,0 +1,33 @@
+import os
+
+from loguru import logger
+from sc_compression import compress
+
+from system.localization import locale
+
+
+def update_csv():
+    from sc_compression.signatures import Signatures
+
+    input_folder = "./CSV/In-Old"
+    export_folder = "./CSV/Out-Updated"
+
+    for file in os.listdir(input_folder):
+        if file.endswith(".csv"):
+            try:
+                with open(f"{input_folder}/{file}", "rb") as f:
+                    file_data = f.read()
+
+                with open(f"{export_folder}/{file}", "wb") as f:
+                    f.write(compress(file_data, Signatures.LZMA))
+            except Exception as exception:
+                logger.exception(
+                    locale.error
+                    % (
+                        exception.__class__.__module__,
+                        exception.__class__.__name__,
+                        exception,
+                    )
+                )
+
+            print()

system/lib/features/csv/decompress.py

@@ -20,7 +20,7 @@ def render_objects(swf: SupercellSWF, output_folder: Path):
     #     rendered_movie_clip = movie_clip.render(swf)
     #     if sum(rendered_movie_clip.size) >= 2:
     #         clip_name = movie_clip.export_name or movie_clip.id
-    #         rendered_movie_clip.save(f"{export_folder}/movie_clips/{clip_name}.png")
+    #         rendered_movie_clip.save(f"{output_folder}/movie_clips/{clip_name}.png")
     #     else:
     #         # For debug:
     #         # logger.warning(f'MovieClip {movie_clip.id} cannot be rendered.')

system/lib/features/csv/update.py

@@ -1,18 +1,38 @@
 import os
 import shutil
 
+IO_TYPES = ("In", "Out")
+
+SC_FILE_TYPES = ("Compressed", "Decompressed", "Sprites")
+CSV_FILE_TYPES = ("Compressed", "Decompressed")
+TEXTURE_FILE_TYPES = ("KTX", "PNG")
+
+
+def create_directories():
+    for io_type in IO_TYPES:
+        for filetype in SC_FILE_TYPES:
+            os.makedirs(f"SC/{io_type}-{filetype}", exist_ok=True)
+
+        for filetype in CSV_FILE_TYPES:
+            os.makedirs(f"CSV/{io_type}-{filetype}", exist_ok=True)
+
+        for filetype in TEXTURE_FILE_TYPES:
+            os.makedirs(f"TEX/{io_type}-{filetype}", exist_ok=True)
+
 
 def clear_directories():
-    for i in ["In", "Out"]:
-        for k in ["Compressed", "Decompressed", "Sprites"]:
-            folder = f"SC/{i}-{k}"
-            if os.path.isdir(folder):
-                shutil.rmtree(folder)
-            os.makedirs(folder, exist_ok=True)
-
-    for i in ["In", "Out"]:
-        for k in ["Compressed", "Decompressed"]:
-            folder = f"CSV/{i}-{k}"
-            if os.path.isdir(folder):
-                shutil.rmtree(folder)
-            os.makedirs(folder, exist_ok=True)
+    for io_type in IO_TYPES:
+        for filetype in SC_FILE_TYPES:
+            _recreate_directory(f"SC/{io_type}-{filetype}")
+
+        for filetype in CSV_FILE_TYPES:
+            _recreate_directory(f"CSV/{io_type}-{filetype}")
+
+        for filetype in TEXTURE_FILE_TYPES:
+            _recreate_directory(f"TEX/{io_type}-{filetype}")
+
+
+def _recreate_directory(directory):
+    if os.path.isdir(directory):
+        shutil.rmtree(directory)
+    os.makedirs(directory, exist_ok=True)

system/lib/features/cut_sprites.py

@@ -31,7 +31,6 @@ def open_sc(input_filename: str) -> tuple[bytes, bool]:
 
     with open(input_filename, "rb") as f:
         file_data = f.read()
-        f.close()
 
     try:
         if b"START" in file_data:

system/lib/features/directories.py

@@ -1,10 +1,10 @@
-import os
 import platform
 
 from loguru import logger
 
-from system import run, clear
+from system import clear, run
 from system.lib import config
+from system.lib.features.directories import create_directories
 from system.lib.features.update.check import get_pip_info, get_tags
 from system.localization import locale
 
@@ -30,20 +30,7 @@ def initialize(first_init=False):
         else:
             logger.info(locale.not_installed % package)
     logger.info(locale.crt_workspace)
-    [
-        [
-            os.makedirs(f"SC/{i}-{k}", exist_ok=True)
-            for k in ["Compressed", "Decompressed", "Sprites"]
-        ]
-        for i in ["In", "Out"]
-    ]
-    [
-        [
-            os.makedirs(f"CSV/{i}-{k}", exist_ok=True)
-            for k in ["Compressed", "Decompressed"]
-        ]
-        for i in ["In", "Out"]
-    ]
+    create_directories()
     logger.info(locale.verifying)
 
     config.initialized = True

system/lib/features/files.py

@@ -0,0 +1,39 @@
+import os
+from pathlib import Path
+
+from system.lib.pvr_tex_tool import convert_ktx_to_png, convert_png_to_ktx
+
+IN_PNG_PATH = Path("./TEX/In-PNG")
+IN_KTX_PATH = Path("./TEX/In-KTX")
+OUT_PNG_PATH = Path("./TEX/Out-PNG")
+OUT_KTX_PATH = Path("./TEX/Out-KTX")
+
+
+def convert_png_textures_to_ktx():
+    input_folder = IN_PNG_PATH
+    output_folder = OUT_KTX_PATH
+
+    for file in os.listdir(input_folder):
+        if not file.endswith(".png"):
+            continue
+
+        png_filepath = input_folder / file
+        if not os.path.isfile(png_filepath):
+            continue
+
+        convert_png_to_ktx(png_filepath, output_folder=output_folder)
+
+
+def convert_ktx_textures_to_png():
+    input_folder = IN_KTX_PATH
+    output_folder = OUT_PNG_PATH
+
+    for file in os.listdir(input_folder):
+        if not file.endswith(".ktx"):
+            continue
+
+        ktx_filepath = input_folder / file
+        if not os.path.isfile(ktx_filepath):
+            continue
+
+        convert_ktx_to_png(ktx_filepath, output_folder=output_folder)

system/lib/features/initialization.py

@@ -19,7 +19,6 @@ def get_run_output(command: str):
 
     with open(temp_filename) as f:
         file_data = f.read()
-        f.close()
 
     os.remove(temp_filename)
 

system/lib/features/ktx.py

@@ -26,7 +26,6 @@ def download_update(zip_url):
 
         with open("updates/update.zip", "wb") as f:
             f.write(urllib.request.urlopen(zip_url).read())
-            f.close()
 
         import zipfile
 

system/lib/features/update/check.py

@@ -77,6 +77,9 @@ def choice(self):
         self._print_divider_line(console_width)
 
         for category in self.categories:
+            if len(category.items) == 0:
+                continue
+
             print_category(category.name)
             for item_index in range(len(category.items)):
                 item = category.items[item_index]