summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorP. J. McDermott <pj@pehjota.net>2023-02-21 17:53:22 (EST)
committer P. J. McDermott <pj@pehjota.net>2023-02-21 17:53:22 (EST)
commitea04e99a57bca3560186b9a39d3859a8707be0ee (patch)
treeafc5ed0171b8a4162135833f8b6529d654960a64
parent0baefe89218c45d2c1a0ded903158c41e48f932a (diff)
downloadoverworld-rpg-ea04e99a57bca3560186b9a39d3859a8707be0ee.zip
overworld-rpg-ea04e99a57bca3560186b9a39d3859a8707be0ee.tar.gz
overworld-rpg-ea04e99a57bca3560186b9a39d3859a8707be0ee.tar.bz2
README: WRITEME
-rw-r--r--README20
1 files changed, 20 insertions, 0 deletions
diff --git a/README b/README
index e69de29..e95a87f 100644
--- a/README
+++ b/README
@@ -0,0 +1,20 @@
+Boukengine
+----------
+
+Boukengine is an engine for developing adventure role-playing games with
+a 2-D top-down third-person perspective and turn-based combat.
+Boukengine renders tile-based and layered world maps and manages color
+palettes with realistic day/night cycling.
+
+Building
+--------
+
+Boukengine requires the following library packages to build and run:
+
+ * `SDL` 1.2
+ * `SDL_image` 1.2
+ * `Expat`
+ * `zlib`
+ * `Lua` 5.1 or later
+
+Boukengine additionally requires `xcftools` at build time.