anim stitcher docs

automation/anim_stitcher/stitcher.py

@@ -33,7 +33,7 @@ def check_sprite_exists(sprite_type: str, sprite_name: str) -> bool:
     return os.path.isdir(sprite_path)
 
 
-def stitch_images_and_write_to_disk(sprite_type: str, sprite_name: str, images: List[str], quantize: bool, fps: float) -> None:
+def stitch_images_and_write_to_disk(sprite_type: str, sprite_name: str, images: List[str], quantize: bool, fps: float, reverse_order: bool) -> None:
 
     # Load all the images
     images_to_stitch = []
@@ -70,9 +70,14 @@ def stitch_images_and_write_to_disk(sprite_type: str, sprite_name: str, images:
         "sheet_width": total_width,
         "published_at": time.strftime("%Y-%m-%d %H:%M:%S", time.gmtime()),
         "published_by": getpass.getuser(),
+        "fps": fps,
         "frames": []
     }
 
+    # Handle reverse order
+    if reverse_order:
+        images_to_stitch.reverse()
+
     # Add the metadata for each image
     x_offset = 0
     for image in images_to_stitch:

automation/anim_stitcher/ui.py

@@ -95,6 +95,15 @@ class AnimStitcherWindow(QtWidgets.QWidget):
         self.fps_layout.addWidget(self.fps_input)
         self.layout().addLayout(self.fps_layout)
 
+        # Add a checkbox to reverse the image order
+        self.reverse_layout = QtWidgets.QHBoxLayout()
+        self.reverse_label = QtWidgets.QLabel("Reverse Image Order")
+        self.reverse_layout.addWidget(self.reverse_label)
+        self.reverse_checkbox = QtWidgets.QCheckBox()
+        self.reverse_checkbox.setEnabled(False)
+        self.reverse_layout.addWidget(self.reverse_checkbox)
+        self.layout().addLayout(self.reverse_layout)
+
         # Add a seperator
         self.layout().addWidget(qt_lines.QHLine())
 
@@ -133,6 +142,7 @@ class AnimStitcherWindow(QtWidgets.QWidget):
             self.stitch_button.setEnabled(True)
             self.optimization_dropdown.setEnabled(True)
             self.fps_input.setEnabled(True)
+            self.reverse_checkbox.setEnabled(True)
 
             # Save the selected files
             self.selected_files = file_dialog.selectedFiles()
@@ -194,7 +204,7 @@ class AnimStitcherWindow(QtWidgets.QWidget):
 
         # Perform the actual stitching action
         stitcher.stitch_images_and_write_to_disk(
-            sprite_type, sprite_name, self.selected_files, self.optimization_dropdown.currentText() == "Size", float(self.fps_input.text()))
+            sprite_type, sprite_name, self.selected_files, self.optimization_dropdown.currentText() == "Size", float(self.fps_input.text()), self.reverse_checkbox.isChecked())
 
         # Close the window
         self.close()

docs/anim-stitcher.md

@@ -4,6 +4,26 @@
 
 ## Usage
 
+To launch `anim_stitcher`, you must first have all the Python dependencies installed. This means installing Python and pip, then running the following in the root of the project:
+
+```sh
+python3 -m pip install -r requirements.txt
+```
+
+*For help with this, contact Evan.*
+
+### Launching the tool
+
+If you are on a Linux system, you can launch the tool with `./launch_anim_stitcher.sh`. 
+
+Otherwise, open the project root folder, and run the `launch_anim_stitcher.bat` script. This will show a window similar to the following:
+
+![Anim Stitcher GUI](./anim_stitcher_gui.png)
+
+As you can see, I have already filled everything out for the `testFox` asset. 
+
+**When selecting PNGs:** Make sure you shift-click to select multiple files. You don't want a spritesheet with only one frame in it.
+
 ## Technical information
 
 `anim_stitcher` exports spritesheets to `game/dist/assets/anm/...`. Each spritesheet also has a metadata JSON file beside it. The filepaths are automatically chosen based on input in the GUI.

game/dist/assets/anm/chr/chr_testFox/chr_testFox.anim_meta.json

@@ -1,8 +1,9 @@
 {
     "sheet_height": 1080,
     "sheet_width": 34560,
-    "published_at": "2022-03-21 17:25:40",
+    "published_at": "2022-03-29 16:46:34",
     "published_by": "ewpratten",
+    "fps": 24.0,
     "frames": [
         {
             "x": 0,

requirements.txt

@@ -1,2 +1,3 @@
 pillow
-PySide2
+PySide2
+autopep8