Difference between revisions of "Lua API Documentation"

From Minetest Developer Wiki
Jump to navigation Jump to search
(Mark as DevWiki as deprecated for Lua API docs)
(Redirected page to Modding Intro)
Tag: New redirect
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The Lua API of Minetest is extensively documented. This page tells you which documentation exists, and where to find it.
+
#REDIRECT [[Modding Intro]]
 
 
== Official documentation ==
 
=== lua_api.txt / HTML ===
 
 
 
This is the most important document you need during modding.
 
 
 
This is a text file containing the only (!) official reference documentation for the entire Lua API. You can find it in the <code>doc</code> directory of your Minetest installation, or available online using the links below. We strongly recommend you read the file installed on your computer so you read the correct version
 
 
 
Latest (in-development) version available online as [https://minetest.gitlab.io/minetest/ HTML] or [https://github.com/minetest/minetest/blob/master/doc/lua_api.txt plaintext].
 
 
 
Note this assumes you are already familiar with Lua programming. If you aren't, take a look into the [[#Minetest_Modding_Book|Minetest Modding Book]] first.
 
 
 
=== Other text files ===
 
In the <code>doc</code> directory of your Minetest installation, you will find a few other text files with related, but less important information and documentation.
 
 
 
== Unofficial Documentation ==
 
=== Minetest Modding Book ===
 
A very extensive introduction into Minetest modding, great for complete beginners. Written by rubenwardy, a long-time developer for Minetest.
 
 
 
https://rubenwardy.com/minetest_modding_book/en/index.html
 
 
 
== Deprecated documentation ===
 
=== Minetest Developer Wiki ===
 
'''WARNING''': The Minetest Developer Wiki does NOT represent the Lua API documentation. You will see a lot of pages that were just lazily copied from <code>lua_api.txt</code> years ago and those are now unsurprisingly horribly outdated and outright misleading. This was a huge mistake and should have never been done in the first place. If you want to know what a specific function XYZ does, do NOT use this wiki, use <code>lua_api.txt</code> (see above). So, yeah, we have a bit of a mess right now and it's not easy to clean it up, which is why we didn't do it so far. See also: [[MinetestWiki:Lua API Wiki Documentation Cleanup]].
 
 
 
While this Developer Wiki ''is'' meant to be is not meant to document the Lua API itself, but instead to document common development practices, pitfalls and general advice or agreed-upon guidelines for engine, game and mod developers. This is OK.
 
 
 
The wiki is useful to find some nice tips and tricks that would not belong into a reference documentation. This part of the wiki should be OK. But ignore everything that makes specific claims about the Lua API, like concrete function names, parameters, etc.
 
 
 
[[Category:Modding API]]
 

Latest revision as of 02:07, 16 August 2022

Redirect to: