An open API service indexing awesome lists of open source software.

https://github.com/notsopreety/quickshell-clock

A google pixel inspired clock widget for wayland using quickshell
https://github.com/notsopreety/quickshell-clock

clock-widget hyprland mui-material quickshell wayland widget

Last synced: 3 days ago
JSON representation

A google pixel inspired clock widget for wayland using quickshell

Awesome Lists containing this project

README

          

# Material Scalloped Clock

A highly customizable, Material 3-inspired analog clock widget for Quickshell.

## Features

- **Responsive Scalloped Design**: Perimeter count and amplitude scale with window size.
- **Pywal Integration**: Automatically inherits system colors from `~/.cache/wal/colors.json`.
- **Hybrid Display**: Combined analog hands with a large digital time background.
- **Customizable Components**: Toggleable numbers, tick marks, day-of-week labels, and date badges.
- **Flexible Mechanics**: Independent control over hand lengths, thicknesses, and floating second-hand indicators.

## Showcase

## Prerequisites

- [Quickshell](https://github.com/outfoxxed/quickshell)
- Wayland compositor (Hyprland, Sway, etc.)

## Installation

1. Copy the `clock` directory to `~/.config/quickshell/`.
2. Ensure `settings.json` and `clock.qml` are in the same folder.

## Configuration

Modify `settings.json` to adjust the widget's behavior:
>Note: For detailed configuration, copy `settings.json.full` in `settings.json`. It's not recomended to do that if you want stable control over widget.

| Property | Type | Description |
|----------|------|-------------|
| `winX` & `winY` | int | Position of widget over screen. |
| `winSize` | int | Total width/height of the widget (proportional scaling). |
| `scallops` | int | Number of scallops around the perimeter. |
| `amplitude`| int | Depth of the scalloped curves. |
| `showNumber` | bool | Toggle visibility of the hour numbers. |
| `showTicks` | bool | Toggle visibility of the hour and minutes ticks. |
| `showDayLabel` | bool | Toggle visibility of week's day. |
| `showDigitalTime` | bool | Toggle visibility of the digital time in numbers. |
| `showDateBadge` | bool | Toggle visibility of the month's day date. |
| `showSecondHand` | bool | Toggle visibility of the second hand. |
| `showSecondHandLine` | bool | Toggle between a full line or a floating dot for seconds. |
| `usePywal` | bool | Prioritize Pywal color palette over static colors. |
| `accentColor` | string | Custom accent color if Pywal isn't installed. |
| `bgColor` | string | Custom bg color if Pywal isn't installed. |
| `primaryColor` | string | Custom primary color if Pywal isn't installed. |