react-rubiks-cube-utils v1.1.2

React Rubiks Cube Utilities

A comprehensive utility package for Rubik's Cube enthusiasts and developers. This package provides tools to generate scrambles for all WCA standard cubes, create visually appealing displays for cubes given any scramble or cube state. Built with TypeScript.

Installation

Run the following command in your terminal to install the package to your application:

npm install react-rubiks-cube-utils or yarn add react-rubiks-cube-utils

Usage

Note: All functions pertaining to a cube are under the assumption that it is oriented in standard position (white up and green facing towards the user) and thus follow standard face names and movement notation.

To get a scramble for a given cube type, use generateScramble

import { generateScramble } from 'react-rubiks-cube-utils';
const scramble: string = generateScramble({ type: '3x3' });

This will return a string containing the number of moves defined in the turns prop for the cube in the type prop. Currently, the supported cube types are...

• 2x2
• 3x3
• 4x4
• 5x5
• 6x6
• 7x7
• Square-1
• Pyraminx
• Clock
• Skewb
• Megaminx

To apply a scramble to a Cube object, use applyScramble

import { applyScramble, Cube } from  'react-rubiks-cube-utils';
const myScramble: string = "B' U' F2 B2 U D2 R' L U' R' U2 L D2 F' B D' B2 R L' U'";
const scrambledCube: Cube = applyScramble({type: '3x3', scramble: myScramble});
console.log(scrambledCube);

This array reflects the state of all 6 faces of the cube after the scramble has been applied to it. Note, apply scramble only supports 2x2, 3x3, 4x4, 5x5, 6x6, and 7x7.

To render the faces of a Cube object in your front-end, use DisplayCube

import { DisplayCube, generateScramble, applyScramble, Cube } from 'react-rubiks-cube-utils';

export default function RubiksCubeDisplay() {
	const myScramble: string = generateScramble({ type: '3x3' });
	const myCube: Cube = applyScramble({ type: '3x3', scramble: myScramble });
	return (
		<main>
			<DisplayCube cube={myCube} />
		</main>
	);
}

This will return a component that displays the faces of a given cube. At the moment, DisplayCube only supports 2x2, 3x3, 4x4, 5x5, 6x6, and 7x7.

To get a Cube object in solved state, use solvedCube

import { solvedCube } from 'react-rubiks-cube-utils';
console.log(solvedCube({ type: '3x3' }));

This will return an array that reflectes the state of a base solved cube, At the moment solvedCube only supports 2x2, 3x3, 4x4, 5x5, 6x6, and 7x7.

Support

If you encounter any issues or have questions, please open an issue on GitHub.