2016-10-15 06:11:27 +02:00
# Safe Eyes
2016-10-23 14:34:24 +02:00
Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.
2016-10-15 06:11:27 +02:00
2016-10-25 17:20:23 +02:00
For more details: [SafeEyes Protects You From Eye Strain When Working On The Computer ](http://www.webupd8.org/2016/10/safeeyes-protects-you-from-eye-strain.html )
2016-10-15 06:11:27 +02:00
## Installation
2016-10-23 18:55:08 +02:00
### Ubuntu:
2016-10-15 06:11:27 +02:00
1: Add the PPA: `sudo add-apt-repository ppa:slgobinath/safeeyes`
2: Download the package list: `sudo apt update`
2016-11-15 09:25:00 +01:00
3: Install Safe Eyes: `sudo apt install safeeyes`
2016-10-15 06:11:27 +02:00
4: Start Safe Eyes from start menu.
2016-10-24 16:25:13 +02:00
### Arch:
2016-10-25 16:37:34 +02:00
Install SafeEyes via [AUR ](https://aur.archlinux.org/packages/safeeyes/ ). Credits to [Yamakaky ](https://github.com/Yamakaky )
2016-10-24 16:25:13 +02:00
2016-10-23 18:55:08 +02:00
### Other Linux:
Manual installation is not tested in any systems. I will update this page as soon as I have tested in any other Linux distributions.
2016-10-25 18:11:21 +02:00
1: Install the dependencies:
2017-02-06 03:37:10 +01:00
* Arch: `hicolor-icon-theme` , `libappindicator-gtk3` , `xorg-xprop` , `python2-xlib` , `python2-gobject` , `python2-dbus` , `xprintidle` and `mpg123`
2016-10-26 01:59:41 +02:00
2017-02-06 03:37:10 +01:00
* Debian: `gir1.2-appindicator3-0.1` , `python-xlib` , `python-gobject` , `python-gi` , `python-dbus` , `gir1.2-notify-0.7` , `python-gtk2` , `xprintidle` and `mpg123`
2016-10-25 18:11:21 +02:00
2017-02-06 03:37:10 +01:00
* Fedora 24: `libappindicator-gtk3` , `python-xlib` , `python-gobject` , `xorg-x11-utils` , `python-dbus` , `xprintidle` and `mpg123`
2016-10-23 18:55:08 +02:00
2017-02-06 14:15:13 +01:00
2: Download and extract [safeeyes.tar.gz ](https://github.com/slgobinath/SafeEyes/releases/download/v1.1.4/safeeyes.tar.gz ) into `/` : `sudo tar -xzvf safeeyes.tar.gz -C /`
2016-10-23 18:55:08 +02:00
2016-10-24 16:25:13 +02:00
If you have any issues in installing Safe Eyes, please report them [here ](https://github.com/slgobinath/SafeEyes/issues )
2016-10-23 18:55:08 +02:00
2016-10-26 02:02:13 +02:00
4: Start Safe Eyes using this command: `/opt/safeeyes/safeeyes`
2016-10-23 18:55:08 +02:00
Once started, Safe Eyes will copy the desktop file to `~/.config/autostart` and the configurations to `~/.config/safeeyes` . Therefore, from next time onwards, it should start with the system.
2016-10-15 06:11:27 +02:00
2016-10-25 17:17:30 +02:00
## Configuring Safe Eyes
2016-10-15 06:11:27 +02:00
Just install and forget; Safe Eyes will take care of your eyes. To customize the preferences, go to Settings from Safe Eyes tray icon.
2016-11-15 14:46:56 +01:00
You can change the look and feel of the break screen in `~/.config/safeeyes/style/safeeyes_style.css` .
2016-10-25 17:17:30 +02:00
## Uninstalling Safe Eyes
Use the following commands to uninstall SafeEyes from your system.
```
sudo apt remove safeeyes
rm -r ~/.config/safeeyes
rm ~/.config/autostart/safeeyes.desktop
```
2016-10-15 06:11:27 +02:00
## Features
- Short breaks with eye exercises
- Long breaks to change physical position and to warm up
- Strict break for those who are addicted to computer
- Highly customizable
- Do not disturb when working with fullscreen applications( Eg: Watching movies)
2016-10-23 14:34:24 +02:00
- Disable the keyboard during break
2016-10-15 06:11:27 +02:00
- Notifications before every break
2017-02-06 03:37:10 +01:00
- Smart pause and resume based on system idle time
- Optional audible alert at the end of break
2016-11-15 14:46:56 +01:00
- Multi-monitor support
2016-10-15 06:11:27 +02:00
- Elegant and customizable design
2016-11-15 14:46:56 +01:00
- Multi-language support
2016-10-15 06:11:27 +02:00
## Contributing
**Are you a user?**
Please test Safe Eyes on your system and report any issues [here ](https://github.com/slgobinath/SafeEyes/issues )
**Are you a developer?**
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request
**Are you using a different Linux system?**
Please test Safe Eyes and create installers for your operating system
2016-11-15 14:46:56 +01:00
**Can you translate English to your mother tongue (or whatever the language)?**
2017-01-10 13:32:57 +01:00
Show your support by translating Safe Eyes to a new language or by improving the existing translations.
2016-11-15 14:46:56 +01:00
## Translating Safe Eyes
From version 1.1.0, Safe Eyes supports translation. Translation files for each langauges must be placed in `/opt/safeeyes/config/lang` directory. The language file name must follow [ISO 639-1 ](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes ) language code standard. For example, the language file of English must be `en.json` . Follow these steps to translate Safe Eyes to your language.
1. Copy `/opt/safeeyes/config/lang/en.json` to `/opt/safeeyes/config/lang/<iso-639-1-language-code>.json`
2. Provide `language_name` in the language itself and `language_name_en` in English.
3. Translate other property values to the selected language.
2017-02-01 01:50:46 +01:00
4. Translate the comment in [safeeyes.desktop ](https://github.com/slgobinath/SafeEyes/blob/master/safeeyes/share/applications/safeeyes.desktop ) file.
2016-11-15 14:46:56 +01:00
**Note 1:** The `{}` used in property values will be replaced by runtime variables related to those commands. For example the `{}` in `Next break at {}` will be replaced by time at the runtime.
**Note 2:** Use Unicode when translating Safe Eyes.
**Note 3:** To change the language of Safe Eyes, change the `language` property in `~/.config/safeeyes/safeeyes.json` to the ISO 639-1 code of your language and restart the Safe Eyes.
For more details, have a look at existing language files: [lang ](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/safeeyes/config/lang )
2016-10-15 06:11:27 +02:00
2017-01-10 13:32:57 +01:00
### Currently available translations
* [Čeština ](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/safeeyes/config/lang/cz.json )
2017-02-05 12:19:05 +01:00
* [Deutsch ](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/safeeyes/config/lang/de.json )
2017-02-06 13:49:15 +01:00
* [English ](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/safeeyes/config/lang/en.json )
2017-02-01 01:50:46 +01:00
* [Español ](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/safeeyes/config/lang/es.json )
2017-01-10 13:32:57 +01:00
* [Français ](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/safeeyes/config/lang/fr.json )
* [Magyar ](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/safeeyes/config/lang/hu.json )
* [Português ](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/safeeyes/config/lang/pt.json )
2017-02-06 13:49:15 +01:00
* [Русский ](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/safeeyes/config/lang/ru.json )
2017-01-10 13:32:57 +01:00
* [Slovenský ](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/safeeyes/config/lang/sk.json )
* [தமிழ் ](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/safeeyes/config/lang/ta.json )
2016-10-15 06:11:27 +02:00
## History
2017-02-06 14:15:13 +01:00
Version 1.1.3:
* Bug fix for no audible alert
2017-02-06 13:49:15 +01:00
Version 1.1.3:
* Optional audible alert after breaks
* Pause Safe Eyes if the system is idle for a given time. (Resume when user is active)
* Bug fix for no break after fullscreen apps found
2017-02-06 14:15:13 +01:00
* Dependency fix for Kubuntu
2017-02-06 13:49:15 +01:00
Version 1.1.2:
* Bug fix for no break
2017-01-10 13:02:07 +01:00
Version 1.1.1:
* About dialog
* UI control to select the language
* Fixed bug in disable option after suspend
2016-11-15 14:46:56 +01:00
Version 1.1.0:
* Multi-language support
* Fixed bug in multi-screen support
* Fixed bug in break screen transparency
* Next break information in tray menu
2016-10-31 14:57:54 +01:00
Version 1.0.9:
* Multi-screen support
* Handling system suspend (Stop and restart during system suspend)
Version 1.0.8:
* Bug fix for Ubuntu Mate
2016-10-15 06:11:27 +02:00
2016-10-25 16:37:34 +02:00
Version 1.0.7:
* Removed python-apscheduler dependency
* Installation directory is restructured
* Bug fixes:
* Supporting Ubuntu 16.10
* Symlink for autostart instead of copying the desktop file
2016-10-23 14:34:24 +02:00
Version 1.0.6:
* Latest stable release
2016-10-15 06:11:27 +02:00
2016-10-25 17:17:30 +02:00
## Tested Environments
* Ubuntu 14.04
* Ubuntu 16.04
* Ubuntu 16.10
* Linux Mint 18
2016-10-31 14:57:54 +01:00
* Ubuntu Mate 16.04
2017-02-06 03:17:01 +01:00
* Kubuntu 16.10
2016-10-15 06:11:27 +02:00
## License
2016-10-25 18:11:21 +02:00
GNU General Public License v3