Difference between revisions of "Modding Intro"
(Move Lua info to Lua) |
Rubenwardy (talk | contribs) |
||
| Line 8: | Line 8: | ||
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. | 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. | ||
| − | For complete beginners, there's also an unofficial guide/tutorial into Lua scripting: The [http://rubenwardy.com/minetest_modding_book/ Minetest Modding | + | For complete beginners, there's also an unofficial guide/tutorial into Lua scripting: The [http://rubenwardy.com/minetest_modding_book/ Minetest Modding Book]. It also includes a HTML version of lua_api.txt which is more readable. |
A very basic overview is written in [[Modding Overview]]. | A very basic overview is written in [[Modding Overview]]. | ||
Revision as of 10:55, 30 September 2020
| 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
The only 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.
For complete beginners, there's also an unofficial guide/tutorial into Lua scripting: The Minetest Modding Book. It also includes a HTML version of lua_api.txt which is more readable.
A very basic overview is written in Modding Overview.
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 proposed to remove those pages as redundant.
Other useful links
- Lua API Documentation
- Check out the Mod Releases forum to see mods that have been published by the community.
- Get mod help from the modding questions thread.
- Suggest a mod idea in the mod request thread.