Difference between revisions of "Engine"

From Minetest Developer Wiki
Jump to navigation Jump to search
Line 1: Line 1:
 
The engine section and core engine category is for documentation of the Minetest engine, which consists of a C++ core and a Lua builtin script.
 
The engine section and core engine category is for documentation of the Minetest engine, which consists of a C++ core and a Lua builtin script.
  
This page attempts to introduce a new contributor to the engine source code.
+
This page contains links to useful information.
  
 
== Useful Resources ==
 
== Useful Resources ==
  
 
* [[Engine/Structure|Engine Structure]] - for a more detailed reference to components.
 
* [[Engine/Structure|Engine Structure]] - for a more detailed reference to components.
* [[Engine/Basic_data_structures|Basic data structures]]
+
* [[Engine/Basic_data_structures|Basic data structures]] - general data structures.
 +
* [[Engine/Objects|Objects]] - documentation on active and static objects.
 
* [http://doxy.minetest.net/ Doxygen] - For a complete (but often missing comments) reference to code.
 
* [http://doxy.minetest.net/ Doxygen] - For a complete (but often missing comments) reference to code.
  

Revision as of 19:41, 18 June 2020

The engine section and core engine category is for documentation of the Minetest engine, which consists of a C++ core and a Lua builtin script.

This page contains links to useful information.

Useful Resources

How to help improve documentation

We want to document most or all of Minetest core with Doxygen-style code comments.
The usage of doxygen is explained there.

Head over to #minetest-devon IRC, and ask someone there to help you get started with documentation. You'll need to download the project through Git and then make your changes.