generated .vmts now save to the correct folder

Author: snake-biscuits

README.md

@@ -6,7 +6,7 @@
 #
 # You should have received a copy of the license along with this
 # work. If not, see <http://creativecommons.org/licenses/by-sa/4.0/>.
-"""generate .vmt files from a folder of .vtf files (from a template .vmt)"""
+"""generate .vmt files from a folder of .vtf files"""
 from __future__ import annotations
 import argparse
 import fnmatch
@@ -15,15 +15,15 @@
 from typing import Dict, List, Tuple
 
 from colour import Color
-from gooey import Gooey
+# from gooey import Gooey
 
-import vtf
+# import VTFLibWrapper
 
 
 __version__ = "1.0.0"
 
 
-def from_template(template: str, vtf_filename: str, **substitutions: Dict[str, str]):
+def from_template(vtf_filename: str, template: str, **substitutions: Dict[str, str]):
     """Generate .vmts from `template` for every .vtf in `folder`"""
     # example usage:
     # from_template("LightmappedGeneric{$basetexture <filename>}", "materials/folder")
@@ -34,30 +34,31 @@ def from_template(template: str, vtf_filename: str, **substitutions: Dict[str, s
         # '$basetexture2 <texture2>' --> '"$blendmodulatetexture" "<filename>_bm"'
         # then at the file level: '<filename>_bm' -> 'texture_bm' for "texture.vmt"
     # NOTE: never put filename in replacements unless you want to replace all textures with one texture!
-    filename = os.splitext(vtf_filename)  # remove .vtf extension
+    filename = os.path.splitext(vtf_filename)[0]  # remove .vtf extension
     with open(f"{filename}.vmt", "w") as vmt_file:
         vmt_file.write(template.replace("<filename>", filename))
 
 
 # TODO: maybe separate file filtering from .vmt writing?
 def from_metadata(vtf_filename: str, shader: str = "LightmappedGeneric", **flags: Dict[str, Tuple[str, str]]):
-    """filename shouldn't have an extension"""
+    """generate an appropriate .vmt from .vmt flags"""
     raise NotImplementedError()
     # * EXPECTED FLAGS *
     # has_alpha: bool   // vtf is transparent e.g. {"has_alpha": "$translucent": 1}
     # colour: Color     // fuzzy colour detection
     # hue_range: float  // [0-1]; how close the texture's hue should be to colour
 
-    filename = os.path.splitext(vtf_filename)
-    vtf_header = vtf.Vtf.from_file(f"{filename}.vtf").header
+    filename = os.path.splitext(vtf_filename)[0]
+
+    vtf = ...  # TODO: load f"{filename}.vtf" with VTFLibWrapper
     # check flags
     if "color" in flags:
         flags["colour"] = flags.pop("color")
     if "transparent" in flags:
         flags["has_alpha"] = flags.pop("transparent")
     checks: Dict[str, bool]
-    checks = {"colour": fuzzy_colour_match(vtf_header.reflectivity, flags["colour"], flags.get("hue_range", 0)),
-              "has_alpha": vtf_header.image_format in vtf.transparent_formats,
+    checks = {"colour": fuzzy_colour_match(vtf.reflectivity, flags["colour"], flags.get("hue_range", 0)),
+              "has_alpha": has_alpha(vtf),
               None: None}
     # ^ {"flag": True or False}
     metadata = {f: checks.get(f, None) for f in flags}
@@ -79,12 +80,17 @@ def fuzzy_colour_match(a: Color, b: Color, hue_range: float) -> bool:
     return abs(a.hsl[0] - b.hsl[0]) <= hue_range
 
 
-def process_folder(method: str, folders: List[str], ignore=[], recursive=False, verbose=False, **kwargs):
+def has_alpha(vtf) -> bool:
+    raise NotImplementedError()
+    return vtf.image_format in (...)
+
+
+def parse_folder(method: str, folders: List[str], template=None, ignore=[], recursive=False, verbose=False, **kwargs):
     # pre-processing
     ignore_patterns = [re.compile(p) for p in ignore]
     if method == "template":
         # kwargs["substutions"]: Dict[str, str] = {"keyword": "replacement"}
-        template = open(kwargs.pop("template")).read()
+        template = open(template).read()
         # NOTE: the "template" kwarg must be supplied! [process_folder(..., template="base.vmt")]
         # template substitutions
         for keyword, replacement in kwargs.pop("substitutions", dict()).items():
@@ -98,11 +104,11 @@ def process_folder(method: str, folders: List[str], ignore=[], recursive=False,
 
     # parse all folders
     for folder in folders:
+        folder_contents = [os.path.join(f) for f in os.listdir(folder)]
         if recursive:
-            folder_contents = [os.path.join(f) for f in os.listdir(folder)]
             folders.extend([d for d in folder_contents if os.path.isdir(d)])
         for vtf_filename in fnmatch.filter(folder_contents, "*.vtf"):
-            filename = os.path.join(folder, os.path.splitext(vtf_filename))
+            filename = os.path.join(folder, os.path.splitext(vtf_filename)[0])
             if any([pattern.match(filename) for pattern in ignore_patterns]):
                 if verbose:
                     print("Skipping {filename}.vmt")
@@ -111,14 +117,15 @@ def process_folder(method: str, folders: List[str], ignore=[], recursive=False,
             if verbose:
                 print(f"Writing {filename}.vmt... ", end="")
             if method == "template":
-                from_template(vtf_filename, template)
+                from_template(filename, template)
             elif method == "metadata":
-                from_metadata(vtf_filename, **kwargs)
+                # TODO: do a keyword substitution pass on flags.values
+                from_metadata(filename, **kwargs)
             if verbose:
                 print("Done!")
 
 
-@Gooey
+# @Gooey
 def main(with_args: List[str] = None):
     notes = ["You can drag any folder over %(prog)s and just use the defaults",
              "--template (default: base.vmt next to %(prog)s) must have a <filename> keyword!",
@@ -134,15 +141,17 @@ def main(with_args: List[str] = None):
     mode = parser.add_mutually_exclusive_group()
     mode.add_argument("-t", "--template", default="base.vmt",
                       help="generate vmts from the supplied template\ndefault: base.vmt")
-    mode.add_argument("-m", "--metadata", action="store_true")
+    mode.add_argument("-m", "--metadata", action="store_true",
+                      help="generate each .vmt based on flags set in the .vtf\nNOT IMPLEMENTED YET")
     parser.add_argument("-f", "--flags",
-                        help="colon separated metadata flags\n(e.g. has_alpha:$translucent:1)")
+                        help="colon separated metadata flags\n(e.g. has_alpha:$translucent:1)\nNOT IMPLEMENTED YET")
+    # TODO: set vmt shader (default: LightmappedGeneric)
     # TODO: list all available flags
-    parser.add_argument("-s", "--substitute", action="append", metavar="KEYWORD:REPLACEMENT", dest="subs",
-                        help="substitute <KEYWORD> in template with REPLACEMENT\n(e.g. `bumpmap:<filename>_bump`)")
+    parser.add_argument("-s", "--substitute", action="append", metavar="keyword:replacement", default=[],
+                        help="substitute <keyword> in template with replacement\n(e.g. `bumpmap:<filename>_bump`)")
     parser.add_argument("-r", "--recurse", action="store_true",
-                        help="generate .vmts for all folders within FOLDER")
-    parser.add_argument("-i", "--ignore", action="append", metavar="PATTERN", nargs="*",
+                        help="generate .vmts for all folders within folder")
+    parser.add_argument("-i", "--ignore", action="append", metavar="patterns", nargs="*", default=[],
                         help="skip <filename> if it matches any of the given patterns")
     # TODO: --generate (metadata based .vmt & adding / removing relevant key-value pairs [no template])
     # TODO: --surfaceprop choice to add a surfaceprop
@@ -157,15 +166,15 @@ def main(with_args: List[str] = None):
         args = parser.parse_args()
 
     # if not args.metadata:  # template mode
-    replacements = {k.strip("<>"): v for a in args.replace for k, v in a.split(":")}
+    replacements = {k.strip("<>"): v for a in args.substitute for k, v in a.split(":")}
     # replacements are colon separated; < & > around the keyword are optional
     # setting filename will give all make all .vmts generated identical! even the basetexture!
-    process_folder("template", args.template, args.folders,
-                   ignore=args.ignore, verbose=args.verbose, substitutions=replacements)
+    parse_folder("template", args.folders, template=args.template, substitutions=replacements,
+                 ignore=args.ignore, verbose=args.verbose)
     # else:  # metadata mode
     # flags = {f: (p, v) for m in args.metadata for f, p, v in m.split(":")}
-    # process_folder("metadata", args.folders,
-    #                ignore=args.ignore, verbose=args.verbose, flags=flags)
+    # process_folder("metadata", args.folders, flags=flags,
+    #                ignore=args.ignore, verbose=args.verbose)
 
 
 if __name__ == "__main__":

batch_vmt.py

@@ -0,0 +1,4 @@
+"LightmappedGeneric"
+{
+	"$basetexture" "<texture>"
+}

tests/materials/0_0.vmt

@@ -0,0 +1,4 @@
+"LightmappedGeneric"
+{
+	"$basetexture" "<texture>"
+}

tests/materials/0_1.vmt

@@ -0,0 +1,4 @@
+"LightmappedGeneric"
+{
+	"$basetexture" "<texture>"
+}

tests/materials/0_10.vmt

@@ -0,0 +1,4 @@
+"LightmappedGeneric"
+{
+	"$basetexture" "<texture>"
+}

tests/materials/0_11.vmt

@@ -0,0 +1,4 @@
+"LightmappedGeneric"
+{
+	"$basetexture" "<texture>"
+}

tests/materials/0_12.vmt

@@ -0,0 +1,4 @@
+"LightmappedGeneric"
+{
+	"$basetexture" "<texture>"
+}

tests/materials/0_13.vmt

@@ -0,0 +1,4 @@
+"LightmappedGeneric"
+{
+	"$basetexture" "<texture>"
+}

tests/materials/0_14.vmt

@@ -0,0 +1,4 @@
+"LightmappedGeneric"
+{
+	"$basetexture" "<texture>"
+}