Terminal interface to find, download, and stream movies, TV shows, and live TV using local media players.
docs: streamline features, prerequisites, badges, and documentation index
Samir Hossains758e4cfa0b41
diff --git a/README.md b/README.mdindex dce2483..c3b1f54 100644--- a/README.md+++ b/README.md@@ -6,37 +6,47 @@[ English ](README.md) • [ বাংলা ](README_BN.md) • [ हिन्दी ](README_HI.md) • [ Español ](README_ES.md)-[](https://t.me/getfromme)-[](#optional-support)+[](https://github.com/mesamirh/MovieBox-Tui/actions/workflows/ci.yml)+[](https://crates.io/crates/moviebox-tui)+[](#license)+[](https://t.me/getfromme)+[](#optional-support)</div>[moviebox-tui-walkthrough.webm](https://github.com/user-attachments/assets/7554a7e5-6ff5-49ec-9d87-f821ea99950e)## Features-- **On Demand Streaming**: Stream movies, series, and anime across multiple providers and community Stremio addons.-- **Live TV and IPTV**: Import custom M3U playlist URLs to search channels, browse categories, and stream live television.-- **Native Video Playback**: Plays directly in your favorite player (`mpv`, `IINA`, `VLC`, or Android video players) with smooth hardware acceleration.-- **Automatic Subtitles**: Automatically searches and loads subtitles in your preferred language into your player.-- **Fast Downloads**: Save single episodes or entire seasons to your computer with pause and resume support.-- **Visual Posters**: Displays cover art and movie posters directly inside your terminal window.-- **Library and History**: Bookmark your favorite titles and pick up watching right where you left off.-- **Custom Themes**: Built in color themes and settings to match your personal terminal look and feel.-- **Cross Platform**: Works identically on macOS, Linux, Windows, and Android.+- **On Demand Streaming**: Stream movies, TV series, anime, and Asian dramas across multiple native providers and community Stremio addons.+- **Live TV & IPTV**: Import custom M3U playlist URLs to search channels, browse categories, and stream live television.+- **Quality & Resolution Selection**: Choose preferred stream resolutions (`1080p`, `720p`, `480p`) directly from the details screen.+- **Hardware Accelerated Playback**: Plays directly in your preferred local media player with automatic authentication and cookie forwarding.+- **Multi Segment Downloader**: Download individual episodes or full seasons concurrently with HTTP range pause and resume support.+- **Automatic Subtitles**: Searches and synchronizes subtitles in your preferred language automatically.+- **Interactive Terminal UI**: Full keyboard and mouse support with vim navigation and command auto suggestions.+- **Visual Posters & Themes**: Renders cover art directly in your terminal, with 9 built-in themes and automatic light and dark detection.+- **Library & Progress Tracking**: Star favorites, track watch history, and resume playback where you left off.+- **Cross Platform & Private**: Runs natively on macOS, Linux, Windows, and Android (Termux) with zero telemetry or data collection.## Prerequisites-Requires at least one media player for streaming:+### Supported Media Players-- **mpv** (recommended across Linux, macOS, and Windows)-- **IINA** (macOS)-- **VLC** (cross platform)-- **Any Android Video Player** via Termux (VLC, Just Player, MX Player)+Requires at least one supported media player installed on your system:-*Poster graphics:* Image rendering requires a graphics capable terminal (Ghostty, Kitty, WezTerm, or iTerm2). Standard terminals display clean text layouts automatically.+- **Desktop (macOS, Linux, Windows):** [mpv](https://mpv.io/), [VLC](https://www.videolan.org/), or [IINA](https://iina.io/) *(macOS)*.+- **Android (Termux):** Any external video player ([VLC](https://play.google.com/store/apps/details?id=org.videolan.vlc), Just Player, or MX Player).-*Optional for MovieBox downloads:* `yt-dlp` and `ffmpeg` are required only for downloading DASH streams from the MovieBox provider. All other providers download directly with the built in engine.+### Terminal Graphics (Posters)+Poster rendering automatically adapts to your terminal environment:++- **Graphics-capable terminals:** Displays high-resolution movie and series posters natively.+- **Standard terminals:** Displays clean, structured text placeholders automatically.++### Optional Dependencies++- **`yt-dlp` & `ffmpeg`:** Required only when downloading DASH streams from the MovieBox provider. All other providers download directly through the built-in HTTP engine.## Installation### macOS and Linux@@ -51,7 +61,8 @@ Or via Homebrew (macOS):brew tap mesamirh/moviebox-tui https://github.com/mesamirh/MovieBox-Tuibrew install moviebox-tui```-*Note:* If Homebrew prompts for tap verification, run `brew trust mesamirh/moviebox-tui`.+> [!NOTE]+> If Homebrew prompts for tap verification on initial install, run `brew trust mesamirh/moviebox-tui`.### Windows@@ -74,7 +85,8 @@ pkg update && pkg install -y curl tar termux-tools termux-amcurl -fsSL https://raw.githubusercontent.com/mesamirh/MovieBox-Tui/main/install.sh | bashtermux-setup-storage```-*Note:* Requires an external video player installed on Android (e.g. VLC or any supported player).+> [!IMPORTANT]+> Video playback on Android launches through your installed external media player (such as VLC, Just Player, or MX Player).<details><summary><b>Cargo and Source Build</b></summary>@@ -122,6 +134,7 @@ Enter `2` to completely remove MovieBox-TUI.```bashbrew uninstall moviebox-tui # Homebrew (macOS)+scoop uninstall moviebox-tui # Scoop (Windows)cargo uninstall moviebox-tui # Cargo```@@ -138,7 +151,17 @@ moviebox-tui## Documentation-Comprehensive guides and architectural references are available at [**mesamirh.github.io/MovieBox-Tui**](https://mesamirh.github.io/MovieBox-Tui/) or in the [`docs/`](docs/) directory.+Comprehensive guides and architectural references are available at [**mesamirh.github.io/MovieBox-Tui**](https://mesamirh.github.io/MovieBox-Tui/) or in the [`docs/`](docs/) directory:++| Guide | Description |+| :--- | :--- |+| [Keyboard & Controls](docs/controls.md) | Keybindings, vim navigation, search, and shortcuts |+| [Configuration](docs/config.md) | Settings, theme customization, and configuration options |+| [Content Providers](docs/providers.md) | Native scrapers (MovieBox, Dramachi, BDIX) and stream extractors |+| [Stremio Addons](docs/addons-mode.md) | Community addon installation, manifest URLs, and stream resolution |+| [Hardware Players](docs/players.md) | Player detection, launch options, and hardware acceleration |+| [Live TV & IPTV](docs/tv-mode.md) | M3U playlist import, channel search, and live streaming |+| [Batch Downloads](docs/downloads.md) | Multi segment HTTP range downloads with pause and resume |## Contributingdiff --git a/docs/README.md b/docs/README.mdindex e93e2f7..f0c8543 100644--- a/docs/README.md+++ b/docs/README.md@@ -6,37 +6,47 @@[ English ](../README.md) • [ বাংলা ](../README_BN.md) • [ हिन्दी ](../README_HI.md) • [ Español ](../README_ES.md)-[](https://t.me/getfromme)-[](../README.md#optional-support)+[](https://github.com/mesamirh/MovieBox-Tui/actions/workflows/ci.yml)+[](https://crates.io/crates/moviebox-tui)+[](../README.md#license)+[](https://t.me/getfromme)+[](../README.md#optional-support)</div>[moviebox-tui-walkthrough.webm](https://github.com/user-attachments/assets/7554a7e5-6ff5-49ec-9d87-f821ea99950e)## Features-- **On Demand Streaming**: Stream movies, series, and anime across multiple providers and community Stremio addons.-- **Live TV and IPTV**: Import custom M3U playlist URLs to search channels, browse categories, and stream live television.-- **Native Video Playback**: Plays directly in your favorite player (`mpv`, `IINA`, `VLC`, or Android video players) with smooth hardware acceleration.-- **Automatic Subtitles**: Automatically searches and loads subtitles in your preferred language into your player.-- **Fast Downloads**: Save single episodes or entire seasons to your computer with pause and resume support.-- **Visual Posters**: Displays cover art and movie posters directly inside your terminal window.-- **Library and History**: Bookmark your favorite titles and pick up watching right where you left off.-- **Custom Themes**: Built in color themes and settings to match your personal terminal look and feel.-- **Cross Platform**: Works identically on macOS, Linux, Windows, and Android.+- **On Demand Streaming**: Stream movies, TV series, anime, and Asian dramas across multiple native providers and community Stremio addons.+- **Live TV & IPTV**: Import custom M3U playlist URLs to search channels, browse categories, and stream live television.+- **Quality & Resolution Selection**: Choose preferred stream resolutions (`1080p`, `720p`, `480p`) directly from the details screen.+- **Hardware Accelerated Playback**: Plays directly in your preferred local media player with automatic authentication and cookie forwarding.+- **Multi Segment Downloader**: Download individual episodes or full seasons concurrently with HTTP range pause and resume support.+- **Automatic Subtitles**: Searches and synchronizes subtitles in your preferred language automatically.+- **Interactive Terminal UI**: Full keyboard and mouse support with vim navigation and command auto suggestions.+- **Visual Posters & Themes**: Renders cover art directly in your terminal, with 9 built-in themes and automatic light and dark detection.+- **Library & Progress Tracking**: Star favorites, track watch history, and resume playback where you left off.+- **Cross Platform & Private**: Runs natively on macOS, Linux, Windows, and Android (Termux) with zero telemetry or data collection.## Prerequisites-Requires at least one media player for streaming:+### Supported Media Players-- **mpv** (recommended across Linux, macOS, and Windows)-- **IINA** (macOS)-- **VLC** (cross platform)-- **Any Android Video Player** via Termux (VLC, Just Player, MX Player)+Requires at least one supported media player installed on your system:-*Poster graphics:* Image rendering requires a graphics capable terminal (Ghostty, Kitty, WezTerm, or iTerm2). Standard terminals display clean text layouts automatically.+- **Desktop (macOS, Linux, Windows):** [mpv](https://mpv.io/), [VLC](https://www.videolan.org/), or [IINA](https://iina.io/) *(macOS)*.+- **Android (Termux):** Any external video player ([VLC](https://play.google.com/store/apps/details?id=org.videolan.vlc), Just Player, or MX Player).-*Optional for MovieBox downloads:* `yt-dlp` and `ffmpeg` are required only for downloading DASH streams from the MovieBox provider. All other providers download directly with the built in engine.+### Terminal Graphics (Posters)+Poster rendering automatically adapts to your terminal environment:++- **Graphics-capable terminals:** Displays high-resolution movie and series posters natively.+- **Standard terminals:** Displays clean, structured text placeholders automatically.++### Optional Dependencies++- **`yt-dlp` & `ffmpeg`:** Required only when downloading DASH streams from the MovieBox provider. All other providers download directly through the built-in HTTP engine.---## Documentation Directory Mapdiff --git a/docs/installation.md b/docs/installation.mdindex 1a74e7a..8e2e46c 100644--- a/docs/installation.md+++ b/docs/installation.md@@ -19,7 +19,8 @@ brew tap mesamirh/moviebox-tui https://github.com/mesamirh/MovieBox-Tuibrew install moviebox-tui```-*Note:* If Homebrew prompts for tap verification, run `brew trust mesamirh/moviebox-tui`.+> [!NOTE]+> If Homebrew prompts for tap verification on initial install, run `brew trust mesamirh/moviebox-tui`.---@@ -49,7 +50,8 @@ curl -fsSL https://raw.githubusercontent.com/mesamirh/MovieBox-Tui/main/install.termux-setup-storage```-*Note:* Requires an external video player installed on Android (e.g. VLC or any supported player).+> [!IMPORTANT]+> Video playback on Android launches through your installed external media player (such as VLC, Just Player, or MX Player).---## Cargo (Crates.io)@@ -106,5 +108,6 @@ Enter `2` to completely remove MovieBox-TUI from your system.```bashbrew uninstall moviebox-tui # Homebrew (macOS)+scoop uninstall moviebox-tui # Scoop (Windows)cargo uninstall moviebox-tui # Cargo```