Skip to content

An interactive tool for comparing layouts of different split mechanical keyboards

License

Notifications You must be signed in to change notification settings

bleys/splitKbCompare

 
 

Repository files navigation

License: MIT

Copyright (c) 2020 John Helveston

Overview

This app is an interactive tool for comparing layouts of different split mechanical keyboards built for the community of ergonomic keyboard users. Split keyboards offer an ergonomic solution to many issues that make regular keyboards painful or uncomfortable to use, but finding which keyboard is right for you can be costly and difficult. Most split keyboards come as DIY kits, making it difficult (if not impossible) to compare different keyboard layouts prior to building them. This app offers one solution to this problem.

View this repo for a more comprehensive list of split keyboards.

Features

Click one of the "print" buttons to download a printable PDF of the true-to-scale keyboard layouts (8.5" x 11" or A4 sizes).

Filter the keyboard list:

  • Maximum number of keys.
  • Has a number row at the top.
  • Degree of stagger across the key columns.
  • Supports rotary encoders.
  • Wireless.
  • One-piece board or two halves.
  • Availability: DIY and/or pre-built.

Run locally

The app is hosted for free online, but you can also run the app locally on your computer by following these steps:

  1. Install R
  2. Run this code in R to install the shiny library:
install.packages("shiny")
  1. Run this code in R to launch the app:
library(shiny)
runGitHub('jhelvy/splitKbCompare')

Under the hood

This app was built using the R shiny package. Shiny apps are typically used to display data and create interactive dashboards. This app has a different purpose: to help the community of ergonomic keyboard users and hobbyists compare different keyboards.

The app uses the magick library to overlay images of different keyboard layouts of the user's choosing. The app dynamically changes the colors of each keyboard image in real time to help identify the contours of each different keyboard. To print the image to scale, the overlay image is inserted into a RMarkdown document and converted into a true-to-scale PDF. The app is hosted for free on shinyapps.io, and the open source code is hosted on Github.

About

An interactive tool for comparing layouts of different split mechanical keyboards

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • R 90.4%
  • CSS 4.9%
  • HTML 4.7%