Skip to content

inixioamillano/rubik-cube-scramble-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

Welcome to rubik-cube-scramble-generator 👋

Version Prerequisite Prerequisite Documentation Maintenance License: MIT Twitter: inixiodev

A simple scramble generator for 3x3x3 Rubik's cubes

Prerequisites

  • npm >=5.5.0
  • node >=9.3.0

Install

npm install --save rubik-cube-scramble-generator

Usage

const scrambler = require('rubik-cube-scramble-generator');
scrambler.generate(); //Returns an array of 10 elements
// Example: ['F', 'R2', 'R', 'U', 'L', 'D2', 'U', 'R', 'L', 'U2']
scrambler.generate(3); //Returns an array of 10 elements
// Example: ['R', 'U', 'L']

Author

👤 Inixio Amillano Casteig

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!


This README was generated with ❤️ by readme-md-generator

About

A npm module to generate Rubik cube scrambles

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published