https://github.com/wraient/buttercup
Torrent and stream Shows / Movies with cli with playback tracking
https://github.com/wraient/buttercup
cli linux movies mpv shows stream streaming torrent tv-shows webtorrent
Last synced: 3 months ago
JSON representation
Torrent and stream Shows / Movies with cli with playback tracking
- Host: GitHub
- URL: https://github.com/wraient/buttercup
- Owner: Wraient
- License: mit
- Created: 2024-11-08T12:43:50.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-11-15T13:14:18.000Z (11 months ago)
- Last Synced: 2025-05-07T16:50:11.751Z (5 months ago)
- Topics: cli, linux, movies, mpv, shows, stream, streaming, torrent, tv-shows, webtorrent
- Language: Go
- Homepage:
- Size: 74.2 KB
- Stars: 16
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# buttercup
A cli application to stream torrents and track the playback using [jackett](https://github.com/Jackett/Jackett) and [webtorrent-cli](https://github.com/webtorrent/webtorrent-cli)
## Join the discord server
https://discord.gg/cNaNVEE3B6
## Demo
The demo speed has been increased, real speed would be slower depending on number of seeders and leechers
Cli Mode:
https://github.com/user-attachments/assets/59a17262-46b8-4cdd-bd79-3c362d72f2c6
Rofi Mode:
https://github.com/user-attachments/assets/c2c18047-b76a-4c98-a00d-fdab9e8fde5c
## Features
- Search for torrents
- Stream torrents
- Track playback
- Save MPV Speed
- Download / Install Jackett
- Config file
- CLI Selection menu
- Rofi Support
## Installing and Setup
> **Note**: `buttercup` requires `mpv`, `rofi`, and `webtorrent-cli` for Rofi support and torrent streaming. These are included in the installation instructions below for each distribution.
### Linux
Arch Linux / Manjaro (AUR-based systems)
Using Yay:
```bash
yay -Sy buttercup
```
or using Paru:
```bash
paru -Sy buttercup
```
Or, to manually clone and install:
```bash
git clone https://aur.archlinux.org/buttercup.git
cd buttercup
makepkg -si
sudo pacman -S rofi npm
npm install -g webtorrent-cli
```
Debian / Ubuntu (and derivatives)
```bash
sudo apt update
sudo apt install -y mpv curl rofi npm
sudo npm install -g webtorrent-cli
curl -Lo buttercup https://github.com/Wraient/buttercup/releases/latest/download/buttercup
chmod +x buttercup
sudo mv buttercup /usr/local/bin/
buttercup
```
Fedora Installation
```bash
sudo dnf update
sudo dnf install -y mpv curl rofi npm
sudo npm install -g webtorrent-cli
curl -Lo buttercup https://github.com/Wraient/buttercup/releases/latest/download/buttercup
chmod +x buttercup
sudo mv buttercup /usr/local/bin/
buttercup
```
openSUSE Installation
```bash
sudo zypper refresh
sudo zypper install -y mpv curl rofi npm
sudo npm install -g webtorrent-cli
curl -Lo buttercup https://github.com/Wraient/buttercup/releases/latest/download/buttercup
chmod +x buttercup
sudo mv buttercup /usr/local/bin/
buttercup
```
Generic Installation
```bash
# Install mpv, curl, rofi, npm, and webtorrent-cli (required for torrent streaming)
# Install npm for any additional packages
curl -Lo buttercup https://github.com/Wraient/buttercup/releases/latest/download/buttercup
chmod +x buttercup
sudo mv buttercup /usr/local/bin/
buttercup
```
Uninstallation
```bash
sudo rm /usr/local/bin/buttercup
```
For AUR-based distributions:
```bash
yay -R buttercup
```
## Usage
Run `buttercup` with the following options:
```bash
buttercup [options]
```
### Options
### Examples
- **Play with Rofi**:
```bash
buttercup -rofi
```
## Configuration
All configurations are stored in a file you can edit with the `-e` option.
```bash
buttercup -e
```
Script is made in a way that you use it for one session of watching.
You can quit it anytime and the resume time would be saved in the history file
more settings can be found at config file.
config file is located at ```~/.config/buttercup/config```
## Dependencies
- mpv - Video player (vlc support might be added later)
- rofi - Selection menu
- tar - Download and unzip Jackett
## API Used
- [Jackett](https://github.com/Jackett/Jackett) - To get torrents