Difference between revisions of "Engine"

Revision as of 16:53, 21 August 2022

The engine section and the 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.

Engine Structure - for an introduction and light reference to the engine's structure. Start here.
Basic data structures - general data structures.
Objects - documentation on active and static objects.
Doxygen - For a complete (but often missing comments) reference to code. You'll need to generate this yourself
See all pages on the engine.
See Rules and Guidelines.

Doxygen: 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-dev on 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.

Move stuff from NMPR to Engine Structure, and improve Engine Structure generally.

@@ Line 16: / Line 16: @@
 * Doxygen: We want to document most or all of Minetest core with [http://en.wikipedia.org/wiki/Doxygen Doxygen-style] code comments.
 :* The usage of doxygen is explained [http://www.doxygen.nl/manual/index.html there].
-:* Head over to #minetest-dev on [[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.
+:* Head over to #minetest-dev on 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.
 * Move stuff from [[Engine/NMPR|NMPR]] to [[Engine/Structure|Engine Structure]], and improve [[Engine/Structure|Engine Structure]] generally.
 [[Category:Core Engine]]