Mercurial > public > maze-solver

annotate README.md @ 18:e00c468d4699 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Remove .gitignore
author Dennis C. M. <dennis@denniscm.com>
date Mon, 02 Jun 2025 19:29:37 +0100
parents 01e56e44fd86
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17
01e56e44fd86 Move to mercurial
Dennis C. M. <dennis@denniscm.com>
parents: 16
diff changeset
1 # Maze Solver
1
edee16cfda92 algo working but inefficient
Dennis <denniscmartin@protonmail.com>
parents: 0
diff changeset
2
17
01e56e44fd86 Move to mercurial
Dennis C. M. <dennis@denniscm.com>
parents: 16
diff changeset
3 I recently saw the [Maze solving youtube
01e56e44fd86 Move to mercurial
Dennis C. M. <dennis@denniscm.com>
parents: 16
diff changeset
4 video](https://www.youtube.com/watch?v=rop0W4QDOUI) from Computerphile and I
01e56e44fd86 Move to mercurial
Dennis C. M. <dennis@denniscm.com>
parents: 16
diff changeset
5 find it very interesting. So I decided to build my own maze solver program.
16
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
6
17
01e56e44fd86 Move to mercurial
Dennis C. M. <dennis@denniscm.com>
parents: 16
diff changeset
7 It’s a C program that takes a maze PNG and outputs the solution using the [Wall
01e56e44fd86 Move to mercurial
Dennis C. M. <dennis@denniscm.com>
parents: 16
diff changeset
8 Follower algorithm](https://en.wikipedia.org/wiki/Maze-solving_algorithm)
15
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
9
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
10 ## Constraints
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
11
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
12 - Only PNG files
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
13 - Mazes should be square
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
14 - Walls should be black `rgb(0, 0, 0)` and path white `rg(255, 255, 255)`
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
15 - Walls and path should be `1px` width
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
16 - The starting point must be at `(x: 0, y: 1)`
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
17 - The ending point should be at `(x: width, y: height - 1)`
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
18
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
19 ## Usage
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
20
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
21 - Build executable
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
22 - Make a folder named `mazes` and place your mazes there
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
23 - Make a folder named `sols`. The script place the solutions here
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
24 - Run the program `./maze_solver maze1.png`
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
25
16
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
26 ### Input
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
27
17
01e56e44fd86 Move to mercurial
Dennis C. M. <dennis@denniscm.com>
parents: 16
diff changeset
28 ![alt text](.repo/1.png)
16
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
29
17
01e56e44fd86 Move to mercurial
Dennis C. M. <dennis@denniscm.com>
parents: 16
diff changeset
30 ```bash $ ./maze_solver maze.png Filename: maze.png Width: 101 Height: 101
01e56e44fd86 Move to mercurial
Dennis C. M. <dennis@denniscm.com>
parents: 16
diff changeset
31 Algorithm duration: 0.000121 seconds ```
16
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
32
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
33 ### Output
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
34
17
01e56e44fd86 Move to mercurial
Dennis C. M. <dennis@denniscm.com>
parents: 16
diff changeset
35 ![alt text](.repo/2.png)
16
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
36
15
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
37 ## Note
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
38
17
01e56e44fd86 Move to mercurial
Dennis C. M. <dennis@denniscm.com>
parents: 16
diff changeset
39 You can use this [website](https://keesiemeijer.github.io/maze-generator/) to
01e56e44fd86 Move to mercurial
Dennis C. M. <dennis@denniscm.com>
parents: 16
diff changeset
40 generate mazes