Added README and renamed mod

README.md

@@ -0,0 +1,29 @@
+# Geo Mapgen
+Geo Mapgen is a (still experimental) mod for [Minetest](https://www.minetest.net/) that allows to generate map from digital elevation models like [SRTM](http://srtm.csi.cgiar.org/SELECTION/inputCoord.asp).
+
+It is somewhat like [realterrain](https://forum.minetest.net/viewtopic.php?f=11&t=12666) but behaves differently: you need to run a separate Python file that transform the image into a database that is directly readable by Minetest. This solution was made to avoid running Lua libraries with Minetest (which is not recommended) or reading directly the image with the Lua API that is not made for that.
+
+## Usage
+You must first convert the DEM image into a database, using the python script `image_convert.py` provided by this mod. You need a working Python installation, with libraries `numpy` and `imageio`.
+
+The database should be placed in the world directory and named `heightmap.dat`.
+
+Syntax for the Python script:
+```
+image_convert.py input_file.tif output_file.dat [-f fragmentation]
+```
+Note that even if TIFF files are the most commonly used, any image with only one color channel can be loaded by this script.
+
+In the database, the image is cut into squares with a fixed size (usually 80 px) to make data searching faster. If you want a different size, you can specify it with `-f`.
+
+Example of use:
+```
+./image_convert.py '/home/gael/dem/srtm_38_04.tif' '/home/gael/.minetest/worlds/bidule/heightmap.dat' -f 100
+```
+The conversion may take several minutes.
+
+Once the heightmap.dat file is in the world dir, you can start playing.
+
+## Additional information
+Distributed under the GNU Lesser General Public License, version 2.1.
+Code by Gael-de-Sailly (Gaël C.)

mod.conf

@@ -1 +1 @@
-name = imgen
+name = geo_mapgen