Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/brettferdosi/grayscale

macOS status bar app for easily toggling the grayscale display filter
https://github.com/brettferdosi/grayscale

filter grayscale macos statusbar

Last synced: 11 days ago
JSON representation

macOS status bar app for easily toggling the grayscale display filter

Awesome Lists containing this project

README

        

# grayscale

`grayscale` is a macOS status bar app for managing the system grayscale display filter. It allows you to toggle grayscale mode easily by clicking the status bar icon or using a keyboard shortcut, and it also supports enabling or disabling grayscale based on which application is currently active.

Using the grayscale filter can help you reduce your screen time. For more information, check out the following links:

- https://www.nytimes.com/2018/01/12/technology/grayscale-phone.html
- https://blog.mozilla.org/internetcitizen/2018/02/13/grayscale/

`grayscale` has been tested on macOS 11 Big Sur but may also work on other versions.

## Using grayscale

`grayscale` enables or disables grayscale mode based on the active application. It stores a default grayscale value, which determines whether grayscale mode should be on or off for all applications that have not overridden it. To toggle the default value, you can left click the status bar icon or use a keyboard shortcut. Right-clicking the icon brings up a menu, which allows you to view the default value, override it for the active application, and configure the keyboard shortcut.

`grayscale` is designed to make using grayscale mode practical. It's not realistic to keep your screen in grayscale all the time, and automatic transitions reduce the burden of manually turning it on and off. I recommend enabling grayscale by default and disabling it for specific applications that benefit from colors but don't use them to capture your attention, like a text editor with syntax highlighting. Potentially addictive applications that sometimes need color, like web browsers, can then be used with the default setting (i.e. with grayscale enabled), and you can use the keyboard shortcut to toggle grayscale as necessary.

## Installing grayscale

**Install option 1: homebrew**

Run `brew install --cask --no-quarantine brettferdosi/tap/grayscale`. `grayscale.app` will be
installed in `/Applications`.

**Install option 2: run the installer (easiest for non-technical users)**

Download the [most recent installer](https://github.com/brettferdosi/grayscale/releases/latest/download/GrayscaleInstaller.pkg) (`GrayscaleInstaller.pkg`) from the [releases page](https://github.com/brettferdosi/grayscale/releases).
To run the installer, control-click its icon, click *Open*, then click *Open* again.
See the [Apple support page](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac) if the process for running apps from unidentified developers has changed.
It will install `grayscale.app` in `/Applications`.
If there is already a version of `grayscale.app` on your system, the installer will detect and overwrite it.

**Install option 3: build from source**

Clone this git repository using `git clone --recurse-submodules` and run `make` in it.
`grayscale.app` will be placed into `build/Build/Products/Release`.

**Optional: open at login**

Automatically open `grayscale` at login by adding it to the list in System Settings > General > Login Items.
See the [Apple support page](https://support.apple.com/guide/mac-help/open-items-automatically-when-you-log-in-mh15189/mac) if the location of the list has changed.