https://github.com/janasunrise/maze-generation-algorithm

An implementation of Maze generation algorithm in python using the game and GUI framework pygame.
https://github.com/janasunrise/maze-generation-algorithm

algorithm algorithms hacktoberfest maze-generator python

Last synced: about 1 month ago
JSON representation

An implementation of Maze generation algorithm in python using the game and GUI framework pygame.

• Host: GitHub
• URL: https://github.com/janasunrise/maze-generation-algorithm
• Owner: janaSunrise
• License: apache-2.0
• Created: 2021-04-05T19:30:52.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-06-18T07:40:34.000Z (over 3 years ago)
• Last Synced: 2024-05-11T22:45:04.301Z (6 months ago)
• Topics: algorithm, algorithms, hacktoberfest, maze-generator, python
• Language: Python
• Homepage:
• Size: 179 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Maze generation algorithm

An implementation of [Maze generation algorithm](https://en.wikipedia.org/wiki/Maze_generation_algorithm)

in python using the game and GUI framework pygame.

## Running Demo

Here's a Demo on how it works

![The Maze demo](https://github.com/janaSunrise/maze-generation-algorithm/blob/main/resources/maze.gif)

## Installation

The project uses pipenv for dependencies. If you don't have it yet, Use `pip install pipenv`

to install `pipenv`.

Here's how to install the dependencies.

```sh

pipenv sync -d

```

## Usage

This project has run steps configured using pipenv. Use the following command to

get the maze generation visualization! 

Once ready, Hit the spacebar for the generation! You can also keep hitting

spacebar for generating further when one ends.

```sh

pipenv run start

```

## 🤝 Contributing

Contributions, issues and feature requests are welcome. After cloning & setting up project locally, you can just submit 

a PR to this repo and it will be deployed once it's accepted.

⚠️ It’s good to have descriptive commit messages, or PR titles so that other contributors can understand about your 

commit or the PR Created. Read [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.3/) before 

making the commit message.

## Show your support

We love people's support in growing and improving. Be sure to leave a ⭐️ if you like the project and 

also be sure to contribute, if you're interested!



  Made by Sunrit Jana with ❤️