https://github.com/sentriz/wlr-sunclock

wayland desktop widget to show to the sun's shadows on earth
https://github.com/sentriz/wlr-sunclock

Last synced: 3 days ago
JSON representation

wayland desktop widget to show to the sun's shadows on earth

• Host: GitHub
• URL: https://github.com/sentriz/wlr-sunclock
• Owner: sentriz
• License: lgpl-3.0
• Created: 2020-08-02T23:22:08.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-05-20T11:37:47.000Z (over 3 years ago)
• Last Synced: 2024-12-26T15:21:55.665Z (7 days ago)
• Language: C
• Size: 4.52 MB
• Stars: 59
• Watchers: 5
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![](.github/gif.gif)

(demo gif, in reality it updates in real time)

# wlr-sunclock

wayland desktop widget to show to the sun's shadows on earth.  

uses [gtk-layer-shell](https://github.com/wmww/gtk-layer-shell) and the [layer shell protocol](https://github.com/swaywm/wlr-protocols/blob/master/unstable/wlr-layer-shell-unstable-v1.xml) to render on your desktop, behind your windows

now with colour support 😎

![](.github/tile.png)

## Installation

[![](https://repology.org/badge/vertical-allrepos/wlr-sunclock.svg)](https://repology.org/project/wlr-sunclock/versions)

### from source

    pacman -S gtk-layer-shell gtk3 wayland librsvg

    meson build

    sudo ninja -C build install

### from AUR

please see [wlr-sunclock-git](https://aur.archlinux.org/packages/wlr-sunclock-git/)

### from OBS

please see [X11:Wayland/wlr-sunclock](https://build.opensuse.org/package/show/X11:Wayland/wlr-sunclock) for the openSUSE package

### from Fedora Copr

please see [wef/wlr-sunclock](https://copr.fedorainfracloud.org/coprs/wef/wlr-sunclock/) for a Fedora package

## CLI args

    -a, --anchors=ANCHORS                       string of window anchors (see below)

    -i, --monitor-index=MONITOR_INDEX           monitor to show window on (starts at 0)

    -l, --layer= desktop layer to show the widget on

    -m, --margins=MARGINS                       comma separated margins for window

    -w, --width=WIDTH                           width of the window

    -d, --border-width=BORDER_WIDTH             width of the window's border

    -o, --colour-ocean=COLOUR_OCEAN             colour of the ocean

    -n, --colour-land=COLOUR_LAND               colour of the land

    -v, --version                               print version

## Anchors

    -a tl   -a tr   -a br   -a bl   -a ''   -a tblr

    ┌─┬───┐ ┌───┬─┐ ┌─────┐ ┌─────┐ ┌─────┐ ╔═════╗

    ├─┘   │ │   └─┤ │     │ │     │ │ ┌─┐ │ ║     ║

    │     │ │     │ │   ┌─┤ ├─┐   │ │ └─┘ │ ║     ║

    └─────┘ └─────┘ └───┴─┘ └─┴───┘ └─────┘ ╚═════╝

## Start on boot with sway example

    # ~/.config/sway/config

    exec wlr-sunclock \

       --margins "0,16,0,16" \

       --width 800 \

       --layer bottom \

       --anchors br \

       --border-width 2 \

       --colour-ocean "#C4B5FD" \

       --colour-land "#6D28D9"