xmaps/README.md

41 lines
1.0 KiB
Markdown
Raw Normal View History

2022-05-20 19:59:18 +02:00
# 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