Documentation Resources: edit

This commit is contained in:
ROllerozxa 2023-07-15 19:52:40 +00:00
parent 0df424ecd3
commit ce22ee1d4d

View File

@ -0,0 +1,22 @@
This page aims to be a complete list of developer documentation resources for Minetest. They are ordered rougly in how useful they are and how beginner-friendly they are.
[toc]
## The Minetest Modding Book
The [Minetest Modding Book](https://rubenwardy.com/minetest_modding_book/) by rubenwardy is a friendly introduction to Minetest modding and game creation, introducing you to various aspects of the API. It is a perfect resource for learning to develop with Minetest's API, even if you are already experienced with programming.
## Lua API reference
The Lua API reference (also known as `lua_api.md`, formerly `lua_api.txt`) is a Markdown file detailing the entire Minetest Lua API. It is bundled with Minetest and can be found in the `doc/` folder, or online on GitHub [here](https://github.com/minetest/minetest/blob/master/doc/lua_api.md). There is also a prettier HTML version available at [minetest.gitlab.io/minetest/](https://minetest.gitlab.io/minetest/).
It is the official reference for the Lua API, it is maintained by the Minetest core developers and is usually seen as the source of truth, but can be overly dry at times.
## minetest_docs
[minetest_docs](https://github.com/minetest/minetest_docs) was a project that sought out to create better documentation for Minetest. This fell flat and is currently dormant but contains some gems, most of which is available on the Voxelmanip Wiki.
## Minetest Wiki
The [Minetest Wiki](https://wiki.minetest.net) (not to be confused with the Voxelmanip Minetest Wiki) is the official Wiki, originally meant for "players". The contents mostly consist of outdated information about Minetest Game, but also contains some useful documentation gems about the engine.
Due to the bad performance of the Wiki server, ROllerozxa has set up a mirror available at [wiki.minetest.land](https://wiki.minetest.land) (rather than wiki.minetest.net).
## Minetest Developer Wiki
The [Minetest Developer Wiki](https://dev.minetest.net) is intended to be a Minetest Wiki for developers, as opposed to the "player" Wiki. Outside of a tiny amount of gems for core engine development, it is lacking and sometimes worse than useless.