From d07708ff01b2d47eee1ee8f39cc7db1f20d652f7 Mon Sep 17 00:00:00 2001
From: ahakkar <107028220+ahakkar@users.noreply.github.com>
Date: Wed, 15 Feb 2023 17:15:05 +0200
Subject: [PATCH] Add a basic readme describing current features
---
README.md | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2687d7d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# ACSIM
+A Micropolis clone. This is mainly a hobby project which helps me to learn how to do new things.
+
+Uses placeholder graphics from Micropolis during the prototype phase, until I can make my own graphics:
+https://github.com/bsimser/Micropolis/blob/develop/Micropolis/Assets/Micropolis/Resources/Tilesets/classic95/tiles.png
+
+Made using Godot 4 game engine, Vulkan renderer.
+
+Features implemented as of 15.2.2023:
+- Mapgen based on provided .png image
+- Map sizes 128x128 - 4096x4096, one tile is ~3x3 meters
+- Procedural forest generation with noise map
+- Chunk rendering to support larger maps
+- Camera pan, zoom in, and out with mouse
+- Camera rotation with arrow keys, in 45 degree steps, or stepless
+- Minimap: move camera with mouse clicks
+- Minimap: show the camera view with a rectangle
+
+Example screenshots:
+
+
+With a rotated camera (and a rotated camera box in minimap):
+