New Script: gui/cult-lists #664
Conversation
|
|
||
| --TO-DO | ||
| -- zoom on unit -- can't be done yet | ||
| -- never touch LUA script again |
There was a problem hiding this comment.
You'll be surprised how much it grows on you..
There was a problem hiding this comment.
Try to wrap .rst files at about 80 columns.
| ============== | ||
|
|
||
| .. dfhack-tool:: | ||
| :summary: List information related to deites and religions |
There was a problem hiding this comment.
summary has to end in a period for the in-game help parser to pick it up correctly.
|
|
||
| .. dfhack-tool:: | ||
| :summary: List information related to deites and religions | ||
| :tags: fort inspection |
There was a problem hiding this comment.
I think units would belong in the tags too, wouldn't it?
| ============== | ||
|
|
||
| .. dfhack-tool:: | ||
| :summary: List information related to deites and religions |
There was a problem hiding this comment.
I'd call this more than just a "List". How about "Interactive religion, deity, and worshiper browser."?
| ``-help`` | ||
| print in-game help message |
There was a problem hiding this comment.
you can support a help param (and many scripts do), we just don't generally document it since the canonical way to get help is help commandname
| gui/cult-lists [<options>] | ||
|
|
||
|
|
||
| Options |
There was a problem hiding this comment.
In order to present the APIs consistently between scripts that use argparse.processArgs and argparse.processArgsGetopt(), multi-character ("long") options should be documented with two leading dashes. argparse.processArgs still supports the single-dash format for compatibility, but it shouldn't be in the docs.
| @@ -0,0 +1,58 @@ | |||
| cult-lists.lua | |||
There was a problem hiding this comment.
It kind of feels like this script could be the home for all religion-related functionality. how about calling it gui/religion?
| ``-nogui`` | ||
| disables the GUI | ||
|
|
||
| ``-console`` | ||
| prints results to console plus a number of options | ||
| default state prints all deities and their followers | ||
|
|
||
| ``-printreligions`` | ||
| prints all religions and their members | ||
|
|
||
| ``-printunits`` | ||
| prints all units and their personal deities | ||
|
|
||
| ``-printall`` | ||
| prints cults list, worship list and unit list | ||
| warning: large forts will exceed the console history limit. | ||
|
|
||
| ``-showids`` | ||
| prints religion's history entity ids, deity's history figure ids and unit's in-game ids |
There was a problem hiding this comment.
just so I understand, what is the intended use case for the text dumping? who is the consumer that is not using the GUI to browse the info?
There was a problem hiding this comment.
I haven't looked through this code yet, but could you address the lint errors. Also, please use four-space indents, no tabs.
|
@gero-pardo have you had a chance to review the comments? I'd love to get this into the next beta release. |
|
My apologies! I'm unable so far. Got mid-terms and a special final just shoved in for the end of this month. I'm in no way abandoning the project, but unfortunately this is how my general schedule works - summer's free, winter's not so much. I'll chime in as soon as I can spare a week, but even then I won't be able to pull in as many hours as I did at the start. |
Info gathering script for deities and religions.
Comes with a GUI and print to console options.
It's all set code-wise, but most likely not up to lint and formatting standards
Somewhat informal with comments, I'll remove if requested.