Skip to content
This repository was archived by the owner on Sep 29, 2023. It is now read-only.

Commit d5a2e36

Browse files
Discontinued
1 parent 896cff6 commit d5a2e36

File tree

3 files changed

+13
-5
lines changed

3 files changed

+13
-5
lines changed

changelog.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
# Changelog
22

3-
**Changes from 1.4.0 to 1.4.1**
4-
* Updated 'commander' package.
5-
* Fixed moderate security vulnerability
6-
* Updated license copyright for 2022
3+
**Changes from 1.4.1 to 1.5.0**
4+
Repository discontinued

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "maze-graph-pathfinding",
3-
"version": "1.4.1",
3+
"version": "1.5.0",
44
"description": "Used to find the shortest path between start and end nodes on a maze graph",
55
"main": "maze.js",
66
"scripts": {

readme.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
# Maze Graph Pathfinding
22

3+
---
4+
5+
## As of 29 September 2023, this repository has been discontinued
6+
7+
---
8+
39
This is a command line application that I have developed in Node JS during my free time throughout the 2020 COVID pandemic. The program receives an [image](./info/input-types/maze.png) or [text](./info/input-types/absolute.md) input file representing a maze and outputs it as a HTML file rendered with [Cytoscape.js](https://js.cytoscape.org/). As the name suggests, this program can perform several different pathfinding operations on the maze. This includes finding the shortest path using [Dijkstra](https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm) or [A*Star](https://en.wikipedia.org/wiki/A*_search_algorithm) algorithms.
410

511
---
612

713
## Background
14+
815
One afternoon, I decided on impulse to watch a [Computerphile video](https://www.youtube.com/watch?v=GazC3A4OQTE) hosted by [Dr. Mike Pound](https://github.com/mikepound) demonstrating Dijkstra's algorithm. During my free time in the following months, I set about to write a program in Node JS that can perform pathfinding on mazes either from an image, or a specific-format text file.
916

1017
---
1118

1219
## Getting Started
20+
1321
After downloading the project, open a terminal inside the root folder and run `npm install`. Afterwards, run `node maze` to confirm that the program has been installed and to see a list of supported commands.
1422

1523
For example, the command `node maze map-absolute ./examples/absolute/input.txt dsktra` performs Dijkstra pathfinding on a maze text file. The program will then produce a file `graph.html` in the root directory.
@@ -19,11 +27,13 @@ Example maze images have been generated using Kees Meijer's [Maze Generator](htt
1927
---
2028

2129
## Documentation
30+
2231
* [Commands](./info/commands/readme.md)
2332
* [Input Types](./info/input-types/readme.md)
2433
* [Pathfinding Modes](./info/pathfinding-modes/readme.md)
2534

2635
---
2736

2837
## Disclaimer
38+
2939
This project is licensed under [MIT](https://opensource.org/licenses/MIT). I wrote this program as a personal exercise and for my professional portfolio. You are free to use this project as you see fit for both commercial and non-commercial purposes as long as proper credit is retained and that the MIT license remains intact.

0 commit comments

Comments
 (0)