Difference between revisions of "Modding Intro"
Rubenwardy (talk | contribs) |
(rename modding book) |
||
| (17 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | Luanti has a scripting '''API''', which is used to program games and mods, creating whole new experiences or extending existing ones. | |
| − | + | The API is accessed using Lua, an easy-to-use programming language. | |
| + | Version 5.1 of Lua is used, but many people run LuaJIT for greater performance. | ||
| − | The only thing you will need is ''basic'' programming knowledge | + | The only thing you will need is ''basic'' programming knowledge. |
== Documentation == | == Documentation == | ||
| + | |||
| + | === Tutorials === | ||
| + | The [https://rubenwardy.com/minetest_modding_book/ Luanti Modding Book] is a friendly introduction to Luanti modding and game creation, introducing you to various aspects of the API. | ||
| + | |||
| + | It is recommended you start here, even if you are already apt at programming, to get a good understanding of how Luanti mods work and are structured. | ||
=== Lua API Reference === | === Lua API Reference === | ||
| + | The official Lua API documentation is <code>lua_api.md</code>. It's available as [https://github.com/minetest/minetest/blob/master/doc/lua_api.md markdown] or [https://api.minetest.net/ HTML]. You can find the plaintext version in your Luanti installation, in the <code>doc</code> directory. | ||
| − | + | This is a concise description of the entire API, explaining functions, data structures, registration templates & more. The core developers of Luanti maintain it, changes going through a quality control process. | |
| − | + | Any functions not listed here are subject to change and not guaranteed to be compatible across versions, though usually they are. | |
| − | + | === The Minetest-Docs Project === | |
| + | A work-in-progress project is underway to create new, more detailed, documentation. They can be read from its [https://github.com/minetest/minetest_docs/ GitHub repo], contributions are greatly appreciated. | ||
| − | |||
| − | + | == Useful tools == | |
| + | Here are some useful tools that most modders use when making Luanti mods: | ||
| − | + | * [https://code.visualstudio.com/ Visual Studio Code]/[https://vscodium.com/ VSCodium], powerful code editor with a [https://marketplace.visualstudio.com/items?itemName=GreenXenith.minetest-tools Minetest extension] available for code completion. | |
| + | * [https://github.com/lunarmodules/luacheck luacheck], static analysis tool for Lua. See [https://rubenwardy.com/minetest_modding_book/en/quality/luacheck.html this modding book chapter] for more information on how to use it with Luanti. | ||
== Other useful links == | == Other useful links == | ||
| − | + | * Check out [https://content.minetest.net/ ContentDB] to see mods that have been published by the community. | |
| − | * Check out | + | * Get mod help from the community: |
| − | * Get mod help from the [https://forum.minetest.net/ | + | ** [https://forum.minetest.net/viewforum.php?f=47 Forums] |
| + | ** [https://discord.gg/minetest Discord] | ||
| + | ** [https://matrix.to/#/#minetest:tchncs.de Matrix] | ||
| + | ** ...[https://www.minetest.net/get-involved/ more] | ||
* 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]] | ||
Latest revision as of 21:14, 24 October 2024
Luanti has a scripting API, which is used to program games and mods, creating whole new experiences or extending existing ones.
The API is accessed using Lua, an easy-to-use programming language. Version 5.1 of Lua is used, but many people run LuaJIT for greater performance.
The only thing you will need is basic programming knowledge.
Documentation
Tutorials
The Luanti Modding Book is a friendly introduction to Luanti modding and game creation, introducing you to various aspects of the API.
It is recommended you start here, even if you are already apt at programming, to get a good understanding of how Luanti mods work and are structured.
Lua API Reference
The official Lua API documentation is lua_api.md. It's available as markdown or HTML. You can find the plaintext version in your Luanti installation, in the doc directory.
This is a concise description of the entire API, explaining functions, data structures, registration templates & more. The core developers of Luanti maintain it, changes going through a quality control process.
Any functions not listed here are subject to change and not guaranteed to be compatible across versions, though usually they are.
The Minetest-Docs Project
A work-in-progress project is underway to create new, more detailed, documentation. They can be read from its GitHub repo, contributions are greatly appreciated.
Useful tools
Here are some useful tools that most modders use when making Luanti mods:
- Visual Studio Code/VSCodium, powerful code editor with a Minetest extension available for code completion.
- luacheck, static analysis tool for Lua. See this modding book chapter for more information on how to use it with Luanti.