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
|
||||
# precedence over any definitions in the baseline aliases configuration file at
|
||||
# hack/data/quickfort/aliases-common.txt. See that file for aliases that are
|
||||
# already defined.
|
||||
# This file defines custom keycode shortcuts for query mode blueprints.
|
||||
# Definitions in this file take precedence over any definitions in the baseline
|
||||
# aliases configuration file at hack/data/quickfort/aliases-common.txt. See that
|
||||
# file for aliases that are already defined.
|
||||
#
|
||||
# This file can be used to simplify repetitive tasks, such as building minecart
|
||||
# tracks or adjusting a food stockpile to accept seeds only. Making new aliases
|
||||
# is just a matter of mimicking the keys used to navigate through the menus and
|
||||
# select options.
|
||||
# If possible, build on the baseline aliases when defining your own aliases. If
|
||||
# the DF UI screens change, updated baseline aliases may allow your aliases to
|
||||
# automatically adapt to the new UI. For example, if you create an alias to
|
||||
# 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
|
||||
#
|
||||
# Special keys:
|
||||
# {Right}, {Left}, {Up}, {Down}, >, < move the DF cursor
|
||||
# {/}, {*}, {+}, {-} can be used to navigate some DF menus
|
||||
# {Enter}, +{Enter}, {ExitMenu} - Enter, Shift+Enter, and Escape, respectively
|
||||
# {Wait} pauses playback briefly
|
||||
# Where aliasname is at least two letters or digits long and keystrokes are
|
||||
# whatever you would type into the DF UI. A keystroke can also be a named
|
||||
# keycode from the DF interface definition file (data/init/interface.txt),
|
||||
# enclosed in curly brackets like an alias, like: "{Right}" or "{Enter}". In
|
||||
# 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
|
||||
# example: {Down 5}
|
||||
# Anything enclosed within curly brackets can also have a number after it,
|
||||
# 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 {ExitMenu}
|
||||
# % expands to {Wait}
|
||||
|
||||
# @ expands to {Shift}{Enter}
|
||||
# + expands to {Shift}
|
||||
# ~ 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
|
||||
#
|
||||
# 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.
|
||||
blueprints_dir=blueprints
|
||||
|
||||
# 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
|
||||
# designated in marker mode.
|
||||
# mode. If false, only cells with dig codes explicitly prefixed with an "m" will
|
||||
# be designated in marker mode.
|
||||
force_marker_mode=false
|
||||
|
||||
# Allows you to manually select building materials for each
|
||||
# building/construction when running (or creating orders for) build blueprints.
|
||||
# Materials in selection dialogs are ordered according to preferences in
|
||||
# materials.txt. If false, will only prompt for materials that have :labels.
|
||||
# See https://github.com/joelpt/quickfort#manual-material-selection for details.
|
||||
force_interactive_build=false
|
||||
# Set to the maximum number of resources you want assigned to stockpiles of the
|
||||
# relevant types. Set to -1 for DF defaults (number of stockpile tiles for
|
||||
# stockpiles that take barrels and bins, 1 wheelbarrow for stone stockpiles).
|
||||
# The default here for wheelbarrows is 0 since using wheelbarrows normally
|
||||
# *decreases* the efficiency of your fort.
|
||||
stockpiles_max_barrels=-1
|
||||
stockpiles_max_bins=-1
|
||||
stockpiles_max_wheelbarrows=0
|
||||
|
||||
Loading…
Reference in New Issue