JSPM

sr-scrambler

2.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4
  • Score
    100M100P100Q41879F
  • License ISC

utilitiy to generate scrambles for twisty puzzles (rubiks cube, megaminx, pyraminx, skewb, square1)

Package Exports

  • sr-scrambler
  • sr-scrambler/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (sr-scrambler) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

srScrambler

Tool to generate scrambles for various twisty puzzles. This is not an official WCA scrambler. srScrambler won't generate scrambles with canceling moves, but it is still a naive scramble implemenation. But good enough for casual use.

  • Rubiks Cube (NxN)
  • Skewb
  • Pyraminx
  • Megaminx
  • Square1

Instalation

Install the package using npm

npm install --save sr-scrambler

Usage

Import the module

import * as Scrambler from 'sr-scrambler'

Generate a scramble by invoking the method for the puzzle you want;

// U' B L2 F L2 D2 B D' B' ...
let cubeScramble = Scrambler.cube();

// D++ R++ D-- R++ D++ R++ ...
let megaminxScramble = Scrambler.megaminx();

// U R' U R' L R' L U' R' U r' l' b
let pyraminxScramble = Scrambler.pyraminx();

// U' B L' R L B L' B' U
let skewbScramble = Scrambler.skewb();

// (0, -1) / (3, 4) / (-3, 0) / (3, -3) ...
let square1Scramble = Scrambler.square1();

Cube scrambles can be generated for larger puzzles

let cubeSize = 5 // 5x5
let scrambleSize = 30
let cubeScramble = Scrambler.cube(cubeSize, scrambleSize);

Other scrambles can be generated longer or smaller by providing a scramble size

// U' B R' B U' B' R' B' R' B R' L U B R'
let skewbScramble = Scrambler.skewb(15);