justinj / cube-simian

Heise cube sim keys helper library

simian

A library for making use of the common mappings for Rubik's Cube simulators.

Notable examples of simulators which use the mappings this library is based off of are hi-games, jflysim, and qcube.

Install

$ npm install --save cube-simian

API

simian.lettersToAlg(<string>)

Example:

simian.lettersToAlg("ijkf") // => "R U R' U'"

simian.keycodeToMove(<int>)

Example:

simian.keycodeToMove(73) // => "R"

for when you have an event handler.