Skip to content
This repository has been archived by the owner on Sep 18, 2020. It is now read-only.

manunio/ICAScrambo

Repository files navigation

ICAScrambo - Puzzle Scramble Generator

scrambo

Usage

// Generate a new 4x4 scramble with the seed of 1
const seeded_scramble = new ICAScrambow().setType('444').setSeed(1).get();
console.log(seeded_scramble);

// Generate 5 scrambles (defaults to 3x3)
const multiple_scrambles = new ICAScrambowow().get(5);
console.log(multiple_scrambles);

Cli

npm install -g icascrambo

Command line options

-V, --version        output the version number
-n, --number [num]   set amount of scrambles to generate
-t, --type [string]  set the scramble type (default: "333")
-s, --seed [num]     set seed
-l, --length [num]   set scramble length
-h, --help           output usage information

Node.js

npm install icascrambo
const ICAScrambo = require('icascrambo').Scrambow;

const threebythree = new ICAScrambow(); // Defaults to 3x3
console.log(threebythree.get(5)); // Returns 5 scrambles

API

.get(num); // Returns a number of scrambles, defaults to 1.
.setType(str); // Sets the scramble type, defaults to 333.
.setSeed(num); // Repeatable scrambles.
.setLength(num); // Set scramble length, currently only for NNN, minx scrambles.

Current status

Working! Fixed - state of 222 and pyram

Credits

This is a fork of scrambo

Releases

No releases published

Packages

No packages published