# Reddish Shift
[![Build](https://img.shields.io/github/actions/workflow/status/mahor1221/reddish-shift/ci.yaml?logo=github)](https://github.com/mahor1221/reddish-shift/actions)
[![Coverage](https://img.shields.io/codecov/c/github/mahor1221/reddish-shift?logo=codecov)](https://codecov.io/gh/mahor1221/reddish-shift)
[![Crates.io](https://img.shields.io/crates/v/reddish-shift.svg?logo=rust)](https://crates.io/crates/reddish-shift)
[![Support](https://img.shields.io/badge/support-7289da.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/E6uKg67f)

A port of [Redshift](https://github.com/jonls/redshift).
Translated line by line with the help of [C2Rust](https://github.com/immunant/c2rust).

Reddish Shift adjusts the color temperature of your screen according to your
surroundings. This may help your eyes hurt less if you are working in front of
the screen at night.



## Installation
[![REPOSITORIES](https://repology.org/badge/vertical-allrepos/reddish-shift.svg?columns=3&exclude_unsupported=1)](https://repology.org/project/reddish-shift)

<details>
  <summary>Cargo</summary>

```bash
cargo install reddish-shift
```
</details>

<details>
  <summary>Archlinux</summary>

```bash
paru -S reddish-shift
paru -S reddish-shift-bin
paru -S reddish-shift-git
```
</details>



## Usage
For a quick start, run:
```bash
reddish-shift daemon --location LATITUDE:LONGITUDE
```
replace `LATITUDE` and `LONGITUDE` with your current geolocation.

To see all available commands:
```bash
reddish-shift -h
```

To see all available options for a given command (e.g. daemon):
```bash
reddish-shift daemon --help
```
Note that using `--help` instead of `-h` prints a more detailed help message.

A [configuration file](config.toml) can also be used. It should be saved in
the following location depending on the platform:
  * Linux: `$XDG_CONFIG_HOME/reddish-shift/config.toml`
           or `$HOME/.config/reddish-shift/config.toml` if `$XDG_CONFIG_HOME` is not set
           or `/etc/reddish-shift/config.toml` for system wide configuration
  * macOS: `$HOME/Library/Application Support/reddish-shift/config.toml`
  * Windows: `%AppData%\reddish-shift\config.toml`



## Building
Run `cargo build --release --all` to build these files:
- `target/release/reddish-shift`: the main program
- `target/release/man1/`: man pages
- `target/release/completion/`: various shell completion scrips



## RoadMap
* Linux
  * [x] XRANDR gamma adjustment
  * [x] XVidMode gamma adjustment
  * [ ] DRM gamma adjustment
  * [ ] reddish-shift-gtk (from redshift-gtk)
  * [ ] systemd service, apparmor config (from [redshift/data](https://github.com/jonls/redshift/tree/master/data))
* Windows
  * [ ] Win32gdi gamma adjustment
* [ ] Support installation with: Appimage, AUR, DEB, PPA, MSI, Choco
* [ ] Geoclue2 location provider
* [ ] Real screen brightness control (experimental)
* Supporting macOS is not planned currently. Contributions are welcomed.
* [ ] Unit testing
* [ ] Automatic Conversion from Redshift's config file to `reddish-shift/config.toml`



## License
This project is licensed under the terms of [GNU General Public License v3.0](LICENSE).