Rubik's cube

---

A python program that can solve a rubik's cube.

---

How to install

git clone https://github.com/blahberi/rubiks_cube.git

Then all you need is in the Cube folder, so take it out and put it in your project.

Requirements

No requirements needed at all!!! All of the libraries that the program uses are preinstalled with python.

---

How to use

from Cube.cube import Cube  # import cube
from Cube.Solver.beginners import solver

cube = Cube()  # create a cube
cube.scramble()  # scramble cube
solver.solve(cube)  # solve the cube

scramble = cube.scramble() # Cube.scramble() returns a string of the scramble
solution = solver.solve(cube) # solver.solve() returns a string of the solution

The strings will contain the "algorithm" that does that certain action. I will explain what is an algorithm in cubing in the "How does beginners method work" section.

In the solution string you might encounter the move "mR" or "mL".
All that means is completely turn the cube. The "R" or "L" is for L-eft and R-ight.

scrambleSize = 10
cube.scramble(scrambleSize) # you can decide how complex the scramble will be. default of 20

print(cube) # you can also get the string of a cube

Getting the string of a cube will return this:

each square of colors is a side on the cube which goes in the order:

1. Top
2. Left
3. Front
4. Right
5. Back
6. Bottom

w w w 
w w w 
w w w 

o o o 
o o o 
o o o 

g g g 
g g g 
g g g 

r r r 
r r r 
r r r 

b b b 
b b b 
b b b 

y y y 
y y y 
y y y 

• w = White
• o = Orange
• g = Green
• r = Red
• b = Blue
• y = Yellow

So this is a solved cube with white on top and green on front.

---

About this project

I created this project for fun and to learn more about programming.

---

How does it work

The program uses the "beginner's method" to solve a cube. The beginner's method is one of the easiest ways to solve a cube. As you guessed it, beginners use this method to solve a cube as well.

---

How does beginners method work

Beginners method solves the cube layer by layer.

• You first solve a cross on the bottom layer, then you insert the corners of the bottom layer into the bottom layer.
• Then you use algorithms to insert pieces into the second layer.
• After that you use more algorithms to solve a cross on the top side and then you solve the top side entirely.
• Finally, you use even more algorithms to solve the top layer corners and then top layer edges.

An algorithem in cubing means a sequence of moves for example: R U R' U'.
Each letter means which side to turn(default is clockwise)

• R - Right side
• U - Up side
• L - Left side
• D - Down side
• F - Front side
• B - Back side

There are also different symbols at the end which can mean different things

• x' means turn counter clockwise
• x2 means turn 2 times

---

Currently in the work

• Show cube with openGL.
• Make algorithm more efficient.
• Add another algorithm that solves the cube with a shorter solution.