Skip to content

mattrltrent/algorithm_visualizer

Repository files navigation

Pathfinding Algorithms Visualization

algorithm_visualizer is a program that visualizes various pathfinding algorithms. This project aims to provide a visual representation of different pathfinding algorithms, allowing users to understand and compare their performance.

Table of Contents

Introduction

Pathfinding algorithms play a crucial role in various fields, such as robotics, game development, and logistics. This project provides an interactive and visual way to explore different pathfinding algorithms, helping users grasp their underlying principles and observe their performance in different scenarios.

Features

  • Visualization of popular pathfinding algorithms
  • Interactive grid-based environment
  • Start and target node selection
  • Obstacle creation for testing algorithm efficiency
  • Speed control for adjusting animation speed
  • Statistics display to compare algorithm performance
  • Resizable maps

Supported Algorithms

The following pathfinding algorithms are currently supported:

  • Breadth-First Search (BFS)
  • Depth-First Search (DFS)

Installation

To install and run the program locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/mattrltrent/algorithm_visualizer.git
  2. Navigate to the project directory:

    cd algorithm_visualizer
  3. Install the necessary dependencies:

    This Project Requires Flutter/Dart to run, https://docs.flutter.dev/get-started/install.

  4. Run the program:

    flutter run

Usage

  1. Upon running the program, you will be presented with a grid-based environment.
  2. Select a start node by selecting the green icon and clicking on any cell.
  3. Select a target node by selecting the red icon and clicking on another cell.
  4. Add obstacles by clicking and dragging the mouse across the grid.
  5. Choose the desired pathfinding algorithm from the options menu.
  6. Click the "Start" button to begin the visualization.
  7. Observe the algorithm's progress as it attempts to find the optimal path.
  8. Adjust the speed control to modify the animation speed.
  9. Reset the grid and start over by modifying the grid or pressing the "Run Algorithem" button again.

Contributing

Contributions to the project are welcome and encouraged! If you'd like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make the necessary modifications.
  4. Commit and push your changes.
  5. Submit a pull request explaining the changes you've made.

License

MIT License

About

Algorithm visualizer.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published