https://github.com/akashcs50/breadth-first-path-finding-algorithm

Implementing FIFO based Breadth First path finding algorithm
https://github.com/akashcs50/breadth-first-path-finding-algorithm

algorithm breadth-first-search fifo maze pygame python3 tkinter

Last synced: about 1 month ago
JSON representation

Implementing FIFO based Breadth First path finding algorithm

• Host: GitHub
• URL: https://github.com/akashcs50/breadth-first-path-finding-algorithm
• Owner: AKASHCS50
• License: mit
• Created: 2019-10-06T08:48:36.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-10-07T08:47:41.000Z (about 5 years ago)
• Last Synced: 2024-04-23T09:02:37.453Z (8 months ago)
• Topics: algorithm, breadth-first-search, fifo, maze, pygame, python3, tkinter
• Language: Python
• Homepage:
• Size: 40 KB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

 ##  Breadth First Path Finding Algorithm



  

[![GitHub license](https://img.shields.io/github/license/AKASHCS50/Breadth-First-Path-Finding-Algorithm)](https://github.com/AKASHCS50/Breadth-First-Path-Finding-Algorithm/blob/master/LICENSE)








  

    

                              

  

    

  



## Table of Contents

* [About the Project](#about-the-project)

* [Built With](#built-with)

* [Getting Started](#getting-started)

  * [Installation](#installation)

  * [Usage](#usage)

* [Roadmap](#roadmap)

* [Contributing](#contributing)

* [Contact](#contact)

* [License](#license)  

## About The Project

* This Project implements Breadth First path finding algorithm. The algorithm uses FIFO model implemented using queue data structure to find the shortest path. For making the project more fun, and visually appealing I have used pygame python module. You can generate your own maze by just clicking on the box in order to make it behave as an obstacle.

* Once done with your maze hit Spacebar to run the algorithm.

* Also you can generate random maze by hitting the delete key.

## Built With

* Python

* [Pygame](https://pypi.org/project/pygame/)

* [Tkinter](https://tkdocs.com/tutorial/install.html)  (For message box)

## Getting Started

This is an example of how you may give instructions on setting up your project locally.

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

#### Installation

1. Clone the repo ✔     

```sh

git clone https://github.com/AKASHCS50/Breadth-First-Path-Finding-Algorithm

```

2. Install pygame ✔

```pip

pip install pygame

```

3. Install Tkinter ✔


Tkinter is being used to show pop up message box when no path is found.

4. Setting up dimentions of maze ✔


Open main.py code and change screen_width on line number 183 and screen_size on 184 to required value

```python

def main():

    pygame.init()

    screen_size = 500    👈   

    screen_width = 10    👈

    run = True

    lock = 0

```




You are all ready to go 👍

#### Usage

Spacebar - Run Algorithm

Delete - Generate random maze (while window is open).

## Roadmap

The algorithm being used is quite slow for bigger sized mazes. Hence extending the project on same model (code) to implement more advanced algorithms like A* and Dijkstra.


Contributions are welcomed.

## 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 Feature'`)

4. Push to the Branch (`git push origin feature/Feature`)

5. Open a Pull Request

## Contact

Akash Sharma:   [Gmail](mailto:[email protected]) -   [Linkedin](https://www.linkedin.com/in/akash-sharma-1a5433178/)

Project Link: [https://github.com/AKASHCS50/Breadth-First-Path-Finding-Algorithm](https://github.com/AKASHCS50/Breadth-First-Path-Finding-Algorithm)

## License

[MIT](https://github.com/AKASHCS50/Breadth-First-Path-Finding-Algorithm/blob/master/LICENSE) © Akash Sharma





 ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨ ✨