Commit Graph

164 Commits (07c8f035c7c133da150edeccead7dc4bc3dcda2b)

Author SHA1 Message Date
Tachytaenius a996b29cf5 Some editing of mod guide 2022-07-14 11:10:23 +01:00
Tachytaenius d7976e63b6 const example. also, (preemptively acquiescing) readme.mkd --> readme.md 2022-07-13 22:44:38 +01:00
Tachytaenius 9c04a28bd9 Shouldn't've replaced the TODO 2022-07-13 22:43:01 +01:00
Tachytaenius c39e2fe2cb Mod structure 2022-07-13 22:42:35 +01:00
Tachytaenius c9cffc7da9 Fix docs bugs 2022-07-12 11:26:49 +01:00
Tachytaenius aa8809833b Do the "running shoes" TODO 2022-07-11 18:56:28 +01:00
Tachytaenius f670ef4b60 Add custom raw tokens link and add prefix to custom raw tokens in raws 2022-07-11 18:24:07 +01:00
myk002 8d99b7e6e1
prepare for plugin doc split 2022-07-10 20:19:09 -07:00
Tachytaenius 25175b5c28 Fire rate code 2022-07-09 17:04:20 +01:00
Tachytaenius 15aae9cf1e More guide 2022-07-07 19:23:10 +01:00
Myk 9f44fd3f72
[manipulator] add the professions library (#2234)
* move professions out of the examples folder

* install professions into professions/library

* guard unguarded header from multiple inclusion

* load and display library professions

* update changelog

* move example professions docs from examples guide

* update dreamfort documentation

* note that professions folder has changed

* Fix bad merge
2022-07-06 07:21:26 -07:00
Myk e0d37a31ae
Make the manager orders library available by default (#2233)
* move orders out of examples directory

* install orders into library dir

* read orders from new library dir

* update documentation

* update dreamfort references to orders import

* update changelog

* ignore json files in pre-commit
2022-07-06 07:03:29 -07:00
Tachytaenius 0237567c18 More modding guide 2022-07-04 17:11:21 +01:00
Tachytaenius f8a8bf6e29 Some more 2022-07-03 17:33:36 +01:00
Tachytaenius b86d16d64c Some of Detecting Triggers 2022-07-03 15:59:01 +01:00
Tachytaenius 46d0f36d41 Pad out Getting used to gm-editor and DFStructs exploration a bit 2022-07-01 19:10:26 +01:00
Tachytaenius c026bd6dcb Split sections a bit 2022-07-01 12:04:18 +01:00
Tachytaenius f812e09ae1 Update modding guide with an extra paragraph and syntax fixes 2022-06-21 21:35:07 +01:00
Tachytaenius ac864204c2 More work on guide, added to existing sections and revised sections list 2022-06-21 21:07:35 +01:00
Tachytaenius 41526f376d Fix wrong - length 2022-06-21 13:02:10 +01:00
Tachytaenius 6f2998d7e5
Update docs/guides/modding-guide.rst
Co-authored-by: Myk <myk002@yahoo.com>
2022-06-21 12:58:40 +01:00
Tachytaenius 52161df428
Update docs/guides/modding-guide.rst
Co-authored-by: Myk <myk002@yahoo.com>
2022-06-21 12:58:36 +01:00
Tachytaenius 92ab6b1052
Update docs/guides/modding-guide.rst
Co-authored-by: Myk <myk002@yahoo.com>
2022-06-21 12:58:29 +01:00
Tachytaenius 88a9755d78
Update docs/guides/modding-guide.rst
Co-authored-by: Myk <myk002@yahoo.com>
2022-06-21 12:54:45 +01:00
Tachytaenius ccee6ba487 Added link to modding guide from changelog 2022-06-21 12:53:59 +01:00
Tachytaenius 0ae8a42080 Unfinished modding guide 2022-06-20 20:07:07 +01:00
Myk 4152be13c7
Simplify bug extlink 2022-06-08 19:02:58 -07:00
myk002 ff373bb9e2 use extlinks where appropriate in docs 2022-06-08 16:53:46 -07:00
myk002 3928bb67d7 promote gui/quickfort in the library guide
also add a link to the TheQuickFortress online spreadsheets
2022-06-04 20:05:11 -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
myk002 f37de835da center uncentered image in blueprint library guide 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 89a3ca8ee9 update docs and changelog 2022-03-12 13:45:32 -08:00
myk002 17f400d091 add light aquifer tap library blueprint and docs 2022-02-26 14:54:42 -08:00
myk002 56e8de592c simplify dreamfort with new quickfort features
also:
- add in iron and flux indicators on the industry level
- fix out of date docs for professions
2022-02-19 17:54:01 -08:00
myk002 89038ffafa add pump stack blueprint to the libarary, add docs 2022-02-18 15:47:33 -08: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 e6d93f4170 update docs for example orders and professions 2021-09-22 10:30:41 -07:00
myk002 596f72f06b implement --playback-start param and logic 2021-09-20 16:10:15 -07:00
myk002 53c1582080 update library guide 2021-09-20 13:01:07 -07:00
myk002 d5a9a9534e dreamfort improvements
- shift seventh dwarf from craftsdwarf to farmer
- give starting miners some skill in engraving to make smoothing the
  cistern go faster
- update embark suggestions and sample profile accordingly
- widen clearcutting area for surface fort so trees don't overhang the
  roof
- move wax from the cookables stockpile to the industry goods pile
- move coins from goods to metal
- move sheets from goods to textiles
2021-09-20 13:01:07 -07:00
myk002 4a593a489c add reference to dffd file in dreamfort help 2021-09-05 23:54:48 -07:00
myk002 695106afae add a link to the fully built dreamfort on dffd 2021-09-05 23:54:48 -07:00
myk002 f8d041b9aa dreamfort and supporting files update
- merge otherstock into basic (safe now that we have orders sort)
- don't overproduce weapons and armor
- update dreamfort help and examples guide
2021-09-03 00:31:42 -07:00
myk002 2249b42506
update examples docs 2021-09-01 13:06:07 -07:00
myk002 b1632c0413 alphabetize professions list; add Migrant 2021-08-30 23:52:52 -07:00
myk002 3a8f815f98 fix doc link typo 2021-08-30 23:10:28 -07:00
myk002 62bbfb1296 update examples documentation 2021-08-30 23:10:28 -07:00
myk002 65e5b89d4c add goblet-related aliases 2021-08-30 23:10:28 -07:00
myk002 c25d50217c fix doc typo 2021-08-30 23:10:28 -07:00
myk002 4b9df5c2db minor adjustments to professions; more to come 2021-08-30 23:10:28 -07:00
myk002 c8d329e334
add documentation for examples files 2021-08-19 21:58:26 -07:00
myk002 a5c329cfb2 add plumbing example and center images 2021-07-30 07:16:03 -07:00
myk002 b8ccd6e40b add dreamfort screenshots to library guide 2021-07-30 07:16:03 -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
myk002 5a6263f72c
fix indentation 2021-02-24 21:56:40 -08:00
myk002 23461e17c2
separate sand bags into their own stockpile
since quantum stockpiling them dumps out their contents
2021-02-24 19:50:29 -08: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 b3666da0a6
fix wheelbarrow UI change attribution 2021-02-18 23:11:09 -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 330bde7660
add heavy feeder piles
and other minor fixes found during playtesting
refine the embark profile suggestions
2021-02-04 23:01:12 -08:00
myk002 6c6a9968ff
hauling aliases can take from multile stockpiles 2021-02-03 13:51:02 -08:00
myk002 824beb0253
documentation for bin/barrel/wb feature 2021-02-01 02:22:04 -08:00
myk002 4c7e25739f
more dreamfort refinements (details on forum) 2021-01-31 19:36:05 -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
myk002 8e53fb450c
use normal title replacement for search-plugin 2021-01-30 00:56:36 -08:00
myk002 4bad609e33
use the search plugin for tallow aliases
and document the dependency
2021-01-29 12:20:25 -08:00
myk002 aeb911878b
document new aliases 2021-01-27 14:57:03 -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
lethosor 0089edde1e
Merge remote-tracking branch 'myk002/myk_docs_ignore' into develop 2021-01-21 00:14:15 -05:00
myk002 b5b7319a23
add documentation for #ignore blueprints 2021-01-11 15:58:16 -08:00
myk002 b49768a7cf
use and document new {Empty} quickfort keycode 2021-01-11 15:04:41 -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 4ac6716abc
add default values for optional sub-aliases 2020-12-06 10:37:09 -08:00
myk002 96126418ab
remove a tab that snuck in at the end of a line 2020-12-05 18:58:15 -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
Myk Taylor a0c86b8a9b rewrite quickfort user guide into
spend more space highlighting how users can use the blueprint plugin to
avoid learning how to write blueprints themselves
2020-10-24 21:14:09 -07:00