Unshackle - Modular Movie, TV, and Music Archival Software

[WhiskeyJack]

I have created a new folder and made code changes in the most recent push. This update will help resolve any confusion regarding binaries and PATH issues. Inside the "unshackle" folder, there is a subfolder called "binaries" where you can place everything. Please refer to the attached image for the naming conventions to follow.

For example, "shaka-packager" should be searched for as "packager-win-x64.exe," etc.


[Attachment 87945 - Click to enlarge]

cool. but you may need to edit for linux users, some systems have shaka-packager in the repos but the system call is packager.

unshackle env check
                                                                                
                ▄• ▄▌ ▐ ▄ .▄▄ ·  ▄ .▄ ▄▄▄·  ▄▄· ▄ •▄ ▄▄▌  ▄▄▄ .                 
                █▪██▌•█▌▐█▐█ ▀. ██▪▐█▐█ ▀█ ▐█ ▌▪█▌▄▌▪██•  ▀▄.▀·                 
                █▌▐█▌▐█▐▐▌▄▀▀▀█▄██▀▐█▄█▀▀█ ██ ▄▄▐▀▀▄·██▪  ▐▀▀▪▄                 
                ▐█▄█▌██▐█▌▐█▄▪▐███▌▐▀▐█ ▪▐▌▐███▌▐█.█▌▐█▌▐▌▐█▄▄▌                 
                 ▀▀▀ ▀▀ █▪ ▀▀▀▀ ▀▀▀ · ▀  ▀ ·▀▀▀ ·▀  ▀.▀▀▀  ▀▀▀                  
                   v 3.3.3 Copyright © 2019-2025 rlaphoenix                     
                              v 1.0.1 - unshackle                               
                                                                                
                                                                                
                                  Dependencies                                  
     ┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓     
     ┃ Name               ┃  Installed  ┃ Path                            ┃     
     ┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩     
     │ CCExtractor        │      ✔      │ /usr/local/bin/ccextractor      │     
     │ FFMpeg             │      ✔      │ /usr/bin/ffmpeg                 │     
     │ MKVToolNix         │      ✔      │ /usr/bin/mkvmerge               │     
     │ Shaka-Packager     │     ❌      │ Not Found                       │     
     │ N_m3u8DL-RE        │      ✔      │ /usr/bin/n-m3u8dl-re            │     
     │ Aria2(c)           │      ✔      │ /usr/bin/aria2c                 │     
     └────────────────────┴─────────────┴─────────────────────────────────┘

on arch

yay shaka-packager
1 aur/shaka-packager-bin 3.4.2-1 (+0 0.00) (Installed)
    A tool and a media packaging SDK for DASH and HLS packaging and encryption.
==> Packages to install (eg: 1 2 3, 1-3 or ^4)
==> 
------
shaka-packager --version
packager version v3.4.2-c819dea-release
------
packager --version
packager version v3.4.2-c819dea-release

[PunchDrunkL0ve]

+1 for packager-win-x64 ----> shaka-packager

[ImSp4rky]

I have created a new folder and made code changes in the most recent push. This update will help resolve any confusion regarding binaries and PATH issues. Inside the "unshackle" folder, there is a subfolder called "binaries" where you can place everything. Please refer to the attached image for the naming conventions to follow.

For example, "shaka-packager" should be searched for as "packager-win-x64.exe," etc.


[Attachment 87945 - Click to enlarge]

cool. but you may need to edit for linux users, some systems have shaka-packager in the repos but the system call is packager.

unshackle env check
                                                                                
                ▄• ▄▌ ▐ ▄ .▄▄ ·  ▄ .▄ ▄▄▄·  ▄▄· ▄ •▄ ▄▄▌  ▄▄▄ .                 
                █▪██▌•█▌▐█▐█ ▀. ██▪▐█▐█ ▀█ ▐█ ▌▪█▌▄▌▪██•  ▀▄.▀·                 
                █▌▐█▌▐█▐▐▌▄▀▀▀█▄██▀▐█▄█▀▀█ ██ ▄▄▐▀▀▄·██▪  ▐▀▀▪▄                 
                ▐█▄█▌██▐█▌▐█▄▪▐███▌▐▀▐█ ▪▐▌▐███▌▐█.█▌▐█▌▐▌▐█▄▄▌                 
                 ▀▀▀ ▀▀ █▪ ▀▀▀▀ ▀▀▀ · ▀  ▀ ·▀▀▀ ·▀  ▀.▀▀▀  ▀▀▀                  
                   v 3.3.3 Copyright © 2019-2025 rlaphoenix                     
                              v 1.0.1 - unshackle                               
                                                                                
                                                                                
                                  Dependencies                                  
     ┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓     
     ┃ Name               ┃  Installed  ┃ Path                            ┃     
     ┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩     
     │ CCExtractor        │      ✔      │ /usr/local/bin/ccextractor      │     
     │ FFMpeg             │      ✔      │ /usr/bin/ffmpeg                 │     
     │ MKVToolNix         │      ✔      │ /usr/bin/mkvmerge               │     
     │ Shaka-Packager     │     ❌      │ Not Found                       │     
     │ N_m3u8DL-RE        │      ✔      │ /usr/bin/n-m3u8dl-re            │     
     │ Aria2(c)           │      ✔      │ /usr/bin/aria2c                 │     
     └────────────────────┴─────────────┴─────────────────────────────────┘

on arch

yay shaka-packager
1 aur/shaka-packager-bin 3.4.2-1 (+0 0.00) (Installed)
    A tool and a media packaging SDK for DASH and HLS packaging and encryption.
==> Packages to install (eg: 1 2 3, 1-3 or ^4)
==> 
------
shaka-packager --version
packager version v3.4.2-c819dea-release
------
packager --version
packager version v3.4.2-c819dea-release

Fixed a slight bug in env check and few other locations wasn't actually using the binaries.find but was using old shutil.which so if the files aren't in the PATH it won't work so now it will prioritise the binaries folder then anywhere else on the machine. env check now includes more information of "Required" files and "Optional"


[Attachment 87959 - Click to enlarge]

Also fixed env info not loading correctly.

[PunchDrunkL0ve]

Thanks ImSp4rky


Any chance we could have the audio track set as default during muxing? Thanks.

https://github.com/unshackle-dl/unshackle/blob/1b9fbe340174691dd08e2235c4725a958fbe647...tracks.py#L325

       for i, at in enumerate(self.audio):
            if not at.path or not at.path.exists():
                raise ValueError("Audio Track must be downloaded before muxing...")
            events.emit(events.Types.TRACK_MULTIPLEX, track=at)
            cl.extend(
                [
                    "--track-name", 
                    f"0:{at.get_track_name() or ''}",
                    "--language", 
                    f"0:{at.language}",
                    "--default-track", 
                    f"0:{i == 0}",
                    "--visual-impaired-flag", 
                    f"0:{at.descriptive}",
                    "--original-flag", 
                    f"0:{at.is_original_lang}",
                    "--compression", 
                    "0:none",  # disable extra compression
                    "(", str(at.path), ")"
                ]
            )

[ImSp4rky]

Thanks ImSp4rky


Any chance we could have the audio track set as default during muxing? Thanks.

https://github.com/unshackle-dl/unshackle/blob/1b9fbe340174691dd08e2235c4725a958fbe647...tracks.py#L325

       for i, at in enumerate(self.audio):
            if not at.path or not at.path.exists():
                raise ValueError("Audio Track must be downloaded before muxing...")
            events.emit(events.Types.TRACK_MULTIPLEX, track=at)
            cl.extend(
                [
                    "--track-name", 
                    f"0:{at.get_track_name() or ''}",
                    "--language", 
                    f"0:{at.language}",
                    "--default-track", 
                    f"0:{i == 0}",
                    "--visual-impaired-flag", 
                    f"0:{at.descriptive}",
                    "--original-flag", 
                    f"0:{at.is_original_lang}",
                    "--compression", 
                    "0:none",  # disable extra compression
                    "(", str(at.path), ")"
                ]
            )

Default track is set by is_original_lang = true inside the get_tracks

Method 1: Set during Audio track creation

  tracks.add(Audio(
      id=audio_id,
      url=audio_url,
      language=audio_language,
      is_original_lang=True,  # or some condition
      # other parameters...
  ))

Method 2: Set after track creation

  track = Audio(id=audio_id, url=audio_url, language=audio_language)
  track.is_original_lang = True
  tracks.add(track)

Method 3: Compare with title language

is_original_lang=is_close_match(audio_language, [title.language])

Method 4: Check if it matches original content language

is_original_lang=is_close_match(x["code"], [title.language])

The key is to determine which audio track represents the original language of the content and set is_original_lang=True for that track only.

It will be down to you to identify the correct audio for the show/movie and flag it within the service, I was tempted to set it if audio tracks only = 1 but if its 1 track its already selected when playing.

[PunchDrunkL0ve]

It will be down to you to identify the correct audio for the show/movie and flag it within the service, I was tempted to set it if audio tracks only = 1 but if its 1 track its already selected when playing.

OK thanks.
Some (older) players require the default tag even if there is only one audio track so it would be nice to have it

[mickmars]

How would I completely thoroughly uninstall every single trace of unshackle and UV to start over ?

[ImSp4rky]

It will be down to you to identify the correct audio for the show/movie and flag it within the service, I was tempted to set it if audio tracks only = 1 but if its 1 track its already selected when playing.

OK thanks.
Some (older) players require the default tag even if there is only one audio track so it would be nice to have it

I'll look at making a config change if you want that feature.

[ImSp4rky]

How would I completely thoroughly uninstall every single trace of unshackle and UV to start over ?

delete the folder if you installed via git clone and uv sync. But if you installed with uv tool install use

uv tool uninstall unshackle

That will remove every trace of it.

[PunchDrunkL0ve]

It will be down to you to identify the correct audio for the show/movie and flag it within the service, I was tempted to set it if audio tracks only = 1 but if its 1 track its already selected when playing.

OK thanks.
Some (older) players require the default tag even if there is only one audio track so it would be nice to have it

I'll look at making a config change if you want that feature.

That would be very much appreciated

[Danker1990]

has uktv changed its code or method of connecting as tried both scripts ànd i get this.

[PSXman_uk]

What is the command you are using ? I have no issues so far with U

[phased]

If you've made a local repo for unshackle and made changes, such as to unshackle/unshackle.yaml and services/ ,then git allows you to keep the changes with a bit of commitment. (pun intended)

This is the process I've just followed to allow me to keep unshackle.yaml; unshackle/services/ and vaults/HTTPAPI.py and pull new changes from the online repo.

git add . 
git commit -m 'keep local changes '
git pull

(Note the full stop after git add )

[PunchDrunkL0ve]

I believe .gitignore now works as intended and `git pull` doesn't overwrite services, vaults and unshackle.yaml anymore, at least on my setup

[PSXman_uk]

phased how do you revert the change

git add .
git commit -m 'keep local changes '
git pull

[WhiskeyJack]

git revert

[phased]

I believe .gitignore now works as intended and `git pull` doesn't overwrite services, vaults and unshackle.yaml anymore, at least on my setup

That wasn't the case for me. .gitignore and .gitattributes get over-written by the pull and what is in them doesn't appear to stop the yaml and services being clobbered.