pk3make 1.1.4__tar.gz → 2025.10.5__tar.gz

{pk3make-1.1.4 → pk3make-2025.10.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pk3make
-Version: 1.1.4
+Version: 2025.10.5
 Summary: Build system for Weissblatt PK3 files
 Project-URL: Homepage, https://github.com/liquidunderground/pk3make
 Project-URL: GitHub, https://github.com/liquidunderground/pk3make
@@ -19,9 +19,21 @@ Requires-Dist: natsort
 Requires-Dist: pillow
 Description-Content-Type: text/markdown
 
-# PK3Make
+# PK3Make - Build system for Weissblatt PK3 files
 
-"Make" for Weissblatt PK3 files
+[PK3] is a package format for game mods based on ZIP. Although originally introduced by Quake III Arena, it has been adopted by modern source ports of Doom and by extension Weissblatt.
+
+[PK3]: https://doomwiki.org/wiki/PK3
+
+PK3Make lets you automatically convert Textures, Flats, FADEs, color palettes, COLORMAPs and TINTTABs into lumps for Weissblatt and package them into a tidy PK3. Additional features include:
+
+- Deterministic PK3s - make sure that your project's PK3s are byte-for-byte reproducible
+- [METAINFO]-inspired syntax with support for sprite offsets, marker definitions and Glob-based LUMPDEFs
+- Bring your own PK3Makefile - Build different PK3s from the same asset tree
+- Multi-threaded building
+- Timestamp-based version checks - only build what's necessary as you develop
+
+[METAINFO]: https://mtrop.github.io/DoomTools/dimgconv.html
 
 ## Installation
 
@@ -110,8 +122,15 @@ outdated files into `?workdir` during the compilation process.
 
 `?palette:` defines the main color palette, by `LUMPNAME` (`PLAYPAL` by default)
 
-`?destfile:` describes a filepath to the destination PK3. This is where
-`?workdir` will get copied to during packing.
+`?destfile: <PATH>` describes a filepath to the destination PK3. This is where `?workdir` will get copied to during packing.
+
+`?compression: <TYPE>` and `?compression_level: <INT>` define file the destination PK3's compression method and level respectively. The following compression types are supported:
+
+1. `none | uncompressed`: Used to create uncompressed PK3s (default)
+2. `zlib`: zlib/DEFLATE-based compression.  (valid compression levels: `0...9`)
+3. `bzip2`: bzip2-based compression. (valid compression levels: `1...9`)
+4. `lzma`: LZMA compression.
+5. `zstd`: Zstandard compression (Python 3.14+; valid compression levels: `-131072...22`).
 
 
 ## Lump definitions

{pk3make-1.1.4 → pk3make-2025.10.5}/README.md

@@ -1,6 +1,18 @@
-# PK3Make
+# PK3Make - Build system for Weissblatt PK3 files
 
-"Make" for Weissblatt PK3 files
+[PK3] is a package format for game mods based on ZIP. Although originally introduced by Quake III Arena, it has been adopted by modern source ports of Doom and by extension Weissblatt.
+
+[PK3]: https://doomwiki.org/wiki/PK3
+
+PK3Make lets you automatically convert Textures, Flats, FADEs, color palettes, COLORMAPs and TINTTABs into lumps for Weissblatt and package them into a tidy PK3. Additional features include:
+
+- Deterministic PK3s - make sure that your project's PK3s are byte-for-byte reproducible
+- [METAINFO]-inspired syntax with support for sprite offsets, marker definitions and Glob-based LUMPDEFs
+- Bring your own PK3Makefile - Build different PK3s from the same asset tree
+- Multi-threaded building
+- Timestamp-based version checks - only build what's necessary as you develop
+
+[METAINFO]: https://mtrop.github.io/DoomTools/dimgconv.html
 
 ## Installation
 
@@ -89,8 +101,15 @@ outdated files into `?workdir` during the compilation process.
 
 `?palette:` defines the main color palette, by `LUMPNAME` (`PLAYPAL` by default)
 
-`?destfile:` describes a filepath to the destination PK3. This is where
-`?workdir` will get copied to during packing.
+`?destfile: <PATH>` describes a filepath to the destination PK3. This is where `?workdir` will get copied to during packing.
+
+`?compression: <TYPE>` and `?compression_level: <INT>` define file the destination PK3's compression method and level respectively. The following compression types are supported:
+
+1. `none | uncompressed`: Used to create uncompressed PK3s (default)
+2. `zlib`: zlib/DEFLATE-based compression.  (valid compression levels: `0...9`)
+3. `bzip2`: bzip2-based compression. (valid compression levels: `1...9`)
+4. `lzma`: LZMA compression.
+5. `zstd`: Zstandard compression (Python 3.14+; valid compression levels: `-131072...22`).
 
 
 ## Lump definitions

{pk3make-1.1.4 → pk3make-2025.10.5}/examples/PK3Makefile

@@ -29,6 +29,7 @@
 
 PLAYPAL palette
 PAL* palette
+CREDITS.txt raw preserve_filename
 CLM0031 colormap PAL0031
 COLORMAP colormap PLAYPAL
 TRANS50 tinttab PAL0031 0.5

{pk3make-1.1.4 → pk3make-2025.10.5}/src/pk3make/__main__.py

@@ -111,7 +111,7 @@ def build(makefile):
 
 
 
-            for lump in natsorted(lumpglob, alg=ns.PATH):
+            for lump in natsorted(lumpglob, alg=ns.PATH, key=lambda x: x[1]):
                 lump_dcheck = doomglob.find_lump(opts["srcdir"], lump[0])
 
                 srcfile = opts["srcdir"] + '/' + lump[1]
@@ -145,7 +145,7 @@ def build(makefile):
     return
 
 def pack(makefile):
-    from .modules import pk3zip, doomglob
+    from .modules import pk3zip, doomglob, pk3makefile
     from natsort import natsorted, ns
     import io, os, hashlib, pathlib, re
 
@@ -153,7 +153,10 @@ def pack(makefile):
     if opts["destfile"] == None:
         raise FileNotFoundError("destfile is not defined")
 
-    print("# Packing")
+    compression = pk3makefile.Compression[opts["compression"]]
+    compression_level = int(opts["compression_level"])
+
+    print(f"# Packing (compression: {opts["compression"]} @ lv {opts["compression_level"]})")
     
     # Keep PK3 file in memory to avoid Windows' file access locks
     pk3buf = io.BytesIO()
@@ -169,17 +172,17 @@ def pack(makefile):
                 if args.verbose:
                     print(f"## Adding marker {lumpdef[0]}")
                 with pk3zip.PK3File(pk3buf, "a") as pk3:
-                    pk3.writestr(lumpdef[0], "")
+                    pk3.writestr(lumpdef[0], "", compress_type=compression, compresslevel=compression_level)
             case _:
                 params = re.match(r"\s*([\w]+)\s*", lumpdef[2] or '')
                 searchname = os.path.dirname(lumpdef[0])+'/'+pathlib.Path(lumpdef[0]).stem[:8]
                 if params != None and "preserve_filename" in params.groups():
                     searchname = lumpdef[0]
                 
-                with pk3zip.PK3File(pk3buf, "a") as pk3:
+                with pk3zip.PK3File(pk3buf, "a", compression=compression, compresslevel=compression_level) as pk3:
 
                     wf_glob = doomglob.find_lump(opts["workdir"], searchname)
-                    wf_glob = natsorted(wf_glob, alg=ns.PATH)
+                    wf_glob = natsorted(wf_glob, alg=ns.PATH, key=lambda x: x[1])
 
                     #print(f'\nGLOB: {wf_glob}\n')
                     #print(f'NAMELIST: {pk3.namelist()}\n')
@@ -201,7 +204,7 @@ def pack(makefile):
                         if args.verbose:
                             print(f'## Packing lump {arcpath}')    
 
-                        pk3.write(wf_path, arcpath)
+                        pk3.write(wf_path, arcpath, compress_type=compression, compresslevel=compression_level)
 
     
     # Commit in-memory PK3 file to disk

{pk3make-1.1.4 → pk3make-2025.10.5}/src/pk3make/modules/pk3makefile.py

@@ -6,6 +6,17 @@ class PK3MakeDependencyError(Exception):
     """To be raised when a lump should really be unique"""
     pass
 
+import enum,zipfile
+
+Compression = {
+    "none"            :   zipfile.ZIP_STORED,
+    "uncompressed"    :   zipfile.ZIP_STORED,
+    "lzma"            :   zipfile.ZIP_LZMA,
+    "bzip2"           :   zipfile.ZIP_BZIP2,
+    "zlib"            :   zipfile.ZIP_DEFLATED,
+    #zstd            =   zipfile.ZIP_ZSTANDARD
+}
+
 class PK3Makefile():
     #def __init__(self):
         #pass
@@ -18,6 +29,8 @@ class PK3Makefile():
             "workdir": None,
             "destfile": None,
             "palette": None,
+            "compression": None,
+            "compression_level": None,
         }
 
         self.lumps = []
@@ -34,7 +47,7 @@ class PK3Makefile():
                 tokens = re.match(re_buildopt, workline)
                 if tokens: # Is it a Buildopt?
                     match tokens.group(1):
-                        case "srcdir" | "workdir" | "destfile" | "palette" as cmd:
+                        case "srcdir" | "workdir" | "destfile" | "palette" | "compression" | "compression_level" as cmd:
                             self.options[cmd] = tokens.group(2).rstrip('/')
                 tokens = re.match(re_lumpdef, workline)
                 if tokens: # Is it a Lumpdef?