Introduction

This page includes information relevant for a developer to get setup to start developing.

Source Code

Keyboarding Master

The source code for keyboarding master (excluding jinput) is maintained on bitbucket.  Download the source here.

jinput

jinput is a dependant library that was modified in order to allow keyboarding master to function properly.  This is also slightly confusing as the original project was hosted via svn.  That project repo is now deprecated; however, before it was deprecated, a user from the community created a project on github.  When I initially added the necessary changes into the library (for grabbing events), the svn project looked to be dead and so I worked with the project maintainer to integrate my changes.  Now, it seems the jinput project has been resurrected (yah!) but the original devs.  They seemed to have created a new project on git hub here just in sept of 2015.  The problem is that my changes were back from 2012.  So I will need to work with them to perhaps get my changes merged into the now new mainline.

Created an issue here.

IDE

Keyboarding master uses JavaFX for the UI and so its highly recommended that you use Netbeans as the IDE.

Instructions

• Create a new project by selecting File -> New Project
• Select JavaFX and JavaFX Project with Existing Source

• Enter kbmaster for Project Name
• Set the Project Folder to the full path to the keyboardingmaster git repo.

• Select the project source as the src folder in the keyboardingmaster directory.
• Select the Finish button
• Right click on kbmaster from project tree and select properties
• Click on libraries
• Click on Add JAR/Folder and add the jars from the project libs folder (see image below for versions).

• Click on Run
• Enter -Djava.library.path=libs/native in the VM Options list.

• Click OK

Now you are ready to compile and run.

UI Editing

To use the nice Graphical Tools to build the JavaFX UI layer, you will need to download the scene builder.  Download the file from here (see note below).

Once downloaded, netbeans needs to be updated with the path.

• Click on Tools -> Options
• Click on Java
• Click on JavaFX
• Set the path to the install directory.