Difference between revisions of "Modding Intro"

From Minetest Developer Wiki
Jump to navigation Jump to search
Line 8: Line 8:
  
 
=== Lua API Reference ===
 
=== Lua API Reference ===
The official Lua API documentation is [https://github.com/minetest/minetest/blob/master/doc/lua_api.txt lua_api.txt]. You can find this file in your Minetest installation, in the <code>doc</code> directory. Use this file to look up functions, core features of the Lua API, etc. This file is maintained by the core developers of Minetest and every change to it goes through a quality control process.
+
The official Lua API documentation is lua_api.txt. It's available in [https://github.com/minetest/minetest/blob/master/doc/lua_api.txt plaintext] or [https://minetest.gitlab.io/minetest/ HTML]. You can find the plaintext version in your Minetest installation, in the <code>doc</code> directory.
 +
 
 +
Use this file to look up functions, core features of the Lua API, etc. This file is maintained by the core developers of Minetest and every change to it goes through a quality control process.
  
 
This document explains everything you need to know about the Lua API in concise form, but may be daunting for newbies to read. Therefore, it's recommended that you start with a tutorial.
 
This document explains everything you need to know about the Lua API in concise form, but may be daunting for newbies to read. Therefore, it's recommended that you start with a tutorial.
 
There is also (as of april 2020) a automatically [https://minetest.gitlab.io/minetest/ generated version] that might be easier to read.
 
  
 
=== Tutorials ===
 
=== Tutorials ===

Revision as of 02:10, 16 August 2022

Language: [[::Modding Intro|English]]

Minetest has a scripting API (Application Programming Interface), which is used to program mods (short for "modifications") for the game, extending its features and adding new items. This API is accessed using an easy-to-use programming language called Lua. More specifically, the version of Lua is 5.1.

The only thing you will need is basic programming knowledge. See Lua for details.

Documentation

Lua API Reference

The official Lua API documentation is lua_api.txt. It's available in plaintext or HTML. You can find the plaintext version in your Minetest installation, in the doc directory.

Use this file to look up functions, core features of the Lua API, etc. This file is maintained by the core developers of Minetest and every change to it goes through a quality control process.

This document explains everything you need to know about the Lua API in concise form, but may be daunting for newbies to read. Therefore, it's recommended that you start with a tutorial.

Tutorials

The Minetest Modding Book is a friendly introduction to Minetest modding and game creation, introducing you to various aspects of the API.

Other useful links