Merge pull request #2582 from myk002/myk_init_examples

fix example init file and related doc
develop
Myk 2023-01-09 23:50:20 -08:00 committed by GitHub
commit 646acc8b45
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 18 additions and 12 deletions

@ -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).

@ -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 ]
@ -25,9 +25,6 @@ repeat -name autoMilkCreature -time 14 -timeUnits days -command [ workorder "{\"
# Fulfill high-volume orders before slower once-daily orders
repeat -name orders-sort -time 1 -timeUnits days -command [ orders sort ]
# Don't let caravans bring barrels of blood and other useless liquids
fix/blood-del
# Manages crop assignment for farm plots
enable autofarm
autofarm default 30
@ -40,8 +37,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

@ -13,16 +13,16 @@ your preferences.
The ``init/`` subfolder
-----------------------
The :source:`init/ <data/examples/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/ <data/dfhack-config/init/examples>` 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 <data/examples/init/onMapLoad_dreamfort.init>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:source:`onMapLoad_dreamfort.init <data/dfhack-config/init/examples/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