# Overview module - credits

The files in this directory (`Overview.qml`, `OverviewWidget.qml`, `OverviewWindow.qml`) and
their support singletons (`../../common/Appearance.qml`, `../../common/Config.qml`,
`../../common/functions/ColorUtils.qml`, `../../common/widgets/Styled*.qml`,
`../../services/HyprlandData.qml`) are copied from
[Shanu-Kumawat/quickshell-overview](https://github.com/Shanu-Kumawat/quickshell-overview),
which was itself extracted from the overview feature in
[end-4/dots-hyprland](https://github.com/end-4/dots-hyprland) ("illogical-impulse") by
[end-4](https://github.com/end-4).

Released under the GPL by the upstream project.

### Local deviations from upstream

- `Overview.qml` / `OverviewWidget.qml` / `OverviewWindow.qml`: added one `import "../.."` line
  each, so `GlobalStates.overviewOpen` (merged into `own/GlobalStates.qml`, see below) resolves
  from this subdirectory. No other logic changed.
- `../../common/Appearance.qml`: `defaultColors` was retuned to pull from this shell's own
  `Theme`/`Colors` wallust singletons instead of the stock M3 purple palette, so the overview
  matches the bar's colors (needed one added `import ".."`). This is the module's own documented
  way to customize its palette (see upstream README, "Theme & Colors").
- `../../common/Config.qml`: untouched. Transparency/rounding are instead tuned via
  `~/.config/quickshell/overview/config.json` (the module's own documented user-override file),
  kept separate from the upstream defaults it reads.

## Why a copy instead of a symlink/submodule

The module was merged into this shell's own process (`own/shell.qml`) so it runs in the same
`quickshell -c own` instance as the bar, rather than as a second `qs -c overview` process.

An untouched clone of the upstream repo is kept side by side at
`~/.config/quickshell/overview` - use it as the reference copy when checking for upstream
updates (`git -C ~/.config/quickshell/overview pull`) and re-sync the files above by hand if
anything changes there.

## Configuration

Runtime options (grid size, scale, effects, etc.) are unaffected by the merge - `Config.qml`
still reads user overrides from `$XDG_CONFIG_HOME/quickshell/overview/config.json` regardless
of where the QML itself lives. See `~/.config/quickshell/overview/config.example.json` and
`~/.config/quickshell/overview/README.md` (in the untouched upstream clone) for the full list
of options.

## Toggling it

The merged module still registers the same IPC target, just under the `own` shell instance:

```bash
qs ipc -c own call overview toggle
qs ipc -c own call overview open
qs ipc -c own call overview close
```