Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.01 KB

README.md

File metadata and controls

40 lines (26 loc) · 1.01 KB

Rubix

A rubix cube simulation library

Done (i.e. In testing)

  • Rubix cube data representation
  • Visual representations of the cube
  • Rubix cube transformation algorithms (face rotations)
  • Batch move execution
  • Random scrambling by seed value
  • Unscrambling by seed value
  • Builds as shared library
  • Interactive rubix cube shell via python

In Development:

  • Enhancements to interactive rubix cube shell via python
  • Monkeys

Down the road:

  • Save/Load state to/from hard drive
  • Rubix cube cube solution algorithm implementation

How to build the tests (which include some demos):

Initialize and update submodules: git submodule init && git submodule update Build with: make test Run with: ./test

Clean the directory with make clean

How to actually use the library:

However you damn please, this code is open source.

That in mind, I recommend using the Python API instead of the C API, as it was hacked together in a day or so

But, try out make && python rubix.py and see what happens