Skip to content

Commit

Permalink
Merge pull request #1027 from myk002/myk_ban_docs
Browse files Browse the repository at this point in the history
[ban-cooking] reformat and clarify documentation
  • Loading branch information
myk002 authored Mar 7, 2024
2 parents 50ad2b5 + 3672f27 commit 6c790e4
Showing 1 changed file with 28 additions and 18 deletions.
46 changes: 28 additions & 18 deletions docs/ban-cooking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,12 @@ ban-cooking

Some cookable ingredients have other important uses. For example, seeds can be
cooked, but if you cook them all, then your farmers will have nothing to plant
in the fields. Similarly, thread can be cooked, but if you do that, then your
weavers will have nothing to weave into cloth and your doctors will have
nothing to use for stitching up injured dwarves.
in the fields. Similarly, booze can be cooked, but if you do that, then your
dwarves will have nothing (good) to drink.

If you open the Kitchen screen, you can select individual item types and choose
to ban them from cooking. To prevent all your booze from being cooked, for
example, you'd select the Booze tab and then click each of the visible types of
example, you'd filter by "Drinks" and then click each of the visible types of
booze to prevent them from being cooked. Only types that you have in stock are
shown, so if you acquire a different type of booze in the future, you have to
come back to this screen and ban the new types.
Expand All @@ -23,12 +22,12 @@ items (e.g. all types of booze) in one go. It can even ban types that you don't
have in stock yet, so when you *do* get some in stock, they will already be
banned. It will never ban items that are only good for eating or cooking, like
meat or non-plantable nuts. It is usually a good idea to run
``ban-cooking all`` as one of your first actions in a new fort.
``ban-cooking all`` as one of your first actions in a new fort. You can add
this command to your Autostart list in `gui/control-panel`.

If you want to re-enable cooking for a banned item type, you can go to the
Kitchen screen and un-ban whatever you like by clicking on the "cook"
icon. You can also un-ban an entire class of items with the
``ban-cooking --unban`` option.
icon. You can also un-ban an entire class of items with the ``--unban`` option.

Usage
-----
Expand All @@ -37,20 +36,31 @@ Usage

ban-cooking <type|all> [<type> ...] [<options>]

Valid types are ``booze``, ``brew`` (brewable plants), ``fruit``, ``honey``,
``milk``, ``mill`` (millable plants), ``oil``, ``seeds`` (plantable seeds),
``tallow``, and ``thread``. It is possible to include multiple types or all
types in a single ban-cooking command: ``ban-cooking oil tallow`` will ban both
oil and tallow from cooking. ``ban-cooking all`` will ban all of the above
types.
Valid types are:

Examples::
- ``booze``
- ``brew`` (brewable plants)
- ``fruit``
- ``honey``
- ``milk``
- ``mill`` (millable plants)
- ``oil``
- ``seeds`` (plantable seeds)
- ``tallow``
- ``thread``

on-new-fortress ban-cooking all
Note that in the vanilla game, there are no items that can be milled or turned
into thread that can also be cooked, so these types are only useful when using
mods that add such items to the game.

Ban cooking all otherwise useful ingredients once when starting a new fortress.
Note that this exact command can be enabled via the ``Autostart`` tab of
`gui/control-panel`.
Examples
--------

``ban-cooking oil tallow``
Ban all types of oil and tallow from cooking.
``ban-cooking all``
Ban all otherwise useful types of foods from being cooked. This command can
be enabled for Autostart in `gui/control-panel`.

Options
-------
Expand Down

0 comments on commit 6c790e4

Please sign in to comment.