Content and functionality can be added to Minetest 0.4 by using Lua scripting in run-time loaded mods.
@@ -388,7 +412,7 @@ source code patches to celeron55@gmail.com<If you have any difficulty in understanding this, please read Programming in Lua.
The main Lua script. Running this script should register everything it wants to register. Subsequent execution depends on minetest calling the registered callbacks.
-minetest.setting_get(name) and minetest.setting_getbool(name) can be used
-to read custom or existing settings at load time, if necessary.
minetest.settings can be used to read custom or existing settings at load
+time, if necessary. (See Settings)
modelsModels for entities or meshnodes.
textures, sounds, mediaRegistered names should generally be in this format:
-"modname:<whatever>" (<whatever> can have characters a-zA-Z0-9_)
+`modname:<whatever>`
+
+<whatever> can have these characters:
+a-zA-Z0-9_
This is to prevent conflicting names from corrupting maps and is
enforced by the mod loader.
@@ -548,7 +575,7 @@ be used for overriding the registrations of some other mod.
The : prefix can also be used for maintaining backwards compatibility.
Aliases
Aliases can be added by using minetest.register_alias(name, convert_to) or
-`minetest.register_alias_force(name, convert_to).
+minetest.register_alias_force(name, convert_to).
This will make Minetest to convert things called name to things called
convert_to.
The only difference between minetest.register_alias and
@@ -624,11 +651,9 @@ specified coordinates.
default_sandstone.png^[resize:16x16
[opacity:<r>
-Makes the base image transparent according to the given ratio.
-r must be between 0 and 255.
-0 means totally transparent.
-255 means totally opaque.
-
+Makes the base image transparent according to the given ratio.
+r must be between 0 and 255.
+0 means totally transparent. 255 means totally opaque.
Example:
default_sandstone.png^[opacity:127
@@ -717,6 +742,145 @@ texture pixel.
Result is more like what you'd expect if you put a color on top of another
color. Meaning white surfaces get a lot of your new color while black parts don't
change very much.
+Hardware coloring
+The goal of hardware coloring is to simplify the creation of
+colorful nodes. If your textures use the same pattern, and they only
+differ in their color (like colored wool blocks), you can use hardware
+coloring instead of creating and managing many texture files.
+All of these methods use color multiplication (so a white-black texture
+with red coloring will result in red-black color).
+Static coloring
+This method is useful if you wish to create nodes/items with
+the same texture, in different colors, each in a new node/item definition.
+Global color
+When you register an item or node, set its color field (which accepts a
+ColorSpec) to the desired color.
+An ItemStacks static color can be overwritten by the color metadata
+field. If you set that field to a ColorString, that color will be used.
+Tile color
+Each tile may have an individual static color, which overwrites every
+other coloring methods. To disable the coloring of a face,
+set its color to white (because multiplying with white does nothing).
+You can set the color property of the tiles in the node's definition
+if the tile is in table format.
+Palettes
+For nodes and items which can have many colors, a palette is more
+suitable. A palette is a texture, which can contain up to 256 pixels.
+Each pixel is one possible color for the node/item.
+You can register one node/item, which can have up to 256 colors.
+Palette indexing
+When using palettes, you always provide a pixel index for the given
+node or ItemStack. The palette is read from left to right and from
+top to bottom. If the palette has less than 256 pixels, then it is
+stretched to contain exactly 256 pixels (after arranging the pixels
+to one line). The indexing starts from 0.
+Examples:
+ 16x16 palette, index = 0: the top left corner
+ 16x16 palette, index = 4: the fifth pixel in the first row
+ 16x16 palette, index = 16: the pixel below the top left corner
+ 16x16 palette, index = 255: the bottom right corner
+ 2 (width)x4 (height) palette, index=31: the top left corner.
+ The palette has 8 pixels, so each pixel is stretched to 32 pixels,
+ to ensure the total 256 pixels.
+ 2x4 palette, index=32: the top right corner
+ 2x4 palette, index=63: the top right corner
+ 2x4 palette, index=64: the pixel below the top left corner
+Using palettes with items
+When registering an item, set the item definition's palette field to
+a texture. You can also use texture modifiers.
+The ItemStack's color depends on the palette_index field of the
+stack's metadata. palette_index is an integer, which specifies the
+index of the pixel to use.
+Linking palettes with nodes
+When registering a node, set the item definition's palette field to
+a texture. You can also use texture modifiers.
+The node's color depends on its param2, so you also must set an
+appropriate drawtype:
+ drawtype = "color" for nodes which use their full param2 for
+ palette indexing. These nodes can have 256 different colors.
+ The palette should contain 256 pixels.
+ drawtype = "colorwallmounted" for nodes which use the first
+ five bits (most significant) of param2 for palette indexing.
+ The remaining three bits are describing rotation, as in wallmounted
+ draw type. Division by 8 yields the palette index (without stretching the
+ palette). These nodes can have 32 different colors, and the palette
+ should contain 32 pixels.
+ Examples:
+ * param2 = 17 is 2 * 8 + 1, so the rotation is 1 and the third (= 2 + 1)
+ pixel will be picked from the palette.
+ * param2 = 35 is 4 * 8 + 3, so the rotation is 3 and the fifth (= 4 + 1)
+ pixel will be picked from the palette.
+* drawtype = "colorfacedir" for nodes which use the first
+ three bits of param2 for palette indexing. The remaining
+ five bits are describing rotation, as in facedir draw type.
+ Division by 32 yields the palette index (without stretching the
+ palette). These nodes can have 8 different colors, and the
+ palette should contain 8 pixels.
+ Examples:
+ * param2 = 17 is 0 * 32 + 17, so the rotation is 17 and the
+ first (= 0 + 1) pixel will be picked from the palette.
+ * param2 = 35 is 1 * 32 + 3, so the rotation is 3 and the
+ second (= 1 + 1) pixel will be picked from the palette.
+To colorize a node on the map, set its param2 value (according
+to the node's draw type).
+Conversion between nodes in the inventory and the on the map
+Static coloring is the same for both cases, there is no need
+for conversion.
+If the ItemStack's metadata contains the color field, it will be
+lost on placement, because nodes on the map can only use palettes.
+If the ItemStack's metadata contains the palette_index field, it is
+automatically transferred between node and item forms by the engine,
+when a player digs or places a colored node.
+You can disable this feature by setting the drop field of the node
+to itself (without metadata).
+Colored items in craft recipes
+Craft recipes only support item strings, but fortunately item strings
+can also contain metadata. Example craft recipe registration:
+minetest.register_craft({
+ output = minetest.itemstring_with_palette("wool:block", 3),
+ type = "shapeless",
+ recipe = {
+ "wool:block",
+ "dye:red",
+ },
+})
+
+To set the color field, you can use minetest.itemstring_with_color.
+Metadata field filtering in the recipe field are not supported yet,
+so the craft output is independent of the color of the ingredients.
+Soft texture overlay
+Sometimes hardware coloring is not enough, because it affects the
+whole tile. Soft texture overlays were added to Minetest to allow
+the dynamic coloring of only specific parts of the node's texture.
+For example a grass block may have colored grass, while keeping the
+dirt brown.
+These overlays are 'soft', because unlike texture modifiers, the layers
+are not merged in the memory, but they are simply drawn on top of each
+other. This allows different hardware coloring, but also means that
+tiles with overlays are drawn slower. Using too much overlays might
+cause FPS loss.
+To define an overlay, simply set the overlay_tiles field of the node
+definition. These tiles are defined in the same way as plain tiles:
+they can have a texture name, color etc.
+To skip one face, set that overlay tile to an empty string.
+Example (colored grass block):
+minetest.register_node("default:dirt_with_grass", {
+ description = "Dirt with Grass",
+ -- Regular tiles, as usual
+ -- The dirt tile disables palette coloring
+ tiles = { {name = "default_grass.png"},
+ {name = "default_dirt.png", color = "white"}},
+ -- Overlay tiles: define them in the same style
+ -- The top and bottom tile does not have overlay
+ overlay_tiles = {"", "",
+ {name = "default_grass_side.png", tileable_vertical = false}},
+ -- Global color, used in inventory
+ color = "green",
+ -- Palette in the world
+ paramtype2 = "color",
+ palette = "default_foilage.png",
+})
+
Sounds
Only Ogg Vorbis files are supported.
For positional playing of sounds, only single-channel (mono) files are
@@ -741,11 +905,15 @@ from the available ones of the following files:
-- Play locationless on all clients
{
gain = 1.0, -- default
+ fade = 0.0, -- default, change to a value > 0 to fade the sound in
+ pitch = 1.0, -- default
}
-- Play locationless to one player
{
to_player = name,
gain = 1.0, -- default
+ fade = 0.0, -- default, change to a value > 0 to fade the sound in
+ pitch = 1.0, -- default
}
-- Play locationless to one player, looped
{
@@ -776,6 +944,7 @@ one player using to_player = name,
e.g. {}
#e.g. {name = "default_place_node"}
#e.g. {name = "default_place_node", gain = 1.0}
+#e.g. {name = "default_place_node", gain = 1.0, pitch = 1.0}
Registered definitions of stuff
Anything added using certain minetest.register_* functions get added to
@@ -811,7 +980,7 @@ the global minetest.registered_* tables.
{name="name", param1=num, param2=num}
param1 and param2 are 8-bit integers. The engine uses them for certain
-automated functions. If you don't use these functions, you can use them to
-store arbitrary values.
param1 and param2 are 8-bit integers ranging from 0 to 255. The engine uses
+them for certain automated functions. If you don't use these functions, you can
+use them to store arbitrary values.
The functions of param1 and param2 are determined by certain fields in the
node definition:
param1 is reserved for the engine when paramtype != "none":
Nodes can also contain extra data. See "Node Metadata".
raillikenodebox -- See below. (Experimental!)mesh -- use models for nodesplantlike_rooted*_optional drawtypes need less rendering time if deactivated (always client side).
noeased) for s
If no flags are specified (or defaults is), 2D noise is eased and 3D noise is not eased.
absvalueAccumulates the absolute value of each noise gradient result.
-Noise parameters format example for 2D or 3D perlin noise or perlin noise maps: - np_terrain = { - offset = 0, - scale = 1, - spread = {x=500, y=500, z=500}, - seed = 571347, - octaves = 5, - persist = 0.63, - lacunarity = 2.0, - flags = "defaults, absvalue" - } - ^ A single noise parameter table can be used to get 2D or 3D noise, - when getting 2D noise spread.z is ignored.
+Noise parameters format example for 2D or 3D perlin noise or perlin noise maps:
+np_terrain = {
+ offset = 0,
+ scale = 1,
+ spread = {x=500, y=500, z=500},
+ seed = 571347,
+ octaves = 5,
+ persist = 0.63,
+ lacunarity = 2.0,
+ flags = "defaults, absvalue"
+}
+^ A single noise parameter table can be used to get 2D or 3D noise,
+ when getting 2D noise spread.z is ignored.
+These tell in what manner the ore is generated.
All default ores are of the uniformly-distributed scatter type.
@@ -1163,14 +1325,12 @@ to small changes. The following is a decent set of parameters to work from: }, noise_threshold = 1.6 -WARNING: Use this ore type very sparingly since it is ~200x more +
WARNING: Use this ore type very sparingly since it is ~200x more computationally expensive than any other ore.
See section "Flag Specifier Format".
-Currently supported flags: absheight
absheightAlso produce this same ore between the height range of -y_max and -y_min.
Useful for having ore in sky realms without having to duplicate ore entries.
+Currently supported flags:
+puff_cliffs, puff_additive_composition.
puff_cliffsIf set, puff ore generation will not taper down large differences in displacement when approaching the edge of a puff. This flag has no effect for ore types other @@ -1211,12 +1371,14 @@ in the form of a table. This table specifies the following fields:
force_place: boolean representing if the node should forcibly overwrite any
previous contents (default: false)About probability values:
- A probability value of 0 or 1 means that node will never appear (0% chance).
- A probability value of 254 or 255 means the node will always appear (100% chance).
-* If the probability value p is greater than 1, then there is a
+
About probability values:
+0 or 1 means that node will never appear (0% chance).254 or 255 means the node will always appear (100% chance).p is greater than 1, then there is a
(p / 256 * 100) percent chance that node will appear when the schematic is
- placed on the map.
+ placed on the map.See section "Flag Specifier Format".
Currently supported flags: place_center_x, place_center_y, place_center_z,
@@ -1338,15 +1500,28 @@ is present, mapped to a boolean of any value, the specified flag is unset.
tool_capabilities.
register_craftitem): A miscellaneous item.All item stacks have an amount between 0 to 65535. It is 1 by +default. Tool item stacks can not have an amount greater than 1.
+Tools use a wear (=damage) value ranging from 0 to 65535. The +value 0 is the default and used is for unworn tools. The values +1 to 65535 are used for worn tools, where a higher value stands for +a higher wear. Non-tools always have a wear value of 0.
Items and item stacks can exist in three formats: Serializes, table format
and ItemStack.
This is called "stackstring" or "itemstring":
+This is called "stackstring" or "itemstring". It is a simple string with +1-3 components: the full item identifier, an optional amount and an optional +wear value. Syntax:
+<identifier> [<amount>[ <wear>]]
+Examples:
'default:dirt 5''default:pick_wood 21323''default:apple''default:apple': 1 apple'default:dirt 5': 5 dirt'default:pick_stone': a new stone pickaxe'default:pick_wood 1 21323': a wooden pickaxe, ca. 1/3 worn outExamples:
@@ -1422,17 +1597,20 @@ effective towards.immortal: Disables the group damage system for an entitypunch_operable: For entities; disables the regular damage mechanism for
+ players punching it by hand or a non-tool item, so that it can do something
+ else than take damage.level: Can be used to give an additional sense of progression in the game.0 is something that is directly accessible at the start of gameplay0 is something that is directly accessible at the start of gameplaydig_immediate: (player can always pick up node without tool wear)2: node is removed without tool wear after 0.5 seconds (rail, sign)3: node is removed without tool wear after 0.15 seconds (torch)dig_immediate: (player can always pick up node without reducing tool wear)
disable_jump: Player (and possibly other things) cannot jump from nodeItem groups are often used for defining, well, groups of items.
- meat: any meat-kind of a thing (rating might define the size or healing
- ability or be irrelevant -- it is not defined as of yet)
- eatable: anything that can be eaten. Rating might define HP gain in half
- hearts.
- flammable: can be set on fire. Rating might define the intensity of the
- fire, affecting e.g. the speed of the spreading of an open fire.
- wool: any wool (any origin, any color)
- metal: any metal
- weapon: any weapon
-* heavy: anything considerably heavy
Item groups are often used for defining, well, groups of items.
+meat: any meat-kind of a thing (rating might define the size or healing
+ ability or be irrelevant -- it is not defined as of yet)eatable: anything that can be eaten. Rating might define HP gain in half
+ hearts.flammable: can be set on fire. Rating might define the intensity of the
+ fire, affecting e.g. the speed of the spreading of an open fire.wool: any wool (any origin, any color)metal: any metalweapon: any weaponheavy: anything considerably heavyGroups such as crumbly, cracky and snappy are used for this
purpose. Rating is 1, 2 or 3. A higher rating for such a group implies
@@ -1491,9 +1671,9 @@ groups to enable interaction with tools.
0, 1, 2 or 3)0, 1, 2 or 3)2 or 3
for this group, and unable to dig the rating 1, which is the toughest.
Unless there is a matching group that enables digging otherwise.
+If the result digging time is 0, a delay of 0.15 seconds is added between +digging nodes; If the player releases LMB after digging, this delay is set to 0, +i.e. players can more quickly click the nodes away instead of holding LMB.
List of damage for groups of entities. See "Entity damage mechanism".
Item metadata only contains a key-value store.
Some of the values in the key-value store are handled specially:
description: Set the itemstack's description. Defaults to idef.descriptiondescription: Set the item stack's description. Defaults to idef.descriptioncolor: A ColorString, which sets the stack's color.palette_index: If the item has a palette, this is used to get the
current color from the palette.container[<X>,<Y>]container_endtooltip[<gui_element_name>;<tooltip_text>;<bgcolor>,<fontcolor>]tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>;<fontcolor>]<bgcolor> tooltip background color as ColorString (optional)field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]fields.key_enter_field will be sent with the name
of this field.x and y position the field relative to the top left of the menuw and h are the size of the fieldfield_close_on_enter to stop enter closing the formspecfield[<name>;<label>;<default>]fields.key_enter_field will be sent with the name
of this field.size[] elementfield_close_on_enter to stop enter closing the formspecfield_close_on_enter[<name>;<close_on_enter>]x, y and name work as per fieldw and h are the size of the buttonhlabel is the text on the buttonw and h: width and heightorientation: vertical/horizontal0-1000)0-1000)minetest.explode_scrollbar_event (main menu: engine.explode_scrollbar_event)table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]0=<value> sets image for image index 01=<value> sets image for image index 12=<value> sets image for image index 20.Most text can contain escape sequences, that can for example color the text.
There are a few exceptions: tab headers, dropdowns and vertical labels can't.
-The following functions provide escape sequences:
- core.get_color_escape_sequence(color):
- * color is a ColorString
- * The escape sequence sets the text color to color
- core.colorize(color, message):
- * Equivalent to:
- core.get_color_escape_sequence(color) ..
- message ..
- core.get_color_escape_sequence("#ffffff")
- color.get_background_escape_sequence(color)
- * color is a ColorString
- * The escape sequence sets the background of the whole text element to
- color. Only defined for item descriptions and tooltips.
- color.strip_foreground_colors(str)
- * Removes foreground colors added by get_color_escape_sequence.
- color.strip_background_colors(str)
- * Removes background colors added by get_background_escape_sequence.
- color.strip_colors(str)
- * Removes all color escape sequences.
minetest.get_color_escape_sequence(color):
+minetest.colorize(color, message):minetest.get_color_escape_sequence(color) ..
+ message ..
+ minetest.get_color_escape_sequence("#ffffff")minetest.get_background_escape_sequence(color)
+minetest.strip_foreground_colors(str)get_color_escape_sequence.minetest.strip_background_colors(str)get_background_escape_sequence.minetest.strip_colors(str)vector.new(a[, b, c]): returns a vector:math.sign(x, tolerance)
minetest.pos_to_string({x=X,y=Y,z=Z}, decimal_places)): returns "(X,Y,Z)"minetest.wrap_text(str, limit): returns a stringminetest.pos_to_string({x=X,y=Y,z=Z}, decimal_places)): returns string "(X,Y,Z)"minetest.is_singleplayer()minetest.features: Table containing API feature flags
- {
- glasslike_framed = true,
- nodebox_as_selectionbox = true,
- chat_send_player_param3 = true,
- get_all_craft_recipes_works = true,
- use_texture_alpha = true,
- -- ^ The transparency channel of textures can be used optionally
- no_legacy_abms = true,
- -- ^ Tree and grass ABMs are no longer done from C++
- texture_names_parens = true,
- -- ^ Texture grouping is possible using parentheses
- area_store_custom_ids = true,
- -- ^ Unique Area ID for AreaStore:insert_area
- add_entity_with_staticdata = true,
- -- ^ add_entity supports passing initial staticdata to on_activate
- no_chat_message_prediction = true,
- -- ^ Chat messages are no longer predicted
- }minetest.has_feature(arg): returns boolean, missing_featuresminetest.features: Table containing API feature flags{
+ glasslike_framed = true,
+ nodebox_as_selectionbox = true,
+ chat_send_player_param3 = true,
+ get_all_craft_recipes_works = true,
+ use_texture_alpha = true,
+-- ^ The transparency channel of textures can be used optionally
+ no_legacy_abms = true,
+-- ^ Tree and grass ABMs are no longer done from C++
+ texture_names_parens = true,
+-- ^ Texture grouping is possible using parentheses
+ area_store_custom_ids = true,
+-- ^ Unique Area ID for AreaStore:insert_area
+ add_entity_with_staticdata = true,
+-- ^ add_entity supports passing initial staticdata to on_activate
+ no_chat_message_prediction = true,
+-- ^ Chat messages are no longer predicted
+}
+minetest.has_feature(arg): returns boolean, missing_featuresarg: string or table in format {foo=true, bar=true}missing_features: {foo=true, bar=true}minetest.get_player_information(player_name):{
+ address = "127.0.0.1", -- IP address of client
+ ip_version = 4, -- IPv4 / IPv6
+ min_rtt = 0.01, -- minimum round trip time
+ max_rtt = 0.2, -- maximum round trip time
+ avg_rtt = 0.02, -- average round trip time
+ min_jitter = 0.01, -- minimum packet time jitter
+ max_jitter = 0.5, -- maximum packet time jitter
+ avg_jitter = 0.03, -- average packet time jitter
+ connection_uptime = 200, -- seconds since client connected
+ prot_vers = 31, -- protocol version used by client
+ -- following information is available on debug build only!!!
+ -- DO NOT USE IN MODS
+ --ser_vers = 26, -- serialization version used by client
+ --major = 0, -- major version number
+ --minor = 4, -- minor version number
+ --patch = 10, -- patch version number
+ --vers_string = "0.4.9-git", -- full version string
+ --state = "Active" -- current client state
+}
+minetest.mkdir(path): returns success.path, creating parent directories
+ if they don't exist.minetest.get_player_information(player_name):-- following information is available on debug build only!!!
--- DO NOT USE IN MODS
---ser_vers = 26, -- serialization version used by client
---prot_vers = 23, -- protocol version used by client
---major = 0, -- major version number
---minor = 4, -- minor version number
---patch = 10, -- patch version number
---vers_string = "0.4.9-git", -- full version string
---state = "Active" -- current client state
-}
- minetest.mkdir(path): returns success.
- * Creates a directory specified by path, creating parent directories
- if they don't exist.
- minetest.get_dir_list(path, [is_dir]): returns list of entry names
- * is_dir is one of:
- * nil: return all entries,
- * true: return only subdirectory names, or
- * false: return only file names.
-* minetest.get_version(): returns a table containing components of the
- engine version. Components:
- * project: Name of the project, eg, "Minetest"
- * string: Simple version, eg, "1.2.3-dev"
- * hash: Full git version (only set if available), eg, "1.2.3-dev-01234567-dirty"
+
minetest.get_dir_list(path, [is_dir]): returns list of entry namesminetest.get_version(): returns a table containing components of the
+ engine version. Components:project: Name of the project, eg, "Minetest"string: Simple version, eg, "1.2.3-dev"hash: Full git version (only set if available), eg, "1.2.3-dev-01234567-dirty"
Use this for informational purposes only. The information in the returned
table does not represent the capabilities of the engine, nor is it
reliable or verifyable. Compatible forks will have a different name and
version entirely. To check for the presence of engine features, test
whether the functions exported by the wanted features exist. For example:
- if core.nodeupdate then ... end.
+ if minetest.nodeupdate then ... end.minetest.register_craft(recipe). For output specify only the item, without a quantity.player: ObjectRef of the playerhp_change: the amount of change. Negative when it is damage.modifier: when true, the function should return the actual hp_change.
+modifier: when true, the function should return the actual hp_change.
Note: modifiers only get a temporary hp_change that can be modified by later modifiers.
modifiers can return true as a second argument to stop the execution of further functions.
Non-modifiers receive the final hp change calculated by the modifiers.minetest.register_chatcommand(cmd, chatcommand definition)minetest.registered_chatcommandsminetest.override_chatcommand(name, redefinition)register_chatcommand.minetest.unregister_chatcommand(name)register_chatcommand.minetest.register_privilege(name, definition)definition: "description text"definition: { description = "description text", give_to_singleplayer = boolean}
the default of give_to_singleplayer is truebasic_privs to grant, see basic_privs minetest.conf setting.minetest.register_authentication_handler(handler)minetest.setting_set(name, value)="{}#.\n""".minetest.setting_get(name): returns string or nilminetest.setting_setbool(name, value)setting_set for restrictions.minetest.setting_getbool(name): returns boolean or nilminetest.setting_get_pos(name): returns position or nilminetest.setting_save(), returns nil, save all settings to config fileminetest.settings: Settings object containing all of the settings from the
+ main config file (minetest.conf).minetest.setting_get_pos(name): Loads a setting from the main settings and
+ parses it as a position (in the format (1,2,3)). Returns a position or nil.minetest.check_password_entry instead.minetest.string_to_privs(str): returns {priv1=true,...}minetest.auth_reload call the authetification handler.
to get the light value of a neighbor.pos: The position where to measure the light.timeofday: nil for current time, 0 for night, 0.5 for day0 and 15 or nil0 and 15 or nilminetest.place_node(pos, node)minetest.auth_reload call the authetification handler.
minetest.find_node_near(pos, radius, nodenames): returns pos or nilminetest.find_node_near(pos, radius, nodenames, [search_center]): returns pos or nil
minetest.find_nodes_in_area(minp, maxp, nodenames): returns a list of positionsminetest.find_nodes_in_area(pos1, pos2, nodenames): returns a list of positionsnodenames: e.g. {"ignore", "group:tree"} or "default:dirt"minetest.find_nodes_in_area_under_air(minp, maxp, nodenames): returns a list of positionsminetest.find_nodes_in_area_under_air(pos1, pos2, nodenames): returns a list of positionsnodenames: e.g. {"ignore", "group:tree"} or "default:dirt"minetest.get_perlin(noiseparams)minetest.auth_reload call the authetification handler.
get_gen_notify(): returns a flagstring and a table with the deco_idsget_gen_notify(): returns a flagstring and a table with the deco_idsminetest.get_mapgen_object(objectname)minetest.auth_reload call the authetification handler.
minetest.get_mapgen_params() Returns mapgen parameters, a table containing
mgname, seed, chunksize, water_level, and flags.minetest.get_mapgen_setting(name) insteadminetest.set_mapgen_params(MapgenParams)minetest.set_mapgen_setting(name, value, override) insteadon_mapgen_initminetest.auth_reload call the authetification handler.
minetest.get_mapgen_setting(name)minetest.get_mapgen_setting(name)minetest.auth_reload call the authetification handler.
is not already present in map_meta.txt.override_meta is an optional boolean (default: false). If this is set to true,
the setting will become the active setting regardless of the map metafile contents."seed", not "fixed_map_seed"minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])minetest.set_noiseparams(name, noiseparams, set_default)minetest.auth_reload call the authetification handler.
action could be one of the following constant values:core.EMERGE_CANCELLED, core.EMERGE_ERRORED, core.EMERGE_FROM_MEMORY,core.EMERGE_FROM_DISK, core.EMERGE_GENERATEDminetest.EMERGE_CANCELLED, minetest.EMERGE_ERRORED, minetest.EMERGE_FROM_MEMORY,minetest.EMERGE_FROM_DISK, minetest.EMERGE_GENERATEDcalls_remaining is the number of callbacks to be expected after this oneminetest.auth_reload call the authetification handler.
time. Default is 1.minetest.raycast(pos1, pos2, objects, liquids): returns Raycast
+minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)pos1 to pos2 or nilpos1: start positionpos2: end positionpos1 to pos2 or nilpos1: start positionpos2: end positionsearchdistance: number of blocks to search in each direction using a maximum metricmax_jump: maximum height difference to consider walkablemax_drop: maximum height difference to consider droppableminetest.auth_reload call the authetification handler.
minetest.spawn_tree (pos, {treedef})pos with definition in treedef tableminetest.transforming_liquid_add(pos)minetest.auth_reload call the authetification handler.
pos1 is the corner of the cuboid with the least coordinates
+pos1 is the corner of the cuboid with the least coordinates
(in node coordinates), inclusive.pos2 is the opposite corner of the cuboid, inclusive.pos2 is the opposite corner of the cuboid, inclusive.minetest.auth_reload call the authetification handler.
true otherwisecore.check_single_for_falling(pos)minetest.check_single_for_falling(pos)group:falling_node node to fall and causes an
unattached group:attached_node node to fall.core.check_for_falling(pos)minetest.check_for_falling(pos)group:falling_node node to fall and causes an
unattached group:attached_node node to fall.minetest.auth_reload call the authetification handler.
minetest.create_detached_inventory(name, callbacks, [player_name]): returns an InvRefplayer_name: Make detached inventory available to one player exclusively,
by default they will be sent to every player (even if not used).
Note that this parameter is mostly just a workaround and will be removed in future releases.minetest.auth_reload call the authetification handler.
minetest.close_formspec(playername, formname)playername: name of player to close formspecformname: has to exactly match the one given in show_formspec, or the formspec will
+formname: has to exactly match the one given in show_formspec, or the formspec will
not close.show_formspec(playername, formname, "") is equal to this expressionminetest.close_formspec(playername, ""). USE THIS ONLY WHEN ABSOLUTELY NECESSARY!minetest.formspec_escape(string): returns a stringminetest.auth_reload call the authetification handler.
minetest.get_all_craft_recipes(query item): returns a table or nilnil if no recipe was found"default:gold_ingot" will return table:
- {
- [1]={type = "cooking", width = 3, output = "default:gold_ingot",
- items = {1 = "default:gold_lump"}},
- [2]={type = "normal", width = 1, output = "default:gold_ingot 9",
- items = {1 = "default:goldblock"}}
- }{
+ method = 'normal' or 'cooking' or 'fuel'
+ width = 0-3, 0 means shapeless recipe
+ items = indexed [1-9] table with recipe items
+ output = string with item name and quantity
+}
+* Example query for `"default:gold_ingot"` will return table:
+
+{
+ [1]={method = "cooking", width = 3, output = "default:gold_ingot",
+ items = {1 = "default:gold_lump"}},
+ [2]={method = "normal", width = 1, output = "default:gold_ingot 9",
+ items = {1 = "default:goldblock"}}
+}
+minetest.handle_node_drops(pos, drops, digger)drops: list of itemstringsminetest.auth_reload call the authetification handler.
ground)minetest.itemstring_with_palette(item, palette_index): returns an item stringitem: the item stack which becomes colored. Can be in string,
+ table and native form.palette_index: this index is added to the item stackminetest.itemstring_with_color(item, colorstring): returns an item stringitem: the item stack which becomes colored. Can be in string,
+ table and native form.colorstring: the new color of the item stackminetest.auth_reload call the authetification handler.
minetest.sound_stop(handle)minetest.sound_fade(handle, step, gain)
+minetest.auth_reload call the authetification handler.
minetest.get_server_status(): returns server status stringminetest.get_server_uptime(): returns the server uptime in secondsminetest.remove_player(name): remove player from database (if he is not connected).minetest.auth_reload call the authetification handler.
collisiondetection, texture, playername)`minetest.delete_particlespawner(id, player)``
+minetest.delete_particlespawner(id, player)
ParticleSpawner with id (return value from minetest.add_particlespawner)ParticleSpawner with id (return value from minetest.add_particlespawner)minetest.auth_reload call the authetification handler.
minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)
probability_list.probability_list.probability_list is an array of tables containing two fields, pos and prob.pos is the 3D vector specifying the absolute coordinates of the
node being modified,prob is the integer value from 0 to 255 of the probability (see: Schematic specifier).prob is an integer value from 0 to 255 that encodes probability and
+ per-node force-place. Probability has levels 0-127, then 128 is added to
+ encode per-node force-place.
+ For probability stated as 0-255, divide by 2 and round down to get values
+ 0-127, then add 128 to apply per-node force-place.pos is not inside the box formed by p1 and p2, it is ignored.probability_list equals nil, no probabilities are applied.ypos instead which
- indicates the y position of the slice with a probability applied.slice_prob_list.slice_prob_list is an array of tables containing two fields, ypos and prob.
minetest.auth_reload call the authetification handler.
minetest.get_item_group(name, group): returns a rating
minetest.get_node_group(name, group): returns a ratingminetest.auth_reload call the authetification handler.
minetest.deserialize(string): returns a tableminetest.deserialize into a tablestring is loaded in an empty sandbox environment.string is loaded in an empty sandbox environment.deserialize('return { ["foo"] = "bar" }'), returns {foo='bar'}deserialize('print("foo")'), returns nil (function call fails)minetest.auth_reload call the authetification handler.
... indicates method-specific arguments. Currently, no methods use this.minetest.rgba(red, green, blue[, alpha]): returns a stringminetest.rgba(10, 20, 30, 40), returns "#0A141E28"minetest.encode_base64(string): returns string encoded in base64minetest.registered_nodesminetest.registered_nodesminetest.registered_chatcommandsminetest.registered_chatcommandsminetest.get_meta(pos).
get_inventory(): returns InvRefmark_as_private(name or {name1, name2, ...}): Mark specific vars as private
+ This will prevent them from being sent to the client. Note that the "private"
+ status will only be remembered if an associated key-value pair exists, meaning
+ it's best to call this when initializing all other meta (e.g. on_construct).ItemStackMetaRefItemStack metadata: reference extra data and functionality stored in a stack.
@@ -3601,7 +3860,7 @@ Can be gotten via minetest.get_node_timer(pos).
timeout is in seconds, and supports fractional values (0.1 etc)elapsed is in seconds, and supports fractional values (0.1 etc)on_timer function after timeout-elapsed secondson_timer function after (timeout - elapsed) secondsstart(timeout)minetest.get_node_timer(pos).
get_elapsed(): returns current elapsed time in seconds
is_started(): returns boolean state of timerminetest.get_node_timer(pos).
remove(): remove object (after returning from Lua)minetest.kick_player insteadget_pos(): returns {x=num, y=num, z=num}minetest.get_node_timer(pos).
set_armor_groups({group1=rating, group2=rating, ...})get_armor_groups(): returns a table with the armor group ratingsset_animation({x=1,y=1}, frame_speed=15, frame_blend=0, frame_loop=true)get_animation(): returns range, frame_speed, frame_blend and frame_loopget_animation(): returns range, frame_speed, frame_blend and frame_loopset_attach(parent, bone, position, rotation)
get_look_pitch(): pitch in radians - Deprecated as broken. Use get_look_vertical.get_look_pitch(): pitch in radians - Deprecated as broken. Use get_look_vertical.get_look_yaw(): yaw in radians - Deprecated as broken. Use get_look_horizontal.get_look_yaw(): yaw in radians - Deprecated as broken. Use get_look_horizontal.set_look_pitch(radians): sets look pitch - Deprecated. Use set_look_vertical.set_look_yaw(radians): sets look yaw - Deprecated. Use set_look_horizontal.set_look_pitch(radians): sets look pitch - Deprecated. Use set_look_vertical.set_look_yaw(radians): sets look yaw - Deprecated. Use set_look_horizontal.get_breath(): returns players breathset_breath(value): sets players breathset_attribute(attribute, value): sets an extra attribute with value on playerget_attribute(attribute): returns value for extra attribute. Returns nil if no attribute found.set_attribute(attribute, value):
+get_attribute(attribute):nil if no attribute found.set_inventory_formspec(formspec)on_joinplayerget_inventory_formspec(): returns a formspec stringminetest.get_node_timer(pos).
get_physics_override(): returns the table given to set_physics_overrideget_physics_override(): returns the table given to set_physics_overridehud_add(hud definition): add a HUD element described by HUD def, returns ID
number on successhud_remove(id): remove the HUD element of the specified idminetest.get_node_timer(pos).
hud_set_flags(flags): sets specified HUD flags to true/falseflags: (is visible) hotbar, healthbar, crosshair, wielditem, minimaptrue/false value of each flag to be set or unsetnil, the flag is not modifiednil, the flag is not modifiedminimap modifies the client's permission to view the minimap -minetest.get_node_timer(pos).
hud_get_hotbar_selected_image: returns texturenameset_sky(bgcolor, type, {texture names})set_sky(bgcolor, type, {texture names}, clouds)bgcolor: ColorSpec, defaults to whiteget_sky(): returns bgcolor, type and a table with the texturesget_sky(): returns bgcolor, type, table of textures, cloudsset_clouds(parameters): set cloud parametersparameters is a table with the following optional fields:density: from 0 (no clouds) to 1 (full clouds) (default 0.4)color: basic cloud color with alpha channel, ColorSpec (default #fff0f0e5)ambient: cloud color lower bound, use for a "glow at night" effect.
+ ColorSpec (alpha ignored, default #000000)height: cloud height, i.e. y of cloud base (default per conf, usually 120)thickness: cloud thickness in nodes (default 16)speed: 2D cloud speed + direction in nodes per second (default {x=0, z=-2})get_clouds(): returns a table with the current cloud parameters as in set_cloudsoverride_day_night_ratio(ratio or nil)0...1: Overrides day-night ratio, controlling sunlight to a specific amountnil: Disables override, defaulting to sunlight based on day-night cycle0...1: Overrides day-night ratio, controlling sunlight to a specific amountnil: Disables override, defaulting to sunlight based on day-night cycleget_day_night_ratio(): returns the ratio or nil if it isn't overriddenminetest.get_node_timer(pos).
frame_speed=30): -- < animation frame speed
get_local_animation(): returns stand, walk, dig, dig+walk tables and frame_speedget_local_animation(): returns stand, walk, dig, dig+walk tables and frame_speedset_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0}): defines offset value for camera per player{x=-10/10,y=-10,15,z=-5/5})get_eye_offset(): returns offset_first and offset_thirdget_eye_offset(): returns offset_first and offset_thirdminetest.get_node_timer(pos).
add_item(listname, stack): add item somewhere in list, returns leftover ItemStackroom_for_item(listname, stack): returns true if the stack of items
can be fully added to the listcontains_item(listname, stack): returns true if the stack of items
- can be fully taken from the listcontains_item(listname, stack, [match_meta]): returns true if
+ the stack of items can be fully taken from the list.
+ If match_meta is false, only the items' names are compared (default: false).remove_item(listname, stack): take as many items as specified from the list,
returns the items that were actually removed (as an ItemStack) -- note that
any item metadata is ignored, so attempting to remove a specific unique
@@ -3949,7 +4234,7 @@ an itemstring, a table or nil.
set_metadata(metadata): (DEPRECATED) Returns true.clear(): removes all items from the stack, making it empty.replace(item): replace the contents of this stack.
to_string(): Returns the stack in itemstring form.next(min, max): return next integer random number [min...max]rand_normal_dist(min, max, num_trials=6): return normally distributed random number [min...max]mean = (max - min) / 2, andvariance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)num_trials improves accuracy of the approximationIt is important to note that VoxelManip is designed for speed, and not ease of use or flexibility. If your mod requires a map manipulation facility that will handle 100% of all edge cases, or the use -of high level node placement features, perhaps minetest.set_node() is better suited for the job.
+of high level node placement features, perhapsminetest.set_node() is better suited for the job.
In addition, VoxelManip might not be faster, or could even be slower, for your specific use case.
VoxelManip is most effective when setting very large areas of map at once - for example, if only
-setting a 5x5x5 node area, a minetest.set_node() loop may be more optimal. Always profile code
+setting a 5x5x5 node area, a minetest.set_node() loop may be more optimal. Always profile code
using both methods of map manipulation to determine which is most appropriate for your usage.
A VoxelManip object can be created any time using either: @@ -4089,9 +4374,9 @@ otherwise explicitly stated.
Once the bulk data has been edited to your liking, the internal VoxelManip state can be set using:
VoxelManip:set_data() for node content (in Content ID form, see section 'Content IDs'),
VoxelManip:set_light_data() for node light levels, and
-VoxelManip:set_param2_data() for the node type-dependent "param2" values.
VoxelManip:set_param2_data() for the node type-dependent param2 values.
The parameter to each of the above three functions can use any table at all in the same flat array -format as produced by get_data() et al. and is not required to be a table retrieved from get_data().
+format as produced byget_data() et al. and is not required to be a table retrieved from get_data().
Once the internal VoxelManip state has been modified to your liking, the changes can be committed back
to the map by calling VoxelManip:write_to_map().
VoxelManip:write_to_map().
Nz = p2.Z - p1.Z + 1.
Then, for a loaded region of p1..p2, this array ranges from 1 up to and including the value of
the expression Nx * Ny * Nz.
Positions offset from p1 are present in the array with the format of:
- Positions offset from p1 are present in the array with the format of: The following builtin node types have their Content IDs defined as constants:
- The following builtin node types have their Content IDs defined as constants: Inside of [
+[
(0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
(0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
...
@@ -4125,10 +4410,12 @@ in place of the node name string for to look up the node name string for a given Content ID.
After registration of a node, its Content ID will remain the same throughout execution of the mod.
Note that the node being queried needs to have already been been registered.VoxelManip:get_data() and core.CONTENT_UNKNOWN (ID for "unknown" nodes)
-core.CONTENT_AIR (ID for "air" nodes)
-core.CONTENT_IGNORE (ID for "ignore" nodes)
+
minetest.CONTENT_UNKNOWN: ID for "unknown" nodesminetest.CONTENT_AIR: ID for "air" nodesminetest.CONTENT_IGNORE: ID for "ignore" nodesMapgen VoxelManip objects
on_generated() callbacks, it is possible to retrieve the same VoxelManip object used by the
core's Map Generator (commonly abbreviated Mapgen). Most of the rules previously described still apply
@@ -4186,7 +4473,7 @@ will place the schematic inside of the VoxelManip.light is false, no light calculations happen, and you should correct
all modified blocks with minetest.fix_light() as soon as possible.
Keep in mind that modifying the map where light is incorrect can cause
- more lighting bugs.
get_node_at(pos): Returns a MapNode table of the node currently loaded in
@@ -4207,8 +4494,8 @@ will place the schematic inside of the VoxelManip.
get_light_data(): Gets the light data read into the VoxelManip object0 to 2550 to 15 each)0 to 2550 to 15 each)light = day + (night * 16)get_param2_data([buffer]): Gets the raw param2 data read into the VoxelManip object
get(key): returns a valueget_bool(key): returns a booleanset(key, value)set(key, value)
+set_bool(key, value)remove(key): returns a boolean (true for success)get_names(): returns {key1,...}write(): returns a boolean (true for success)to_table(): returns {[key1]=value1,...}RaycastA raycast on the map. It works with selection boxes. +Can be used as an iterator in a for loop.
+The map is loaded as the ray advances. If the
+map is modified after the Raycast is created,
+the changes may or may not have an effect on
+the object.
It can be created via Raycast(pos1, pos2, objects, liquids) or
+minetest.raycast(pos1, pos2, objects, liquids) where:
+ * pos1: start of the ray
+ * pos2: end of the ray
+ * objects : if false, only nodes will be returned. Default is true.
+ * `liquids' : if false, liquid nodes won't be returned. Default is false.
next(): returns a pointed_thingA mapgen object is a construct used in map generation. Mapgen objects can be used
by an on_generate callback to speed up operations by avoiding unnecessary
@@ -4346,7 +4662,10 @@ numeric unique decoration ID.
time_from_last_punch: Meant for disallowing spamming of clicks (can be nil)tool_capabilities: capability table of used tool (can be nil)dir: unit vector of direction of punch. Always defined. Points from
- the puncher to the punched.on_death(self, killer)
+killer: an ObjectRef (can be nil)on_rightclick(self, clicker){
hp_max = 1,
physical = true,
- collide_with_objects = true, -- collide with other objects if physical=true
+ collide_with_objects = true, -- collide with other objects if physical = true
weight = 5,
- collisionbox = {-0.5,-0.5,-0.5, 0.5,0.5,0.5},
- visual = "cube"/"sprite"/"upright_sprite"/"mesh"/"wielditem",
- visual_size = {x=1, y=1},
+ collisionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
+ visual = "cube" / "sprite" / "upright_sprite" / "mesh" / "wielditem",
+ visual_size = {x = 1, y = 1},
mesh = "model",
textures = {}, -- number of required textures depends on visual
colors = {}, -- number of required colors depends on visual
- spritediv = {x=1, y=1},
- initial_sprite_basepos = {x=0, y=0},
+ spritediv = {x = 1, y = 1},
+ initial_sprite_basepos = {x = 0, y = 0},
is_visible = true,
makes_footstep_sound = false,
automatic_rotate = false,
stepheight = 0,
automatic_face_movement_dir = 0.0,
--- ^ automatically set yaw to movement direction; offset in degrees; false to disable
+-- ^ Automatically set yaw to movement direction, offset in degrees,
+-- 'false' to disable.
automatic_face_movement_max_rotation_per_sec = -1,
--- ^ limit automatic rotation to this value in degrees per second. values < 0 no limit
+-- ^ Limit automatic rotation to this value in degrees per second,
+-- value < 0 no limit.
backface_culling = true, -- false to disable backface_culling for model
nametag = "", -- by default empty, for players their name is shown if empty
nametag_color = <color>, -- sets color of nametag as ColorSpec
@@ -4698,7 +5019,9 @@ minetest.spawn_tree(pos,apple_tree)
diggable = true, -- If false, can never be dug
climbable = false, -- If true, can be climbed on (ladder)
buildable_to = false, -- If true, placed nodes can replace this node
- floodable = false, -- If true, liquids flow into and replace this node
+ floodable = false, --[[
+ ^ If true, liquids flow into and replace this node.
+ ^ Warning: making a liquid node 'floodable' does not work and may cause problems. ]]
liquidtype = "none", -- "none"/"source"/"flowing"
liquid_alternative_flowing = "", -- Flowing version of source liquid
liquid_alternative_source = "", -- Source version of flowing liquid
@@ -4727,6 +5050,12 @@ minetest.spawn_tree(pos,apple_tree)
^ If drawtype "nodebox" is used and selection_box is nil, then node_box is used. ]]
legacy_facedir_simple = false, -- Support maps made in and before January 2012
legacy_wallmounted = false, -- Support maps made in and before January 2012
+ waving = 0, --[[ valid for mesh, nodebox, plantlike, allfaces_optional nodes
+ ^ 1 - wave node like plants (top of node moves, bottom is fixed)
+ ^ 2 - wave node like leaves (whole node moves side-to-side synchronously)
+ ^ caveats: not all models will properly wave
+ ^ plantlike drawtype nodes can only wave like plants
+ ^ allfaces_optional drawtype nodes can only wave like leaves --]]
sounds = {
footstep = <SimpleSoundSpec>,
dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
@@ -4765,7 +5094,8 @@ minetest.spawn_tree(pos,apple_tree)
^ node placement (i.e. schematics and VoxelManip) or air nodes. If
^ return true the node is not flooded, but on_flood callback will
^ most likely be called over and over again every liquid update
- ^ interval. Default: nil ]]
+ ^ interval. Default: nil.
+ ^ Warning: making a liquid node 'floodable' does not work and may cause problems. ]]
after_place_node = func(pos, placer, itemstack, pointed_thing) --[[
^ Called after constructing node when node was placed using
@@ -4895,6 +5225,9 @@ minetest.spawn_tree(pos,apple_tree)
-- ^ In this example, there is a 3x3x3 cluster where 8 out of the 27 nodes are coal ore
y_min = -31000,
y_max = 64,
+-- ^ Lower and upper limits for ore.
+-- ^ Limits are relative to y = water_level - 1 for core mapgen, or
+-- ^ relative to y = 0 for minetest.generate_ores().
flags = "",
-- ^ Attributes for this ore generation
noise_threshold = 0.5,
@@ -4904,7 +5237,7 @@ minetest.spawn_tree(pos,apple_tree)
-- ^ Needed for sheet ore_type. Omit from scatter ore_type for a uniform ore distribution
random_factor = 1.0,
-- ^ Multiplier of the randomness contribution to the noise value at any
--- given point to decide if ore should be placed. Set to 0 for solid veins.
+-- ^ given point to decide if ore should be placed. Set to 0 for solid veins.
-- ^ This parameter is only valid for ore_type == "vein".
biomes = {"desert", "rainforest"}
-- ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
@@ -4940,6 +5273,7 @@ The Biome API is still in an experimental phase and subject to change.
y_min = 1,
y_max = 31000,
-- ^ Lower and upper limits for biome.
+-- ^ Limits are relative to y = water_level - 1.
-- ^ Because biome is not recalculated for every node in a node column
-- ^ some biome materials can exceed their limits, especially stone.
-- ^ For each node column in a mapchunk, biome is only recalculated at column
@@ -4981,9 +5315,11 @@ The Biome API is still in an experimental phase and subject to change.
-- ^ Can be a list of (or a single) biome names, IDs, or definitions.
y_min = -31000
y_max = 31000
--- ^ Minimum and maximum `y` positions these decorations can be generated at.
--- ^ This parameter refers to the `y` position of the decoration base, so
--- the actual maximum height would be `height_max + size.Y`.
+-- ^ Lower and upper limits for decoration.
+-- ^ Limits are relative to y = water_level - 1 for core mapgen, or
+-- ^ relative to y = 0 for minetest.generate_decorations().
+-- ^ This parameter refers to the `y` position of the decoration base, so
+-- the actual maximum height would be `height_max + size.Y`.
spawn_by = "default:water",
-- ^ Node (or list of nodes) that the decoration only spawns next to.
-- ^ Checks two horizontal planes of neighbouring nodes (including diagonal neighbours),
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..f223c09
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,2 @@
+markdown==2.6.8
+bs4==0.0.1