summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cd7300d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# godot-hexgrid
+
+is a [godot](https://godotengine.org/) based framework to build classical hex boardgames.
+
+code is based on [gdx-boardgame](https://github.com/jeremyz/gdx-boardgame),
+which is based on [rustanddust](https://github.com/jeremyz/rustanddust).
+
+base map made with [gimp](https://www.gimp.org) and my plugin [hexmap](https://github.com/jeremyz/hexmap)
+
+## features
+
+ - [x] Distance
+ - [ ] Adjacents
+ - [x] Line Of Sight
+ - [ ] Reachable Tiles ::: BFS
+ - [ ] Shortest Path ::: A*
+ - [ ] Range Of Influence (LOS - Fire Power)
+ - [ ] Battle lines (Kruskal + farthest apart units are the flank units)
+
+## screenshots
+
+![Line Of Sight - Move](data/los.png)