Add README.md

README.md

@@ -0,0 +1,40 @@
+# Maps
+
+This mod adds map items that show terrain in HUD.
+
+The HUD shows a player position & direction marker.
+
+Treasure maps are like normal maps that show a red X.
+
+## In Minetest Game
+
+A right click with a mapping kit creates a map of the area.
+
+If you target a node, its position shows as a red X on a map.
+
+With the X players can share coordinates or have treasure hunts.
+
+## Maps API
+
+You can use `maps.create_map_item()` to create a treasure map:
+
+```
+local itemstack = maps.create_map_item(pos, { draw_x = true })
+```
+
+## Notes
+
+`maps` is similar to `mcl_maps`, which is part of MineClone2.
+
+All map items have a colormapped TGA file in their item meta.
+
+This allows map items to continue to work in world downloads.
+
+## TODO
+
+* Align mapped area with mapblocks (for better performance)
+* Add support for mods with nodes that can show bitmaps
+* Make it possible to wield map item in player hand
+* Add more icons to represent the terrain better
+* Make maps update while player is moving
+* Make it possible to combine maps

init.lua

@@ -1,6 +1,6 @@
 --[[
 
-maps – Minetest mod to render very ugly HUD maps
+maps – Minetest mod that adds map items that show terrain in HUD
 Copyright © 2022  Nils Dagsson Moskopp (erlehmann)
 
 This program is free software: you can redistribute it and/or modify

mod.conf

@@ -1,4 +1,4 @@
 depends = tga_encoder
 optional_depends = map
-description = Shows maps in the player HUD
+description = Adds map items that show terrain in HUD
 name = maps