Skip to the content

Kyuubuキューブ

Turn CSS 3D cubes by touch, keys or notation, reproduce a scramble from a seed, and follow a solve one named step at a time.

Kyuubu (キューブ) is the Japanese spelling of cube. About the name

Contents

Reference · Cube engine and views

readKeyfunction

What a key means on a cube of side n, given the depth a digit before it set (1 where none did).

Import it

import { readKey } from "@johnmorrisdotca/kyuubu";

Definition

function readKey(key: string, shift: boolean, n: number, depth: number): KeyReading

Parameters

NameTypeDescription
keystring

The pressed key, or the cuboid preset key for a lookup.

shiftboolean

Whether Shift reverses the key’s turn.

nnumber

The cube’s side length.

depthnumber

The layer depth counted from the named face, starting at 1.

Returns

KeyReading

What a key means on a cube of side n, given the depth a digit before it set (1 where none did).

Examples

import { readKey } from "@johnmorrisdotca/kyuubu";

console.log(readKey("r", false, 3, 1));
{ move: { axis: 0, layer: 2, turns: 3 } }

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/kyuubu 1.14.1.