From 2b425e742ef61be87b3e51cb60cfc88929d60b76 Mon Sep 17 00:00:00 2001
From: BuckarooBanzay <BuckarooBanzay@users.noreply.github.com>
Date: Tue, 7 May 2024 14:39:39 +0200
Subject: [PATCH] document basic catalog operations

---
 readme.md | 121 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 121 insertions(+)

diff --git a/readme.md b/readme.md
index 76e4ad7..1837db2 100644
--- a/readme.md
+++ b/readme.md
@@ -52,6 +52,127 @@ For example:
 * `/mb_load xy` loads the schematic from `<world_path>/mapblocks/xy.zip`
 * `/mb_load mymod:schematics/abc` loads the schematic `schematics/abc.zip` from the `mymod` mod-path (`mapblock_lib` has to be a trusted mod)
 
+# Api
+
+## `create_catalog(filename, pos1, pos2, options)`
+
+Creates a mapblock-catalog from the given mapblock range
+
+```lua
+local filename = minetest.get_worldpath() .. "/my-mapblocks.zip"
+local mb_pos1 = { x=0, y=0, z=0 }
+local mb_pos2 = { x=1, y=1, z=1 }
+local options = {
+    -- optional: delay between operations
+    delay = 0.2,
+    -- optional: called when done
+    callback = function()
+        print("done!")
+    end,
+    -- optional: called with current progress
+    progress_callback = function(p)
+        print("progress: " .. p) -- 0 ... 1
+    end
+}
+
+mapblock_lib.create_catalog(filename, mb_pos1, mb_pos2, options)
+```
+
+## `get_catalog(filename)`
+
+Parses a previously create mapblock catalog
+
+```lua
+local filename = minetest.get_worldpath() .. "/my-mapblocks.zip"
+
+local catalog, err = mapblock_lib.get_catalog(filename)
+if err then
+    -- sometehing went wrong
+    error(err)
+end
+
+-- get size in mapblocks
+local size = catalog:get_size()
+-- size, for example: { x=1, y=1, z=1 }
+
+-- check if a mapblock exists within the catalog
+if catalog:has_mapblock({ x=0, y=0, z=0 }) then
+    -- do stuff
+end
+
+-- deserialize a single mapblock into the world
+local catalog_mapblock_pos = { x=0, y=0, z=0 }
+local world_mapblock_pos = { x=10, y=0, z=5 }
+-- all fields are optional
+local options = {
+	-- various transformations to apply to the loaded mapblock
+	transform = {
+		-- rotate the mapblock around the given axis with the angle (90, 180, 270)
+		rotate = {
+			angle = 90,
+			axis = "y",
+			-- disables param2 orientation for the given nodes
+			disable_orientation = {
+				["default:sandstonebrick"] = true
+			}
+		},
+
+		-- replace certain nodes with others
+		replace = {
+			["default:dirt"] = "default:mese"
+		},
+
+		-- bulk set param2 for certain nodes, useful for mass-coloring
+		set_param2 = {
+			["unifiedbricks:brickblock"] = 15
+		}
+	},
+
+	-- metadata callback, can be used to intercept and modify node-metadata/inventory
+	on_metadata = function(pos, content_id, meta)
+		-- resolve nodename (use a var here for better performance)
+		local nodename = minetest.get_name_from_content_id(content_id)
+		if nodename == "default:chest_locked" then
+			print(minetest.pos_to_string(pos), nodename)
+			-- set new owner
+			meta:set_string("owner", "nobody")
+		end
+	end,
+
+	-- placement mode "replace": replace the whole mapblock, "add": replace only air nodes
+	mode = "replace"
+}
+
+local success, err = catalog:deserialize(catalog_mapblock_pos, world_mapblock_pos, options)
+if err then
+    -- sometehing went wrong
+    error(err)
+end
+
+
+-- deserialize all mapblocks to position 1,1,1 without any callback
+local success, err = catalog:deserialize_all({x=1,y=1,z=1})
+
+-- deserialize all mapblocks to position 1,1,1 with options
+local success, err = catalog:deserialize_all({x=1,y=1,z=1}, {
+	-- delay between mapblock exports in seconds (default is 0.2)
+	delay = 1,
+	callback = function(count, micros)
+		-- called after the export is done
+		print("Imported " .. count .. " mapblocks in " .. micros .. " us")
+	end,
+	progress_callback = function(f)
+		-- progress is a fractional number from 0 to 1
+		print("Progress: " .. (f*100) .. "%")
+	end,
+	error_callback = function(import_err)
+		-- handle errors
+		error(import_err)
+	end
+})
+
+```
+
 # License
 
 * Code: MIT