Skip to content

LLDM-Doom-Modding/zdoom-manpages

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CCMD manpages for UZDoom/GZDoom console

A quick help pages ("manual pages", or "manpages") based on the ZDoom Wiki console commands page directly in the engine console.

Pages

  • Just type man COMMAND (e.g., man summon or man dumpclasses) to read all the information about it without needing of a web browser. Usage examples are included!

Searching

  • You also can type man-search PATTERN or just mas PATTERN to search for this PATTERN across all known commands.

Localization

  • Supported internationalization, currently available in English and Russian. Feel free to include other languages!


Available console commands

  • man COMMAND itself: prints a description and examples (if they exist) about the specified COMMAND.
  • man-search PATTERN: searches through all manpages. Short aliases mans PATTERN and mas PATTERN.
  • man-list: lists all known manpages. Short alias manl.

Autoload

You can add this utiltily mod to autoload section. Find the "Global.Autoload" section and add a line with the actual path to the mod in your engine configuration file:

[Global.Autoload]
Path=/path/to/manpages.pk3

Supported engines

Supported in:

  • UZDoom
  • GZDoom 4.0.0+

Not tested, but most probably supported in:

  • LZDoom 4.0.0+
  • VkDoom

Compatibility is expected to be a lot better towards the end of development. Planned to support:

  • GZDoom 3.3.1+
  • LZDoom 3.8.5+
  • ZZDoom 2.9.0+
  • QZDoom 2.0.0+

About

Prototype of the Linux "manual pages" for console in *ZDoom-family ports (the engine must support ZScript). E. g., type `man summon` to show the quick help for command `summon`. Supports global searching via command `man-search`.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors