https://github.com/cssnr/hls-downloader-client
HLS Video Downloader Client
https://github.com/cssnr/hls-downloader-client
Last synced: 3 months ago
JSON representation
HLS Video Downloader Client
- Host: GitHub
- URL: https://github.com/cssnr/hls-downloader-client
- Owner: cssnr
- License: gpl-3.0
- Created: 2024-06-03T06:11:53.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-07-06T22:27:31.000Z (4 months ago)
- Last Synced: 2025-08-01T14:52:01.101Z (4 months ago)
- Language: Python
- Homepage: https://github.com/cssnr/hls-video-downloader
- Size: 99.6 KB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/cssnr/hls-downloader-client/releases/latest)
[](https://github.com/cssnr/hls-downloader-client/releases/latest)
[](https://github.com/cssnr/hls-downloader-client/stargazers)
[](https://github.com/cssnr/hls-downloader-client/actions/workflows/build.yaml)
[](https://github.com/cssnr/hls-downloader-client/actions/workflows/lint.yaml)
[](https://sonarcloud.io/summary/new_code?id=cssnr_hls-downloader-client)
[](https://github.com/cssnr/hls-downloader-client/graphs/commit-activity)
[](https://github.com/cssnr/hls-downloader-client)
[](https://github.com/cssnr/hls-downloader-client)
[](https://cssnr.github.io/)
[](https://discord.gg/wXy6m2X8wY)
[](https://ko-fi.com/cssnr)
# HLS Video Downloader Client
HLS Video Downloader Native Messaging Client for Windows, Linux and macOS.
[](https://github.com/cssnr/hls-downloader-client/releases/latest/download/install-win.exe)
[](https://github.com/cssnr/hls-downloader-client/releases/latest/download/install-linux.deb)
[](https://github.com/cssnr/hls-downloader-client/releases/latest/download/install-macos.pkg)
- Windows: [install-win.exe](https://github.com/cssnr/hls-downloader-client/releases/latest/download/install-win.exe)
- Linux: [install-linux.deb](https://github.com/cssnr/hls-downloader-client/releases/latest/download/install-linux.deb)
- macOS: [install-macos.pkg](https://github.com/cssnr/hls-downloader-client/releases/latest/download/install-macos.pkg)
> [!NOTE]
> On macOS you need to Ctrl+Click or Right-Click the .pkg and then choose Open to install.
This is the client for this Web Extension: https://github.com/cssnr/hls-video-downloader
## Browsers
Tested and working in the following browsers:
- Firefox
- Waterfox
- Edge
- Chrome
- Chromium
- Brave
- Opera
- Vivaldi
- Ghost
## Installing
Download and run the installer for your operating system from the latest
[release](https://github.com/cssnr/hls-downloader-client/releases/latest).
## Running From Source
This can be run directly from the `client.py` source file. To do this, all the configuration must be in place and
Python installed. You can either run the installer first or manually configure the app (see [More Info](#More-Info)).
Then, place the [client.bat](assets/client.bat) (Windows) or the [client.sh](assets/client.sh)
(Linux/macOS) into the installation directory and update it to point to your source `client.py` file.
Note: You may need to place an `ffmpeg` executable in the `src` directory on some operating systems.
```python
ffmpeg = shutil.which("ffmpeg")
if not ffmpeg:
ffmpeg = os.path.join(os.getcwd(), "ffmpeg")
```
Lastly, update the installed manifest file for your browser to point to the client.bat or client.sh.
This information is only here for advanced users.
Different operating systems and browsers have different requirements.
For this purpose, I created an [Installers](#Installing) for each OS.
For more details, see the [More Info](#More-Info) section below.
## Building
This guide is for reference only. The release builds are built with GitHub Actions.
See [build.yaml](.github/workflows/build.yaml) for more details.
### Windows
> [!NOTE]
> The Windows installer uses [Inno Setup](https://jrsoftware.org/isinfo.php)
> which must be manually installed.
Note: FFmpeg must be placed in `dist/ffmpeg.exe`
Build the App:
```shell
python -m pip install -r requirements.txt
pyinstaller --noconfirm client.spec
python manifest.py
```
Create the Installer:
```shell
iscc.exe client.iss
```
### Linux
Note: FFmpeg must be placed in `dist/ffmpeg`
```shell
#python -m pip install -r requirements.txt
python manifest.py
bash build-linux.sh
```
### MacOS
> [!NOTE]
> The macOS installer uses [Packages](http://s.sudre.free.fr/Software/Packages/about.html)
> which must be manually installed.
Note: FFmpeg must be placed in `dist/ffmpeg`
Build the App:
```shell
python -m pip install -r requirements.txt
pyinstaller --noconfirm client.spec
python manifest.py
```
Create the Package:
```shell
bash build-mac.sh
```
## More Info
Windows requires corresponding registry entries for the manifest files (see location links below).
Windows and macOS requires packaging the app with `pyinstaller` to bundle python.
Manifest files must be renamed to `org.cssnr.hls.downloader.json` on Linux and macOS.
Manifest key `path` must be set to the absolute path to the `client` location.
Manifest files must be placed in specific directories:
- Firefox: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_manifests#manifest_location
- Chrome: https://developer.chrome.com/docs/extensions/develop/concepts/native-messaging#native-messaging-host-location
The `client` location must be writable by the user and a writable `log.txt`
must be present in that location due to the current logging configuration in the [client.py](src/client.py).
The `client.py` must be executable by the user with Python installed and working.
# Contributing
Please consider making a donation to support the development of this project
and [additional](https://cssnr.com/) open source projects.
[](https://ko-fi.com/cssnr)
For a full list of current projects visit: [https://cssnr.github.io/](https://cssnr.github.io/)