game_api.txt

   1 minetest_game API
   2 ======================
   3 GitHub Repo: https://github.com/minetest/minetest_game
   4
   5 Introduction
   6 ------------
   7 The minetest_game gamemode offers multiple new possibilities in addition to Minetest's built-in API, allowing you to
   8 add new plants to farming mod, buckets for new liquids, new stairs and custom panes.
   9 For information on the Minetest API, visit https://github.com/minetest/minetest/blob/master/doc/lua_api.txt
  10 Please note:
  11         [XYZ] refers to a section the Minetest API
  12         [#ABC] refers to a section in this document
  13         ^ Explanation for line above
  14
  15 Bucket API
  16 ----------
  17 The bucket API allows registering new types of buckets for non-default liquids.
  18
  19         bucket.register_liquid(
  20                 "default:lava_source",          -- Source node name
  21                 "default:lava_flowing",         -- Flowing node name
  22                 "bucket:bucket_lava",           -- Name to be used for bucket
  23                 "bucket_lava.png",                      -- Bucket texture (for wielditem and inventory_image)
  24                 "Lava Bucket"                           -- Bucket description
  25         )
  26
  27 Beds API
  28 --------
  29         beds.register_bed(
  30                 "beds:bed",                     -- Bed name
  31                 def: See [#Bed definition]      -- Bed definition
  32         )
  33
  34         beds.read_spawns()                      -- returns a table containing players respawn positions
  35         beds.kick_players()                     -- forces all players to leave bed
  36         beds.skip_night()                       -- sets world time to morning and saves respawn position of all players currently sleeping
  37
  38 #Bed definition
  39 ---------------
  40 {
  41         description = "Simple Bed",
  42         inventory_image = "beds_bed.png",
  43         wield_image = "beds_bed.png",
  44         tiles = {
  45             bottom = {[Tile definition],
  46                 ^ the tiles of the bottom part of the bed
  47             },
  48             top = {[Tile definition],
  49                 ^ the tiles of the bottom part of the bed
  50             }
  51         },
  52         nodebox = {
  53             bottom = regular nodebox, see [Node boxes],         -- bottm part of bed
  54             top = regular nodebox, see [Node boxes],            -- top part of bed
  55         },
  56         selectionbox = regular nodebox, see [Node boxes],       -- for both nodeboxes
  57         recipe = {      -- Craft recipe
  58                 {"group:wool", "group:wool", "group:wool"},
  59                 {"group:wood", "group:wood", "group:wood"}
  60         }
  61 }
  62
  63 Doors API
  64 ---------
  65 The doors mod allows modders to register custom doors and trapdoors.
  66
  67 doors.register_door(name, def)
  68 ^ name: "Door name"
  69 ^ def: See [#Door definition]
  70  -> Registers new door
  71
  72 doors.register_trapdoor(name, def)
  73 ^ name: "Trapdoor name"
  74 ^ def: See [#Trapdoor definition]
  75  -> Registers new trapdoor
  76
  77 #Door definition
  78 ----------------
  79 {
  80         description = "Door description",
  81         inventory_image = "mod_door_inv.png",
  82         groups = {group = 1},
  83         tiles_bottom: [Tile definition],
  84         ^ the tiles of the bottom part of the door {front, side}
  85         tiles_top: [Tile definition],
  86         ^ the tiles of the bottom part of the door {front, side}
  87         node_box_bottom = regular nodebox, see [Node boxes], OPTIONAL,
  88         node_box_top = regular nodebox, see [Node boxes], OPTIONAL,
  89         selection_box_bottom = regular nodebox, see [Node boxes], OPTIONAL,
  90         selection_box_top = regular nodebox, see [Node boxes], OPTIONAL,
  91         sound_open_door = sound play for open door, OPTIONAL,
  92         sound_close_door = sound play for close door, OPTIONAL,
  93         only_placer_can_open = true/false,
  94         ^ If true, only placer can open the door (locked for others)
  95 }
  96
  97 #Trapdoor definition
  98 ----------------
  99 {
 100         tile_front = "doors_trapdoor.png",
 101         ^ the texture for the front and back of the trapdoor
 102         tile_side: "doors_trapdoor_side.png",
 103         ^ the tiles of the four side parts of the trapdoor
 104         sound_open = sound to play when opening the trapdoor, OPTIONAL,
 105         sound_close = sound to play when closing the trapdoor, OPTIONAL,
 106         -> You can add any other node definition properties for minetest.register_node,
 107            such as wield_image, inventory_image, sounds, groups, description, ...
 108            Only node_box, selection_box, tiles, drop, drawtype, paramtype, paramtype2, on_rightclick
 109            will be overwritten by the trapdoor registration function
 110 }
 111
 112 Farming API
 113 -----------
 114 The farming API allows you to easily register plants and hoes.
 115
 116 farming.register_hoe(name, hoe definition)
 117  -> Register a new hoe, see [#hoe definition]
 118
 119 farming.register_plant(name, Plant definition)
 120  -> Register a new growing plant, see [#Plant definition]
 121
 122 #Hoe Definition
 123 ---------------
 124 {
 125         description = "",       -- Description for tooltip
 126         inventory_image = "unknown_item.png",   -- Image to be used as wield- and inventory image
 127         max_uses = 30,  -- Uses until destroyed
 128         material = "",  -- Material for recipes
 129         recipe = {      -- Craft recipe, if material isn't used
 130                 {"air", "air", "air"},
 131                 {"", "group:stick"},
 132                 {"", "group:stick"},
 133         }
 134 }
 135
 136 #Plant definition
 137 -----------------
 138 {
 139         description = "",       -- Description of seed item
 140         inventory_image = "unknown_item.png",   -- Image to be used as seed's wield- and inventory image
 141         steps = 8,      -- How many steps the plant has to grow, until it can be harvested
 142         ^ Always provide a plant texture for each step, format: modname_plantname_i.png (i = stepnumber)
 143         minlight = 13, -- Minimum light to grow
 144         maxlight = default.LIGHT_MAX -- Maximum light to grow
 145 }
 146
 147 Stairs API
 148 ----------
 149 The stairs API lets you register stairs and slabs and ensures that they are registered the same way as those
 150 delivered with minetest_game, to keep them compatible with other mods.
 151
 152 stairs.register_stair(subname, recipeitem, groups, images, description, sounds)
 153  -> Registers a stair.
 154  -> subname: Basically the material name (e.g. cobble) used for the stair name. Nodename pattern: "stairs:stair_subname"
 155  -> recipeitem: Item used in the craft recipe, e.g. "default:cobble"
 156  -> groups: see [Known damage and digging time defining groups]
 157  -> images: see [Tile definition]
 158  -> description: used for the description field in the stair's definition
 159  -> sounds: see [#Default sounds]
 160
 161 stairs.register_slab(subname, recipeitem, groups, images, description, sounds)
 162  -> Registers a slabs
 163  -> subname: Basically the material name (e.g. cobble) used for the stair name. Nodename pattern: "stairs:stair_subname"
 164  -> recipeitem: Item used in the craft recipe, e.g. "default:cobble"
 165  -> groups: see [Known damage and digging time defining groups]
 166  -> images: see [Tile definition]
 167  -> description: used for the description field in the stair's definition
 168  -> sounds: see [#Default sounds]
 169
 170 stairs.register_stair_and_slab(subname, recipeitem, groups, images, desc_stair, desc_slab, sounds)
 171  -> A wrapper for stairs.register_stair and stairs.register_slab
 172  -> Uses almost the same arguments as stairs.register_stair
 173  -> desc_stair: Description for stair node
 174  -> desc_slab: Description for slab node
 175
 176 Xpanes API
 177 ----------
 178 Creates panes that automatically connect to each other
 179
 180 xpanes.register_pane(subname, def)
 181  -> subname: used for nodename. Result: "xpanes:subname" and "xpanes:subname_{2..15}"
 182  -> def: See [#Pane definition]
 183
 184 #Pane definition
 185 ----------------
 186 {
 187         textures = {"texture_Bottom_top", "texture_left_right", "texture_front_back"},
 188         ^ More tiles aren't supported
 189         groups = {group = rating},
 190         ^ Uses the known node groups, see [Known damage and digging time defining groups]
 191         sounds = SoundSpec,
 192         ^ See [#Default sounds]
 193         recipe = {{"","","","","","","","",""}},
 194         ^ Recipe field only
 195 }
 196
 197 Raillike definitions
 198 --------------------
 199 The following nodes use the group `connect_to_raillike` and will only connect to
 200 raillike nodes within this group and the same group value.
 201 Use `minetest.raillike_group(<Name>)` to get the group value.
 202
 203 | Node type             | Raillike group name
 204 +-----------------------+----------------------------------
 205 | default:rail          | "rail"
 206
 207 Example:
 208 If you want to add a new rail type and want it to connect with default:rail,
 209 add `connect_to_raillike=minetest.raillike_group("rail")` into the `groups` table
 210 of your node.
 211
 212
 213 Default sounds
 214 --------------
 215 Sounds inside the default table can be used within the sounds field of node definitions.
 216
 217 default.node_sound_defaults()
 218 default.node_sound_stone_defaults()
 219 default.node_sound_dirt_defaults()
 220 default.node_sound_sand_defaults()
 221 default.node_sound_wood_defaults()
 222 default.node_sound_leaves_defaults()
 223 default.node_sound_glass_defaults()
 224
 225 Default constants
 226 -----------------
 227 default.LIGHT_MAX
 228 ^ The maximum light level (see [Node definition] light_source)
 229
 230 Player API
 231 ----------
 232 The player API can register player models and update the player's appearence
 233
 234 default.player_register_model(name, def)
 235 ^ Register a new model to be used by players.
 236  -> name: model filename such as "character.x", "foo.b3d", etc.
 237  -> def: See [#Model definition]
 238
 239 default.registered_player_models[name]
 240 ^ Get a model's definition
 241  -> see [#Model definition]
 242
 243 default.player_set_model(player, model_name)
 244 ^ Change a player's model
 245  -> player: PlayerRef
 246  -> model_name: model registered with player_register_model()
 247
 248 default.player_set_animation(player, anim_name [, speed])
 249 ^ Applies an animation to a player
 250  -> anim_name: name of the animation.
 251  -> speed: frames per second. If nil, default from the model is used
 252
 253 default.player_set_textures(player, textures)
 254 ^ Sets player textures
 255  -> player: PlayerRef
 256  -> textures: array of textures
 257  ^ If <textures> is nil, the default textures from the model def are used
 258
 259 default.player_get_animation(player)
 260 ^ Returns a table containing fields "model", "textures" and "animation".
 261 ^ Any of the fields of the returned table may be nil.
 262  -> player: PlayerRef
 263
 264 Model Definition
 265 ----------------
 266 {
 267         animation_speed = 30, -- Default animation speed, in FPS.
 268         textures = {"character.png", }, -- Default array of textures.
 269         visual_size = {x=1, y=1,}, -- Used to scale the model.
 270         animations = {
 271                 -- <anim_name> = { x=<start_frame>, y=<end_frame>, },
 272                 foo = { x= 0, y=19, },
 273                 bar = { x=20, y=39, },
 274                 -- ...
 275         },
 276 }
 277
 278 Leafdecay
 279 ---------
 280 To enable leaf decay for a node, add it to the "leafdecay" group.
 281
 282 The rating of the group determines how far from a node in the group "tree"
 283 the node can be without decaying.
 284
 285 If param2 of the node is ~= 0, the node will always be preserved. Thus, if
 286 the player places a node of that kind, you will want to set param2=1 or so.
 287
 288 The function default.after_place_leaves can be set as after_place_node of a node
 289 to set param2 to 1 if the player places the node (should not be used for nodes
 290 that use param2 otherwise (e.g. facedir)).
 291
 292 If the node is in the leafdecay_drop group then it will always be dropped as an
 293 item.
 294
 295 Dyes
 296 ----
 297 To make recipes that will work with any dye ever made by anybody, define
 298 them based on groups. You can select any group of groups, based on your need for
 299 amount of colors.
 300
 301 #Color groups
 302 -------------
 303 Base color groups:
 304 - basecolor_white
 305 - basecolor_grey
 306 - basecolor_black
 307 - basecolor_red
 308 - basecolor_yellow
 309 - basecolor_green
 310 - basecolor_cyan
 311 - basecolor_blue
 312 - basecolor_magenta
 313
 314 Extended color groups (* = equal to a base color):
 315 * excolor_white
 316 - excolor_lightgrey
 317 * excolor_grey
 318 - excolor_darkgrey
 319 * excolor_black
 320 * excolor_red
 321 - excolor_orange
 322 * excolor_yellow
 323 - excolor_lime
 324 * excolor_green
 325 - excolor_aqua
 326 * excolor_cyan
 327 - excolor_sky_blue
 328 * excolor_blue
 329 - excolor_violet
 330 * excolor_magenta
 331 - excolor_red_violet
 332
 333 The whole unifieddyes palette as groups:
 334 - unicolor_<excolor>
 335 For the following, no white/grey/black is allowed:
 336 - unicolor_medium_<excolor>
 337 - unicolor_dark_<excolor>
 338 - unicolor_light_<excolor>
 339 - unicolor_<excolor>_s50
 340 - unicolor_medium_<excolor>_s50
 341 - unicolor_dark_<excolor>_s50
 342
 343 Example of one shapeless recipe using a color group:
 344 minetest.register_craft({
 345         type = "shapeless",
 346         output = '<mod>:item_yellow',
 347         recipe = {'<mod>:item_no_color', 'group:basecolor_yellow'},
 348 })
 349
 350 #Color lists
 351 ------------
 352 dye.basecolors
 353 ^ Array containing the names of available base colors
 354
 355 dye.excolors
 356 ^ Array containing the names of the available extended colors
 357
 358 Trees
 359 -----
 360 default.grow_tree(pos, is_apple_tree)
 361 ^ Grows a tree or apple tree at pos
 362
 363 default.grow_jungle_tree(pos)
 364 ^ Grows a jungletree at pos
 365
 366 default.grow_pine_tree(pos)
 367 ^ Grows a pinetree at pos