50f0d11372
include tool desc in the index for all formats
2022-09-23 13:19:13 -07:00
4ae1b7fb74
fix anchor text transformation
2022-09-23 12:51:50 -07:00
98b6ad4954
fix index titles on pdf
2022-09-23 12:34:50 -07:00
1cd5e8657a
link directly to the tool page title
...
instead of the top of the page
this is especially important on mobile where the top of the page is
taken up with the sidebar boilerplate
2022-09-23 11:33:14 -07:00
52011bde7b
share tag list between tool and commands
...
so all relevant tag index entries get generated
2022-09-23 11:13:49 -07:00
5869ba64c8
add tag description to the tag index page
...
this is a terrible hack that only works because sphinx doesn't sanitize
its input for the html builder. we set the title to
'%s<h4>%s</h4>' % (tag, desc)
so the final html looks like <h1>adventure<h4>...</h4></h1>
this may not play nice with the pdf builder..
2022-09-23 10:21:53 -07:00
1b9cd83009
use a domain index instead of the genindex
2022-09-23 10:10:28 -07:00
a92e5d1f74
populate, merge, and generate real tag indices
2022-09-23 09:32:08 -07:00
a1d3fe77b5
add a bit more index infrastructure
2022-09-23 08:46:50 -07:00
278b7528ac
implement basic domain index structure
2022-09-23 08:46:50 -07:00
4913637b62
genindex label "alphabetical" -> "annotated"
2022-09-23 08:46:50 -07:00
618a191c87
fix directive use for reveal.rst
2022-09-23 08:46:50 -07:00
7c498e6611
add note about regenerating dwarfmonitor.json
2022-09-23 08:39:40 -07:00
6810f9bb90
Remove empty indented line
2022-09-22 20:31:43 +01:00
30100bec8f
Add link to Tachy Guns and show more code configurations in guide
2022-09-22 20:23:56 +01:00
2e64464bb8
reword sentence after title expansion
2022-09-21 10:44:01 -07:00
ee51e830ad
update wording in Tools docs
2022-09-21 10:40:17 -07:00
682ed29c0c
replace deprecated support page with a redirect
...
configured on the readthedocs web admin page
2022-09-21 10:36:46 -07:00
35152bf022
create genindex entries for all tools and commands
2022-09-21 10:12:30 -07:00
a3a06fb363
Update docs/plugins/spectate.rst
...
removes extra blank line
2022-09-19 10:23:18 -07:00
8e718d9851
add docs for dfhack.gui.getMousePos()
2022-09-18 13:31:20 -07:00
b084171048
add overlay docs
2022-09-16 21:56:04 -07:00
301563d1e6
update changelog
2022-09-16 21:56:04 -07:00
b7357204e6
ensure artifacts dir exists for docs build
2022-09-16 21:55:49 -07:00
170d7b9b51
typo fix in infiniteSky docs
2022-09-16 15:24:18 -07:00
c1154085cf
Fix tool name auto-detection for scripts in subfolders
2022-09-15 23:03:34 -04:00
20919a8bb1
missed two upcased headers
2022-09-14 13:33:24 -07:00
9117d1bef6
fix casing and spacing in dev guide header
2022-09-14 13:21:16 -07:00
8a36d5607b
lcase section headers
2022-09-14 13:19:26 -07:00
d1acd45372
add syntax highlighting to code blocks
2022-09-14 13:19:10 -07:00
20a55299dd
Update modding-guide.rst
...
Add some potentially helpful comments to explain an inconsistenecy
2022-09-14 20:04:50 +01:00
ee123a2461
Update modding-guide.rst
...
Add missing slashes and change the wording to be more consistent in one part
2022-09-14 19:41:45 +01:00
d714274921
fix reqscript link name
2022-09-14 11:24:27 -07:00
b90126600f
whiiittespaaaace!!!
2022-09-14 11:00:26 -07:00
d5cfbf5e77
Merge branch 'develop' into modding-guide
2022-09-14 10:57:58 -07:00
7079fe7ea0
rewrap, fix a code syntax error
2022-09-14 10:56:58 -07:00
51f5349baf
labels must go above a section header
2022-09-14 10:43:51 -07:00
d68c17d070
fix paths/clean up code/use best practices
2022-09-14 10:33:27 -07:00
bb52e7bac8
list tools in categories with tags builtin
2022-09-13 23:17:19 -07:00
7ccacd7875
editing pass for the structure of a full mod
...
the sample code itself needs some adjustment to exemplify best pratices.
2022-09-13 23:16:54 -07:00
92b047fda1
Update modding-guide.rst
...
Obects to objects typo fix
2022-09-13 10:52:56 +01:00
b89a30a309
Update modding-guide.rst
...
Change use of word entities to objects because entitiy is a taken word in DF, and remove incorrect slash from a command.
2022-09-13 10:51:38 +01:00
cd83f3fcf1
Remove bad link
2022-09-12 15:04:16 -07:00
4a7faeef55
editing pass up through Custom raw tokens
2022-09-12 14:51:26 -07:00
0e30160c3c
update documentation documentation
2022-09-12 14:50:48 -07:00
540a2a9fa7
editing pass up through The structure of the game
2022-09-12 00:14:03 -07:00
253a1a80ad
add modding guide to guides index
2022-09-11 23:02:04 -07:00
04754b0a81
Merge branch 'develop' into modding-guide
2022-09-11 23:00:33 -07:00
d4914e7511
implement mouse click reactions for scrollbar
2022-09-11 19:33:01 -07:00
f71f034d1d
show full scrollbars instead of just scroll icons
2022-09-11 17:58:10 -07:00
09372680a2
Merge pull request #2281 from myk002/myk_helpdb_wrap
...
[helpdb] dynamically wrap long help text, preserving block indents
2022-09-11 14:40:43 -07:00
2311158792
fix reference to old ls param in Lua API docs
...
also add another example to the ls example commands
2022-09-11 14:06:21 -07:00
23994d4f4c
dynamically wrap helpdb long help text (default 80)
2022-09-11 13:41:20 -07:00
bd51d9c455
Changelog entry for hideGuard
2022-09-10 15:34:17 -04:00
82e954692e
update changelog
2022-09-10 10:15:08 -07:00
cae2bca0a7
add dfhack.screen.hideGuard
2022-09-10 09:49:43 -07:00
2733ce7684
update workflow summary to match the gui version
2022-09-10 09:49:42 -07:00
a392a5371d
add keybinding for gui/workorder-details
2022-09-07 22:02:33 -07:00
040d018b8e
fix order of tree designation in autochop
2022-09-07 10:34:56 -07:00
86e1a8d59c
When smoothing walls, connect to doors and fgates
2022-09-07 10:11:51 -07:00
483652e193
Rewrite utils.df_expr_to_ref() for consistency, add tests
2022-09-07 09:14:09 -07:00
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
73b7f13ad6
tombstone gui/assign-rack
2022-09-05 14:28:35 -07:00
c0682625f9
tombstone fix/merchants
2022-09-04 23:27:57 -07:00
df244cd519
tombstone fix/feeding-timers
2022-09-04 23:26:18 -07:00
d07bc349f8
tombstone fix/diplomats
2022-09-04 23:05:16 -07:00
e399e2205b
tombstone fix/fat-dwarves
2022-09-04 22:28:03 -07:00
446c321c62
fix spacing error
...
and floorplan error
2022-09-04 12:27:50 -07:00
ef1e85e6ff
Make doc docs match the docs
2022-09-03 20:00:38 -07:00
e24963a441
Updates changelog.txt with new Pause API under World module
2022-09-03 18:28:30 -07:00
a260e6992e
Reorders spectate code blocks, and adds persisting configuration
2022-09-03 17:02:57 -07:00
a06c1b1d07
Adds minor improvement to spectate documentation
2022-09-03 11:34:21 -07:00
b6c97214ca
Adds more features to spectate
2022-09-03 11:18:46 -07:00
bd4d17d205
update changelog
2022-09-01 22:48:18 -07:00
b3284c9d82
Updates spectate.rst
2022-09-01 17:14:10 -07:00
cd34749fec
Re-deletes Plugins.rst
2022-09-01 16:58:12 -07:00
33b92e6f69
Implements auto-unpause feature for spectate plugin
2022-09-01 16:53:26 -07:00
d258035b88
update changelog
2022-08-31 23:39:24 -07:00
b1a8662c4a
Merge branch 'develop' into docs
2022-08-31 23:00:39 -07:00
3d162a52ce
Add removed scripts to the graveyard
2022-08-31 22:47:43 -07:00
074a6ec5cd
allow EditFields to ignore specified keys
...
like "+" and "-", so you can use them as hotkeys in the parent view
2022-08-31 10:22:41 -07:00
8804dab182
update dreamfort traffic designations
2022-08-29 22:04:22 -07:00
29d4d530b5
Merge branch 'develop' into modding-guide
2022-08-27 09:00:53 -07:00
0b6178f5d2
Apply suggestions from code review
...
Co-authored-by: Myk <myk.taylor@gmail.com>
2022-08-27 15:24:22 +01:00
155525b853
Update Lua API.rst
2022-08-26 20:33:23 -07:00
306822b175
Update changelog.txt
2022-08-26 20:33:23 -07:00
65dd62a96e
remove unnecessary label for probe
2022-08-26 16:51:29 -07:00
b0ae9ed9c0
align quickfort guides with new defaults
2022-08-26 13:38:19 -07:00
0d3f5c2904
get new script docs to compile
2022-08-25 21:53:35 -07:00
25c99b5d1f
make summary text easier to read in text mode
2022-08-25 21:46:23 -07:00
95cd8f9d54
Merge branch 'develop' into docs
2022-08-19 15:36:07 -07:00
d0967b7e59
add alt-N keybinding for do-job-now
2022-08-19 09:34:38 -07:00
eb73de4670
make Usage a proper header
2022-08-17 22:42:02 -07:00
72de1873e0
Improve keybinding rendering under the text builder
...
Previously rendered as e.g. "CtrlShiftK"
2022-08-17 23:18:58 -04:00
fa8bceba93
Make paragraph labels render as plain text (not bold) under the text builder
2022-08-17 23:17:08 -04:00
06c8269002
Update Documentation.rst with examples of dfhack-tool and dfhack-command
2022-08-17 23:04:17 -04:00
a4e70cf3e1
Remove now-unused dfhack-keybind role
2022-08-17 22:56:06 -04:00
7e0581204d
Refactor everything to use make_labeled_paragraph()
2022-08-17 22:37:03 -04:00
fe7414baae
Make .dfhack-tool-summary styles consistent with Sphinx 5+
...
Under Sphinx 5, `topic` nodes now render as `<aside>` elements, and without an
explicit background color
2022-08-17 22:22:06 -04:00
22356e2fd6
resort tags according to new spreadsheet order
...
also fix tag syncing command so short descriptions with internal periods
are parsed correctly
2022-08-16 09:36:17 -07:00
4373f865a3
make `dfhack` a "when" tag
2022-08-16 08:23:48 -07:00
83e1fa7de0
add summary text in its own paragraph element
2022-08-16 00:12:25 -07:00
60458ad885
reorganize and alphabetize tags
2022-08-15 23:43:02 -07:00
7acec133ba
organize tags by group, add more info about tools
2022-08-15 23:14:50 -07:00
b01ef4a962
add todos about not using strong for text output
2022-08-15 23:14:16 -07:00
df9c37a8b7
Merge branch 'develop' into docs
2022-08-15 17:09:36 -07:00
8672282fd8
add helpdb, unit test, and document API
...
note that we have to dynamically sort some of the expected lists for
locale agnosticism
2022-08-15 16:31:52 -07:00
f7a0423566
update changelog
2022-08-15 16:27:43 -07:00
6fd0f4505f
add dfhack history repository and expose to lua
2022-08-15 16:27:43 -07:00
7dddb5e2ed
document widget mouse integration
2022-08-15 16:24:34 -07:00
7c3b06d71e
update changelog
2022-08-15 16:24:34 -07:00
79b6cd13e9
support scrolling by half pages in Label
2022-08-15 16:24:34 -07:00
0aa9a187cf
support cursor movement in EditFields
2022-08-15 16:24:34 -07:00
43b1abcdcf
support submit2 for EditFields
2022-08-15 16:24:34 -07:00
f400ee50f8
refine docs, logging, help text
2022-08-15 16:15:41 -07:00
a4c8535977
add argparse int checking methods, more docs
2022-08-15 16:15:41 -07:00
2f9021a3a0
move examples to the examples folder
2022-08-15 16:15:41 -07:00
9f648d532e
modify seedwatch all to actually watch all seeds
2022-08-15 16:11:13 -07:00
2a3a812b3c
update tag reference in Core.rst
2022-08-13 21:21:48 -07:00
eb91feff7c
revise tag list and assignments
2022-08-13 21:17:24 -07:00
f6699c0014
Sync tags descriptions from spreadsheet
2022-08-13 13:40:14 -07:00
b21fc8aa75
remove extra space at bottom of tool summary
2022-08-13 13:32:45 -07:00
f9930b313a
migrate all docs to the new directives
...
add a summary option for tools and commands so we can output them with
their tags and keybindings at the top of the file.
2022-08-09 22:37:24 -07:00
2d60c543fd
Remove "Tool:" line
2022-08-08 21:22:55 -04:00
e6b5d5b0c1
Remove commas from tag lists
2022-08-08 17:35:58 -04:00
daf3bc516b
Switch to <topic> to fix line breaks in text output
...
No visible change in HTML output; PDF looks different but still acceptable
2022-08-08 17:32:42 -04:00
6e29ddf2d3
Move space out of <strong> node for better text rendering
2022-08-08 17:32:42 -04:00
1e7ce2602e
Shrink tool/command boxes somewhat
2022-08-08 17:32:42 -04:00
6b32e008b3
Attempt to port keybinding documentation verification to new extension
...
Likely requires a sphinx Domain to work with parallel builds properly
2022-08-08 17:32:42 -04:00
7651d301d2
Remove extra paragraph around keybindings
2022-08-08 17:32:41 -04:00
5a14992aca
Use new directives for a few plugins
2022-08-08 17:32:40 -04:00
ed95db27f5
Move dfhack-keybind role to tool_docs.py and call from dfhack-command
2022-08-08 17:30:19 -04:00
5ef36d210f
Render implicit dfhack-command alongside dfhack-tool unless :no-command: is passed
2022-08-08 17:30:19 -04:00
39e9288458
Render commands as literals
2022-08-08 17:30:18 -04:00
b3d79f87cb
Fix optional name override
2022-08-08 17:30:18 -04:00
d19ffa1806
Add stub dfhack-command directive, refactor to support
2022-08-08 17:30:18 -04:00
12b3363b2c
Make dfhack-tool tags link to tag descriptions
2022-08-08 17:30:18 -04:00
bb2ca0cc16
Render dfhack-tool as admonition
...
Getting a section header integrated is complicated, so might as well emulate
Mediawiki with a box-like element instead
2022-08-08 17:30:17 -04:00
de5f4d3566
Default to document basename in dfhack-tool directive
2022-08-08 17:30:17 -04:00
e47c681e9c
Use write_file_if_changed() in changelog.py
...
Speeds up incremental builds significantly
2022-08-08 17:30:17 -04:00
89a88e94a9
Allow empty :tags:, give section a name to prevent errors
2022-08-08 17:30:17 -04:00
d96260556e
Make title visible by putting it in its own section
2022-08-08 17:30:16 -04:00
c44c8721c9
Initial attempt at dfhack-tool directive
...
Doesn't appear to produce headings that can be used as link targets...
2022-08-08 17:30:16 -04:00
a8d0cc7980
support scrolling by half pages in Label
2022-08-06 23:48:25 -07:00
9098914ce4
Add --offline option to docs/build.py to disable image downloads
2022-08-06 22:47:38 -04:00
6700a8d922
add missing keybinds for filltraffic plugin
2022-08-05 22:31:51 -07:00
b3a2a10caa
clean up generate doc dirs with ninja clean
2022-08-05 22:05:52 -07:00
f7acc5cfc6
sync tags spreadsheet to git
...
spreadsheet - https://docs.google.com/spreadsheets/d/1hiDlo8M_bB_1jE-5HRs2RrrA_VZ4cRu9VXaTctX_nwk/edit#gid=170388995
sync command - for fname in *rst; do name=$(echo $fname | sed 's/[.]rst//'); tagline=$(egrep ",$name," ~/Downloads/DFHack\ taxonomy\ -\ Tool\ tags.csv | ~/Downloads/csvtotags.sh); sed -ri "s;[*]*Tags:.*;$tagline;" $fname; done
contents of csvtotags.sh -
fgrep . | sed -r 's/^[^,]+,([^,]+),[^.]+[.]"?,/\1,/' | awk -F, '
function tag(idx, tagname) {
if ($idx == "TRUE") {
if (hastag == 1) {printf(", ")}
printf("`tag/%s`", tagname)
hastag = 1
}
}
{
printf("%s", "**Tags:** ")
hastag = 0
tag(2, "adventure")
tag(3, "fort")
tag(4, "legends")
tag(5, "embark")
tag(6, "system")
tag(7, "dev")
tag(8, "auto")
tag(9, "productivity")
tag(10, "inspection")
tag(11, "design")
tag(12, "quickfort")
tag(13, "interface")
tag(14, "fps")
tag(15, "fix")
tag(16, "mod")
tag(17, "armok")
tag(18, "animals")
tag(19, "buildings")
tag(20, "items")
tag(21, "jobs")
tag(22, "map")
tag(23, "labors")
tag(24, "units")
tag(25, "stockpiles")
tag(26, "trees")
printf("\n")
}
'
2022-08-05 17:55:33 -07:00
ebfe00b112
editing pass of short descriptions
...
and fix some short description parsing
2022-08-05 10:08:23 -07:00
6f48c1f4d0
remove some cruft from autobutcher docs
2022-08-05 08:08:47 -07:00
46c3862a08
update docs for zone
2022-08-05 08:08:34 -07:00
feed91d098
[pre-commit.ci] auto fixes from pre-commit.com hooks
...
for more information, see https://pre-commit.ci
2022-08-04 07:34:33 +00:00
8f242ac5cc
Update tweak.rst
2022-08-04 00:24:36 -07:00
5e9dde8a61
Update autobutcher.rst
2022-08-04 00:22:07 -07:00
26863fe468
Update zone.rst
2022-08-04 00:18:06 -07:00
5c9be942a5
update docs for workflow
2022-08-03 23:40:35 -07:00
b2ab93b3cd
update docs for autonestbox
2022-08-03 23:35:13 -07:00
3b17448597
update docs for autobutcher
2022-08-03 23:34:56 -07:00
03027b513a
Merge branch 'develop' into docs
2022-08-03 22:55:38 -07:00
9595e2152d
update changelog (fix typo)
2022-08-03 21:44:25 -07:00
db81538f63
update changelog
2022-08-03 21:44:25 -07:00
7e3acc410e
update changelog
2022-08-02 22:46:04 -07:00
d8f3e203e0
add image for stonesense
2022-07-31 13:41:30 -07:00
6686f703ae
update docs for workNow
2022-07-31 13:41:30 -07:00
e4c5b14670
update docs for tweak
2022-07-31 13:41:30 -07:00
a5a57a8631
update docs for tubefill
2022-07-31 13:41:30 -07:00
a6bdd9e3dc
update docs for trackstop
2022-07-31 13:41:30 -07:00
2362d60a3a
update docs for title-folder and title-version
2022-07-31 13:41:30 -07:00
51f79f9464
update docs for tiletypes
2022-07-31 13:41:30 -07:00
b240748684
update docs for tailor
2022-07-31 13:41:29 -07:00
3d0eab1a9b
update docs for strangemood
2022-07-31 13:41:29 -07:00
464f566928
update docs for stonesense
2022-07-31 13:41:29 -07:00
e1e245b4b4
update docs for stocks
2022-07-31 13:41:29 -07:00
5621a19278
update docs for stockpiles
2022-07-31 13:41:29 -07:00
08d434d16e
update docs for stockflow
2022-07-31 13:41:29 -07:00
479494e5a6
update docs for steam-engine
2022-07-31 13:41:29 -07:00
af0631cbd9
update docs for spectate
2022-07-31 13:41:29 -07:00
7261914826
update docs for sort
2022-07-31 13:41:29 -07:00
a1f937e354
update docs for siege-engine
2022-07-31 13:41:28 -07:00
8f7a23ee4d
update docs for showmood
2022-07-31 13:41:28 -07:00
edb7bd3168
update docs for seedwatch
2022-07-31 13:41:28 -07:00
feda5851e9
add example for ruby plugin
2022-07-31 13:41:28 -07:00
8cc0cee9a8
Fix grammar in power meter docs
2022-07-30 07:37:46 -07:00
f785a910ff
update docs for search
2022-07-29 17:38:23 -07:00
438293c0a0
update docs for reveal
2022-07-29 17:12:15 -07:00
c6d5fcb378
update docs for resume
2022-07-29 17:12:01 -07:00
a7011421b4
update docs for rendermax
2022-07-29 16:31:37 -07:00
eef7812bf6
update docs for rename
2022-07-29 16:08:00 -07:00
7a4e8ea18e
some plugins can't be directly enabled by the user
2022-07-29 16:05:49 -07:00
e513253d8d
update docs for regrass
2022-07-28 23:20:24 -07:00
1270cf3f0a
update docs for prospector
2022-07-28 23:12:11 -07:00
cf69a1a2cf
update docs for probe
2022-07-28 23:04:07 -07:00
1bbe996d58
update docs for power-meter
2022-07-28 22:55:20 -07:00
2d400fb571
update docs for plants
...
n.b. original docs were a lie.
2022-07-28 22:51:17 -07:00
2e2abbe87a
update docs for petcapRemover
...
and make it actually start running when it is enabled
2022-07-28 16:46:10 -07:00
380b003b56
fix list formatting for manipulator
2022-07-28 06:05:35 -07:00
4dea700ac9
Merge branch 'develop' into docs
2022-07-28 05:52:50 -07:00
b6e27b1875
fix rendering of quoted backtick
2022-07-28 05:46:25 -07:00
507b1632a2
support backtick as a keybinding
2022-07-28 05:45:50 -07:00
ac2d943fb1
remove commas from cleaners index entry
2022-07-28 05:41:29 -07:00
5954d7a19a
make docs for plug match the implementation
2022-07-28 05:32:30 -07:00
a6fb509cc7
convert table to list so it's readable in text rendering
2022-07-28 04:05:41 -07:00
e8bc9d9c0e
fix formatting in mousequery docs
2022-07-28 03:49:52 -07:00
5b8d8d7fe8
update docs for orders
2022-07-28 03:48:27 -07:00
88648284b0
update docs for nestboxes
2022-07-28 03:25:00 -07:00
f68b58c460
update docs for mousequery
2022-07-28 03:22:32 -07:00
bcab483b57
update docs for mode
2022-07-28 02:50:37 -07:00
b6f20ee61a
update docs for manipulator
2022-07-28 02:49:46 -07:00
756900393f
update docs for misery
2022-07-28 02:47:32 -07:00
6aabf5f3c3
no commas in index params
2022-07-28 02:47:32 -07:00
a2bca50587
docs/build.py: Add support for xml and pseudoxml output formats
...
Useful for debugging layout of generated docutils nodes
2022-07-27 22:03:03 -04:00
ddae1aa900
update docs for liquids
2022-07-27 17:14:40 -07:00
52a0b0f2ca
update docs for lair
2022-07-27 17:14:30 -07:00
e94f1891c2
update docs for labormanager
2022-07-27 17:14:18 -07:00
58c0f94a2d
order autolabor docs similarly to labormanager
2022-07-27 17:14:00 -07:00
ed113466d9
update docs for isoworldremote
2022-07-27 16:29:54 -07:00
382ad84125
add example for job item-type
2022-07-27 16:14:24 -07:00
2008fd3955
update docs for jobutils.
...
I was unable to find an example usage for `job item-type`. I couldn't
find any combination of jobs or parameters that worked.
2022-07-27 16:03:49 -07:00
e677e8098d
add docs for plugins that only provide Lua apis
2022-07-27 15:48:11 -07:00
6293b71e9e
Revert "remove docs for non-enableable, command-less plugin"
...
This reverts commit c88423e655
2022-07-26 22:01:39 -07:00
c88423e655
remove docs for non-enableable, command-less plugin
2022-07-25 22:05:32 -07:00
4438134711
add missing keybinding for infiniteSky
2022-07-25 22:01:28 -07:00
06fc84fb39
update docs for infiniteSky
2022-07-25 22:00:56 -07:00
69d88a62dd
update docs for hotkeys
2022-07-25 21:54:34 -07:00
b93e3365f6
update docs for get plants
2022-07-25 21:50:52 -07:00
094f8d7257
fix typos in forceequip cpp/docs
2022-07-25 16:57:08 -07:00
367ac0064e
update docs for generated-creature-renamer
2022-07-25 16:54:28 -07:00
eb0f016804
update docs for forceequip
2022-07-25 16:40:19 -07:00
82953d8b2f
fix doc build errors
2022-07-25 13:37:52 -07:00
20ccd3a99c
update docs for follow
2022-07-25 10:55:31 -07:00
e13aae2ce1
update docs for flows
2022-07-25 10:55:04 -07:00
ea3dfe399e
update docs for fixveins
2022-07-25 10:54:11 -07:00
9c0bd6bd70
update docs for fix-unit-occupancy
2022-07-25 10:23:26 -07:00
2654de583f
update docs for filltraffic
2022-07-25 10:23:05 -07:00
ab9c3a07c4
add missing 'enable' usage for dwarfmonitor
2022-07-25 10:22:42 -07:00
989befa582
update docs for fastdwarf
2022-07-25 10:22:23 -07:00
a6cb79c237
remove defunct tool fix-armory
2022-07-25 10:21:59 -07:00
886289d805
update docs for fix-armory
2022-07-25 10:21:33 -07:00
38c17b5215
update docs for RemoteFortressReader
2022-07-25 06:56:21 -07:00
6b1c0b5308
rename building-hacks section
2022-07-25 06:53:08 -07:00
4132dbdbbb
remove docs for no-command, un-enableable plugin
...
it's already documented in lua-api
2022-07-25 06:51:40 -07:00
98ad22dddd
align remaining plugin docs to plugin names
2022-07-25 06:08:59 -07:00
02cc085a43
update docs for embark-tools
2022-07-24 23:59:04 -07:00
d94fef36ff
update docs for embark-assistant
2022-07-24 23:39:13 -07:00
32e2ac2103
update docs for dwarfvet
2022-07-24 23:24:52 -07:00
595fb221b8
code block is not valid json
2022-07-24 23:24:35 -07:00
ac11cde213
update docs for dwarfmonitor
2022-07-24 23:22:51 -07:00
d624e91673
Fix missing newline
2022-07-24 20:59:24 -07:00
b2ca3cb194
update docs for diggingInvaders
2022-07-24 20:12:04 -07:00
60b599865c
update docs for digFlood
2022-07-24 17:01:50 -07:00
ca06d1d9c5
update docs for dig (again)
2022-07-24 16:08:35 -07:00
9dd62f2291
update docs for dig
2022-07-23 22:40:33 -07:00
5f56d79235
move dfhack.history to dfhack-config/dfhack.history
2022-07-23 21:55:49 -07:00
947889873d
update all docs I've done so far to new standards
2022-07-23 16:03:40 -07:00
e4273589e1
one fewer char per line so no horiz scrolling
2022-07-23 15:38:35 -07:00
a94f3c3cca
fix some formatting
2022-07-23 15:32:08 -07:00
c1a694cb18
Improve syntax highlighting in Documentation.rst
2022-07-23 18:26:40 -04:00
62523bdcb1
update documentation for the documentation
2022-07-23 15:13:11 -07:00
3141ecbec2
remove cromulate. it has outlived its purpose
2022-07-22 21:04:22 -07:00
5dde613a12
fix formatting errors
2022-07-22 19:06:50 -07:00
a7346dd05b
add missing labels
2022-07-22 17:51:48 -07:00
4cb57d25f1
update dig-now docs
2022-07-22 17:46:33 -07:00
675f2edee2
update deramp docs
2022-07-22 17:46:22 -07:00
0f3811b933
update debugfilter docs
2022-07-22 17:46:11 -07:00
65b3ce6e96
remove unattached docs and plugins
2022-07-22 17:45:23 -07:00
19a4905933
update docs for "c" plugins
2022-07-22 16:42:36 -07:00
e8ffa55dfe
use a label instead of a custom role
...
since I can't seem to figure out how to inject a link to a label via the
role processing code
2022-07-22 15:16:57 -07:00
6752025848
fix up some index links
2022-07-22 14:38:16 -07:00
2fd6d528ce
move support docs to the intro page
...
but leave an orphan link to the new section in case external links still
point to the old page
2022-07-22 14:37:47 -07:00
6a31b316dc
add structure for category indices
2022-07-22 14:37:24 -07:00
b38ccfe03d
fix typo in automaterial docs
2022-07-22 10:18:32 -07:00
d637c87496
ensure all plugins are indexed
2022-07-22 10:15:03 -07:00
3175e8b33d
update tags and text for builtins
2022-07-22 10:15:03 -07:00
bd58158126
get rid of tool TOC, use genindex
...
also add a stub role for dfhack-tag
2022-07-22 10:15:03 -07:00
9c7731f072
remove reference to dfhack.init-example
2022-07-22 10:15:03 -07:00
3522b89f5c
[pre-commit.ci] auto fixes from pre-commit.com hooks
...
for more information, see https://pre-commit.ci
2022-07-22 14:20:02 +00:00
53cdf57043
add missing digv label
2022-07-22 00:08:03 -07:00
6b9803daaf
update docs up to the end of the b's
2022-07-22 00:05:53 -07:00
b3679bef25
enable index building and update builtin docs
2022-07-21 23:21:56 -07:00
5521a5a45d
Remove old build*.sh scripts
2022-07-22 00:47:33 -04:00
4b0b0e02f8
Update Documentation.rst for new workflow and output formats
2022-07-22 00:46:44 -04:00
68b8837a8d
Replace docs/build*.sh with more flexible build.py
...
Notable changes:
- can build any combination of output formats in series
- `-E` is no longer passed by default to aid in development, but can be passed
manually
2022-07-22 00:30:36 -04:00
d9a1104473
update docs for cleanowned
2022-07-20 14:51:06 -07:00
e9e477c680
update docs for clean and spotclean
2022-07-20 13:51:03 -07:00
1f3c4cdd18
update docs for cleanconst
2022-07-20 13:26:30 -07:00
d3dd12c38f
update docs for changevein
2022-07-20 13:24:27 -07:00
fae5f0635a
update docs for changelayer
2022-07-20 13:21:05 -07:00
ddd2e5003a
update docs for changeitem
2022-07-20 13:00:27 -07:00
0fe4bed121
document both burrow command and burrows plugin
2022-07-20 12:42:27 -07:00
1cad77601e
update formatting for plugin docs
2022-07-19 23:11:02 -07:00
954e246140
reformat builtins and properly read tags
2022-07-19 23:01:25 -07:00
66b7bcaf1a
update docs for burrows
2022-07-18 17:09:48 -07:00
19a4accca4
update docs for bulidingplan
2022-07-18 16:58:01 -07:00
629c22b148
update docs for building-hacks
2022-07-18 16:38:28 -07:00
154dc7c96c
update docs for blueprint
2022-07-18 16:32:43 -07:00
2bc6e09ba0
fix formatting typos
2022-07-18 16:20:43 -07:00
08154ca1b5
update docs for autotrade
2022-07-18 16:13:27 -07:00
fd84fdce73
update docs for automelt
2022-07-18 16:13:20 -07:00
0ba3a4684b
update docs for automaterial
2022-07-18 16:13:04 -07:00
87e67ea8b3
update docs for autolabor
2022-07-18 14:53:06 -07:00
6c760d1a3d
update docs for autohauler
2022-07-18 14:33:24 -07:00
b1916f16b1
update docs for autogems
2022-07-18 13:59:11 -07:00
3ca7997d3e
update docs for autofarm
2022-07-18 13:49:51 -07:00
25bc59297b
update docs for autodump (and related hotkeys)
2022-07-18 13:28:16 -07:00
3969a366ec
update docs for autoclothing
2022-07-18 13:02:03 -07:00
51c817191c
update docs for autochop
2022-07-18 12:52:38 -07:00
5ff31e0cc1
remove defunct advtools plugin
2022-07-18 12:36:11 -07:00
02ba204f5b
update docs for add-spatter
2022-07-18 11:39:52 -07:00
2207f26992
update docs for 3dveins
2022-07-18 11:34:58 -07:00
d27def7128
spacing is important
...
otherwise the usage and examples lists don't put the explanations on the
next line
2022-07-18 11:16:05 -07:00
019856883b
update sc-script docs based on code spelunking
2022-07-18 11:10:56 -07:00
8173f6dd02
Merge remote-tracking branch 'upstream/develop' into docs
2022-07-18 10:59:00 -07:00
301c8e93a1
move builtin docs to individual files
2022-07-18 10:58:35 -07:00
f354200728
update widget docs
2022-07-16 22:23:22 -07:00
27425e47f6
support cursor movement in EditFields
2022-07-15 22:22:51 -07:00
9b340a7630
support submit2 for EditFields
2022-07-15 13:46:01 -07:00
7cf5a7dac9
main.lua --> raw/scripts/main.lua
2022-07-15 19:44:21 +01:00
fcd8839c0d
Wrap lines to 80 characters
2022-07-15 19:43:48 +01:00
0e704f39f7
Got the really big part of the guide done
2022-07-15 19:28:59 +01:00
c9a87511bd
add dfhack history repository and expose to lua
2022-07-15 09:18:27 -07:00
e926e1116e
replace more Core cpp code with calls to helpdb
...
also document devel/dump-rpc builtin
2022-07-14 13:19:30 -07:00
3f848b8836
Misc minor changes to modding guide
2022-07-14 17:46:12 +01:00
d06a63e4dc
DFStructs (a nickname?) --> df-structures
2022-07-14 11:11:50 +01:00
a996b29cf5
Some editing of mod guide
2022-07-14 11:10:23 +01:00
d7976e63b6
const example. also, (preemptively acquiescing) readme.mkd --> readme.md
2022-07-13 22:44:38 +01:00
9c04a28bd9
Shouldn't've replaced the TODO
2022-07-13 22:43:01 +01:00
c39e2fe2cb
Mod structure
2022-07-13 22:42:35 +01:00
f021dd0e0a
Gui::getAnyItem(): add support for viewscreen_treasurelistst
2022-07-12 11:25:16 -04:00
4cdb0ff138
Merge branch 'rm-old-modules' into develop
2022-07-12 11:23:10 -04:00
c9cffc7da9
Fix docs bugs
2022-07-12 11:26:49 +01:00
328d839f19
support backtick as a keybinding
...
and bind it to gui/launcher
2022-07-11 17:23:56 -07:00
aa8809833b
Do the "running shoes" TODO
2022-07-11 18:56:28 +01:00
f670ef4b60
Add custom raw tokens link and add prefix to custom raw tokens in raws
2022-07-11 18:24:07 +01:00
fdd406b722
ensure all files are reread on every docs build
...
this fixes the issue where the Stonesense docs were getting ignored
2022-07-10 20:19:12 -07:00
12557f8dc1
[pre-commit.ci] auto fixes from pre-commit.com hooks
...
for more information, see https://pre-commit.ci
2022-07-10 20:19:12 -07:00
3e2320aa60
split the plugin docs into individual files
2022-07-10 20:19:11 -07:00
8d99b7e6e1
prepare for plugin doc split
2022-07-10 20:19:09 -07:00
4ad8e7199a
Support builtin commands in helpdb ( #2241 )
...
* support builtin commands in helpdb, implement list API, document api
2022-07-10 20:17:52 -07:00
64aba7a8a3
Myk rendered help ( #2240 )
...
* implement help db
* add initial list of tags
* read tags fr help, read script short desc, filter
2022-07-10 20:14:21 -07:00
27d7c3acc6
Myk sample command help ( #2238 )
...
* add example tool documentation in proposed format
* refine Tools.rst
2022-07-10 20:14:20 -07:00
28e15162a5
reorganize init scripts into dfhack-config ( #2232 )
...
* reorganize init scripts into dfhack-config
allows player init scripts to build on defaults instead of replace them
this also moves the init scripts out of the main df directory
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* escape asterisks in docs
* remove unneeded dfhack.init file creation for test
* write the test init script to the new init dir
* create the init dir before trying to write a file
* rename default init files for clarity
* Update changelog
* Update docs/changelog.txt
Co-authored-by: Alan <lethosor@users.noreply.github.com>
* Try to get buildmaster to work with old branches
* Update changelog
* get keybindings from all init scripts
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Fix spacing in changelog
* split default loading into its own file
* update docs with new changes
* update help text wording in default init files
* Apply suggestions from code review
Co-authored-by: Alan <lethosor@users.noreply.github.com>
* Alphabetize changelog
* Update onMapLoad.default.init
* Update onMapLoad.init
* Update Core.rst
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Alan <lethosor@users.noreply.github.com>
2022-07-10 08:54:55 -07:00
25175b5c28
Fire rate code
2022-07-09 17:04:20 +01:00
15aae9cf1e
More guide
2022-07-07 19:23:10 +01:00
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
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
091068c710
[prospect] give player control over which information is output ( #2231 )
...
* give player control over prospect output
* suspend the core *before* we call to Lua
2022-07-06 06:57:13 -07:00
0237567c18
More modding guide
2022-07-04 17:11:21 +01:00
f8a8bf6e29
Some more
2022-07-03 17:33:36 +01:00
b86d16d64c
Some of Detecting Triggers
2022-07-03 15:59:01 +01:00
46d0f36d41
Pad out Getting used to gm-editor and DFStructs exploration a bit
2022-07-01 19:10:26 +01:00
c026bd6dcb
Split sections a bit
2022-07-01 12:04:18 +01:00
739871bc0f
Remove Hooks-egg.cpp and related code and configuration options
2022-06-29 23:35:14 -04:00
1147add520
Constructions module: remove some old/unused functions/types
2022-06-29 23:35:14 -04:00
4c7caa2658
Remove unneeded dependencies on modules/Graphic.h
2022-06-29 23:35:13 -04:00
8bb047fcc6
Remove Notes module
...
Only used in a devel plugin that prints notes, and can be easily replaced
with `ui.waypoints.points`
2022-06-29 23:35:13 -04:00
9788a8a22a
Add default selection handler to `materials.ItemTraitsDialog` ( #2211 )
...
* add forward compatibility for future `job_item_flags`
* add default selection handler to `materials.ItemTraitsDialog`
* add a call to `error()` in 'unknown'-branch inside `setTrait`
* add `ItemTraitsDialog` improvement description to changelog.txt
2022-06-28 16:27:18 -07:00
ba629b8e0a
manually handle DestroyBuilding jobs ( #2209 )
...
* don't delete general refs from jobs that we cancel
though we still disconnect the refs if we can
* get job remove working in all cases
we apparently need to manually handle DestroyBuilding jobs
everything else we should let cancel_job handle
* update changelog
2022-06-21 16:38:04 -07:00
f812e09ae1
Update modding guide with an extra paragraph and syntax fixes
2022-06-21 21:35:07 +01:00
ac864204c2
More work on guide, added to existing sections and revised sections list
2022-06-21 21:07:35 +01:00
a9ab415ac7
Clean merge heckery and clean up label reference
2022-06-21 15:20:49 +01:00
41526f376d
Fix wrong - length
2022-06-21 13:02:10 +01:00
6f2998d7e5
Update docs/guides/modding-guide.rst
...
Co-authored-by: Myk <myk002@yahoo.com>
2022-06-21 12:58:40 +01:00
52161df428
Update docs/guides/modding-guide.rst
...
Co-authored-by: Myk <myk002@yahoo.com>
2022-06-21 12:58:36 +01:00
92ab6b1052
Update docs/guides/modding-guide.rst
...
Co-authored-by: Myk <myk002@yahoo.com>
2022-06-21 12:58:29 +01:00
88a9755d78
Update docs/guides/modding-guide.rst
...
Co-authored-by: Myk <myk002@yahoo.com>
2022-06-21 12:54:45 +01:00
4c2a533de0
Remove "added anchor" from changelog
2022-06-21 12:54:28 +01:00
ccee6ba487
Added link to modding guide from changelog
2022-06-21 12:53:59 +01:00
a880a2b92d
Move changelog entries to proper place
2022-06-21 12:48:28 +01:00
f33c9bc881
Update tile-material.lua ( #2218 )
...
* Update tile-material.lua
* Update changelog.txt
* Update changelog.txt
* Update changelog.txt
* Update tile-material.lua
2022-06-20 12:38:37 -07:00
063e4897a8
Forgot to stage a change
2022-06-20 20:31:19 +01:00
0ae8a42080
Unfinished modding guide
2022-06-20 20:07:07 +01:00
88ae50b9ae
update version and changelog to 0.47.05-r6
2022-06-17 15:42:23 -07:00
b361a66a52
ensure our docs build cleanly with sphinx-5 ( #2193 )
...
* ensure our docs build cleanly with sphinx-5
* adapt to the API change in sphinx 5
while keeping compatibility with <5
* get rid of the extra colons in field lists
2022-06-17 09:35:31 -07:00
d38ab1d152
Fix UNIT_NEW_ACTIVE events ( #2197 )
...
* Updates eventful.lua to use UNIT_NEW_ACTIVE
* Fixes bug #2189
* Revises activeUnits declaration/initialization
* Fixes build error
* Update changelog.txt
* reword changelog entry
* add changelog entry for event name change
Co-authored-by: Myk <myk002@yahoo.com>
2022-06-17 09:34:41 -07:00
ae5b00523e
Add myself to Authors.rst ( #2208 )
...
As suggested in: https://github.com/DFHack/scripts/pull/404#issuecomment-1152780958
2022-06-14 00:35:59 -04:00
fc384fd1a2
Update eventful.lua ( #2203 )
...
* Update eventful.lua
Had wrong function. Fixes https://github.com/DFHack/dfhack/issues/2202
* Update Lua API.rst
Update docs to add onReactionCompleting and remove outdated info
* Update Lua API.rst
Some more minor doc fixes
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* add changelog entry
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2022-06-12 07:12:49 -07:00
1a629a26bf
add `ItemTraitsDialog` to materials.lua ( #2199 )
...
* add `ItemTraitDialog` to materials.lua
* rename `ItemTraitDialog` to `ItemTraitsDialog` (plural)
* Update changelog.txt
2022-06-12 07:03:04 -07:00
85d7489b3c
ensure refs are cleaned up when we remove a job ( #2184 )
...
* ensure job items are disassociated from the job
when the job is removed. the new df-provided ``cancel_job()`` doesn't do
this for us whereas the old custom implementation did.
ref: #2028
* remove trailing whitespace
* Clean up general refs before removing job
Because the game method doesn't do it itself
* Fix typo in var name
* clean up code
* update changelog
2022-06-11 07:38:22 -07:00
4152be13c7
Simplify bug extlink
2022-06-08 19:02:58 -07:00
ff373bb9e2
use extlinks where appropriate in docs
2022-06-08 16:53:46 -07:00
9b21c0d64a
Merge branch 'DFHack:develop' into Bumber64-patch-2
2022-06-06 01:53:05 -07:00
5e0a947d51
Fix changelog entry and release for #2028
2022-06-06 01:49:23 -04:00
30ed483e1d
Fetch and merge
2022-06-05 16:55:54 -07:00
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
f993c23d75
fix whitespace
2022-06-04 12:22:19 -07:00
23e85a0d24
Fetch and merge
2022-06-04 12:17:28 -07:00
b0b601cf0f
Remove recenterViewscreen, update revealInDwarfmodeMap
2022-06-04 11:59:04 -07:00
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
27bf4c758b
Allow player to pause the confirmation dialog without disabling ( #2164 )
...
* basic pause functionality for confirm
* update changelog
* wrap the pause message and output in white
* unpause on viewscreen transition when we can
but still use esc detection when we won't get a viewscreen transition
(like when we're intercepting input on viewscreen_dwarfmodest
* add more code docs about unpause detection
2022-06-02 06:24:13 -07:00
89d3d45e87
Allow EditField widgets to manage their own activation and keyboard focus ( #2147 )
...
* use new focus subsystem in widgets.EditField
* always eat the enter key if we have an on_submit
* add modal attribute
* give EditFields a default height of 1
so they can be autoarranged
2022-06-01 21:48:21 -07:00
ad2d9cad03
[lua] implement keyboard focus subsystem ( #2160 )
...
* implement keyboard focus subsystem
* Fix error in focus group combining
* documentation for the inputToSubviews decision
* modify unit tests to catch that last bug
2022-06-01 17:42:13 -07:00
bc0def4342
MiscUtils word_wrap: Add option to trim only leading whitespace after wrapping ( #2169 )
...
* Update changelog.txt
2022-05-30 22:58:46 -04:00
1c3ea000e1
Trim trailing whitespace
2022-05-28 15:56:49 -07:00
2b29431806
More fixes
...
* Use word_wrap()
* add_proper_report utility fn; have addCombatReportAuto use this
* Update Lua API.rst
* Update Gui.cpp
2022-05-28 12:35:49 -07:00
4b21e7afb4
Remove parseReportString from API (now utility fn)
...
Implementations using `word_wrap()` are commented out pending changes to that function.
2022-05-24 03:52:33 -07:00
77d045488b
Confirmation dialog for removing manager orders ( #2163 )
2022-05-23 21:17:52 -07:00
8b1070b553
tombstone deteriorate*rb scripts ( #2157 )
...
* tombstone deteriorate*rb scripts
* update to scripts head so we can build docs
* fix anchors
2022-05-19 15:27:08 -07:00
18628ff5b8
make key_sep more configurable
...
and add more configuration to HotkeyLabel and EditField to take
advantage of it
2022-05-18 16:46:33 -07:00
53609db1f9
let CycleHotkeyLabels take numeric initial_options
...
even if all of the option values are non-numeric
2022-05-18 15:39:52 -07:00
ce34ac8f33
Use debugfilter; remove redundant changelog entries
2022-05-16 18:41:47 -07:00
d6df928d69
update changelog
2022-05-13 14:36:49 -07:00
7439678214
tombstone devel/unforbidall script
2022-05-10 15:37:37 -07:00
1203274e9f
Update Authors.rst
...
This time with missing scripts and df-structures authors since 0.47.04-r1
Just one: DFHack/scripts#339
2022-05-10 00:51:16 -04:00
018452af82
Update changelog.txt
2022-05-05 22:57:04 -07:00
585888c2d3
update version, changelog, modules for 0.47.05-r5
2022-05-04 17:21:31 -07:00
5be0fe2a44
Fix issues, update changelog and docs
...
Initialize variables in LuaApi.cpp, solve changelog conflicts, hyperlink and escape char info in docs
2022-05-02 23:52:47 -07:00
0389637ac8
clean up changelog.txt
2022-05-02 21:54:41 -07:00
621ccef996
Merge branch 'develop' into Bumber64-patch-2
2022-05-01 23:42:21 -07:00
038b6f0d86
Fix changelog conflicts
2022-05-01 23:07:52 -07:00
f565de88e8
Fix stuff ( #4 )
...
* Update Lua API.rst
* Update Gui.h
* Update Gui.cpp
* Update LuaApi.cpp
2022-05-01 22:53:53 -07:00
cc20d9fbb7
Update Authors.rst
...
Checked as far back as 0.47.04-r1.
Oldest missing was chrismdp from before 0.47.05-r3.
2022-05-01 13:35:30 -04:00
876d9132b1
Add a link to the rust library for interacting with the remote API ( #2121 )
...
* Add link to the rust api client library
Add a link to https://docs.rs/dfhack-remote/latest/dfhack_remote/index.html a library interacting with DFHack remote API for the Rust programming language
* Use the docs.rs link
* Fix duplicate link label, included the change in the changelog
Co-authored-by: pierre <pierre>
2022-05-01 06:31:59 -07:00
fe29bff845
Adds cxxrandom unit test and fixes interface problems ( #2099 )
...
* Adds cxxrandom unit test and fixes interface problems
* Tightens braces
* Adds detection code for Shuffle's seqID/engID
* Adds usage examples for cxxrandom
* Gives cxxrandom objects id ranges, sort of
* Updates changelog
* Updates changelog.txt
* Increases id space for cxxrandom
* Fixes bool distribution error message and improves check
* Adds comment explaining the seeded RNG tests for cxxrandom
* Fixes type problem for 32bit builds
* Reduces loop count a few magnitudes
* Fixes a mistake in test.cxxrandom_seed
2022-04-30 21:46:47 -07:00
e2fb15a3a5
add dwarfmode.MenuOverlay:renderMapOverlay() ( #2119 )
...
* add dwarfmode.MenuOverlay:renderMapOverlay()
* ensure we move with the viewport when bounds_rect is nil
2022-04-29 20:32:22 -07:00
24dd4d8ac0
Update init files ( #2117 )
...
* update example init files
replace onLoad.init-example with documentation on how to create scripts that run on world/map load
it was confusing to show it being loaded with sc-script since it gets autorun anyway if it is just named properly
* update changelog
* add quickfort keybinding
* move standard tweaks from dreamfort init to main
2022-04-29 20:24:09 -07:00
b9c36c1e63
Added custom-raw-tokens utility ( #2038 )
...
* Added (chain) for [CHAIN_METAL_TEXT] armours in gui/materials.lua used by gui/create-item-- again (oops)
* Added customRawData utility
* Oops, whitespace
* Revised rawStringsFieldNames
* Dialed down on lua trickery and fixed wrongly formatted changelog entry
* Fixed changelog in wrong place and made customRawData a proper module
* Fixed not caching not-present tags, revised examples and fixed error
* Fixed whitespace. Changing settings in editor!
* customRawData docs
* Added getCreatureTag for respecting caste tags, "fixed" bizarre caching error (quotes because I don't even know what was causing it) and updated docs
* Added line limiting for docs, I guess
* Added missing string convert argument
* docs indent fix, code block fix, and revision
* Major revision
* gdi, docs error
* Another? But... huh.
* ...
* Made requested changes
* Whoops
* Rearrange docs lines
* Followed example, should fix linter issues
* fix typo. linted offline this time......
* Make it so that last instance of tag is what is read from
* Added requested change
* eventful key change
* i to lenArgs
* change eventful key
* add test for broken caste selection
* Major redesign
* tags --> tokens
* Added plant growth behaviour and did some requested changes
* More error handling
* fix docs
* Added basic error suppression
* Docs clarification.
* Docs registering example and fix error
* Strip errors on frame after onWorldLoad, not on map load
* Revert "Strip errors on frame after onWorldLoad, not on map load"
This reverts commit e20a0ef8d3743f79d961077f46910b77b16f36b9.
* Revert "Docs registering example and fix error"
This reverts commit 9c848c54c3f84e0ecc1dc421137c8a8b4a52280d.
* Revert "Docs clarification."
This reverts commit 6b4b6a1aa40c50398504f37ecf1ff0f93d6459b1.
* Revert "Added basic error suppression"
This reverts commit d11cb1438cf1e56ff700469e944f0b9af64651d7.
* Use more eventful key more consistent with other files
* use onStateChange instead of eventful and remove redundant utils require
* Code review stuff
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Update docs/Lua API.rst
committing a suggestion
Co-authored-by: Alan <lethosor@users.noreply.github.com>
* Prepend examples with DFHACK_
* Remove unused parameters
* Use new ensure_key global
* Named a couple of unnamed arguments (untested)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Alan <lethosor@users.noreply.github.com>
2022-04-29 08:39:59 -07:00
f08a268e8a
add scroll icons to Label widget ( #2101 )
...
* WIP: add scroll icons to Label widget
It's an opt-out. The icons are rendered in the right-most column of the 1st and last row. They are only rendered when text can actually be scrolled in the corresponding direction.
WIP: Currently, the icons might overlay text characters, there is no mechanism preventing it
* gui.lua: expose the `parse_inset()` function
* refactor Label's scroll icon code
* since `render_scroll_icons` only works with a label, it's now a class function
* `update_scroll_inset` ensures `frame_inset.r` or `.l` is at least 1, according to `show_scroll_icons`
* `show_scroll_icons` has 4 possible values: `false` for no icons, `left` for icons on the first column on the left (also ensuring `frame_inset.l >= 1`), `right` - last column on the right, `DEFAULT_NIL` - same as `right` if text height greater than `frame_body.height`, else same as `false`.
* make `render_scroll_icons` always draw icons
The check now happens in `onRenderFrame`
* draw frame's background
calling `Label.super.onRenderFrame(self, dc, rect)` makes frame's background invisible for some reason
* remove trailing spaces
* fix scroll icons placed far above/below text
With `Label.frame_inset = 1` the text could be vertically centered with plenty of space below and above,
but not all rendered. Before this change, the scroll icons would be at the very top and bottom of the frame
instead of near the first and last rendered text line.
* always `update_scroll_inset` to react to resized window
* draw scroll icons next to text
* update `Lua API.rst` with new `Label` parameters
* move comment separator up
This way every scroll related parameter is in one group
* list default values for new parameters in docs
* add missing description of `Label.scroll_keys`
2022-04-29 06:55:08 -07:00
c89baa5e33
Update Lua API.rst
2022-04-28 22:40:36 -07:00
dcadde38d7
add new global function: ensure_key
2022-04-27 17:35:49 -07:00
6ad362d698
return a reference to the created dialogs
2022-04-27 11:51:46 -07:00
dc2a14c0c2
Add "partial-items" tweak.
...
When active, the displayed names of partially-consumed items (e.g.
hospital cloth) will display a percentage indicator at the end.
Also re-sort a few Tweaks so they're in alphabetical order again.
2022-04-27 11:27:11 -07:00
fe0b33d9c4
fix typo: equiptment
2022-04-26 17:11:21 -07:00
a47bf1533e
Update changelog.txt
2022-04-25 00:17:31 -07:00
ad9a08f1e7
Update Lua API.rst
...
Fix formatting (again)
2022-04-25 00:10:26 -07:00
709adda968
Update Lua API.rst
...
Fix formatting
2022-04-25 00:06:53 -07:00
c66448015e
Update Lua API.rst
...
Document autoDFAnnouncement, pauseRecenter, and recenterViewscreen.
2022-04-25 00:02:37 -07:00
ed5523152c
factor text wrapping out of TooltipLabel into WrappedLabel
2022-04-22 09:53:10 -07:00
2aa28d34b6
Adding ids output to cursecheck ( #2093 )
...
Co-authored-by: Guilherme Abraham <guilherme.abraham@zpesystems.com>
Co-authored-by: Myk <myk002@yahoo.com>
2022-04-21 20:22:05 -07:00
2bbe1aa6f5
Alphabetizes job-(material/duplicate) correctly
2022-04-18 17:40:12 -07:00
f570b5441a
Alphabetizes confirm/command-prompt correctly
2022-04-18 17:40:12 -07:00
634751a12c
Alphabetizes the sections of Plugins.rst
2022-04-18 17:40:12 -07:00
e7062e2e45
Alphabetizes the "Mods and Cheating" section
2022-04-18 17:40:12 -07:00
b13b927a70
Alphabetizes the "Map modification" section
2022-04-18 17:40:12 -07:00
1c825baac1
Alphabetizes the "Job and Fortress management" section
2022-04-18 17:40:12 -07:00
e9c0c01364
Alphabetizes the "UI Upgrades" section
2022-04-18 17:40:12 -07:00
d5c4ad4ccc
Alphabetizes the "Bugfixes" section
2022-04-18 17:40:12 -07:00
96fa0b4241
Alphabetizes the "Data inspection and visualizers" section
2022-04-18 17:40:12 -07:00
07761e1d5d
add some more handy widgets to the library
...
TooltipLabel
HotkeyLabel
CycleHotkeyLabel
ToggleHotkeyLabel
2022-04-18 17:37:11 -07:00
cb123e5076
default unset `frame_inset` values to 0 ( #2100 )
...
* default unset `frame_inset` values to 0
This change allows writing `frame_inset = {r=1}` instead of `frame_inset = {l=0, r=1, t=0, b=0}`
2022-04-16 08:17:35 -07:00
bf60879c81
[tweak/stable-cursor] Keep stable cursor when viewport is near enough
...
Allow the viewport to move a bit and still keep the cursor location.
2022-04-12 19:53:16 -07:00
0f464b13b3
Merge remote-tracking branch 'lethosor/pre-commit' into develop
2022-04-12 21:17:15 -04:00
d1f0edd33b
Apply initial pre-commit config
2022-04-12 14:48:19 -04:00
fd1ee233a2
automatically manage sidebar modes in MenuOverlay ( #2083 )
2022-04-11 20:58:54 -07:00
10f22ecc27
add ResizingPanel class and autolayout for Panels ( #2086 )
...
* add autolayout for Panels and new ResizingPanel
2022-04-11 18:25:00 -07:00
e6299700bf
Handle punctuation in FilteredList filter matching ( #2085 )
...
* allow punctuation to be typed into a filter
and allow the filter to match keys with punctuation
2022-04-11 18:22:31 -07:00
4a383b1c84
handle number-indexed lua maps in safe_index
2022-04-11 18:02:57 -07:00
4f9608da13
Document and update argparse module ( #2089 )
...
also add unit tests and use new string fns in processArgs and allow it to recognize parameters with two dashes instead of just one
2022-04-11 16:16:55 -07:00
9a8fd12785
ensure ListBoxes always have enough height ( #2084 )
...
so they can always display an error message if the filter doesn't match anything
2022-04-11 16:15:50 -07:00
96b5b4420b
Add string:escape_pattern() utility function ( #2082 )
...
* add string:escape_pattern() to dfhack.lua
stolen from devel/query.lua. will migrate scripts to use the common implementation later
2022-04-10 21:18:01 -07:00
c603d6a9f3
Move docs for include_prefix param to correct function
...
It was listed under listdir, but it only appears in listdir_recursive
2022-04-08 23:13:10 -07:00
3aebc6776a
Disambiguate Lua API header in plugins
2022-04-06 05:54:20 -07:00
189da79d10
Document new blueprint phases and options
2022-04-01 20:45:51 -07:00
54e8761aa0
capture fortifications and engravings in blueprint
2022-04-01 12:20:37 -07:00
fbd1fac210
document transform behavior for buildings and keys
2022-04-01 11:00:41 -07:00
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
8a120837c6
only designate enough trees to reach max_logs ( #2064 )
...
* only designate enough trees to reach max_logs
* Chop largest trees first
2022-03-31 20:41:44 -07:00
7653c2a932
document that script-paths.txt is only read at startup
2022-03-31 21:20:54 +01:00
b5af004194
[manipulator] Tweak colors to make cursor easier to locate ( #2051 )
2022-03-30 23:39:20 -07:00
e286b2a54d
update changelog
2022-03-30 14:42:37 -07:00
db5e7d55c1
fix guidm.enterSidebarMode(DesignateMine)
...
it would end up in DesignateChopTrees if you happened to be looking at
the surface z-level.
2022-03-28 16:57:24 -07:00
078e732a42
update changelog
2022-03-28 16:00:29 -07:00
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
f37de835da
center uncentered image in blueprint library guide
2022-03-28 16:00:29 -07:00
ab54cbff7a
[confirm] Fix typo in help message ( #2046 )
2022-03-23 19:45:13 -07:00
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
19c0a4fe06
Added (chain) for [CHAIN_METAL_TEXT] armours in library/gui/materials.lua used by the gui/create-item script ( #2037 )
2022-03-19 15:32:16 -07:00
e1961f5fcd
visual studio 2022/2019 build instructions ( #2034 )
...
* visual studio 2022/2019
update instructions to recommend using VS 2022 or VS 2019 with downlevel tool support
* reinsert accidentally deleted line
* fix markup
* notes on abi compatibility, changelog
2022-03-17 13:19:12 -07:00
ce30843b92
update Windows build docs for Visual C++ 2015 ( #2032 )
...
* update Windows build docs for Visual C++ 2015
* fixed doc errors / moved changelog entry to future section
2022-03-16 13:10:00 -07:00
07e96a6a1c
Update changelog.txt
2022-03-15 08:23:18 -07:00
dda487a535
Adds new plugin: Spectate ( #1918 )
...
* Adds spectate plugin
* Updates spectate.cpp
* Changes spectate toggle message
* Updates changelog.txt
* Adds spectate to Plugins.rst
* Adds requested changes
- foreach syntax replaces active units loops
- removes CR_FAILURE return on double enable/disable usage
- removes disabled code
- implements a few clion clang tidy suggestions (auto declare when casting)
- Updates zcount to have accurate count for performing RNG
- adds eof newline
- adds todo comment about a redundant if condition
* Declares spectate section in Plugins.rst
2022-03-14 19:33:41 -07:00
88b403ec7a
Add functions reverse-engineered from ambushing unit code ( #1992 )
...
* Add functions reverse-engineered from ambushing unit code
* Fix whitespace
* Fix debug_showambush check
* Remove getOuterContainerRef from Lua API
Don't think this works properly without allocating a new specific_ref. More trouble that it's worth.
* Fixed tile visibility check
* I don't think gamemode or gametype are ever NULL
* Minor tweaks to documentation
* Reimplement getOuterContainerRef for Lua; fix some comments
* Update Units.cpp and changelog
* Update Units.cpp
* Update changelog.txt
2022-03-13 17:19:35 -07:00
d2d01843a2
Update changelog.txt
...
update changelog for changes to Job::remove_postings
2022-03-12 15:37:33 -08:00
89a3ca8ee9
update docs and changelog
2022-03-12 13:45:32 -08:00
25d37143e4
update changelog
2022-03-12 13:33:36 -08:00
82910015c1
update changelog
2022-03-12 12:41:19 -08:00
9f8a477f09
move EventManager changelog entries to 'Future'
...
ref: #1876
2022-03-12 11:38:43 -08:00
28ebc3921d
Revises changelog
2022-03-12 11:33:27 -08:00
0cb6e18e16
Adds changelog entries for PR #1876
2022-03-12 11:33:27 -08:00
2c3f573610
really fix the docs typo
2022-03-10 20:03:37 -08:00
a1e3f2dbe1
fix typo in docs
2022-03-10 18:31:16 -08:00
858d459232
update changelog for clsocket PR#20
2022-03-10 14:07:48 -08:00
cf54b84fd6
Bump to 0.47.05-r4
2022-03-09 14:27:20 -08:00
7aaccb781e
update changelog
2022-03-03 21:37:38 -08:00
c752fa07a8
update changelog
2022-03-01 05:44:36 -08:00
4d47bf54ce
update changelog
2022-02-26 15:32:25 -08:00
41ea2527eb
update changelog
2022-02-26 14:54:42 -08:00
17f400d091
add light aquifer tap library blueprint and docs
2022-02-26 14:54:42 -08:00
0362c09811
update changelog
2022-02-25 12:59:38 -08:00
5937e55cfd
update changelog
2022-02-25 12:58:56 -08:00
1d6b942293
update wording in changelog
2022-02-25 12:57:17 -08:00
2d561ad73d
move fortplan docs to Removed.rst
2022-02-25 12:57:17 -08:00
e458e74058
use correct header in changelog
2022-02-25 12:57:17 -08:00
6b0f2eace9
update changelog
2022-02-25 12:57:17 -08:00
eae90c9448
remove fortplan code; leave doc stub
2022-02-25 12:57:17 -08:00
91b55a648b
update changelog
2022-02-19 17:54:01 -08:00
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
3dcc6fd899
update changelog
2022-02-18 15:47:33 -08:00
89038ffafa
add pump stack blueprint to the libarary, add docs
2022-02-18 15:47:33 -08:00
0303e182a8
fix typo in shift syntax, explain why +y is down
2022-02-18 14:54:45 -08:00
f2865beb57
add docs for blueprint shifting and transformation
2022-02-18 14:54:45 -08:00
myk002
Tachytaenius
Josh Cooper
lethosor
Myk
Josh Cooper
pre-commit-ci[bot]
Timur Kelman
quarque2
Rafał
Warmist
Ryan Williams
Pierre Lulé
Quietust
Nik Nyby
Guilherme Abraham
Tim Siegel
Su
Kelly Kinkade
Zishi Wu