# Lume

A minimalist clock overlay for Windows. Always-on-top, transparent, and click-through—so it stays out of your way while keeping time and hardware stats visible.

![Lume Control Window](assets/Screenshot%202026-03-13%20234946.png)

## Features

- **Clock overlay** — Displays time in 12h or 24h format, always on top of all windows
- **Hardware monitoring** — Optional CPU, RAM, GPU usage, and GPU temperature (NVIDIA via nvidia-smi)
- **Customizable** — Font, size, color, opacity, background, and position
- **9-position grid** — Place the overlay in any corner or edge of your screen
- **Reverse HUD** — Option to show hardware stats first with time at the end
- **Global hotkey** — Toggle overlay with Ctrl+Shift+L (customizable)
- **System tray** — Minimize to tray, launch at startup
- **Free and open source**

## Requirements

- Windows 10 or later
- [Flutter SDK](https://docs.flutter.dev/get-started/install) (for building from source)

## Getting Started

### Build from source

```bash
git clone <repository-url>
cd lume_clock
flutter pub get
flutter build windows
```

The executable will be at `build/windows/x64/runner/Release/lume.exe`.

### Run in development

```bash
flutter run -d windows
```

## Usage

1. Launch Lume — the control window opens; you can minimize it to the system tray
2. Enable **Show overlay** to display the clock on screen
3. Use the 3×3 grid to choose position (top-right by default)
4. Adjust font, size, color, and opacity in **Appearance**
5. Enable **Reverse HUD** to put time at the end
6. Toggle CPU, RAM, GPU usage, and GPU temp in **Hardware**
7. Use **Ctrl+Shift+L** (or your custom hotkey) to show or hide the overlay anytime

## License

© 2026 Lume. Free and open source.