search

sbrl / Minetest-WorldEditAdditions

Extra tools and commands to extend WorldEdit for Minetest
https://worldeditadditions.mooncarrot.space/
Mozilla Public License 2.0
16 stars 3 forks source link

Integrated reference #55

Open sbrl opened 3 years ago

sbrl commented 3 years ago

As WorldEditAdditions grows, so too does the number of commands we have - and the documentation thereof.

It would be of significant benefit if we could display our own formspec-based help GUI that automatically parses Chat-Command-Reference.md. /help for example does this already to display the current commands categorised by the mods they are from.

A sensible direction to head in might be to integrate with the doc mod. The API thereof can be found here: https://repo.or.cz/minetest_doc.git/blob/HEAD:/API.md.

Care must be taken here to keep a single source of truth for our documentation - that way it'll stay easy to update.

VorTechnix commented 3 years ago

We should probably also have better categorization of our commands e.g. Fillers, Shape Generators, Terrain Modifiers etc.

sbrl commented 3 years ago

Better categorisation is also something to look into! Currently the canonical categorisation is that in the quick reference guide. I'm open to suggestions if you have a better way off categorising them :-)

sbrl commented 3 years ago

Unfortunately, Minetest doesn't allow you to read from files outside the mod directory - even if you're part of a modpack you can't read from the main modpack directory. Furthermore, symlinks don't help.

This means that we can't automatically read in and parse Chat-Command-Reference.md because read access thereto is blocked.

If anyone has a workaround for this that does not involve moving the existing Chat-Command-Reference.md, please do comment here.