remove some cruft from autobutcher docs

develop
myk002 2022-08-05 08:08:47 -07:00
parent 46c3862a08
commit 6f48c1f4d0
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
1 changed files with 11 additions and 75 deletions

@ -67,8 +67,6 @@ Usage:
default command if autobutcher is run without parameters. default command if autobutcher is run without parameters.
``autobutcher list_export`` ``autobutcher list_export``
Print commands required to set the current settings in another fort. Print commands required to set the current settings in another fort.
Useful to run form dfhack-run like:
``dfhack-run autobutcher list_export > autobutcher.script``
To see a list of all races, run this command: To see a list of all races, run this command:
@ -76,6 +74,16 @@ To see a list of all races, run this command:
Though not all the races listed there are tameable/butcherable. Though not all the races listed there are tameable/butcherable.
.. note::
Settings and watchlist are stored in the savegame, so you can have different
settings for each save. If you want to copy your watchlist to another,
savegame, you can export the commands required to recreate your settings.
To export, open an external terminal in the DF directory, and run
``dfhack-run autobutcher list_export > filename.txt``. To import, load your
new save and run ``script filename.txt`` in the DFHack terminal.
Examples Examples
-------- --------
@ -91,6 +99,7 @@ alpacas, sheep, and llamas (for wool), and pigs (for milk and meat). All other
unnamed tame units will be marked for slaughter as soon as they arrive in your unnamed tame units will be marked for slaughter as soon as they arrive in your
fortress:: fortress::
enable autobutcher
autobutcher target 2 2 2 2 DOG autobutcher target 2 2 2 2 DOG
autobutcher target 1 1 2 2 CAT autobutcher target 1 1 2 2 CAT
autobutcher target 50 50 14 2 BIRD_GOOSE autobutcher target 50 50 14 2 BIRD_GOOSE
@ -98,76 +107,3 @@ fortress::
autobutcher target 5 5 6 2 PIG autobutcher target 5 5 6 2 PIG
autobutcher target 0 0 0 0 new autobutcher target 0 0 0 0 new
autobutcher autowatch autobutcher autowatch
Options:
:example: Print some usage examples.
:start: Start running every X frames (df simulation ticks).
Default: X=6000, which would be every 60 seconds at 100fps.
:stop: Stop running automatically.
:sleep <x>: Changes the timer to sleep X frames between runs.
:watch R: Start watching a race. R can be a valid race RAW id (ALPACA,
BIRD_TURKEY, etc) or a list of ids seperated by spaces or
the keyword 'all' which affects all races on your current
watchlist.
:unwatch R: Stop watching race(s). The current target settings will be
remembered. R can be a list of ids or the keyword 'all'.
:forget R: Stop watching race(s) and forget it's/their target settings.
R can be a list of ids or the keyword 'all'.
:autowatch: Automatically adds all new races (animals you buy from merchants,
tame yourself or get from migrants) to the watch list using
default target count.
:noautowatch: Stop auto-adding new races to the watchlist.
:list: Print the current status and watchlist.
:list_export: Print the commands needed to set up status and watchlist,
which can be used to import them to another save (see notes).
:target <fk> <mk> <fa> <ma> <R>:
Set target count for specified race(s). The first four arguments
are the number of female and male kids, and female and male adults.
R can be a list of spceies ids, or the keyword ``all`` or ``new``.
``R = 'all'``: change target count for all races on watchlist
and set the new default for the future. ``R = 'new'``: don't touch
current settings on the watchlist, only set the new default
for future entries.
:list_export: Print the commands required to rebuild your current settings.
.. note::
Settings and watchlist are stored in the savegame, so that you can have
different settings for each save. If you want to copy your watchlist to
another savegame you must export the commands required to recreate your settings.
To export, open an external terminal in the DF directory, and run
``dfhack-run autobutcher list_export > filename.txt``. To import, load your
new save and run ``script filename.txt`` in the DFHack terminal.
Examples:
You want to keep max 7 kids (4 female, 3 male) and max 3 adults (2 female,
1 male) of the race alpaca. Once the kids grow up the oldest adults will get
slaughtered. Excess kids will get slaughtered starting with the youngest
to allow that the older ones grow into adults. Any unnamed cats will
be slaughtered as soon as possible. ::
autobutcher target 4 3 2 1 ALPACA BIRD_TURKEY
autobutcher target 0 0 0 0 CAT
autobutcher watch ALPACA BIRD_TURKEY CAT
autobutcher start
Automatically put all new races onto the watchlist and mark unnamed tame units
for slaughter as soon as they arrive in your fort. Settings already made
for specific races will be left untouched. ::
autobutcher target 0 0 0 0 new
autobutcher autowatch
autobutcher start
Stop watching the races alpaca and cat, but remember the target count
settings so that you can use 'unwatch' without the need to enter the
values again. Note: 'autobutcher unwatch all' works, but only makes sense
if you want to keep the plugin running with the 'autowatch' feature or manually
add some new races with 'watch'. If you simply want to stop it completely use
'autobutcher stop' instead. ::
autobutcher unwatch ALPACA CAT