Skip to content

HenryQuillin/pathfinding-algorithm-visualizer

Repository files navigation

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage Examples
  4. License
  5. Contact

About The Project

This Pathfinding Algorithm Visualizer does exactly what it sounds like it does - visualizes algorithms. This desktop application utilizes an unweighted and undirected grid as the graph that the algorithms will traverse. Click anywhere to place the start node, and click a second time to place the end node. After the start and end nodes have been placed, clicking will create a "wall" node (a node that is not traversable by the algorithms). Chose from the dropdown to select an algorithm, press start, and watch the magic happen. As the algorithm traverses the grid, open nodes are green, closed nodes are blue, and the shortest path nodes are purple. Clicking the "Show Heuristic" button will add the algorithm's heuristic to the visualization. If the algorithm has no heuristic - like BFS - it will not be shown. Finally, the application includes an 'Analytics' tab. After each run, this menu will be updated with the type of algorithm, nodes searched, and Nodes seen from the previous run.

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Installation

(These are Mac Commands, but the general steps still apply for Microsoft devices)

  1. Clone the repo
    git clone https://github.com/HenryQuillin/pathfinding-algorithm-visualizer
    
  2. Run setup.py
    sudo python3 setup.py install
    
  3. Wait for the build folder to appear
  4. Run 'main.py'
    python3 main.py
    

Usage

A* Screen Shot 2021-04-05 at 1 06 53 PM A* Screen Shot 2021-04-05 at 1 06 53 PM Breadth First Search Screen Shot 2021-04-05 at 1 06 53 PM Breadth First Search Screen Shot 2021-04-05 at 1 06 53 PM Best First Search Screen Shot 2021-04-05 at 1 06 53 PM

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Henry Quillin - Personal Website - Linkedin - [email protected]

Project Link: https://github.com/github_username/PONG-with-a-twist

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages