scramble-visualizer

A 2D virtual Rubik's Cube written in C++.

The main program can take any algorithm in WCA notation and apply it to the virtual cube to show the resultant state.

Screenshots

Compiling

You need:

SFML 2.5+ development headers and library
C++17 compliant compiler
CMake build system

To compile, run CMake on the project directory with CMAKE_BUILD_TYPE=Release and you'll get Makefile or equivalent for your platform, with which you can compile the project.

On Linux and macOS:

~ $ git clone https://github.com/HueFlux/scramble-visualizer.git
~ $ cd scramble-visualizer
~/scramble-visualizer $ mkdir build/ && cd build/
~/scramble-visualizer/build $ cmake -DCMAKE_BUILD_TYPE=Release ..
~/scramble-visualizer/build $ make

Command-Line Version

By default, the SFML version of the project will be built with the method above. If you would instead like to build the command-line version of this project which does not use SFML, you need to run CMake with COMMAND_LINE=ON.

On Linux and macOS:

~ $ git clone https://github.com/HueFlux/scramble-visualizer.git
~ $ cd scramble-visualizer
~/scramble-visualizer $ mkdir build/ && cd build/
~/scramble-visualizer/build $ cmake -DCMAKE_BUILD_TYPE=Release -DCOMMAND-LINE=ON ..
~/scramble-visualizer/build $ make

Switching Between Versions

It is important to note that CMake cache variables persist during reruns of CMake, so in order to switch to the SFML version of the project after building the command-line version, you must either rerun CMake with COMMAND_LINE=OFF or remove CMakeCache.txt from the build directory and rerun CMake normally.

On Linux and macOS:

~/scramble-visualizer/build $ cmake -DCMAKE_BUILD_TYPE=Release -DCOMMAND-LINE=OFF ..
~/scramble-visualizer/build $ make

~/scramble-visualizer/build $ rm CMakeCache.txt
~/scramble-visualizer/build $ cmake -DCMAKE_BUILD_TYPE=Release ..
~/scramble-visualizer/build $ make

Changing Cube Size

By default, the virtual Rubik's Cube is a 3x3x3. To change the size of the cube you must change the size value N in include/cube.hpp to the desired size

class Cube {
    public:
        static const unsigned int N = 3; // Size (Creates a 3x3x3)

and then recompile the project with make or an equivalent.

On Linux and macOS:

~/scramble-visualizer/build $ make

The visualizer should work for any positively sized cube within the memory constraints of your particular system.

Yes, that does mean you can have a trivial 1x1x1 Rubik's Cube:

hueflux / scramble-visualizer Goto Github PK