Documentation system integration for Advtrains (mirror)

Y. Wang d0948f45b4 Describe conns for track nodes il y a 2 ans
ci dc80f5f7dc Add helper for mineunit CI il y a 2 ans
locale d603166fcc Correct translation for "preset" il y a 2 ans
.dir-locals.el 58d34ea39b Add config for luacheckrc and emacs il y a 2 ans
.luacheckrc 339240a8ec Add basic LaTeX generation il y a 2 ans
LICENSE 0fae9ba31c Initial commit il y a 2 ans
README.md dc80f5f7dc Add helper for mineunit CI il y a 2 ans
init.lua d0948f45b4 Describe conns for track nodes il y a 2 ans
mod.conf 377f189adf Detect dlxtrains livery system il y a 2 ans

README.md

This mod integrates Advtrains with the doc mod.

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.

If you use Mineunit, you can copy (or add a symlink to) this directory into the fixtures directory of your mod and then using (for exmaple) the code below to generate wagon datasheets.

require "mineunit"
mineunit "core"
fixture "advtrains_doc_integration/ci/init"
sourcefile "init"

If you do not use Mineunit, the following functions are available in the advtrains_doc_integration table:

  • write_wagon_info_as_latex, which exports the datasheet of a single type of wagon as LaTeX, and
  • write_all_wagons_as_latex, which exports all wagon datasheets as LaTeX.

It is also possible to export wagon datasheets using the atdoc_write command in Minetest.

The datasheets are exported to the world directory (or, for Mineunit, the fixtures directory). Note that the result of generating datasheets from Minetest and from CI may differ for various reasons.