233ce26ab5
update changelog
2020-10-23 09:45:41 -07:00
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
26505acb70
Add some cross-references and clean up
2020-10-20 01:18:25 -04:00
2bd0e938ad
Move pathable to Lua API docs
2020-10-20 01:11:01 -04:00
84973d1fb8
Sort plugins in Lua API.rst
2020-10-20 01:06:47 -04:00
3a200fcd92
Expand `probe` documentation
2020-10-20 01:01:02 -04:00
05d2e5b65c
update case study: order-dependent aliases
...
since the example I had used no longer exists now that we have
parameterized aliases. I had to find another example in the industry
blueprints. I made it a proper "tip" and added more explanation as well.
2020-10-18 13:49:11 -07:00
6c3bac2d6c
document extended zone configuration syntax
2020-10-17 22:20:39 -07:00
09fbaba726
buildingplan: support all building types
...
Allow buildingplan to handle all building types, update the docs, and add in little extra fixes to ensure all the new types work correctly.
2020-10-16 14:23:35 -07:00
82013c0c5e
prep buildingplan for core algorithm changes
...
Lots of refactoring and reorganizing, with only cosmetic player-visible changes.
- show quickfort mode hotlkey label regardless of whether the current building type has buildingplan enabled. before, it was only shown after the user enabled buildingplan for the current building. this eliminates the extra step when enabling quickfort mode, which force-enables all building types.
- changed signature of lua-exported isPlannableBuilding to take subtype
and custom type in addition to building type. this is only used by
quickfort, and it already sends all three params in preparation for
this change
- added lua-exported scheduleCycle(), which is like doCycle(), but only
takes effect on the next non-paused frame. this lets quickfort
run only one buildingplan cycle regardless of how many #build
blueprints were run
- declared a few dfhack library methods and params const so buildingplan
could call them from const methods
- converted buildingplan internal debug logging fn to have a printf api
- reshaped buildingplan-planner API and refactored implementation in
preparation for upcoming core algorithm changes for supporing all
building types (no externally-visible functionality changes)
- changed df::building_type params to type, subtype, custom tuple keys
- introduced capability to return multiple filters per building type
(though the current buildings all only have one filter per)
- split monolith hook functions in buildingplan.cpp into one per scope.
this significantly cleans up the code and preps the hooks to handle
iterating through multiple item filters.
- got rid of send_key function and replaced with better reporting of
whether keys have been handled
2020-10-16 13:52:23 -07:00
ce7772a1c2
Add Filesystem::restorecwd()
...
This allows restoring the working directory to its original value, which may not actually be the DF root. See #1671 , dfhack/scripts#152
2020-10-14 21:22:53 -04:00
e4b6fb0ff4
Merge branch 'buildingplan_refactor' into buildingplan_refactor2_squashed
2020-10-12 22:39:55 -07:00
cc159909e2
Mention some third-party Linux packages
...
Closes #20
2020-10-13 00:24:29 -04:00
93520b4b00
dwarfmonitor prefs: fix segfault if item_subtype is null for some item types
2020-10-11 20:45:56 -04:00
9d2abafefc
Merge branch 'buildingplan_refactor' into buildingplan_refactor2_squashed
2020-10-11 12:11:51 -07:00
b343d00800
Update to 0.47.04-r3 (authors, changelog, and submodules)
2020-10-10 17:31:30 -04:00
9c8098b4f0
Expose to_search_normalized to Lua, add test, and use in ListColumn (most useful for the `stocks` plugin)
2020-10-10 01:40:00 -04:00
8d85261cdc
Update changelog ( #1658 and more of #1652 )
2020-10-09 22:20:07 -04:00
b972246d16
Update docs ( #1652 )
2020-10-09 21:43:58 -04:00
5e63e6e103
Convert some links to use :wiki:
2020-10-09 19:24:52 -04:00
2382247398
Update some docs links to use HTTPS
2020-10-09 19:17:59 -04:00
9eff62a05d
Update docs for #1659
2020-10-09 12:38:45 -04:00
28efe1d2a7
Add local TOCs to Lua API plugin sections
2020-10-09 12:20:13 -04:00
f10bc7678e
Allow breaking long inline code snippets if necessary
2020-10-09 12:16:25 -04:00
c2280356cb
Set language of some code blocks to enable syntax highlighting
2020-10-09 01:15:42 -04:00
a5f85e256d
Default to a basic DFHack-specific pygments lexer (supporting comments and prompts)
2020-10-09 00:27:22 -04:00
2fdd6f7aed
Convert to explicit ref targets (occasionally section links) and fix messages() -> message()
2020-10-08 23:19:16 -04:00
f54eb9627d
Merge remote-tracking branch 'myk002/quickfort_case_study' into develop
2020-10-08 01:01:37 -04:00
6d18ef865d
Merge remote-tracking branch 'myk002/quickfort_docs' into develop
2020-10-08 00:45:27 -04:00
600ea23f12
Update scripts and authors
2020-10-08 00:23:01 -04:00
3e2dd2a396
quickfort docs: dreamfort case study
2020-10-07 14:01:22 -07:00
293bc66f4a
update quickfort docs
...
default dig
notes blueprints
buildingplan
2020-10-06 22:41:54 -07:00
d254ff2401
Tweak links to quickfort command docs
2020-10-06 22:02:14 -04:00
a3699a54b8
Merge branch 'buildingplan_refactor' into buildingplan_refactor2_squashed
2020-10-05 22:26:19 -07:00
4d7f4d80ad
prep buildingplan for core algorithm changes
...
player-visible changes
- removed text that showed up if you used the wrong hotkeys. no other
dfhack screen does this, and it seems unneeded. can add back if others
think otherwise, though
internal changes
- changed signature of lua-exported isPlannableBuilding to take subtype
and custom type in addition to building type. this is only used by
quickfort, and it already sends all three params in preparation for
this change
- added lua-exported scheduleCycle(), which is like doCycle(), but only
takes effect on the next non-paused frame. this lets quickfort
run only one buildingplan cycle regardless of how many #build
blueprints were run
- declared a few dfhack library methods and params const so buildingplan
could call them from const methods
- converted buildingplan internal debug logging fn to have a printf api
- reshaped buildingplan-planner API and refactored implementation in
preparation for upcoming core algorithm changes for supporing all
building types (no externally-visible functionality changes)
- changed df::building_type params to type, subtype, custom tuple keys
- introduced capability to return multiple filters per building type
(though the current buildings all only have one filter per)
- split monolith hook functions in buildingplan.cpp into one per scope.
this significantly cleans up the code and preps the hooks to handle
iterating through multiple item filters.
- got rid of send_key function and replaced with better reporting of
whether keys have been handled
2020-10-04 20:05:08 -07:00
2ff4197afe
Add anchor
2020-10-03 23:56:57 -04:00
5f47491e78
Use custom link roles when possible
2020-10-02 00:22:35 -04:00
90994f2abd
Standardize title
2020-10-01 22:19:33 -04:00
00cd52dca7
Add user guides section to main toctree
2020-10-01 22:17:53 -04:00
4746e5c046
Change/remove headings to match original TOC nesting
2020-10-01 22:10:11 -04:00
77c37ebb73
Switch to native RST table of contents
2020-10-01 22:08:58 -04:00
53b78d5266
Convert external docs links to internal links
2020-10-01 21:59:48 -04:00
5d98193c54
Convert quickfort user guide to RST using pandoc
...
Unchanged. First pass of dfhack#1653
2020-10-01 21:50:28 -04:00
93d43ba9e3
Update changelog ( #1620 , #1660 )
2020-09-29 20:08:35 -04:00
3c037ef52a
Clean up plugin mkmodule/require explanation
2020-09-24 00:16:32 -04:00
72fb6d09d6
Merge remote-tracking branch 'upstream/develop' into buildingplan_isenabled
2020-09-23 19:21:16 -07:00
dfac5bc143
Update gui.Painter docs, add sections to dfhack.screen, add more links, etc
2020-09-23 22:00:39 -04:00
12769de232
revert dup isEnabled and document real isEnabled
2020-09-22 23:24:20 -07:00
b73750e706
Merge remote-tracking branch 'upstream/develop' into buildingplan_isenabled
2020-09-22 22:53:01 -07:00
c6111ba017
expose if buildingplan is enabled to lua
2020-09-20 16:38:26 -07:00
0e6e00af5e
getplants: fix crash when world_object_data is not present for certain blocks
2020-09-20 01:24:46 -04:00
9c37a3a068
Add "createitem inspect" subcommand
2020-09-19 20:33:47 -04:00
23dc7727b5
Merge remote-tracking branch 'kristjanmoore/develop' into develop
2020-08-29 17:43:46 -04:00
100ba998a1
Update changelog, authors ( #1633 )
2020-08-28 18:44:16 -04:00
0fa4987edb
Update authors
2020-08-23 18:01:16 +00:00
cb8a903240
Update changelog
2020-08-23 17:38:27 +00:00
8779ca0659
Merge remote-tracking branch 'myk002/quickfort_civzones' into develop
2020-08-21 00:34:26 -04:00
7bac4c89c4
Update API docs for setJobCooldown and removeWorker, use "cooldown" for consistency with C++
...
Ref http://www.bay12forums.com/smf/index.php?topic=164123.msg8180385#msg8180385
2020-08-19 17:12:40 -04:00
45a0b7b3a6
Fix stockpiles crash when building food map
...
Fixes #1628
Broke due to ecd6bcc9ed
2020-08-18 21:00:10 -04:00
19a4d1df5a
Merge remote-tracking branch 'myk002/quickfort_buildingplan' into develop
2020-08-17 23:43:05 -04:00
e4a35514ab
document buildingplan Lua API
2020-08-15 23:03:49 -07:00
e546d3eec3
rename is_civzone to the more general allow_wall
2020-08-15 20:13:48 -07:00
dd3ff7252d
document additional parameter to checkFreeTiles
2020-08-15 17:26:38 -07:00
1e9562bd76
add target label for xlsxreader
2020-08-10 23:35:38 -07:00
0d9614154f
don't turn a rst list into code
2020-08-10 23:04:05 -07:00
a2279cc9a7
update docs in Lua API.rst too
2020-08-10 14:37:59 -07:00
4a04273fae
document xlsxreader functions
2020-08-09 09:28:19 -07:00
f2b0f012c9
Bump to 0.47.04-r2
2020-08-08 14:53:24 -04:00
504b0c1ec7
Update changelog ( #1596 )
2020-08-08 14:47:59 -04:00
8f047530c4
Make Units::getRaceNameById and other ID-related functions available to Lua
2020-08-08 14:28:17 -04:00
13380008c4
Update scripts, authors, changelog
2020-08-08 13:28:31 -04:00
3b3b0be8c5
Update submodules, tweak changelog order
2020-08-08 02:00:12 -04:00
6a1f046995
Add --sizecheck option to Linux launcher script, update docs
2020-08-08 00:41:04 -04:00
f7fda8e7f5
Update changelog, authors, xml ( #1615 )
2020-08-08 00:06:59 -04:00
23c22b3b9d
Merge branch 'develop' of https://github.com/DFHack/dfhack into feature/manipulator_goal
2020-08-07 22:17:32 +01:00
a85b77e6f1
Retrieve goal string values from enum attributes and add new Units methods to Lua API and docs
2020-08-07 22:07:48 +01:00
c7e4c724e8
Sort tweaks alphabetically
2020-08-06 22:37:04 -04:00
0c53b2b6c5
Add do-job-now tweak
...
Forum thread: http://www.bay12forums.com/smf/index.php?topic=176700
Original source: https://github.com/dlmarquis/dfhack/blob/dojobnow-r1/plugins/dojobnow.cpp
Co-authored-by: dlmarquis <dlmarquis@users.noreply.github.com>
2020-08-06 22:36:57 -04:00
bdb9433822
Update/expand Contributing.rst regarding pull requests
2020-08-06 02:30:17 -04:00
7c2af344a1
Update changelog ( #1564 ) and xml ( dfhack/df-structures#400 )
2020-08-06 02:04:23 -04:00
dba7df7ab8
Add "delete word" support to Console-posix
2020-08-02 23:10:35 -04:00
411176c75e
Add rudimentary map docs with tile descriptions from @AtomicChicken
...
Based on http://www.bay12forums.com/smf/index.php?topic=164123.msg8158676#msg8158676
2020-07-28 00:38:22 -04:00
c1219642b5
Reorganize dev docs TOC, add label to remote TOC
2020-07-28 00:21:23 -04:00
0f0306fc84
Move to internal changelog section + shorten
2020-07-25 15:20:20 -04:00
48d4013bcb
don't list subdirectories named 'internal'
...
instead of just specifically for lua files with a '-internal.lua' suffix
2020-07-24 22:07:16 -07:00
da11932d6b
Merge remote-tracking branch 'upstream/develop' into internal_scripts
2020-07-24 20:47:24 -07:00
fcb14623a7
Update authors, submodules
...
Ref dfhack/scripts#162
2020-07-24 22:18:00 -04:00
fddda1818e
Merge remote-tracking branch 'myk002/quickfort_skeleton' into develop
2020-07-24 22:08:24 -04:00
86e9f69d42
Merge branch 'quickfort_skeleton' into internal_scripts
2020-07-24 08:24:45 -07:00
ca1742243b
Merge remote-tracking branch 'upstream/develop' into quickfort_skeleton
2020-07-23 22:45:01 -07:00
e61f2b7451
update Lua API.rst
2020-07-23 22:44:34 -07:00
e17d492203
address PR review comments on api docs
2020-07-23 21:55:05 -07:00
8541db17cd
Remove :width: table directive (requires docutils 0.15)
2020-07-22 02:30:41 -04:00
655b363238
Fix some spelling errors
2020-07-22 02:23:29 -04:00
eb074b8a49
Link to Wireshark script
2020-07-22 02:04:02 -04:00
4b6325eeab
Add RPC protocol description to docs and reformat
...
From https://gist.github.com/BenLubar/1f51cf570b4c8dca275db9687fa6b9e3
Ref dfhack/dfhack#1574
2020-07-22 01:35:32 -04:00
dfc9f78fa4
Refer to server config docs from dfhack-run
2020-07-21 23:14:59 -04:00
b34aa86d3c
Document remote server config
2020-07-21 21:41:41 -04:00
b200219967
support for splitting lua scripts into parts
...
without polluting the output of #DFHack ls
2020-07-20 23:04:23 -07:00
6a851537d5
update changelog
2020-07-19 17:29:56 -07:00
d88137b1d6
Split remote API info into separate doc, add example tools and clients
2020-07-19 01:13:43 -04:00
1e734938ae
Add isoworldremote to Plugins.rst
2020-07-19 01:00:00 -04:00
6921277e81
Add upgrading instructions
2020-07-18 12:35:04 -04:00
128050c684
Move installation docs to a separate document and expand
2020-07-18 03:16:52 -04:00
0cc6f40bd6
Update API docs ( #1607 )
2020-07-17 17:35:09 -04:00
35d659091d
Merge remote-tracking branch 'myk002/blueprint_in_blueprints' into develop
2020-07-17 17:32:59 -04:00
56e43a0dde
Linux: make Process::getPath (and dfhack.getDFPath()) not depend on cwd, for consistency with other platforms
2020-07-16 23:21:56 -04:00
6cafd230c5
Link to bug from docs ( #1585 )
2020-07-16 22:42:36 -04:00
89c24ac8be
Merge remote-tracking branch 'quietust/reaction-gloves' into develop
2020-07-16 22:40:49 -04:00
bb91fdcf8c
Merge remote-tracking branch 'upstream/develop' into blueprint_in_blueprints
2020-07-16 09:24:52 -07:00
a0d627ebc7
Merge remote-tracking branch 'PatrikLundell/embark-assistant' into develop
2020-07-16 01:48:07 -04:00
470456583c
Document PDF build process and add a script for it
2020-07-15 21:42:43 -04:00
bca76b8fc6
Remove excess/inconsistent padding from lists containing other lists
2020-07-15 21:15:07 -04:00
e2334387a9
blueprint: write blueprints to blueprints/ subdir
...
to enable writing to a subdir that may not exist, blueprint now automatically
creates folder trees. E.g. ``blueprint 30 30 1 rooms/dining dig`` will create
the file ``blueprints/rooms/dining-dig.csv``). Previously it would fail if the
``blueprints/rooms/`` directory didn't already exist.
2020-07-15 16:57:14 -07:00
9b922c1965
Update scripts, changelog ( #1543 )
2020-07-15 00:09:47 -04:00
1f1bb5a055
Update Lua API docs for ref_target field, add tests
2020-07-14 02:57:30 -04:00
89283026ae
Improve changelog error handling a bit when called from sphinx
2020-07-13 20:14:11 -04:00
ced8f4a551
Update changelog ( #1565 )
2020-07-13 20:05:08 -04:00
f33f9136c8
Update changelog + authors ( #1606 )
2020-07-13 19:57:14 -04:00
a8d34bb64e
Add explicit home link to sidebar
2020-07-12 00:30:28 -04:00
279d3e80f2
Add kazimuth to authors
2020-07-11 23:56:15 -04:00
801961bf78
Move changelog, license, authors into main TOC tree
2020-07-11 23:55:02 -04:00
1043a4e49b
Update intro, fix bay12 link, shorten index, add quick links section
2020-07-11 23:50:51 -04:00
9284daaf89
Unset content min-width to improve mobile layout
2020-07-10 19:59:34 -04:00
fdb4487a36
Update Linux sphinx installation instructions, define substitution for minumum sphinx version
2020-07-10 02:11:03 -04:00
ba0f8553ed
Misc updates, links
2020-07-08 23:46:38 -04:00
7e620b09a4
Update dev-intro
...
Doxygen was removed in 787c54d8a
2020-07-08 23:38:18 -04:00
108e100d22
Move structures overview to Structures-intro.rst and update/elaborate
2020-07-08 23:11:02 -04:00
87fd32d330
Move general dev info to a separate doc (Dev-intro)
2020-07-08 22:52:20 -04:00
858e90e6c2
Move Scripts-removed.rst to Removed.rst and update a bit
2020-07-08 21:04:23 -04:00
24d64175fb
Remove top-level links from TOCs
2020-07-08 02:13:37 -04:00
85003a40c2
Split memory research into separate doc and expand
2020-07-08 01:03:58 -04:00
aff2944f28
Add "scripts-" prefix to generated scripts subpage anchors
2020-07-08 01:01:34 -04:00
7f56faa64a
Tweak Documentation.rst TOC
2020-07-08 00:08:47 -04:00
512f425c65
Move Contributing.rst to docs/, add GitHub-specific version in .github/
2020-07-07 23:49:28 -04:00
b122870b6a
Move documentation standards to Documentation.rst
2020-07-07 01:54:59 -04:00
b0fe96f6c7
Add gen_changelog.py compatibility shim, fix paths when run under cmake
2020-07-04 02:35:55 -04:00
f81f77352c
Restructure changelog generation as a Sphinx extension
2020-07-04 02:16:11 -04:00
fa910cd74f
Include custom CSS separately instead of overriding theme CSS
...
May help with https://github.com/DFHack/dfhack/issues/1578#issuecomment-635512324
2020-07-03 22:45:04 -04:00
9a3747d307
Make sidebar fixed
2020-07-03 20:42:23 -04:00
30c8db811d
Add note referring to gui/liquids, update scripts (docs)
2020-07-03 16:51:28 -04:00
27ee6a30d4
Add additional path to strawberry perl docs
...
From http://www.bay12forums.com/smf/index.php?topic=164123.msg8141934#msg8141934
2020-07-01 23:56:41 -04:00
e39150ac36
Update authors ( dfhack/scripts#157 )
2020-06-29 23:05:03 -04:00
ce3cc24228
Split docs on documentation into a separate file and reorganize/expand a bit
2020-06-24 00:12:08 -04:00
c2776c20b9
Update changelog
2020-06-23 13:37:11 -06:00
aee4fcd1a6
Add confirmation for convicting dwarves of crimes
...
Closes #1593
2020-06-20 12:06:50 -04:00
861c8c8148
Remove -q from docs/build.sh to make -v work
2020-06-17 20:36:07 -04:00
dda31c06db
merged
2020-06-02 15:08:02 +02:00
5d05cfc7cc
Fix several functions in the Units module ignoring unit caste.
...
Fixes #1583 .
2020-06-02 01:18:57 -05:00
d189b91f49
Update macOS -> OS X, tweak a bit and add more anchors
2020-05-13 22:58:32 -04:00
Myk Taylor
lethosor
kristjanmoore
Ryan Bennitt
Quietust
PatrikLundell
Ben Lubar