Harmony Save workfile. Clean up before Zip and upload

8firebird8 · 9 July 2025 13:21

HI
I’m trying to find a way to modify the Harmony Save Workfile function.
The goal is to reduce the file size.
I need to complete two tasks on Workfile Save before it gets zipped and uploaded.

1st.) Clean up (empty) the “frames” folder in the Harmony project structure. Goal – Remove the preview TGAs generated from OpenGL preview.

2nd.) Keeping External Linked Palettes.

The save workfile will convert them to local and copy all the textures to the scene structure. Into the “palette-library” folder and changing the “PALETTE_LIST” file from our shared locations path to the local ones.

We have lots of bitmap textures, unnecessarily adding to the scene size on save and load.

In my simple mind, a solution would be to clean up the palette-library folder and simply replace the “PALETTE_LIST” file with one that has the correct paths. After the .xstage file got saved but before it gets zipped and uploaded.

As I’m not a coder, I tried to help myself with AI assistance.
It suggested implementing my functions directly in the Harmony addon.
Putting it in between the function which saves the .xstage file and before the zip_and_move function gets called.

I’m not sure if I should trust that, or are there maybe other better options to achieve that?

Any tips will help. Thanks

mustafa_jafar · 9 July 2025 20:27

Hello,
So, the save action is implemented here.
Feel free to tweak them and PRs are much welcomed

github.com/ynput/ayon-harmony

client/ayon_harmony/api/pipeline.py

bf247b6e4


      
          def save_workfile(self, filepath=None):
              return save_file(filepath)

github.com/ynput/ayon-harmony

client/ayon_harmony/api/workio.py

bf247b6e4


      
          def save_file(filepath):
              global save_disabled
              if save_disabled:
                  return ProcessContext.server.send(
                      {
                          "function": "show_message",
                          "args": "Saving in progress, please wait until it finishes."
                      })["result"]
          
              save_disabled = True
              temp_path = get_local_harmony_path(filepath)
          
              if ProcessContext.server:
                  if os.path.exists(temp_path):
                      try:
                          shutil.rmtree(temp_path)
                      except Exception as e:
                          raise Exception(f"cannot delete {temp_path}") from e
          
                  ProcessContext.server.send(

This file has been truncated. show original

8firebird8 · 10 July 2025 09:42

Great thanks.
Seems like I was on the right path.

Lets see if I can make it work.