deppth -> deppth2

Author: xiaoxiao921

DEV.md

@@ -1,4 +1,4 @@
 python -m build --wheel
 python setup.py bdist_wheel
 
-pip install .\dist\deppth-0.1.5.0-py3-none-any.whl
+pip install .\dist\deppth2-0.1.5.0-py3-none-any.whl

README.md

@@ -1,17 +1,17 @@
-# deppth
-Decompress, Extract, and Pack for Pyre, Transistor, and Hades.
+# deppth2
+Decompress, Extract, and Pack for Pyre, Transistor, Hades and Hades 2.
 
-Deppth is a high-level I/O interface for package files in the games Transistor, Pyre, and Hades. Deppth provides both command-line and programmer interfaces.
+Deppth2 is a high-level I/O interface for package files in the games Transistor, Pyre, Hades and Hades 2. Deppth provides both command-line and programmer interfaces.
 
 ## Installation
 
-To install Deppth, download the latest [wheel](https://github.com/SGG-Modding/deppth/releases) and `pip install` it. Then read the following instructions to install dependencies.
+To install Deppth2, download the latest [wheel](https://github.com/SGG-Modding/deppth/releases) and `pip install` it. Then read the following instructions to install dependencies.
 
 ### Dependencies
 
-Deppth technically has no required dependencies outside of Python's core modules, but you may find its functionality very limited without also installing the following optional dependencies. If an optional dependency is missing, Deppth will abort an operation dependent on that module informing you of the missing module.
+Deppth2 technically has no required dependencies outside of Python's core modules, but you may find its functionality very limited without also installing the following optional dependencies. If an optional dependency is missing, Deppth2 will abort an operation dependent on that module informing you of the missing module.
 
-Packages primarily contain sprite sheets. Deppth uses Pillow to work with the image data within. If you plan to export/import sprite sheets to/from image files, you'll need to install that: `pip install pillow`.
+Packages primarily contain sprite sheets. Deppth2 uses Pillow to work with the image data within. If you plan to export/import sprite sheets to/from image files, you'll need to install that: `pip install pillow`.
 
 Hades uses LZ4 compression on its packages. If you plan to work with these packages, you'll want to install the LZ4 module: `pip install lz4`.
 
@@ -21,29 +21,29 @@ Transistor and Pyre both use LZF compression on their packages. If you plan to w
 
 Let's say we want to edit a spritesheet in Launch.pkg. First, we'll want to **extract** the package to get the individual assets out.
 
-    deppth ex Launch.pkg
+    deppth2 ex Launch.pkg
 
 This will create a folder called Launch in the current working directory. The texture atlases will be in the textures/atlases directory within there.
 
 Let's say I edit Launch_Textures02.png. Now, to rebuild the package, I'll want to **pack** this folder into a package again.
 
-    deppth pk -s Launch -t Launch.pkg
+    deppth2 pk -s Launch -t Launch.pkg
 
 If I then replace the package file in the game files with this package file, it should use my updated asset. But, suppose I'm trying to distribute a mod. I probably only want to distribute my change to the package, not the entire package. In that case, you probably want to build a patch for someone else to apply.
 
 To do this, you can use the **pack** command with the **entries** flag to only include any items you changed (this works similar to patterns in other CLI tools).
 
-    deppth pk -s Launch -t Launch_patch.pkg -e *Launch_Textures02*
+    deppth2 pk -s Launch -t Launch_patch.pkg -e *Launch_Textures02*
 
 I can then distribute Launch_patch.pkg and Launch_patch.pkg_manifest. To apply this patch to the actual package, one would need to place these files in the same folder and then use the **patch** command to perform the patching. 
 
-    deppth pt Launch.pkg Launch_patch.pkg
+    deppth2 pt Launch.pkg Launch_patch.pkg
 
 This will replace any entries in the package with any matching entries in the patches and append any new entries in the patches. More than one patch can be applied at a time (later ones take precedence if there are conflicts).
 
-## Deppth API
+## Deppth2 API
 
-The Deppth module exposes functions that perform the actions described above, plus a fourth (which is also part of the CLI) to list the contents of a package. It's basically just a programmer interface for the same things the CLI does -- the latter is just a wrapper for the former.
+The Deppth2 module exposes functions that perform the actions described above, plus a fourth (which is also part of the CLI) to list the contents of a package. It's basically just a programmer interface for the same things the CLI does -- the latter is just a wrapper for the former.
 
     list(name, *patterns, logger=lambda  s: None)
     extract(package, target_dir, *entries, subtextures=False, logger=lambda  s: None)
@@ -89,9 +89,9 @@ For example, here is a directory tree.
 
 Using the command line in order to create your package for your mod, the package name must include the ``Mod-GUID`` (ThunderstoreTeamName-ModName) in order to work with Hell2Modding.
 
-    deppth hpk -s NewDeppthPackage -t ThunderstoreTeamName-NewIconPackage
+    deppth2 hpk -s NewDeppthPackage -t ThunderstoreTeamName-NewIconPackage
 
-This will generate a folder called ThunderstoreTeamName-NewIconPackage in the parent directory that will be correctly formatted for deppth packaging, as well as 2 package files to use for your mod.
+This will generate a folder called ThunderstoreTeamName-NewIconPackage in the parent directory that will be correctly formatted for deppth2 packaging, as well as 2 package files to use for your mod.
 
 This will also generate the paths needed to be used in the game.
 
@@ -109,7 +109,7 @@ For example, if the package was in the folder by itself its file path in-game wo
 ### Args
 
     -s or --source is the name of the folder in which to recursively search for images
-    -t or --target is the name of the resulting folder to be packed by deppth, must be in the form of a mod GUID (ModAuthor-ModName).
+    -t or --target is the name of the resulting folder to be packed by deppth2, must be in the form of a mod GUID (ModAuthor-ModName).
     -c or --codec is to specify the image codec to use for packing, default is RGBA, often used is BC7 because of max chunk size being 32MB.
-    -dp or --deppthpack (not used above) set to anything but "True" to disable automatic Deppth Packing.
+    -dp or --deppthpack (not used above) set to anything but "True" to disable automatic Deppth2 Packing.
     -iH or --includehulls (not used above) set to anything but "False" to calculate hull points.

deppth-runner.py

@@ -0,0 +1,6 @@
+"""Convenience wrapper for running deppth2 directly from source tree."""
+
+from deppth2.cli import main
+
+if __name__ == '__main__':
+  main()

deppth/__main__.py

@@ -0,0 +1,4 @@
+"""__main__: executed when deppth2 directory is called as a script."""
+
+from .deppth2 import main
+main()

deppth/img.py

@@ -1,13 +1,13 @@
-"""Command-line interface for deppth functionality"""
+"""Command-line interface for deppth2 functionality"""
 import os
 import argparse
 import sys
 
-from .deppth import list_contents, pack, patch, extract
+from .deppth2 import list_contents, pack, patch, extract
 from .texpacking import build_atlases_hades
 
 def main():
-    parser = argparse.ArgumentParser(prog='deppth', description='Decompress, Extract, Pack for Pyre, Transistor, and Hades')
+    parser = argparse.ArgumentParser(prog='deppth2', description='Decompress, Extract, Pack for Pyre, Transistor, and Hades')
     subparsers = parser.add_subparsers(help='The action to perform', dest='action')
 
     # List parser
@@ -39,11 +39,11 @@ def main():
     patch_parser.set_defaults(func=cli_patch)
 
     # Pack textures
-    hadespack_parser = subparsers.add_parser('hadespack', help='Format images into an atlas and manifest for packing with deppth', aliases=['hpk'])
+    hadespack_parser = subparsers.add_parser('hadespack', help='Format images into an atlas and manifest for packing with deppth2', aliases=['hpk'])
     hadespack_parser.add_argument('-s', '--source', metavar='source', default='MyPackage', type=str, help='The directory to recursively search for images in, default is current folder')
     hadespack_parser.add_argument('-t', '--target', metavar='target', default='ThunderstoreTeamName-MyPackage', help='Filenames created will start with this plus a number')
     hadespack_parser.add_argument('-c', '--codec', metavar='codec', default = "RGBA", help='Specify the image codec to use for packing, default is RGBA, often used is BC7 because of max chunk size being 32MB')
-    hadespack_parser.add_argument('-dP', '--deppthpack', metavar='deppthpack', default='True', help='Automatically Pack your images and Manifest using deppth')
+    hadespack_parser.add_argument('-dP', '--deppthpack', metavar='deppthpack', default='True', help='Automatically Pack your images and Manifest using deppth2')
     hadespack_parser.add_argument('-iH', '--includehulls', metavar='includehulls', default = "False", help='Set to anything if you want hull points computed and added')
     hadespack_parser.set_defaults(func=cli_hadespack)
 
@@ -84,15 +84,15 @@ def cli_hadespack(args):
     target = args.target
     codec = args.codec
 
-    deppth = True
+    deppth2 = True
     if args.deppthpack != "True":
-        deppth = False
+        deppth2 = False
 
     hulls = False
     if args.includehulls != "False":
         hulls = True
 
-    build_atlases_hades(source, target, deppth, hulls, codec=codec)
+    build_atlases_hades(source, target, deppth2, hulls, codec=codec)
 
 def cli_patch(args):
     package = args.package