mirror of
https://github.com/unshackle-dl/unshackle.git
synced 2026-11-12 20:15:10 +00:00
imSp4rky
c7ab04028a
setup downloads the external tools, writes a first config and imports CDM devices; install.sh and install.bat bootstrap uv and run it.
62 lines
2.5 KiB
Markdown
62 lines
2.5 KiB
Markdown
<p align="center">
|
|
<img width="16" height="16" alt="no_encryption" src="https://github.com/user-attachments/assets/6ff88473-0dd2-4bbc-b1ea-c683d5d7a134" /> unshackle
|
|
<br/>
|
|
<sup><em>Movie, TV, and Music Archival Software</em></sup>
|
|
<br/>
|
|
<a href="https://discord.gg/mHYyPaCbFK">
|
|
<img src="https://img.shields.io/discord/1395571732001325127?label=&logo=discord&logoColor=ffffff&color=7289DA&labelColor=7289DA" alt="Discord">
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="#install">Install</a> ·
|
|
<a href="https://docs.unshackle.dev">Docs</a> ·
|
|
<a href="https://discord.gg/mHYyPaCbFK">Discord</a>
|
|
</p>
|
|
|
|
---
|
|
|
|
A modular archival tool for movies, TV, and music. Fork of [Devine](https://github.com/devine-dl/devine/) with DASH/HLS/ISM parsing, Widevine & PlayReady DRM, and a REST API.
|
|
|
|
<p align="center">
|
|
<a href="https://asciinema.org/a/ldMiqYFFTgPAOxW7">
|
|
<img src="https://asciinema.org/a/ldMiqYFFTgPAOxW7.svg" alt="unshackle demo" width="700">
|
|
</a>
|
|
</p>
|
|
|
|
## Install
|
|
|
|
The recommended way is a git clone with the install script. The script installs `uv` and unshackle, then runs `unshackle setup` to download the external tools and write a first config.
|
|
|
|
```shell
|
|
git clone https://github.com/unshackle-dl/unshackle.git
|
|
cd unshackle
|
|
sh install.sh # Windows: .\install.bat
|
|
uv run unshackle env check
|
|
```
|
|
|
|
In a clone, run every command as `uv run unshackle ...`.
|
|
|
|
> [!NOTE]
|
|
> Advanced: `uv tool install git+https://github.com/unshackle-dl/unshackle.git` installs unshackle into the tool folder of `uv`, not a folder that you choose. `unshackle setup` then puts the tools, config, and data in your user data and config directories. See [Installation](https://docs.unshackle.dev/getting-started/installation/) for details.
|
|
|
|
### Requirements
|
|
|
|
External tools. (recommended versions):
|
|
|
|
- [Python](https://www.python.org/) - 3.11 - 3.14
|
|
- [uv](https://docs.astral.sh/uv/) - ≥ 0.5
|
|
- [FFmpeg](https://ffmpeg.org/) - ≥ 6.0
|
|
- [MKVToolNix](https://mkvtoolnix.download/) - ≥ 80
|
|
- [shaka-packager](https://github.com/shaka-project/shaka-packager/releases) - 2.6.1, or ≥ 3.10.0
|
|
|
|
Optional:
|
|
|
|
- [Bento4](https://github.com/axiomatic-systems/Bento4) - ≥ 1.6.0-639
|
|
- [dovi_tool](https://github.com/quietvoid/dovi_tool) - ≥ 2.1
|
|
- [SubtitleEdit](https://github.com/SubtitleEdit/subtitleedit/releases) - ≥ 5.0 (`SeConv` CLI)
|
|
|
|
## License
|
|
|
|
[GPL-3.0](LICENSE). Do not use unshackle for content you do not have the rights to. Keep the core free and open. Keep service code private. Be kind.
|