Skip to content

Latest commit

 

History

History
187 lines (140 loc) · 5.5 KB

README.md

File metadata and controls

187 lines (140 loc) · 5.5 KB
Raw

Octopus

Octopus is a CLI tool for managing and watching TV shows and movies directly from the terminal or using Rofi for a GUI selection. Designed for simplicity and control, Octopus allows seamless playback and tracking of episodes with customizable options.

Important

Octopus uses vadapav.mov API and It also hosts the content. Please consider donating to vadapav.mov

Bitcoin

bc1q8yxttnkuf3fygzxffj5wd85fgya0w39nr5tkau

Monero

42UXZfPr4SyZ4StxqNtA9HdvNr8ieSuMYdPxs3zL7qrKUnrWCMMUAuH9ARC342732VPS3KU6R8JbN15HWEdR234aPWF5ned

Demo

CLI mode:

flick-demo.mp4

Rofi mode:

flick-rofi-demo.mp4

Features

  • Watch shows/movies: Stream media directly in the CLI or through Rofi.
  • Playback management: Continue, pause, and resume playback using MPV.
  • Progress tracking: Automatically marks episodes as watched based on custom percentage.
  • Configurable storage and playback: Set custom storage paths and MPV playback settings.
  • Customizable through CLI options: Toggle between CLI and Rofi interface, configure playback speed, and more.

Installing and Setup

Note: Octopus requires mpv, rofi for Video playback and Rofi support. These are included in the installation instructions below for each distribution.

Linux

Arch Linux / Manjaro (AUR-based systems)

Using Yay

yay -Sy octopus-player

or using Paru:

paru -Sy octopus-player

Or, to manually clone and install:

git clone https://aur.archlinux.org/octopus.git
cd octopus
makepkg -si
sudo pacman -S rofi
Debian / Ubuntu (and derivatives) 
sudo apt update
sudo apt install mpv curl rofi
curl -Lo octopus https://github.com/Wraient/octopus/releases/latest/download/octopus
chmod +x octopus
sudo mv octopus /usr/local/bin/
octopus
Fedora Installation 
sudo dnf update
sudo dnf install mpv curl rofi
curl -Lo octopus https://github.com/Wraient/octopus/releases/latest/download/octopus
chmod +x octopus
sudo mv octopus /usr/local/bin/
octopus
openSUSE Installation 
sudo zypper refresh
sudo zypper install mpv curl rofi
curl -Lo octopus https://github.com/Wraient/octopus/releases/latest/download/octopus
chmod +x octopus
sudo mv octopus /usr/local/bin/
octopus
Generic Installation 
# Install mpv, curl, rofi
curl -Lo octopus https://github.com/Wraient/octopus/releases/latest/download/octopus
chmod +x octopus
sudo mv octopus /usr/local/bin/
octopus
Uninstallation 
sudo rm /usr/local/bin/octopus

For AUR-based distributions:

yay -R octopus

Windows Installer

Usage

Run octopus -h to see available commands and options:

Here's a table version for the command options:

Option Description Default
-e Edit the Octopus configuration file N/A
-next-episode-prompt Prompt for the next episode playback (accepts true/false) N/A
-no-rofi Disable the Rofi interface; run in CLI mode N/A
-percentage-to-mark-complete Set the percentage of an episode to mark as complete 92
-player Set player for playback (only MPV supported) "mpv"
-rofi Enable Rofi interface for selection N/A
-save-mpv-speed Save MPV speed setting (accepts true/false) true
-storage-path Define custom path for storage directory $HOME/.local/share/octopus
-update Update the Octopus script N/A

This makes it easy to scan and find each option’s purpose and default values!

Examples

  • Watch with Rofi interface: 
    octopus -rofi
  • Play next episode in CLI: 
    octopus -next-episode-prompt
  • Change storage path: 
    octopus -storage-path="/custom/path"

Configuration

Edit the Octopus configuration file to customize settings:

octopus -e

Dependencies

  • mpv - Video player (vlc support might be added later)
  • rofi - Selection menu

API Used

License

Octopus is open-source software licensed under the MIT License.

Credits