# OptiKey

OptiKey is an assistive on-screen keyboard which runs on Windows. It is designed to be used with an eye-tracking device to bring keyboard control, mouse control and speech to people with motor and speech limitations, such as people living with Amyotrophic Lateral Sclerosis (ALS) / Motor Neuron Disease (MND).

It works out of the box once you have your eye-tracking device installed and allows selections to be made using dwell selection, buttons, etc. If you do not have an eye tracking device you can use OptiKey with a mouse.

OptiKey was written to challenge the outrageously expensive, unreliable and difficult to use AAC (alternative and augmentative communication) products on the market. It is, therefore, fully open-source and free. Forever.


# Getting Started

[**The OptiKey Wiki**](https://github.com/JuliusSweetland/OptiKey/wiki/) contains full information on getting started, system requirements, a user guide, demo videos, a troubleshooting page, and more. Here are some quick links if you're in a hurry:

* If you want to install and use OptiKey on Windows then download the installer from the [latest release](https://github.com/JuliusSweetland/OptiKey/releases/latest).
* Watch the [intro video](https://www.youtube.com/watch?v=Cgnamj5SA3Y).
* If you wish to get in touch my email is <optikeyfeedback@gmail.com>.

# Supported Platforms

OptiKey targets the .Net 4.5 Framework, which is available for  Windows Vista SP2 onwards. It was designed to run on Windows 8/8.1.

# Problems?

If you find a problem (a crash, an unexpected behaviour, or something similar) please visit the [issue tracker](https://github.com/JuliusSweetland/OptiKey/issues) and report the issue.

Please be kind and search to see if the issue is already logged before creating a new one. If you're pressed for time, log it anyways.

When creating an issue, please clearly explain:

* What you were trying to do.
* What you expected to happen.
* What actually happened.
* Steps to reproduce the problem.
* Also include any other information you think is relevant to reproduce the problem (such as screenshots).

# License

Licensed under the GNU GENERAL PUBLIC LICENSE (Version 3, 29th June 2007)

# Contact

Want to get in touch, ask a question, or talk to me about anything else which isn't on the [**OptiKey WIKI**](https://github.com/JuliusSweetland/OptiKey/wiki/) then my email address is <optikeyfeedback@gmail.com>.

Thanks for your interest,
Julius
