Mercurial > public > maze-solver

annotate README.md @ 16:d85066c2de4a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add images to readme
author Dennis C. M. <dennis@denniscm.com>
date Wed, 20 Nov 2024 08:46:42 +0000
parents 7514f6678025
children 01e56e44fd86
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
edee16cfda92 algo working but inefficient
Dennis <denniscmartin@protonmail.com>
parents: 0
diff changeset
1 # maze-solver
edee16cfda92 algo working but inefficient
Dennis <denniscmartin@protonmail.com>
parents: 0
diff changeset
2
16
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
3 I recently saw the [Maze solving youtube video](https://www.youtube.com/watch?v=rop0W4QDOUI) from Computerphile and I find it very interesting. So I decided to build my own maze solver program.
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
4
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
5 It’s a C program that takes a maze PNG and outputs the solution using the [Wall 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
6
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
7 ## Constraints
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
8
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
9 - Only PNG files
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
10 - Mazes should be square
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
11 - 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
12 - Walls and path should be `1px` width
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
13 - 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
14 - 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
15
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
16 ## Usage
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
17
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
18 - Build executable
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
19 - 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
20 - 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
21 - Run the program `./maze_solver maze1.png`
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
22
16
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
23 ### Input
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
24
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
25 ![alt text](.github/1.png)
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
26
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
27 ```bash
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
28 $ ./maze_solver maze.png
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
29 Filename: maze.png
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
30 Width: 101
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
31 Height: 101
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
32 Algorithm duration: 0.000121 seconds
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
33 ```
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
34
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
35 ### Output
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
36
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
37 ![alt text](.github/2.png)
d85066c2de4a Add images to readme
Dennis C. M. <dennis@denniscm.com>
parents: 15
diff changeset
38
15
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
39 ## Note
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
40
7514f6678025 Add docs to README
Dennis Concepción Martín <dennis@denniscmartin.com>
parents: 14
diff changeset
41 You can use this [website](https://keesiemeijer.github.io/maze-generator/) to generate mazes