MagicCube: A NxNxN Rubik Cube implementation

A fast implementation of the Rubik Cube based in Python 3.x.

Makes it easy to create cubes of various sizes (2x2x2, 3x3x3, 4x4x4, 6x6x6, ...., 100x100x100).

Fast rotation speed when compared with other Python implementations, which makes it suitable for Rubik Cube simulations.

Includes:

• Simple solver for the 3x3x3 cube.
• Move optimizer which reduces the number of moves.

Installation

pip install magiccube

Usage

import magiccube

# 3x3x3 Cube
cube = magiccube.Cube(3,"YYYYYYYYYRRRRRRRRRGGGGGGGGGOOOOOOOOOBBBBBBBBBWWWWWWWWW")
print(cube)

# Rotate the cube
cube.rotate("R' L2 U D' F B'2 R' L")

# Solve the 3x3x3 cube
solver = BasicSolver(cube)
solver.solve()

# Complex moves 6x6x6 Cube
cube = magiccube.Cube(6)
cube.rotate("Lw") # L wide rotation
cube.rotate("Lw'") # L wide counter-rotation
cube.rotate("Lw2") # 2x L wide rotation
cube.rotate("3L") # 3rd line L rotation
cube.rotate("3Lw") # 3rd line L wide rotation
cube.rotate("3Lw'2") # 2x 3rd line L wide counter-rotation

Examples

See examples folder.

Supported Moves and Notation

Basic moves

Advanced Moves

Cube Coordinates

• Cube coordinates are expressed as a tuple of x,y,z.
• (0,0,0) is the piece on the LEFT,DOWN,BACK corner.
• In a 3x3x3, (2,2,2) is the piece on the RIGH,UP,FRONT corner.

Solver

The solver uses the beginner method to solve the cube

Move Optimizer

The move optimizer does the following optimizations:

• Eliminates redundant moves (ex: L L L L)
• Converts 3x moves to the inverse (ex: F F F -> F')
• Eliminates cube rotations (ex: Y F -> R)

Development

Install pyenv

curl https://pyenv.run | bash

Setup the environment using pyenv

pyenv virtualenv 3.11 cube-3.11
pyenv local cube-3.11
pip install -r requirements.txt
direnv allow

Install commit hooks

pre-commit install