Skip to content

Commit 1f60218

Browse files
author
JasonNumberThirteen
committed
Update the README file
1 parent e15d41a commit 1f60218

1 file changed

Lines changed: 23 additions & 16 deletions

File tree

README.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,27 @@
2121
- [GIMP](https://www.gimp.org/ "GIMP - GNU Image Manipulation Program") & [Paint.NET](https://www.getpaint.net/ "Paint.NET - Free Software for Digital Photo Editing") for making graphics.
2222

2323
## Features
24-
- Taking screenshots of the map,
25-
- An animated path trail showing direction,
26-
- Zooming in/out by using a mouse scroll wheel,
27-
- Adjusting weight of heuristic by the input field,
28-
- Tiled map generation by the given dimensions in tiles,
29-
- Finding a path between the start and destination tiles,
30-
- Changing position of map tiles by dragging with a mouse,
31-
- Adjusting weight to each map tile by using a mouse scroll wheel,
32-
- Adjusting finding a path by enabling/disabling diagonal movement,
33-
- Adjusting map dimensions (extending & shrinking) by the given size,
34-
- 3 types of heuristics: Manhattan, Euclidean and Chebyshev distance metrics,
35-
- Coloring tiles on the map which define a path along with those that were set as visited,
36-
- Simulation Mode for showing how the algorithm works in time (by the adjusted timestep),
37-
- 2 types of simulation mode: Timed (step between interval in seconds) & Stepwise (step after clicking a button).
24+
- **MAP GENERATION**
25+
- Generation of a map by the given dimensions in tiles (from **3x3** to **50x50**)
26+
- Adjusting dimensions (extending & shrinking) by the given size in the input field
27+
- **MAP EDITING**
28+
- Changing position of map tiles by dragging with a mouse
29+
- Adjusting weight to each map tile by using a mouse scroll wheel
30+
- Changing tiles type (**passable**/**impassable**) depending on their weight (if it is below 0, then tile is impassable)
31+
- **ALGORITHM**
32+
- Finding a path between the start and destination tiles
33+
- Support of both **4-way** and **8-way** (diagonal) movement
34+
- Coloring on the map which define a path along with those that were set as visited
35+
- Drawing an animated path trail
36+
- **HEURISTIC**
37+
- 3 types: **Manhattan**, **Euclidean** and **Chebyshev** distance metrics
38+
- Adjusting weight (multiplier) by the input field
39+
- **SIMULATION MODE**
40+
- Showing how the algorithm works step by step
41+
- 2 types: **Timed** (step between interval in seconds) and **Stepwise** (step after clicking a button)
42+
- **MISCELLANEOUS**
43+
- Taking screenshots of the map
44+
- Zooming in/out by using a mouse scroll wheel
3845

3946
## Screenshots
4047
![A* Visualiser](./Screenshots/AStarVisualiser.png?raw=true)
@@ -47,10 +54,10 @@
4754

4855
## Project status
4956
<p align = "center"><b>IN PROGRESS</b></p>
50-
<p align = "center"><img src="https://upload.wikimedia.org/wikipedia/commons/7/78/Gasr95percent.png"/></p>
57+
<p align = "center"><img src="https://upload.wikimedia.org/wikipedia/commons/f/f3/Gasr100percent.png"/></p>
5158

5259
---
53-
<p align = "center"><b>The project is completed in ~95%</b>. It still requires further implementations.</p>
60+
<p align = "center"><b>The project is complete and ready to build</b>.</p>
5461

5562
## Credits
5663
This project was made **entirely** by [Stanisław "Jason" Popowski](https://jasonxiii.pl "Jason. Cała informatyka w jednym miejscu! Oficjalna strona internetowa! Setki artykułów na różne tematy! Wszystko stworzone przez jedną osobę!").

0 commit comments

Comments
 (0)