# Luxaforus

Minimalist [Luxafor](https://luxafor.com/) client application for macOS.

## How it works

There are no explicit controls for the light, instead the light turns red when the 'Do Not Disturb' mode is enabled in the macOS Notification Center and green when it's disabled. When your computer goes to sleep mode or the application is quitting, the light will be turned off.

You can speed up access to your 'Do Not Disturb' mode by setting a global keyboard shortcut for it (see 'Preferences' for details).

Luxaforus is also integrated with the Slack API to synchronise your 'Do Not Disturb' status with your Slack account.

## Credentials

While this application is open source, some credentials linked to specific accounts (e.g. Slack) are omitted from this repository and must be provided as follows:

1. Go to 'Luxaforus' project directory
2. Copy 'Credentials.m.example' and rename it to 'Credentials.m'
3. Replace the dummy values inside with ones you intend to use
4. Add the file to the Xcode project, by dragging it into the Project navigator

Below are some useful links on how to register your own credentials:

* Slack API: [Creating apps](https://api.slack.com/slack-apps#creating_apps)

## License

This project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE) file.

# Luxaforus

Minimalist [Luxafor](https://luxafor.com/) client application for macOS.

**NOTE:** Luxaforus is an open-source project that simply uses the Luxafor API and is not affiliated with Luxafor. For any support issues, please contact Luxafor directly! No planned development is happening on this project, features are added ad-hoc when developers have a need for them, so feature requests will not be attended do. However, you are welcome to implement features yourself and contribute them - your pull request will be happily reviewed.

## How it works

There are no explicit controls for the light, instead the light turns red when the 'Do Not Disturb' mode is enabled in the macOS Notification Center and green when it's disabled. When your computer goes to sleep mode or the application is quitting, the light will be turned off.

You can speed up access to your 'Do Not Disturb' mode by setting a global keyboard shortcut for it (see 'Preferences' for details).

Luxaforus is also integrated with the Slack API to synchronise your 'Do Not Disturb' status with your Slack account.

## Credentials

While this application is open source, some credentials linked to specific accounts (e.g. Slack) are omitted from this repository and must be provided as follows:

1. Go to 'Luxaforus' project directory
2. Copy 'Credentials.m.example' and rename it to 'Credentials.m'
3. Replace the dummy values inside with ones you intend to use
4. Add the file to the Xcode project, by dragging it into the Project navigator

Below are some useful links on how to register your own credentials:

* Slack API: [Creating apps](https://api.slack.com/slack-apps#creating_apps)

## License

This project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE) file.

Add affiliation disclaimer and project status to readme
Add affiliation disclaimer and project status to readme
