Difference between revisions of "Lua API Documentation"

Latest revision as of 02:07, 16 August 2022

Redirect to:

Modding Intro

@@ 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 ===
-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. You can also read the latest (in-development) version of this file online here: [https://github.com/minetest/minetest/blob/master/doc/lua_api.txt lua_api.txt]. But we strongly recommend you read the file installed on your computer so you read the correct version.
-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
-=== lua_api.txt, but more readable ===
-You can view a more readable version of this document here: https://minetest.gitlab.io/minetest/ It's the same content, just nicely formatted and up to date.
-=== Minetest Developer Wiki ===
-The very wiki you are reading right now 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.
-The wiki is useful to find some nice tips and tricks that would not belong into a reference documentation.
-However, we have a bit of a mess right now: There is currently a large amount of pages that were copied from lua_api.txt ages ago which are all horribly outdated now. If you want to know what a specific function XYZ does, do NOT use this wiki, use lua_api.txt. See also: [[MinetestWiki:Lua API Wiki Documentation Cleanup]]
-[[Category:Modding API]]

Difference between revisions of "Lua API Documentation"

Latest revision as of 02:07, 16 August 2022

Navigation menu

Search