https://github.com/Vlamonster/maze_solver_rust

Generate, display and solve mazes in an animated way in the terminal.
https://github.com/Vlamonster/maze_solver_rust

animation maze-generator maze-solver rust terminal

Last synced: 4 days ago
JSON representation

Generate, display and solve mazes in an animated way in the terminal.

• Host: GitHub
• URL: https://github.com/Vlamonster/maze_solver_rust
• Owner: Vlamonster
• Created: 2023-01-07T14:32:27.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-01-12T20:01:32.000Z (almost 2 years ago)
• Last Synced: 2024-08-02T13:34:49.899Z (4 months ago)
• Topics: animation, maze-generator, maze-solver, rust, terminal
• Language: Rust
• Homepage:
• Size: 275 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# How to Run

```

Usage: maze_solver.exe [OPTIONS] <--generator |--input > [ROWS] [COLUMNS]

Arguments:

  [ROWS]     Number of rows to draw [default: 16]

  [COLUMNS]  Number of columns to draw [default: 48]

Options:

  -g, --generator   Generator used [possible values: depth_first_search, breadth_first_search, kruskal]

  -i, --input           Input path used

  -s, --solver         Solver used. If Some, then the generator will run with a delay of 0 [possible values: depth_first_search, a_star]

  -t, --trace                  Flag to enable drawing visited cells

  -d, --delay           Number of milliseconds between animation [default: 25]

  -h, --help                   Print help information

  -V, --version                Print version information

```

Here are some examples:

```

# Animate generating a 10 by 12 maze using the depth-first seach generator.

cargo run --release -- 10 12 -g depth_first_search

# Animate generating a 16 by 48 maze using the depth-first seach generator and a delay of 0ms (instant).

cargo run --release -- -g depth_first_search -d 0

# Animate solving a 16 by 48 kruskal maze using the depth-first search solver.

cargo run --release -- -g kruskal -s depth_first_search

# Animate solving a 16 by 48 kruskal maze with trace using the depth-first search solver.

cargo run --release -- -g kruskal -s depth_first_search -t

# Animate solving the medium sized example using the depth-first search solver.

cargo run --release -- -i examples/medium.maze -s depth_first_search

```

I tested that this works on at least Windows 10, Ubuntu and macOS.

# Generators

The following generators are included:

Randomized depth-first search.

![](examples/dfs.gif)

Randomized breadth-first search.

![](examples/bfs.gif)

Kruskal's algorithm.

![](examples/kruskal.gif)

# Solvers

The following solvers are included:

Depth-first search

![](examples/dfs_solver.gif)

A*

No gif yet.

# Note on Design

It was important to me that large mazes could be drawn in a limited space, which meant that some thought had to be given

on how the maze should be represented. A simple (yet effective) representation would look like this:

```

+ +-+   [N, H]     

| | |   [V, V, V]     

+ +-+   [N, H]

|   |   [V, N, V]

+-+ +   [H, N]

H: Horizontal,

V: Vertical,

N: None,

```

This is 5x5 character matrix to represent a 2x2 maze. We can do better by combining the vertical and horizontal walls

into the same line:

```

_ ___   [H, N, H, H, H]

| |_|   [V, N, H, V, H]

|__ |   [V, H, N, N, V]

H: Horizontal,

V: Vertical,

N: None,

```

This gives us a 3x3 character matrix, which is a lot better! Furthermore, if replace the underscores with underlines,

then we can actually draw characters inside the cells. This allows for very nice looking animations.