Skip to content

Terminal interface to find, download, and stream movies, TV shows, and live TV using local media players.

docs(help): clean up in-app help overlay and streamline readme reference

Samir Hossains08cb82dca90c
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 16b8891..6e2c7d9 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,7 +3,7 @@
## [Unreleased]
### Added
-- **Unified Interactive Settings & Preferences Hub (`/settings`)**: Introduced a consolidated, mouse-friendly modal dialog replacing fragmented slash commands. Features 4 categorized tabs (`General`, `Content Modes`, `Appearance`, `Maintenance`), live player cycling (`Auto Detect`, `mpv`, `VLC`, `IINA`, `Android`), live theme cycling with palette preview swatches, inline download directory editing, and multi-mode toggling with safety guards. Streamlined slash command autocomplete suggestions while retaining full legacy command compatibility.
+- **Unified Interactive Settings & Preferences Hub (`/settings`)**: Introduced a consolidated, mouse-friendly modal dialog replacing fragmented slash commands. Features 4 categorized tabs (`General`, `Content Modes`, `Appearance`, `Maintenance`), installed media player selection via interactive popup picker, live visual theme palette swatch picker integration, inline download directory editing, and multi-mode toggling with safety guards. Streamlined slash command autocomplete suggestions and in-app help overlays while retaining full legacy command compatibility.
- **Stream list tabular column headers (`stream_table_header_spans`)**: Rendered aligned header row (`Quality`, `Size`, `Codecs`, `Duration`, `Release / Source`) at the top of stream results in the Details view on viewports $\ge 76$ columns.
- **Vim navigation in Theme picker (`j` / `k`)**: Added `j` (down) and `k` (up) key support to navigate and live-preview themes inside the `/theme` picker popup.
- **Live stream verification test suite (`tests/live_stream_verification.rs`)**: Integrated end-to-end verification verifying movie and series stream resolution against live backend endpoints and asserting absence of legacy notice hashes.
diff --git a/README.md b/README.md
index 532da43..fac7119 100644
--- a/README.md
+++ b/README.md
@@ -141,31 +141,9 @@ Start the app:
```bash
moviebox-tui
```
-
-
-### Key Shortcuts
-
-| Key | Context | Action |
-| :--- | :--- | :--- |
-| **`?`** | Global | Open interactive in-app help menu |
-| **`↑` / `↓` / `k` / `j`** | Global | Navigate lists, search results, and modal pickers |
-| **`←` / `→` / `h` / `l`** | Details | Switch details panes (Audio / Seasons / Episodes / Streams) |
-| **`Enter`** | Search / Details | Submit query / Play selected stream or TV channel |
-| **`o`** | Streams / TV | Open alternative player selection picker |
-| **`d`** | Details | Download current episode or full season batch |
-| **`f`** / **`*`** | Home | Favorite / unfavorite selected title |
-| **`f`** | Details | Favorite / unfavorite currently viewed title |
-| **`s`** | Details | Open subtitle language picker |
-| **`c`** | Normal Mode | Clear active search query and return to landing |
-| **`Space`** / **`P`** | `/history` | Instant 1-key direct resume for recorded episode |
-| **`Ctrl+S`** / **`Ctrl+T`** / **`Ctrl+A`** | Global | Switch to Streaming / TV / Addon Mode |
-| **`Ctrl+P`** | Streaming / Addon | Switch content provider or open Addon Manager |
-| **`Esc`** | Global | Focus search bar / Dismiss popup dialog / Return to landing |
-| **`q`** / **`Ctrl+C`** | Global | Quit application |
-- **Interactive Help:** Press `?` inside the app anytime to view all keyboard shortcuts and mouse actions.
+- **Interactive Help:** Press `?` inside the app anytime to view contextual keyboard shortcuts and mouse controls.
- **Mouse & Keyboard:** Full mouse navigation and keyboard controls are supported throughout the application.
-- **Full Reference:** See [Controls & Shortcuts](docs/controls.md) for the complete list of keybindings and slash commands.
-
+- **Complete Reference:** See [Controls & Shortcuts](docs/controls.md) for the full list of keybindings, mouse actions, and slash commands.
## Documentation
All in-depth guides and technical details are available in the [`docs/`](docs/) directory:
diff --git a/docs/controls.md b/docs/controls.md
index a94d051..7425829 100644
--- a/docs/controls.md
+++ b/docs/controls.md
@@ -111,25 +111,14 @@ Type these commands directly into the search bar:
| Command | Applicable Mode | Action |
| :--- | :--- | :--- |
-| `/settings` | All | Open interactive Settings & Preferences Hub |
+| `/settings` | All | Open interactive Settings & Preferences Hub (configuration, modes, players, maintenance) |
| `/browse` | Streaming / Addon | Browse curated views (Trending, Popular) or Addon catalogs (Top Movies, Top Series) |
| `/history` | Streaming / Addon | View watch history with latest progress |
| `/favorites` | Streaming / Addon | View all starred titles |
-| `/theme` | All | Open visual theme swatch picker |
+| `/theme` | All | Open visual theme palette swatch picker |
| `/clear` | All | Clear search results and return to landing |
| `/help` | All | Open interactive keybinding help menu |
| `/list` | TV | View live TV channels |
-| `/download-dir` | All | View, change, or reset the download directory |
-| `/update` | All | Check if a new release is available on GitHub |
-| `/clear-cache` | All | Clear temporary cache files |
-| `/github` | All | Open the project repository |
-| `/toggle-update` | All | Toggle automatic startup update checks |
-| `/toggle-streaming` | All | Toggle Streaming Mode navigation in bottom dock |
-| `/toggle-tv` | All | Toggle TV Mode navigation in bottom dock |
-| `/toggle-addons` | All | Toggle Addon Mode navigation in bottom dock |
-| `/toggle-bdix` | Streaming | Toggle BDIX FTP sources |
-| `/probe` | All | Re-run terminal graphics detection and report the result |
-
## Help Overlay
- Open with `?`; close with `?`, `Esc`, or `q`.
diff --git a/src/tui/screens/help.rs b/src/tui/screens/help.rs
index c5ee6bb..1fc4d70 100644
--- a/src/tui/screens/help.rs
+++ b/src/tui/screens/help.rs
@@ -232,7 +232,7 @@ pub fn draw(frame: &mut Frame, area: Rect, state: &AppState, theme: &Theme) {
help_text.push(Line::from(vec![]));
help_text.push(Line::from(vec![Span::styled(
- " System & Settings",
+ " System & Commands",
theme.header.add_modifier(ratatui::style::Modifier::BOLD),
)]));
help_text.push(Line::from(vec![
@@ -241,37 +241,15 @@ pub fn draw(frame: &mut Frame, area: Rect, state: &AppState, theme: &Theme) {
]));
help_text.push(Line::from(vec![
Span::styled(" /theme ", theme.header),
- Span::styled("Change Color Theme", theme.text),
+ Span::styled("Open Visual Theme Swatch Picker", theme.text),
]));
help_text.push(Line::from(vec![
- Span::styled(" /download-dir ", theme.header),
- Span::styled("Configure Download Directory", theme.text),
+ Span::styled(" /clear ", theme.header),
+ Span::styled("Clear Search & Return to Landing", theme.text),
]));
help_text.push(Line::from(vec![
- Span::styled(" /clear-cache ", theme.header),
- Span::styled("Clear Application Cache", theme.text),
- ]));
- help_text.push(Line::from(vec![
- Span::styled(" /update ", theme.header),
- Span::styled("Check for GitHub Updates", theme.text),
- ]));
- help_text.push(Line::from(vec![
- Span::styled(" /toggle-update ", theme.header),
- Span::styled("Toggle Auto Updates on Startup", theme.text),
- ]));
- if !state.is_tv_mode && !state.is_addon_mode {
- help_text.push(Line::from(vec![
- Span::styled(" /toggle-bdix ", theme.header),
- Span::styled("Toggle BDIX FTP Providers", theme.text),
- ]));
- }
- help_text.push(Line::from(vec![
- Span::styled(" /probe ", theme.header),
- Span::styled("Re-detect Terminal Graphics", theme.text),
- ]));
- help_text.push(Line::from(vec![
- Span::styled(" /github ", theme.header),
- Span::styled("Open GitHub Repository", theme.text),
+ Span::styled(" /help ", theme.header),
+ Span::styled("Toggle Interactive Help Menu", theme.text),
]));
let content_width = help_text.iter().map(Line::width).max().unwrap_or(42) as u16;