# User guide

## Installation and uninstallation

Run `wrec -V` to see **Installed via** (`Scoop`, `manual PATH install`, or `portable ZIP`).

### Scoop

```powershell
scoop bucket add mew https://github.com/mewisme/scoop-mew
scoop install wrec
```

Uninstall:

```powershell
scoop uninstall wrec
```

Removes the app, shim, and **wrec** shortcuts. Optional: `scoop bucket rm mew`.

`wrec install` / `wrec uninstall` do not apply to Scoop installs.

### WinGet

```powershell
winget install Mew.Wrec
```

The Inno Setup installer adds PATH and **wrec** shortcuts (same layout as `wrec install`).

Uninstall:

```powershell
winget uninstall Mew.Wrec
```

`wrec install` / `wrec uninstall` are not needed for WinGet installs.

### PowerShell or manual PATH install

The [install.ps1](https://github.com/mewisme/wrec/blob/main/install.ps1) script downloads a release and runs `wrec install`. You can also install from an extracted ZIP:

```powershell
wrec install                    # → %USERPROFILE%\.local\bin
wrec install --dir D:\tools\bin
```

`wrec install` copies the executable to your user PATH and creates **wrec** shortcuts on the desktop and in the Start menu.

Uninstall:

```powershell
wrec uninstall
wrec uninstall -d D:\tools\bin  # custom install dir
```

Or use **Uninstall** at the bottom of the GUI. Removes the executable, PATH entry, and shortcuts.

Restart your terminal after install or uninstall so PATH changes take effect.

### Portable (extracted ZIP, no install)

Extract `wrec.exe` and run it directly — no PATH changes.

The first GUI launch may create **wrec** shortcuts on the desktop and in the Start menu.

Uninstall:

1. Quit wrec (**Exit** from the tray menu if the GUI is running).
2. Delete the folder containing `wrec.exe`.
3. Remove **wrec** shortcuts from the desktop and Start menu (`wrec.lnk`) if present.

---

## GUI

Launch:

```powershell
wrec
wrec gui
```

Both open the same GUI. With no subcommand, `wrec` defaults to the GUI.

Double-clicking `wrec.exe` opens the GUI with the console window hidden. Launching from a terminal keeps the console visible.

### Workflow

1. Choose **Mode**: **Window** (default) or **Monitor**.
2. **Refresh** the source list.
   - **Window mode** — top-level windows. Enable **Show all** to include tool, invisible, or shell windows.
   - **Monitor mode** — displays with device name, resolution, and primary flag.
3. **Check** one or more rows to record (multi-select).
4. Choose a **Layout** (auto, grid, horizontal, vertical; **focus** is window mode only).
5. Set output file or folder, quality preset, FPS, and bitrate as needed.
6. Click **Start Recording**.

**Cursor** and **Hotkeys** are checked by default. **Start paused** arms capture without writing frames until you press Ctrl+Alt+S.

**Taskbar** (fake Windows taskbar overlay) is available in window mode only; it is disabled when recording monitors.

**Stop** (or Ctrl+Alt+S while recording) finalizes the MP4. **Play Recent** opens the last successful recording in your default player.

Custom per-source placement (`--source` / `--canvas`) is CLI-only; the GUI uses automatic layouts.

### Settings and config

Open **Settings** from the GUI to edit defaults (output folder, preset, taskbar overlay, etc.) and **Save Config**. Settings persist to `%USERPROFILE%\.wrec\config.ini`. The CLI can merge flags into the same file with `--save` on any command.

### System tray

When the GUI is running, a tray icon stays in the notification area.

- **Close the window** — hides the GUI to the tray; recording and hotkeys keep working.
- **First hide** — shows a one-time balloon: *wrec is still running in the system tray.*
- **Left-click the tray icon** — shows the GUI (or brings it to the foreground if already visible).
- **Right-click** — context menu:
  - Show GUI / Hide GUI
  - Show Console / Hide Console (if a console is attached)
  - Start Recording / Stop Recording
  - Pause / Resume (while recording)
  - Open Output Folder
  - Exit — stops recording gracefully if active, then quits

To fully exit, use **Exit** from the tray menu (or stop recording first, then exit). Closing the window does not quit the app.

### Closing while recording

Closing the GUI window hides it to the tray; recording continues. Use the tray **Exit** item (or Ctrl+Alt+Q) to stop, finalize the MP4, and quit.

If you close the **console** while recording, wrec stops gracefully: it finalizes the file first, then exits. The status bar shows **Stopping and saving…** during this.

---

## Hotkeys

Enabled by default in the GUI and with `--hotkeys on` (default) in the CLI.

| Key | Action |
|-----|--------|
| Ctrl+Alt+S | Stop and finalize — or **start** writing if armed (`--start-paused` / **Start paused**) |
| Ctrl+Alt+P | Pause / resume |
| Ctrl+Alt+Q | Quit and finalize |

Each action shows a brief tray balloon notification.

In the GUI, hotkeys are registered on the main window and forwarded to the recording thread.

---

## Output files

| Situation | Result |
|-----------|--------|
| `-o demo.mp4` | Writes to that path (relative paths resolve against the output folder) |
| No `-o` | Auto name: `%USERPROFILE%\Videos\wrec-YYYYMMDD-HHMMSS.mp4` |
| `-d D:\captures` only | Same auto name inside `D:\captures` |

Default output folder is **Videos** under your user profile.