From d918e2d9d83d649fb2bdc24ebc077eb6f4dfd39d Mon Sep 17 00:00:00 2001 From: Myk Taylor Date: Mon, 9 Jan 2023 15:33:04 -0800 Subject: [PATCH] fix example init file and related doc --- data/dfhack-config/init/examples/README.md | 9 +++++++++ .../init/examples/onMapLoad_dreamfort.init | 6 +++--- docs/guides/examples-guide.rst | 12 ++++++------ 3 files changed, 18 insertions(+), 9 deletions(-) create mode 100644 data/dfhack-config/init/examples/README.md diff --git a/data/dfhack-config/init/examples/README.md b/data/dfhack-config/init/examples/README.md new file mode 100644 index 000000000..99060b0a3 --- /dev/null +++ b/data/dfhack-config/init/examples/README.md @@ -0,0 +1,9 @@ +# Example DFHack init scripts + +This folder contains ready-to-use examples of DFHack init scripts. +You can use them by copying them to the dfhack-config/init folder. +You can use them unmodified, or you can customize them to better +suit your preferences. + +For information on each of the files in this library, see the +[DFHack Example Configuration File Guide](https://docs.dfhack.org/en/stable/docs/guides/examples-guide.html). diff --git a/data/dfhack-config/init/examples/onMapLoad_dreamfort.init b/data/dfhack-config/init/examples/onMapLoad_dreamfort.init index 8f341cf7e..c1d129c33 100644 --- a/data/dfhack-config/init/examples/onMapLoad_dreamfort.init +++ b/data/dfhack-config/init/examples/onMapLoad_dreamfort.init @@ -10,7 +10,7 @@ #on-new-fortress buildingplan set boulders false; buildingplan set logs false # Disable cooking of useful item types when you start a new fortress. -on-new-fortress ban-cooking tallow; ban-cooking honey; ban-cooking oil; ban-cooking seeds; ban-cooking brew; ban-cooking fruit; ban-cooking mill; ban-cooking thread; ban-cooking milk; ban-cooking booze +on-new-fortress ban-cooking all # Show a warning dialog when units are starving repeat -name warn-starving -time 10 -timeUnits days -command [ warn-starving ] @@ -40,8 +40,8 @@ enable automelt enable tailor # auto-assigns nesting birds to nestbox zones and protects fertile eggs from -# being cooked/eaten -enable zone autonestbox nestboxes +# being gathered and eaten +enable autonestbox nestboxes # manages seed stocks enable seedwatch diff --git a/docs/guides/examples-guide.rst b/docs/guides/examples-guide.rst index bcb7c77ec..d2581cf81 100644 --- a/docs/guides/examples-guide.rst +++ b/docs/guides/examples-guide.rst @@ -13,16 +13,16 @@ your preferences. The ``init/`` subfolder ----------------------- -The :source:`init/ ` subfolder contains useful DFHack -`init-files` that you can copy into your :file:`dfhack-config/init` folder -- -the same directory as ``dfhack.init``. +The :source:`init/ ` subfolder contains useful +DFHack `init-files` that you can copy into your :file:`dfhack-config/init` +folder -- the same directory as ``dfhack.init``. .. _onMapLoad-dreamfort-init: -:source:`onMapLoad_dreamfort.init ` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +:source:`onMapLoad_dreamfort.init ` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This is the config file that comes with the `dreamfort` set of blueprints, but +This is the config file that designed for the `dreamfort` set of blueprints, but it is useful (and customizable) for any fort. It includes the following config: - Calls `ban-cooking` for items that have important alternate uses and should