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

https://github.com/asterics/keyboardx

Multi-purpose on-screen keyboard.
https://github.com/asterics/keyboardx

Last synced: about 1 year ago
JSON representation

Multi-purpose on-screen keyboard.

Awesome Lists containing this project

README

          

# KeyboardX

KeyboardX is a multi-purpose on-screen keyboard. It was designed with the needs of handicapped persons in mind. Due to its flexibility it can be used for several tasks though. Find more in [features](#features).

It was originally developed as a master thesis project for [Institut Integriert Studieren](http://jku.at/iis) at [JKU](http://jku.at). Currently it's hosted as an open source project by [Kompetenznetzwerk KI-I ](http://ki-i.at).

## Documentation

Please look at the [wiki](https://github.com/asterics/KeyboardX/wiki) for full documentation, examples and other information.

- [Getting Started](https://github.com/asterics/KeyboardX/wiki/Getting-Started)
- [Development Hints](https://github.com/asterics/KeyboardX/wiki/Development)
- [Screenshots](https://github.com/asterics/KeyboardX/wiki/Screenshots)

## Features

KeyboardX consists of two parts, the [player application](https://github.com/asterics/KeyboardX/blob/master/Player) which is able to open a given [keyboard](https://github.com/asterics/KeyboardX/blob/master/Keyboards/showroom) file.

### Player

Is written in C# for the Windows plattform and has the following features:
- flexible configuration hierarchy
- override settings at many levels
- different drawers
- `GridBorderDrawer`
- `GridBorderGapDrawer`
- `GridBorderMarginDrawer`
- scanning
- different scanning mode per grid
- linear scanning, column-row scanning, row-column scanning
- configurable scanning times
- actions
- TCP command
- text to speech
- open source and extensible: implement your own drawers, scanners and actions

### Keyboards

A keyboard is basically a XML file which is defined by XML Schema. A keyboard contains one or several grids. The player shows one grid at a time. Keyboards allow a very flexible structure.

- several grids per keyboard
- own configuration per grid
- buttons
- icon support (jpeg, png, bmp, svg, wmf)
- background-color
- cloning of buttons
- empty space (NOP buttons), allow flexible layout

Further a graphical editor for building keyboard files comfortably is planed.

## Contribution

If you like or find this software useful, please consider to solve one or two [issues]( https://github.com/asterics/KeyboardX/issues?q=is%3Aopen+is%3Aissue+label%3Atodo).

Things you should read before starting development can be found in the wiki under [Development](https://github.com/asterics/KeyboardX/wiki/Development).

## License

KeyboardX is licensed under the GNU General Public License v2, see [LICENSE](https://github.com/asterics/KeyboardX/blob/master/LICENSE).