Allow multiple clients to share a map

[hydra-dragonfire.git] / doc / comp_map.md

diff --git a/doc/comp_map.md b/doc/comp_map.md
new file mode 100644 (file)
index 0000000..1c72a34
--- /dev/null
+++ b/doc/comp_map.md
@@ -0,0 +1,16 @@
+# Map Component
+Source code: [comp_map.go](../comp_map.go)
+
+The Map component stores a reference to a `hydra.map` (See [map.md](map.md)).
+
+Initially, an empty map is created. You can replace this by a map reference obtained from `hydra.map` however: this way, multiple clients can share a map and explore different areas of it.
+
+Handles the `blk_data` and `node_metas_changed` packets.
+May send `got_blks` packets.
+
+## Functions
+
+`self:set(mapref)`: Data will be stored in `mapref` in the future.
+
+`self:get()`: Returns the current `mapref`.
+