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. This document explains everything you need to know about the Lua API in concise form, but may be daunting for newbies to read.
The '''only''' 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. This document explains everything you need to know about the Lua API in concise form, but may be daunting for newbies to read.
 
  
 
There is also (as of april 2020) a automatically [https://minetest.gitlab.io/minetest/ generated version] that might be easier to read.
 
There is also (as of april 2020) a automatically [https://minetest.gitlab.io/minetest/ generated version] that might be easier to read.
 
'''WARNING''': A huge amount of pages on this wiki regarding Lua methods and objects are extremely outdated. Ignore them for now, use lua_api.txt instead. It has been [https://forum.minetest.net/viewtopic.php?f=47&t=22469 proposed] to remove those pages as redundant.
 
  
 
=== Tutorials ===
 
=== Tutorials ===
  
There's also an unofficial guide/tutorial about Minetest modding: The [https://rubenwardy.com/minetest_modding_book/ Minetest Modding Book].
+
The [https://rubenwardy.com/minetest_modding_book/ Minetest Modding Book] is a friendly introduction to Minetest modding and game creation, introducing you to various aspects of the API.
 
 
A very basic overview is written in [[Modding Overview]].
 
  
 
== Other useful links ==
 
== Other useful links ==
* [[Lua API Documentation]]
+
* Check out the [https://content.minetest.net/ ContentDB] to see mods that have been published by the community.
* Check out the [https://forum.minetest.net/viewforum.php?f=11 Mod Releases forum] to see mods that have been published by the community.
 
 
* Get mod help from the [https://forum.minetest.net/viewtopic.php?f=9&t=4668 modding questions thread].
 
* Get mod help from the [https://forum.minetest.net/viewtopic.php?f=9&t=4668 modding questions thread].
 
* Suggest a mod idea in the [https://forum.minetest.net/viewtopic.php?f=9&t=2434 mod request thread].
 
* Suggest a mod idea in the [https://forum.minetest.net/viewtopic.php?f=9&t=2434 mod request thread].
  
 
[[Category:Modding API]]
 
[[Category:Modding API]]

Revision as of 22:18, 15 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. You can find this file 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.

There is also (as of april 2020) a automatically generated version that might be easier to read.

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