Commit Graph

65 Commits (06faeb669b0183b09efa674804726db51fd623a2)

Author SHA1 Message Date
Myk Taylor 6185df25d6
update quickfort user guide for new take_from semantics 2023-08-28 17:59:52 -07:00
Myk Taylor ca45fec5e6
quickfort user guide update 2nd draft 2023-06-14 15:20:25 -07:00
Myk Taylor f894634eef
update dreamfort case study and general formatting 2023-06-14 11:28:41 -07:00
Myk Taylor e4f6424f23
use new logistics features in dreamfort
and document quickfort options
2023-06-12 13:21:24 -07:00
Myk Taylor d7b0cc8340
remove obsolete docs 2023-06-08 12:54:58 -07:00
Myk Taylor 25530d6e7b
guide update - first draft 2023-06-08 12:40:33 -07:00
Myk Taylor c7a058c308
fix library paths in docs 2023-03-12 15:43:32 -07:00
Myk Taylor 63d752b3f8
update docs 2023-02-26 10:53:30 -08:00
Myk 8e9f3e902f
Update quickfort-user-guide.rst
Fix typo
2022-10-01 16:59:33 -07:00
myk002 9a2cb5ea44
fix ALL the typos
done by copying everything into Google docs and running spellcheck
2022-09-28 14:49:03 -07:00
myk002 8a36d5607b
lcase section headers 2022-09-14 13:19:26 -07:00
myk002 e37b7650fa
update guides
including fixing the ordering of the TOC, which, while in alphabetical
order, was not in a logical order
2022-09-05 20:53:44 -07:00
myk002 b0ae9ed9c0
align quickfort guides with new defaults 2022-08-26 13:38:19 -07:00
myk002 ff373bb9e2 use extlinks where appropriate in docs 2022-06-08 16:53:46 -07:00
Myk ed2ba69713
Improvements to dreamfort, quickfort keystroke aliases, and example orders (#2162)
* add alt-f as a hotkey for quickfort

to mimic the existing windows hotkey for the old quickfort
hopefully this will ease the transition from the old quickfort to the
new

* add and document new quickfort aliases

* reduce quantity requirement for dyeing

15 is just too high. the counter counts bags, not units

* dreamfort blueprint improvements

most of these suggested by ldog on the forums. Thanks!
- significantly extend the list of hostile creatures that get stashed in the prisoner quantum stockpile
- send adamantine thread to the metalworker stockpiles
- give from thread/cloth stockpiles to clothier, loom, and dyer to protect the adamantine thread
- automatically create tavern, library, and temple locations (restricted to residents only by default)
- automatically associate the rented rooms with the tavern
- place a stockpile under the dump zone so you can set up stockpile links for dumped items
- doc improvements. in particular, point people to the new assign-minecarts tool for assigning minecarts to quantum stockpile dumps

* update changelog

* fix typo in cloth stockpile settings

* fix typo in guildhall location setup

* don't restrict stockpiles for clothiers and dyers

* deprecate jugs alias and add stone|woodentools

* remove dye thread, make jugs wooden

remove dye thread to protect adamantine
make jugs wooden to differentiate them from scroll rollers. that gives
us a chance to actually have a usable jugs-only stockpile

* dreamfort improvements

- move trap corridor gates and levers before the walls and traps so they get
  constructed first
- give useful names to the craftsdwarf's workshops
- redesign the services level to:
  - fit better in a 1x1 embark
  - add doors to the hospital recovery rooms to protect from
    werebeasts-to-be
  - add an interrogation room (sheriff's office) next to the jail

* shape hospital zone to exactly the hospital area

* don't clutter the hospital with statues

* update changelog
2022-06-02 15:51:45 -07:00
myk002 fbd1fac210 document transform behavior for buildings and keys 2022-04-01 11:00:41 -07:00
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 1976288efb quickfort user guide doc refresh
- add docs for negative expansion syntax
- add information on how negative expansion syntax can be used to
  simplify carved track designations
- full editing pass, fixing grammar, typos, formatting, and clarifying text
- added tip about using dig priorities to ensure miners dig one level at
  a time
- add "Dreamfort organization and packaging" section to the dreamfort
  case study
- add inline screenshots for each dreamfort level in the section that
  discusses that level
- fix Links section to use the actual header text of the target links
2022-03-28 16:00:29 -07:00
Myk be32e35642
Reword the titles of the various guides (#2041)
so they are more distinct. even I got confused about the difference
between the quickfort library guide (which is about blueprints, but
listing the pre-made onces) and the
quickfort blueprint guide (which is about blueprints, but editing them)
2022-03-21 12:58:17 -07:00
myk002 0303e182a8 fix typo in shift syntax, explain why +y is down 2022-02-18 14:54:45 -08:00
myk002 f2865beb57 add docs for blueprint shifting and transformation 2022-02-18 14:54:45 -08:00
myk002 10d5f23400 add documentation for repeat() meta markers
and some overall editing updates (sorry for the clutter!)
2022-02-12 18:28:47 -08:00
myk002 e0ea113d88 add docs for extended syntax for z-level changes
in quickfort blueprints
2022-02-06 16:56:07 -08:00
myk002 dadb053d5f fix typo in hostpital supply config
powder -> plaster
2021-10-04 15:32:26 -07:00
myk002 c292b14b3e add documentation for quickfort single-tile tracks 2021-10-04 11:02:18 -07:00
myk002 596f72f06b implement --playback-start param and logic 2021-09-20 16:10:15 -07:00
lethosor 001e608aa7
Fix invalid role name
Resolves #1851

See https://github.com/sphinx-doc/sphinx/pull/8345 for details
2021-05-11 19:46:01 -04:00
lethosor 96e91fa5e2
Merge remote-tracking branch 'myk002/myk_aliases_docs' into develop 2021-02-24 13:53:22 -05:00
lethosor 1be75f269b
Merge remote-tracking branch 'myk002/myk_dreamfort' into develop
+typo fix in quickfort-alias-guide.rst
2021-02-20 00:47:59 -05:00
myk002 3278519c98
document how to specify containers for stockpiles
that are not specified with expansion syntax
2021-02-19 11:43:10 -08:00
myk002 cf0506e650
add documentation for #aliases blueprints 2021-02-17 23:10:47 -08:00
myk002 4790e23a5c
add more docs for quickfort orders 2021-02-13 07:46:45 -08:00
myk002 13fae4628b
add docs for #place-generated manager orders 2021-02-05 17:05:34 -08:00
myk002 824beb0253
documentation for bin/barrel/wb feature 2021-02-01 02:22:04 -08:00
myk002 fb143516cd
refresh the dreamfort case study 2021-01-30 19:32:41 -08:00
myk002 0c165e020c
fix formatting error 2021-01-30 18:47:34 -08:00
myk002 32d4eb001a
update dreamfort case study according to changes 2021-01-30 18:43:39 -08:00
lethosor d01e61c658
Fix some error message formatting and add some cross-links to docs
Followup to #1747
2021-01-22 21:05:20 -05:00
lethosor 5ef7a81fd1
Merge remote-tracking branch 'myk002/myk_buildingplan_set_settings' into develop 2021-01-22 20:57:30 -05:00
myk002 ad39bb3c33
address review comments 2021-01-22 12:48:36 -08:00
myk002 b5b7319a23
add documentation for #ignore blueprints 2021-01-11 15:58:16 -08:00
myk002 16a8f31b93
high level docs for quickfort blueprint library 2020-12-17 09:59:37 -08:00
myk002 45a9106e9f
address review comments
- use :: shorthand where we can
- clarify sub-alias docs
- remove note about multiple modifier keys not being supported
2020-12-11 11:22:38 -08:00
myk002 593d746dd0
add link to blueprint library sources back in 2020-12-05 18:52:13 -08: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 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 76759184d3
reinforce that meta blueprints can't cross files
they must refer to labels that are within the same .xlsx or .csv file
2020-11-12 23:23:03 -08:00
Myk Taylor 93c8de9b23
use numbered lists in meta blueprints section 2020-11-12 23:23:03 -08:00
Myk Taylor 647093f5c8
quickfort guide: 'c' stockpiles don't make sense
explain why "custom" stockpiles aren't meaningful to create in a
blueprint and what the user should do instead
2020-11-12 23:23:03 -08:00
lethosor e61839b571
Fix ordered list 2020-10-28 00:01:51 -04:00