search

Warzone2100 / warzone2100

Command the forces of The Project in a battle to rebuild the world after mankind has been nearly destroyed by nuclear missiles. A 100% free and open source real-time strategy game for Windows, macOS, Linux, BSD+
https://wz2100.net
GNU General Public License v2.0
3.17k stars 524 forks source link

documentation expansion #3732

Open vaut opened 5 months ago

vaut commented 5 months ago

man warzone2100 contains less information than warzone2100 --help. It would be nice to add to the generation https://github.com/Warzone2100/warzone2100/blob/a2e1212f9a6420774935a29e7e0d7b55a7aa3c1f/doc/warzone2100.6.asciidoc automatic substitution from https://github.com/Warzone2100/warzone2100/blob/a2e1212f9a6420774935a29e7e0d7b55a7aa3c1f/src/clparse.cpp#L383

You also need to generate information on cheats (debug commands) https://github.com/Warzone2100/warzone2100/blob/a2e1212f9a6420774935a29e7e0d7b55a7aa3c1f/src/cheat.cpp#L48

mirror176 commented 5 months ago

Last I checked, the cheats need a bit of rework/review too as some didn't seem to work as intended. Documentation could consider clearly noting ones that are unstable or have large performance impact and probably shouldn't list broken ones.