Getting Started

Sebastian Huber edited this page Apr 23, 2015 · 7 revisions

Hello KeyboardX!

The easiest way to try out and play around with KeyboardX is by using the latest release. A more sophisticated way is to build it in Visual Studio. In either way you can already create your own keyboard files.

Use Latest Release

If you would like to try out or use KeyboardX without changing the source code follow these steps:

  1. Download the zip package
  • Go to the latest release site
  • Under Downloads you will find a file called KeyboardX-Player-v*.zip
  • Download this one
  1. Extract the content of the zip file (which will be a folder)
  2. The folder contains a Player.exe, which can be opened by double-click
  3. If you get a security warning, ignore it (of course)
  4. Depending on the release there will be shipped one or several keyboard files (e.g. showboard2.xml)
  5. Open the shipped keyboard file, create your own or look at the repository

Build in Visual Studio

  1. Clone the repository from https://github.com/asterics/KeyboardX.git

  2. Open the project file (KeyboardX/Player/Player.csproj) in Visual Studio

    There is no solution file (.sln) checked in, because there are difficulties when opening with different versions of Visual Studio.

  3. Save All now by pressing Ctrl + Shift + S (.sln file will be created)

  4. Go to NuGet-Package-Manager and restore the missing packages nuget manager restore packages

  5. Try to build your project

    In case references are still missing try the following command in Package-Manager-Console. This reinstalls all packages for project Player.

Update-Package -Reinstall -ProjectName Player
  1. To avoid debug messages for OperationCanceledExceptions untick the checkbox under menu Debug - Exceptions like in the following screenshot.

ignore ThreadAbortExceptions

You can also do that the first time the exception is caught by Visual Studio. Some background about this exception can be found here.

Create Own Keyboards

You can easily create your own keyboard files by using your preferred XML editor. It certainly should bring XML Schema support, because this simplifies typing a lot. You could use Visual Studio for example. Make sure that the root tag contains the latest schema inside of xsi:noNamespaceSchemaLocation.

The root tag of your keyboard XML file should look something like this:

<keyboard
    xmlns="http://www.jku.at/iis/KeyboardX"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="../schema/dev1-commented.xsd"
    version="20150101"
>

Example keyboards as well as some tools for building keyboards can be found in the repository.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.