update quickfort docs and configs
Myk Taylor
parent
dba7df7ab8
commit
2b26117685
@ -0,0 +1,15 @@
|
|||||||
|
This directory is for quickfort blueprints. You can apply them to your fortress
|
||||||
|
map with the DFHack
|
||||||
|
[quickfort script](https://docs.dfhack.org/en/stable/docs/_auto/base.html#quickfort).
|
||||||
|
|
||||||
|
You can create blueprints by hand or by using any spreadsheet application,
|
||||||
|
saving them as .xlsx or .csv files. You can also build your plan "for real" in
|
||||||
|
Dwarf Fortress, and then export your map using the DFHack
|
||||||
|
[blueprint plugin](https://docs.dfhack.org/en/stable/docs/Plugins.html#blueprint)
|
||||||
|
for later replay in a different fort.
|
||||||
|
|
||||||
|
DFHack blueprints are compatible with the original Quickfort 2.0 syntax. If you
|
||||||
|
have existing blueprints that worked with https://github.com/joelpt/quickfort,
|
||||||
|
then they should work just fine in DFHack quickfort.
|
||||||
|
|
||||||
|
There are many ready-to-use examples of blueprints in the library subfolder.
|
||||||
@ -1,14 +0,0 @@
|
|||||||
This directory is for quickfort blueprints. You can apply them to your fortress
|
|
||||||
map with the DFHack quickfort plugin. See
|
|
||||||
https://docs.dfhack.org/en/stable/docs/Scripts.html#quickfort for details.
|
|
||||||
|
|
||||||
You can create blueprints by hand or by using any spreadsheet application,
|
|
||||||
saving them as .xlsx or .csv files. You can also build your plan "for real" in
|
|
||||||
Dwarf Fortress, and then export your map using the DFHack blueprint for later
|
|
||||||
replay in a different fort. See
|
|
||||||
https://docs.dfhack.org/en/stable/docs/Plugins.html#blueprint for more info.
|
|
||||||
|
|
||||||
DFHack blueprints follow the original Quickfort 2.0 syntax. See
|
|
||||||
https://github.com/joelpt/quickfort for joelpt's excellent documentation.
|
|
||||||
|
|
||||||
There are many ready-to-use examples of blueprints in the library subfolder.
|
|
||||||
@ -1,30 +1,83 @@
|
|||||||
# quickfort aliases configuration file
|
# aliases for quickfort query mode blueprints
|
||||||
#
|
#
|
||||||
# Defines custom keycode shortcuts for blueprints. Definitions in this file take
|
# This file defines custom keycode shortcuts for query mode blueprints.
|
||||||
# precedence over any definitions in the baseline aliases configuration file at
|
# Definitions in this file take precedence over any definitions in the baseline
|
||||||
# hack/data/quickfort/aliases-common.txt. See that file for aliases that are
|
# aliases configuration file at hack/data/quickfort/aliases-common.txt. See that
|
||||||
# already defined.
|
# file for aliases that are already defined.
|
||||||
#
|
#
|
||||||
# This file can be used to simplify repetitive tasks, such as building minecart
|
# If possible, build on the baseline aliases when defining your own aliases. If
|
||||||
# tracks or adjusting a food stockpile to accept seeds only. Making new aliases
|
# the DF UI screens change, updated baseline aliases may allow your aliases to
|
||||||
# is just a matter of mimicking the keys used to navigate through the menus and
|
# automatically adapt to the new UI. For example, if you create an alias to
|
||||||
# select options.
|
# modify particular furniture stockpile settings, start your alias with
|
||||||
|
# "{furnitureprefix}" instead of manually writing "s{Down 2}". Then, if the
|
||||||
|
# location of the furniture setting changes, your alias will automatically
|
||||||
|
# inherit the updated position when DFHack is updated.
|
||||||
#
|
#
|
||||||
# Syntax:
|
# Aliases simplify repetitive tasks, such as configuring workshop profiles or
|
||||||
|
# adjusting a food stockpile to accept only seeds. Making new aliases is just a
|
||||||
|
# matter of mimicking the keys used to navigate through the menus and select
|
||||||
|
# options. Use the aliases in your blueprint spreadsheets by writing an alias by
|
||||||
|
# itself in a cell, like "nocontainers", or reference an alias in a larger
|
||||||
|
# sequence by enclosing in in curly brackets, like "{nocontainers}{linksonly}"
|
||||||
|
#
|
||||||
|
# For example, say you have the following build and place blueprints:
|
||||||
|
#
|
||||||
|
# #build start(4;1;upper left corner of stockpile) mason stockpile
|
||||||
|
# ~, ~, ~, `, `, `
|
||||||
|
# ~, wm, ~, `, `, `
|
||||||
|
# ~, ~, ~, `, `, `
|
||||||
|
#
|
||||||
|
# #place start(4;1;upper left corner of stockpile) build mason
|
||||||
|
# ~, ~, ~, s, s, s
|
||||||
|
# ~, ~, ~, s, s, s
|
||||||
|
# ~, ~, ~, s, s, s
|
||||||
|
#
|
||||||
|
# and you want to configure the stockpile to hold only non-economic ("other")
|
||||||
|
# stone and to give to the adjacent mason workshop. You could write the
|
||||||
|
# keystrokes directly:
|
||||||
|
#
|
||||||
|
# #query start(4;1;upper left corner of stockpile) configure mason
|
||||||
|
# ~, ~, ~, s{Down 5}deb{Right}{Down 2}p^, `, `
|
||||||
|
# ~, ~, ~, g{Left 2}&, `, `
|
||||||
|
# ~, ~, ~, `, `, `
|
||||||
|
#
|
||||||
|
# or you could use alias names:
|
||||||
|
#
|
||||||
|
# #query start(4;1;upper left corner of stockpile) configure mason
|
||||||
|
# ~, ~, ~, otherstone, `, `
|
||||||
|
# ~, ~, ~, give2left, `, `
|
||||||
|
# ~, ~, ~, `, `, `
|
||||||
|
#
|
||||||
|
#
|
||||||
|
# The syntax for defining aliases is:
|
||||||
# aliasname: keystrokes
|
# aliasname: keystrokes
|
||||||
#
|
#
|
||||||
# Special keys:
|
# Where aliasname is at least two letters or digits long and keystrokes are
|
||||||
# {Right}, {Left}, {Up}, {Down}, >, < move the DF cursor
|
# whatever you would type into the DF UI. A keystroke can also be a named
|
||||||
# {/}, {*}, {+}, {-} can be used to navigate some DF menus
|
# keycode from the DF interface definition file (data/init/interface.txt),
|
||||||
# {Enter}, +{Enter}, {ExitMenu} - Enter, Shift+Enter, and Escape, respectively
|
# enclosed in curly brackets like an alias, like: "{Right}" or "{Enter}". In
|
||||||
# {Wait} pauses playback briefly
|
# order to avoid naming conflicts between aliases and keycodes, the convention
|
||||||
|
# is to start aliases with a lowercase letter. You can add spaces in between
|
||||||
|
# keystrokes to make them easier to read. Spaces in keystroke sequences will be
|
||||||
|
# ignored. To insert a literal space, use "{Space}"
|
||||||
#
|
#
|
||||||
# Special keys can be repeated by adding a number inside the curly braces, for
|
# Anything enclosed within curly brackets can also have a number after it,
|
||||||
# example: {Down 5}
|
# indicating how many times that alias or keycode should be repeated. For
|
||||||
|
# example: "{buildblocks 9}" or "{Down 5}".
|
||||||
#
|
#
|
||||||
# Some shorthand:
|
# Ctrl, Alt, and Shift modifiers can be specified for the next keycode by adding
|
||||||
|
# them as keycodes. For example, Alt-h is written as "{Alt}h".
|
||||||
|
#
|
||||||
|
# Some frequently-used keystrokes are assigned shorthand characters. Think of
|
||||||
|
# them as single-character aliases that don't need to be surrounded in curly
|
||||||
|
# brackets:
|
||||||
# & expands to {Enter}
|
# & expands to {Enter}
|
||||||
# @ expands to +{Enter}
|
# @ expands to {Shift}{Enter}
|
||||||
# ^ expands to {ExitMenu}
|
# + expands to {Shift}
|
||||||
# % expands to {Wait}
|
# ~ expands to {Alt}
|
||||||
|
# ! expands to {Ctrl}
|
||||||
|
# ^ expands to {ESC}
|
||||||
|
#
|
||||||
|
# If you need literal verisons of the shorthand characters, surround them in
|
||||||
|
# curly brackets, for example: "{+}"
|
||||||
|
#
|
||||||
|
|||||||
@ -1,20 +1,26 @@
|
|||||||
# quickfort main configuration file
|
# quickfort main configuration file
|
||||||
#
|
#
|
||||||
# Set startup defaults for the quickfort script in this file. Settings can be
|
# Set startup defaults for the quickfort script in this file. Settings can be
|
||||||
# dynamically overridden in the active session with the `quickfort set` command.
|
# temporarily overridden in the active session with the `quickfort set` command.
|
||||||
|
#
|
||||||
|
# If you have edited this file but want to revert to "factory defaults", delete
|
||||||
|
# this file and a fresh one will be copied from
|
||||||
|
# dfhack-config/default/quickfort/qickfort.txt the next time you start DFHack.
|
||||||
|
|
||||||
# Directory to search for blueprints. Can be set to an absolute or relative
|
# Directory tree to search for blueprints. Can be set to an absolute or relative
|
||||||
# path. If set to a relative path, resolves to a directory under the DF folder.
|
# path. If set to a relative path, resolves to a directory under the DF folder.
|
||||||
blueprints_dir=blueprints
|
blueprints_dir=blueprints
|
||||||
|
|
||||||
# Set to "true" or "false". If true, will designate dig blueprints in marker
|
# Set to "true" or "false". If true, will designate dig blueprints in marker
|
||||||
# mode. If false, only cells with dig codes prefixed with ``m`` will be
|
# mode. If false, only cells with dig codes explicitly prefixed with an "m" will
|
||||||
# designated in marker mode.
|
# be designated in marker mode.
|
||||||
force_marker_mode=false
|
force_marker_mode=false
|
||||||
|
|
||||||
# Allows you to manually select building materials for each
|
# Set to the maximum number of resources you want assigned to stockpiles of the
|
||||||
# building/construction when running (or creating orders for) build blueprints.
|
# relevant types. Set to -1 for DF defaults (number of stockpile tiles for
|
||||||
# Materials in selection dialogs are ordered according to preferences in
|
# stockpiles that take barrels and bins, 1 wheelbarrow for stone stockpiles).
|
||||||
# materials.txt. If false, will only prompt for materials that have :labels.
|
# The default here for wheelbarrows is 0 since using wheelbarrows normally
|
||||||
# See https://github.com/joelpt/quickfort#manual-material-selection for details.
|
# *decreases* the efficiency of your fort.
|
||||||
force_interactive_build=false
|
stockpiles_max_barrels=-1
|
||||||
|
stockpiles_max_bins=-1
|
||||||
|
stockpiles_max_wheelbarrows=0
|
||||||
|
|||||||
Loading…
Reference in New Issue