README: update

This commit is contained in:
Jan Mrna
2025-11-03 05:18:59 +01:00
parent 55350a9a3b
commit 0547ee347d

View File

@@ -3,12 +3,14 @@
This is a demo of pathfinding on a 2D grid. It consists of 2 main parts:
* python notes and implementation
* jupyter notebook file
* standalone python script
* C++ interactive demo
* jupyter notebook file: [`python/pathfinding_demo.ipynb`](./python/pathfinding_demo.ipynb)
* standalone python script: [`./python/pathfinding_demo.py`](./python/pathfinding_demo.py)
* C++ interactive demo: [`cpp`](./cpp/)
## Python
Plots a path from one end of the map to the other. Black tiles represent low-cost path, white tiles have high-cost.
![Python pathfinding demo](./docs/img/py_screenshot.png)
### Standalone script
@@ -21,6 +23,10 @@ Contains the same demo as the standalone script and some notes. Since Github sup
## C++
Interactive demo of entities moving on a simple map with terrains of varying cost. Draw left-mouse button over entities to select them, right-mouse button to send them to selected destination. Simple collision checks are implemented.
Uses some C++20 features. Latest generated architecture drawing is available in [`docs/diagrams/class_diagram.svg`](./docs/diagrams/class_diagram.svg)
![C++ pathfinding demo](./docs/img/screenshot_1.png)
### Windows
@@ -90,4 +96,9 @@ clang-uml
plantuml -tsvg docs/diagrams/*.puml
```
The resulting svg files are located in [docs/diagrams/](./docs/diagrams/).
The resulting svg files are located in [docs/diagrams/](./docs/diagrams/).
## Acknowledgments
Entity sprite comes from the Bomberman game, taken from [archive.org](https://archive.org/details/bombermansprites/Custom%20Edited%20-%20Bomberman%20Customs%20-%20Bomberman%20Super%20Bomberman%202-Style.png)