Documentation system integration for Advtrains (mirror)

Y. Wang 0507e64a7b Fix LaTeX output error for empty advtrains_livery_tools templates 10 months ago
.woodpecker b588e2b9fe Refactor code, part 1 11 months ago
ci dc80f5f7dc Add helper for mineunit CI 1 year ago
locale 9af31611b4 Add header to sections 1 year ago
spec b588e2b9fe Refactor code, part 1 11 months ago
test 716a56dd36 Use mtt for testing 11 months ago
.dir-locals.el 58d34ea39b Add config for luacheckrc and emacs 1 year ago
.gitignore b588e2b9fe Refactor code, part 1 11 months ago
.luacheckrc 92e6fd5672 Describe functions using LuaJIT bytecode if possible 10 months ago
LICENSE 0fae9ba31c Initial commit 2 years ago
README.md 2f95d90be3 Refactor code, part 2 11 months ago
bc.lua 92e6fd5672 Describe functions using LuaJIT bytecode if possible 10 months ago
config.ld 51504061ab Minor UI adjustments 10 months ago
describe.lua 2f95d90be3 Refactor code, part 2 11 months ago
doc_ui.lua 92e6fd5672 Describe functions using LuaJIT bytecode if possible 10 months ago
hypertext.lua 92e6fd5672 Describe functions using LuaJIT bytecode if possible 10 months ago
init.lua 92e6fd5672 Describe functions using LuaJIT bytecode if possible 10 months ago
latex.lua 0507e64a7b Fix LaTeX output error for empty advtrains_livery_tools templates 10 months ago
mathutils.lua 2f95d90be3 Refactor code, part 2 11 months ago
mod.conf 716a56dd36 Use mtt for testing 11 months ago
mtt.lua 2f95d90be3 Refactor code, part 2 11 months ago
utils.lua 51504061ab Minor UI adjustments 10 months ago

README.md

Documentation System Integration for Advtrains

This mod integrates Advtrains with the doc mod, among other things.

Usage

The /helpform command can be used as usual.

This mod adds the "Wagons" category that contains information related to the wagons. It also adds adds certain Advtrains-related properties to certain nodes.

This mod also provides the atdoc_write command, which can be used to export wagon datasheets.

Please keep in mind that, while this mod attempts to provide accurate information, its accuracy, especially for information related to liveries, is limited by various factors. Refer the source code of the relevant mods for authoritative information.

Documentation strings

Wagon mods can add a description to the _doc_wagon_longdesc field of the wagon prototype; adding advtrains_doc_integration as an optional dependency is not needed.

CI

This mod also be used with Mineunit in addition to a regular Minetest environment, such as to generate wagon datasheets. However, please note that, due to various limitations, the datasheet generated in such an environment does not contain certain information that would otherwise be available from Minetest.