Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,34 @@ Pixelpipe ships both interfaces side by side; pick whichever you prefer.

**Tray menu** (right-click the tray icon). Everything is here: per-profile mount controls, bandwidth, setup, diagnostics, tools. Status text updates live every few seconds while the menu is open.

**Main window** (`Open Pixelpipe window...` in the tray, or the new Setup wizard exits to it). Four tabs:
**Main window** (`Open Pixelpipe window...` in the tray, or the new Setup wizard exits to it). Five tabs:

- *Profiles*: dashboard cards with live status pills, storage gauges, session/speed numbers, and Mount/Unmount buttons.
- *Profiles*: dashboard cards with live status dots, drive-letter chips, mounted pills, dark storage gauges, session/speed numbers, and Mount/Unmount buttons.
- *Activity*: a colour-coded timeline parsed from the UI log (mount / unmount / schedule / transfer / watch / error), filterable by category.
- *Diagnostics*: the same data you get from "Copy diagnostics", plus repair buttons.
- *Logs*: per-profile rclone log and the Pixelpipe UI log in a tail viewer.
- *Logs*: per-profile rclone log and the Pixelpipe UI log in a tail viewer with a substring filter.
- *Settings*: bandwidth, startup, verbose logging, re-run setup wizard, check for updates.

**Quick controls popup** (`Quick controls...` in the tray). Small always-on-top window with aggregate live speed, session traffic, bandwidth dropdown, and per-profile status. Designed to sit in a corner during active transfers.

**Setup wizard** runs on first launch and walks through rclone / WinFsp / your first rclone remote / optional API key. Re-runnable any time from the Settings tab or the Setup tray submenu.

## Screenshots

The main-window Profiles tab — live status dots, drive-letter chips, a dark storage gauge, and the four primary mount actions per card:

![Profiles tab](docs/screenshots/profiles-tab.png)

The tray menu, with a live status header and each profile as an expandable submenu:

![Tray menu](docs/screenshots/tray-menu.png)

Adding a cloud remote — nine first-class providers plus custom rclone remotes:

![Add cloud remote](docs/screenshots/add-cloud-remote.png)

More in [docs/SCREENSHOTS.md](docs/SCREENSHOTS.md) (per-profile submenu, Settings tab).

## Features

- Multi-profile tray menu for multiple cloud remotes.
Expand Down
46 changes: 26 additions & 20 deletions docs/SCREENSHOTS.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,33 @@
# Screenshots and visuals
# Screenshots

This repository includes SVG mockups so the README has useful visuals before release screenshots are captured.
Captured from Pixelpipe v0.15.4 on Windows 11. All images live in `docs/screenshots/`.

Recommended real screenshots to add after the first GitHub build:
## Main window — Profiles tab

1. Tray menu with mounted status.
2. First-run setup prompts.
3. `P:\` visible in This PC.
4. Diagnostics / repair window.
5. Bandwidth limit submenu.
The dashboard. Each profile is a card with a status dot, drive-letter chip, mounted/unmounted pill, a dark themed storage gauge, live transfer-quota / session / speed numbers, and the four primary actions (Mount / Full cache / Unmount / Open). The status strip across the top shows global status, rclone, WinFsp, and transfer-quota chips — each with its own colour dot.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Hyphenate "dark themed" to "dark-themed" when used as a compound modifier before the noun "storage gauge" to maintain grammatical consistency.

Suggested change
The dashboard. Each profile is a card with a status dot, drive-letter chip, mounted/unmounted pill, a dark themed storage gauge, live transfer-quota / session / speed numbers, and the four primary actions (Mount / Full cache / Unmount / Open). The status strip across the top shows global status, rclone, WinFsp, and transfer-quota chips — each with its own colour dot.
The dashboard. Each profile is a card with a status dot, drive-letter chip, mounted/unmounted pill, a dark-themed storage gauge, live transfer-quota / session / speed numbers, and the four primary actions (Mount / Full cache / Unmount / Open). The status strip across the top shows global status, rclone, WinFsp, and transfer-quota chips — each with its own colour dot.


Place screenshots in:
![Profiles tab](screenshots/profiles-tab.png)

```text
docs/assets/
```
## Tray menu

Suggested names:
Right-click the tray icon. The disabled header block shows live status (mounted count, rclone / WinFsp presence, transfer quota), then window shortcuts, each profile as a submenu, and the management / setup / tools entries.

```text
tray-menu.png
first-run-setup.png
this-pc-mounted.png
diagnostics-repair.png
bandwidth-menu.png
```
![Tray menu](screenshots/tray-menu.png)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The PR description mentions that tray-menu-tooltip.png was captured as one of the six screenshots, but it is currently not referenced or displayed in the screenshots gallery. Consider adding it under the Tray menu section to showcase the live status tooltip.

Suggested change
![Tray menu](screenshots/tray-menu.png)
![Tray menu](screenshots/tray-menu.png)
Hovering over the tray icon displays a live status tooltip:
![Tray menu tooltip](screenshots/tray-menu-tooltip.png)


## Per-profile tray submenu

Hovering a profile expands its full detail — remote, drive, provider, status, storage, transfer quota, traffic, speed — plus every action: Test, Mount (low overhead / full cache), Unmount, Open, Edit, Set as primary, Auto-mount, Remove.

![Per-profile submenu](screenshots/tray-profile-submenu.png)

## Add cloud remote

Nine first-class providers plus custom rclone remotes. OAuth providers (Drive, OneDrive, Dropbox, Box) complete sign-in through the rclone config terminal; the rest collect credentials in an in-app form and never put secrets on the command line.

![Add cloud remote menu](screenshots/add-cloud-remote.png)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Update the image alt text to "Add cloud remote" to match the section header and maintain consistency with the alt text used in README.md.

Suggested change
![Add cloud remote menu](screenshots/add-cloud-remote.png)
![Add cloud remote](screenshots/add-cloud-remote.png)


## Settings tab

Dependencies (rclone / WinFsp / rclone-remotes), Pixeldrain quota + DPAPI-encrypted API key management, and Preferences (global bandwidth, startup auto-mount, verbose logging, update check, transfer notifications), with a maintenance row along the bottom.

![Settings tab](screenshots/settings-tab.png)
Binary file added docs/screenshots/add-cloud-remote.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/profiles-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/settings-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/tray-menu-tooltip.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/tray-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/tray-profile-submenu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading