Files
TwinVine/README.md
T

126 lines
5.3 KiB
Markdown
Raw Normal View History

2025-08-25 11:20:53 +01:00
**TwinVine**
2025-08-25 11:20:20 +01:00
2025-08-25 11:21:33 +01:00
![TwinVine GUI](https://github.com/vinefeeder/TwinVine/blob/main/images/vinefeederA.png)
2025-08-24 15:26:26 +01:00
2025-08-24 14:33:48 +01:00
2025-08-24 14:47:44 +01:00
TwinVine is the home of TWO packages [Vinefeeder](https://github.com/vinefeeder/TwinVine/blob/main/packages/vinefeeder/src/vinefeeder/README.md)
and [Envied](https://github.com/vinefeeder/TwinVine/blob/main/packages/envied/README.md)
2025-08-24 14:33:48 +01:00
TwinVine is the easy way to handle your download tasks.
2025-08-25 14:30:01 +01:00
* When you have an exact program url - just use envied as a command line call.
* When you only have the program name - just start with a search in vinefeeder.
* When you dont know what you want; use the browse function.
* Browse media categories like Film, Drama or Sport, for a selected service.
* Batch Mode: select multiple downloads from various services and download all together.
2025-08-24 14:33:48 +01:00
2025-08-24 14:37:01 +01:00
**usage**
2025-08-24 14:42:25 +01:00
```
2025-08-25 14:30:01 +01:00
uv run envied dl (options) (service) (program url)
2025-08-24 14:38:01 +01:00
2025-09-03 22:27:25 +01:00
uv run vinefeeder - to open the interactive GUI for search, browse, etc.
2025-09-13 10:27:03 +01:00
To go to the command line use of 'envied' after using the GUI: close the GUI directly, or ctrl+c in terminal.
2025-08-24 14:42:25 +01:00
```
2025-08-24 14:37:01 +01:00
**Installation**
2025-08-24 14:33:48 +01:00
2025-08-24 14:39:26 +01:00
Uv is the package manager and loads both VineFeeder and Envied together. Envied runs independenly or may be called by Vinefeeder.
2025-08-24 14:33:48 +01:00
2025-08-26 10:52:24 +01:00
If you do not alrealy have uv as a python package install it first, using pip -
2025-08-25 19:36:03 +01:00
```
pip install uv
or
python3 -m pip install uv
```
2025-08-26 10:52:24 +01:00
Then install TwinVine; the following installs the latest version directly from the GitHub repository:
2025-08-24 14:33:48 +01:00
```shell
git clone https://github.com/vinefeeder/TwinVine.git
cd TwinVine
uv clean
2025-09-13 10:13:25 +01:00
uv lock
2025-08-24 14:33:48 +01:00
uv sync
uv run vinefeeder --help or
uv run envied --help
```
2025-08-25 15:36:58 +01:00
**Configuration**
Run this line inside the VineFeeder folder:
```
cp packages/envied/src/envied/envied-working-example.yaml packages/envied/src/envied/envied.yaml
```
This ensures you have your own working copy of envied.yaml. It may be edited and will not be over-written during any updates.
2025-09-03 22:27:25 +01:00
That's it; uv run vinefeeder to get started!
2025-08-26 10:52:24 +01:00
**Linux**
Linux systems are known to screen freeze after envied has finished a download.
2025-09-03 22:27:25 +01:00
The top level vinefeeder config file at TwinVine/packages/vinefeeder/src/vinefeeder/config.yaml should have TERMINAL_RESET: True set.
2025-08-24 14:33:48 +01:00
2025-08-25 15:45:03 +01:00
**Services**
2025-09-24 13:32:44 +01:00
Vinefeeder currently has 10 services for which search, browse and list-select are available
2025-08-25 15:45:03 +01:00
2025-09-22 10:17:17 +01:00
ALL4 BBC ITVX MY5 PLEX RTE STV TPTV TVNZ U
2025-08-25 15:45:03 +01:00
2025-09-28 12:27:20 +01:00
In addition, there is the HellYes GUI, called from a button press, for times where you just need a quick one-off download from a site. HellYes copes with almost everything
2025-08-25 15:45:03 +01:00
Envied has
2025-09-22 10:17:17 +01:00
ALL4 AUBC CBS CWTV DSCP iP MAX MY5 NF PCOK PLEX RTE ROKU SPOT TPTV TVNZ YTBE
2025-08-25 15:45:03 +01:00
ARD CBC CTV DSNP ITV MTSP NBLA NRK PLUTO RTE STV TUBI UKTV ZDF
2025-09-13 10:13:25 +01:00
These services have web-origins and not all have been tested by me.
2025-08-28 12:57:07 +01:00
**Other README's""
TwinVine/packages/vinefeeder/src/vinefeeder/README.md
for details for confuring Envied download options on a service by service basis.
TwinVine/packages/envied/README.md links to wiki (unshackle - envied's parent)
2025-08-25 15:45:03 +01:00
2025-08-26 13:04:04 +01:00
# Newbies
2025-08-26 14:04:34 +01:00
If you are totally new to downloading there are software items that all downloaders call upon to carry out their functions. TwinVine is no different.
2025-08-26 13:04:04 +01:00
You need to have some binaries installed and on your system's Path.
For your security find them from source.
They need to be on your system's Path,
For linux installng to /home/user/.local/bin/ is ideal
For Windows it is less clear cut.
If you know how to create a folder and then add the folder to
the Windows systems Environment Path, then do that and place all your binaries
in the new folder.
(I have cheated in the past and used C:\Windows\System32\)
The binary list:
* Python 3.11 or later installed with Linux: or Windows install from the Windows Store
* ffmpeg (https://github.com/FFmpeg/FFmpeg) https://www.videohelp.com/software/ffmpeg or Linux distro
* N-m3u8DL-RE (https://github.com/nilaoda/N_m3u8DL-RE/releases)
* mp4decrypt (https://github.com/axiomatic-systems/Bento4)
* MKVMerge from MKVToolNix https://mkvtoolnix.download/downloads.html https://www.videohelp.com/software/MKVToolNix
* Shaka-packager https://github.com/shaka-project/shaka-packager/releases rename the binary to shaka-packager
2025-08-24 13:55:40 +01:00
Images
2025-09-28 12:27:20 +01:00
![TwinVine GUI](https://github.com/vinefeeder/TwinVine/blob/main/images/vinefeederA1.png)
2025-08-24 14:13:05 +01:00
![TwinVine GUI](https://github.com/vinefeeder/TwinVine/blob/main/images/vinefeeder1.png)
2025-08-24 14:16:11 +01:00
![TwinVine GUI](https://github.com/vinefeeder/TwinVine/blob/main/images/vinefeeder2.png)
![TwinVine GUI](https://github.com/vinefeeder/TwinVine/blob/main/images/vinefeeder4.png)
![TwinVine GUI](https://github.com/vinefeeder/TwinVine/blob/main/images/vinefeeder5.png)
![TwinVine GUI](https://github.com/vinefeeder/TwinVine/blob/main/images/vinefeeder6.png)
2025-08-25 14:30:01 +01:00
![TwinVine GUI](https://github.com/vinefeeder/TwinVine/blob/main/images/vinefeeder7.png)
![TwinVine GUI](https://github.com/vinefeeder/TwinVine/blob/main/images/vinefeeder8.png)
![TwinVine GUI](https://github.com/vinefeeder/TwinVine/blob/main/images/vinefeeder9.png)
![TwinVine GUI](https://github.com/vinefeeder/TwinVine/blob/main/images/vinefeeder10.png)
![TwinVine GUI](https://github.com/vinefeeder/TwinVine/blob/main/images/vinefeeder11.png)
2025-08-26 14:04:34 +01:00
![TwinVine GUI](https://github.com/vinefeeder/TwinVine/blob/main/images/vinefeederB.png)
2025-09-28 12:27:20 +01:00
![TwinVine GUI](https://github.com/vinefeeder/TwinVine/blob/main/images/hellyes.png)
2025-08-25 14:30:01 +01:00
2025-08-24 14:49:23 +01:00
2025-08-24 14:00:42 +01:00
2025-08-24 14:13:05 +01:00