• Run different search algorithms to solve the drawn maze. Currently available algorithms:

A* Search

Bread-First Search

Depth-First Search

• Freely draw the shapes you want

You can create blocks by right-clicking on nodes.

• Delete unwanted blocks

You can create blocks by left-clicking on nodes.

• Window

You can change several parameters at main.py file. Currently GUI class supports the following parameters:

width : int, optional
    The width of the window, by default 1000
height : int, optional
    The height of the window, by default 700
padding : tuple, optional
    The left, right, bottom, and top respective paddings of the window, by default (0, 0, 0, 0)
gap : int, optional
    The gap between the nodes, by default 1
node_size : int, optional
    The size of the node, by default 25
fps : int, optional
    The amount of frames per second, by default 120

In main.py file you can edit the GUI object creation passing as many parameters as you want, e.g.:

...
gui_fps = 120
path_finding_fps = 30 # FPS used during the PathFinding process.
gui = Gui(width=400, height=200, padding=(0, 0, 5, 5), gap=5, node_size=50, fps=gui_fps)
...

• Keyboard keys mapping

Currently, you can start an algorithm by pressing A for A*, D for Depth-First, and B for Bread-First, which's defined in main.py file:

...
search_mapping = {
    pygame.K_a: aStar,
    pygame.K_d: depthFirst,
    pygame.K_b: breadthFirstSearch,
}
...

You can change this freely by replacing pygame constants with other ones available like pygame.K_a, pygame.K_b, pygame.K_c, pygame.K_d, ..., etc. See all available constants at pygame's documentation

• Colors

You can add new colors for each block function just by following two steps

1- Adding new constant RGB Tuple in colors.py file (There also you will find the existent ones)

...
CUSTOM_COLOR = (122, 42, 177)

2- Editing the node function in node.py file just by calling the name of your new color:

self.state_color_map = {
    "empty": colors.CUSTOM_COLOR,
    "wall": colors.BLACK,
    "start point": colors.GREEN,
    "end point": colors.RED,
    "path": colors.TURQUOISE,
    "visited": colors.ORANGE,
    "watch": colors.PURPLE
}

Thanks for checking out this project!

This project was highly inspired by Cruickshank's A* algorithm explanation, check out his work.