minetest-mod-metatools/README.md

Minetest mod metatools ######################

A mod inspired by mgl512's itemframe issue Version : 1.0

Authors

• LeMagnesium / Mg / ElectronLibre : Source code writer
• Ataron : Texture creater

Purpose

This mod's aim is to provide a way for admins to navigate through any (ok, not ignores) nodes on the map, and see values of its metadatas at any of their stratum.

Media

"metatools_stick.png" by Ataron (CC-BY-NC-SA)

Todo

• Rewrite the table stocking : a variable containing a copy of the global table returned by :to_table(), on which we would work, and a save command to apply it on the node

Special thanks

• mgl512 (Le_Docteur) for its locked itemframe which gave me the idea of a tool allowing to see/edit metadatas
• Ataron who created the stick's texture
• palige who agreed to test the mod for its first release

Command tutorial

• help => Get help
• version => Get version
• open (x,y,z) => Open the node to manipulate at pos (x,y,z)
• show => Show fields/path list at actual position
• enter path => Enter next stratum through path
• quit => Quit actual field and go back to previous stratum
• set name value => Set metadata name to value (create it if it doesn't exist)
• itemstack => Manipulate itemstacks in Node/inventory/*/
  • read name => Read itemstack at field name (itemstring and count)
  • erase name => Erase itemstack at field name
  • write name itemstring [count] => Set itemstack in field name with item itemstring and count count. Default count is one, 0 not handled.
• close => Close node

Node metadatas look like this :

		0	1		2		3		...
		Node/
			|
			+- 		fields
			|		|
			|		+-		foo
			|		+-		bar
			|		+-		...
			+-		inventory
					|
					+-		main
					|		|
					|		+-		1
					|		+-		2
					|		+-		3
					|		+-		...
					+-		craft
					|		|
					|		+-		1
					|		+-		2
					|		+-		3
					|		+-		...
					+-		...