Commit Graph

14 Commits (e60cbfc7436ea6960c27c91876a03454339423fa)

Author SHA1 Message Date
Myk b8c33d8ed0
[quickfort] add documentation and test data for config mode (#2070)
- documents the new config mode
- adds integration test data for [quickfort] implement config mode scripts#361
- adds a note recommending that config mode be used instead of the quickfort query_unsafe setting
- converts the dreamfort /setup blueprint to use config mode; also adjust the aliases used in that blueprint to no longer escape from and re-enter query mode
- adds some more distinctive anchor names for the quickfort and blueprint guides
2022-04-01 09:21:16 -07:00
myk002 025c9ff758
overhaul quickfort alias documentation
- move the alias syntax and usage docs from dfhack-config/quickfort/aliases.txt to a proper guide written in RST. Add examples and more details.
- move the alias library docs from data/quickfort/aliases-common.txt to the new guide
- reorder aliases in aliases-common to match the order in the docs
- factor out the character used to enter the stockpile config screen so we can use the same aliases for stockpiles and hauling routes (use 's' for stockpiles and '{Enter}' for hauling routes)
- reference the new guide in the quickfort user guide
- do an editorial pass of the quickfort user guide
  - change name to "Quickfort Blueprint Guide", but only in the text, not the filename, so we don't change the URL
  - add `quickfort-blueprint-guide` as a label, in addition to the existing `quickfort-user-guide`
  - changed table-like lists to actual tables
  - changed "grid" tables into "simple" tables where possible
  - used ':kbd:' markers whenever we refer to a single character
  - turned Meta blueprints and Notes blueprints sections into subsections of a new "Other blueprint modes" section, in preparation for a few new modes coming in -r5.
  - updated out-of date caveat about bookcases, display furniture, and offering places not being supported
2020-12-05 18:36:15 -08:00
myk002 d2472335fc
add names for quantums and zones 2020-11-12 23:23:04 -08:00
myk002 01741ce6c6
update quickfort guide and aliases
- move bit of alias documentation from aliases-common to aliases.txt
- document new behavior for 'c'ustom stockpiles
2020-11-12 23:23:03 -08:00
Myk Taylor 7e78d8802e migrate qf's buildings_use_blocks to buildingplan
- remove buildings_use_blocks setting from quickfort config file
- add a new Buildingplan Global Settings dialog to house global settings
- move Quickfort Mode (for legacy Python Quickfort) into that dialog
- add four settings to control how generic building materials are matched:
  - blocks
  - boulders
  - logs
  - bars
- ajust the buildingplan algorithm to register duplicate tasks for
  building material item filters, one for each type. since we track how
  many items we've matched for a filter, the first matched item will
  "win" and the extras will get detected as invalid and popped off the
  queue.
- ensure boulders, logs, and bars are scanned last, and in that order
- more global settings planned for the future! see
  http://www.bay12forums.com/smf/index.php?topic=176889.msg8202679#msg8202679
2020-10-22 21:37:49 -07:00
Myk Taylor ea5a5414c9 document (and use) parameterized aliases 2020-10-17 22:21:50 -07:00
Myk Taylor f754164a1d document new query_unsafe option 2020-10-11 22:16:42 -07:00
Myk Taylor bdf2bbc22e remove reference in docs to unimplemented behavior
I never implemented ignoring spaces in alias definitions, and now that
I've thought more about the consequences, I don't plan to : ) Ignoring
spaces would lead to conusing behavior when players attempt to give
names with spaces to buildings
2020-10-11 22:15:01 -07:00
Myk Taylor da020c72de quickfort: refresh aliases docs and doc r+ -> r+& 2020-09-02 16:53:32 -07:00
Myk Taylor a8f215fcfe remove '+' as a special key. it's too useful.
plus, the original quickfort doesn't seem to have generally treated it
as {Shift}. it was special-cased when it preceded {Enter}, which we
don't need to do.
2020-08-14 21:14:50 -07:00
Myk Taylor 0f9f64d137 remove materials files and replace with settings 2020-08-12 15:14:59 -07:00
Myk Taylor 2b26117685 update quickfort docs and configs 2020-08-05 15:44:00 -07:00
Myk Taylor 2026c2b0c3 change settings names to use underscored
since dash makes them invalid lua identifiers
2020-07-18 20:04:22 -07:00
Myk Taylor 88dffd6474 quickfort files and docs 2020-07-18 08:54:24 -07:00