DFHack / dfhack

Memory hacking library for Dwarf Fortress and a set of tools that use it
Other
1.87k stars 475 forks source link

Move full-heal to modtools #1375

Closed warmist closed 6 years ago

warmist commented 6 years ago

IMHO it's more useful as a mod tool, e.g. various scripts/interaction etc, could heal/revive your dwarves or enemies.

lethosor commented 6 years ago

No, people use it manually too.

lethosor commented 6 years ago

More details, since I'm not on mobile anymore:

scripts/modtools/about.txt says this:

``modtools/*`` scripts provide tools for modders, often with changes
to the raw files, and are not intended to be called manually by end-users.

I use full-heal manually often, and from the suggestions and issues people have reported, I'm pretty sure other people do too. There's nothing preventing mods from using scripts that aren't in the modtools folder. On the other hand, moving user-facing scripts to the modtools folder is poor for usability, since that can more than double the command length and hides the scripts from ls by default.

My general rule of thumb is that anyone not actively developing a mod should never have to type "modtools/". By this criteria, there are actually a couple scripts in modtools/ that probably shouldn't be there (but moving them out risks breaking mods if we don't leave an alias behind).

warmist commented 6 years ago

I guess scripts can just call the full-heal script.

I just worry that it will need hundred of params (e.g. leave scars, all etc...).

lethosor commented 6 years ago

Module support from https://github.com/DFHack/scripts/pull/73 should make it easier for other scripts to use directly (or specific functions only).

warmist commented 6 years ago

Ah nice, missed that one.