Generating a Personalized Keyboard

Sorry, you are going to have to do this manually. Server computation is expensive. Python3 is required. Install the latest version of python here.

For advanced options, instructions and premade datasets, visit the official KBMSTR repository.

1. Download the KBMSTR toolset and unzip the contents. Place the configuration made in the last section in toolset directory.
2. In terminal, navigate to toolset directory and install the required libraries: pip install -r requirements.txt
3. Before generating a keyboard, you will need some data. We recommend using the keylogging tool to produce data as you use your keyboard normally. This will produce very personalized data and furtermore a more personalized keyboard.
   • Start the data collection tool in the terminal: python3 collect_data.py
   • The program will produce and pack the collected data into a format suited for the generaiton tool. The data is collected as you use the keyboard normally.
   • We recommend collecting a million characters. Once you collect enough data, stop the data collection by pressing CTRL + C on the terminal.
   • The program will terminate and produce a directory named KBMSTR-DATA-(string of characters) that contains your data. You are able to start and stop this program as you please.
   • Using this tools collects everything you type, hence being called a keylogger. Do not share this data with anyone as it can contain sensative and personal information. We recoomend deleting this data after the generation is done.
   • Alternatively, you can provide data in different ways - read more on the KBMSTR repository
4. Now, you have everything to produce your personalized keyboard! Run the generation tool: python3 KBMSTR.py keyboards/generic.json my_config.json -dataset /dataset_path
   • The program will start to find the best keyboard layout relative to your configuration and dataset.
   • If generation is taking too long, read up on advanced generation options.
5. When the program terminates, your generated keyboard will be saved in the /keyboards directory. You are able to practice your new layout in the practice section!