Pathfinding Project README

Overview

Welcome to the Pathfinding Project! This Python project is designed to implement various pathfinding algorithms to find the shortest path between two points on a grid.

Table of Contents

1. Introduction
2. Features
3. Setup
4. Usage
5. Algorithms

Introduction

Pathfinding is a fundamental problem in computer science, involving finding the most efficient route between two points.

Features

• Grid Visualization: View the pathfinding algorithms in action on a visual grid.
• Multiple Algorithms: Implement and compare popular pathfinding and traversing algorithms like Dijkstra's, A*, Bredth-First Search, Depth-First Search.

Setup

1. Clone the Repository:

   git clone https://github.com/boatnoah/pathfinding-project.git

2. Install Dependencies:

   pip install pygame
   pip install pygbag
   

For information on deploying Pygame on the web visit these sites:

• https://dev.to/sandy_codes_py/deploy-pygames-to-github-pages-with-webassembly-56po (github method)
• https://medium.com/@eri.zhang21/running-a-python-game-on-the-web-aa8b13037e15 (hosting service method)

Usage

1. Run the Application:

   python main.py

2. Interact with the GUI:

   • Left Mouse Button: Set start and target positions.
   • Right Mouse Button: Draw walls.
   • c: Clear the grid.
   • Escape: Return to the algorithm selection menu.
   • Enter: Run the selected algorithm.

Algorithms

The project currently supports the following pathfinding algorithms:

• Dijkstra's Algorithm
• A* Algorithm
• Breadth-First Search
• Depth-First Search