5a2ee6ee23
update documentation for autolabor & autohauler
2022-11-30 21:54:58 -06:00
33d54493f2
fix typo in docs
2022-11-29 15:14:22 -08:00
4c72bdb5ed
add reference to gui/overlay to the overlay docs
2022-11-29 15:12:02 -08:00
344ed4312b
Merge pull request #2111 from cppcooper/channel-safely
...
Channel safely
2022-11-23 12:41:50 -08:00
92a53bbef6
Update docs/plugins/channel-safely.rst
2022-11-23 11:39:04 -08:00
e943b4ed31
Merge pull request #2413 from myk002/myk_resume
...
Turn down resume plugin
2022-11-23 11:29:56 -08:00
6cdb192181
Documents persistence of settings
2022-11-23 10:37:33 -08:00
86ec1c17ad
Fixes doc formatting
2022-11-22 13:28:27 -08:00
cb338e4257
remove resume plugin
...
all functionality has been migrated to unsuspend
2022-11-21 15:27:40 -08:00
8a0999ffdc
Implements plugin: channel-safely v1.1a
2022-11-21 12:39:26 -08:00
b99e948b8a
Implements plugin: spectate v1.0.1a
2022-11-21 12:26:40 -08:00
40cbe4fe88
Implements plugin: spectate v1.0a
2022-11-21 12:26:40 -08:00
ec6cd8d53a
Implements plugin: spectate v0.5
...
Fixes spectate not starting with the first job
Updates spectate.cpp
- refactors features/settings to under a `Configuration` struct with a global variable `config`
- refactors existing `config` => `pconfig`
- moves plugin logic, mostly, to namespace SP (spectate plugin)
- utilizes debugging log macros
- updates status format
- refactors status print code into a separate function
2022-11-21 12:26:27 -08:00
9959ef1b36
Implements plugin: channel-safely v1.0.1a
2022-11-21 09:26:55 -08:00
6c68e72295
Implements plugin: channel-safely v1.0a
2022-11-21 09:26:55 -08:00
92537bc459
Implements plugin: channel-safely v0.6
2022-11-21 09:26:55 -08:00
c2d346fc84
Implements plugin: channel-safely v0.4
2022-11-21 09:26:55 -08:00
22414f26fa
Implements plugin: channel-safely v0.1
2022-11-21 09:26:55 -08:00
1cc9a4d832
make leggings instead of crafts out of shells
...
they have a greater average trade price, and "shleggings" is hilarious.
2022-11-16 12:31:24 -08:00
35cea1b5e1
Merge pull request #2371 from myk002/myk_overlay_hotkeys
...
[hotkeys] implement hotspot menu widget
2022-11-14 16:50:30 -08:00
aecc190b74
update hotkeys docs
2022-11-14 16:46:02 -08:00
722f70437c
update dwarfmonitor docs
2022-11-14 16:45:07 -08:00
19289bf3c8
clean up docs and code
2022-11-14 16:40:36 -08:00
9bdc995f20
write docs and make implementation match the docs
...
added ability to enable/disable all
added showing current widget configuration
added moving widget back to default coordinates
2022-11-14 16:40:35 -08:00
754e1dd4ac
Update docs/plugins/spectate.rst
2022-10-24 17:50:21 -07:00
2ca2066081
Fixes underline in spectate.rst
2022-10-23 10:45:23 -07:00
c18beb30bb
Updates spectate.rst
2022-10-23 10:40:23 -07:00
f66dd6f404
Implements change requests
...
- removes redundant `if (df::global::ui)` checks; and tested to ensure no segfaults cropped up like in the past times I've removed these
- removes useless `if (pause_lock)` pause lock is set when plugin initializes, even if pause lock was left null (since we technically don't need it, and that was the point of the null check) it still would be a useless check (actually an impediment preventing functionality)
- removes disabled interpose code
- removes lua linkage
- updates doc
extra:
- surrounds user input for tick frequency with `std::abs()` not that we would have ended up with a negative value, but it was probably a typo and this is easier than printing an error or letting it underflow past max int (on most systems)
2022-10-20 23:52:30 -07:00
9b1541add5
Merge branch 'develop' into spectate
2022-10-14 17:41:34 -07:00
45ac340f37
Finalizes spectate update
...
- Fixes for state transitions that were found broken. eg. plugin disabled -> enable auto-unpause feature -> enable plugin (auto-unpause will not truly be enabled; similar transitions were broken)
- Adds a commented out lock for if the pause code is ever adopted into the core API, as to enable many mods to use the `World::SetPauseState()` without walking over each other, and in the case of `reveal hell` also be able to avoid needing to set the state every tick in onupdate
- Revises the usage docs with `enable|disable|set` syntax
2022-10-14 17:02:43 -07:00
b1bf80e585
support "group" file split strategy for blueprint
2022-10-14 12:27:24 -07:00
880e9b34ef
Removes disable usage
2022-10-13 11:52:56 -07:00
c52138b168
generate meta blueprints
2022-10-12 17:42:36 -07:00
80d993e734
split rooms phase from query and record names
2022-10-12 16:01:54 -07:00
8d8ef023fd
Merge branch 'develop' into spectate
2022-10-12 14:40:56 -07:00
23c2d14b4a
Updated documentation/changelog
2022-10-12 14:40:21 -07:00
b78af72403
record built constructions in blueprint
2022-10-12 13:31:46 -07:00
ddf7850d90
Merge branch 'develop' into spectate
2022-10-12 11:33:55 -07:00
598f2c4b12
support --smooth option for blueprints
2022-10-12 10:10:53 -07:00
33816b8bc2
optionally process only the cur z-level and below
2022-10-05 14:01:09 -07:00
663916b86b
update wording for autolabor
2022-09-28 14:56:20 -07:00
9a2cb5ea44
fix ALL the typos
...
done by copying everything into Google docs and running spellcheck
2022-09-28 14:49:03 -07:00
b6acf7a928
address feedback on the docs
2022-09-28 12:45:57 -07:00
618a191c87
fix directive use for reveal.rst
2022-09-23 08:46:50 -07:00
a3a06fb363
Update docs/plugins/spectate.rst
...
removes extra blank line
2022-09-19 10:23:18 -07:00
b084171048
add overlay docs
2022-09-16 21:56:04 -07:00
170d7b9b51
typo fix in infiniteSky docs
2022-09-16 15:24:18 -07:00
2733ce7684
update workflow summary to match the gui version
2022-09-10 09:49:42 -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
b3284c9d82
Updates spectate.rst
2022-09-01 17:14:10 -07:00
65dd62a96e
remove unnecessary label for probe
2022-08-26 16:51:29 -07:00
0d3f5c2904
get new script docs to compile
2022-08-25 21:53:35 -07:00
eb73de4670
make Usage a proper header
2022-08-17 22:42:02 -07: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
eb91feff7c
revise tag list and assignments
2022-08-13 21:17:24 -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
e6b5d5b0c1
Remove commas from tag lists
2022-08-08 17:35:58 -04:00
5a14992aca
Use new directives for a few plugins
2022-08-08 17:32:40 -04:00
5ef36d210f
Render implicit dfhack-command alongside dfhack-tool unless :no-command: is passed
2022-08-08 17:30:19 -04:00
d19ffa1806
Add stub dfhack-command directive, refactor to support
2022-08-08 17:30:18 -04:00
de5f4d3566
Default to document basename in dfhack-tool directive
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
6700a8d922
add missing keybinds for filltraffic plugin
2022-08-05 22:31:51 -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
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
ac2d943fb1
remove commas from cleaners index entry
2022-07-28 05:41:29 -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
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
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
Kelly Kinkade
Myk
myk002
Josh Cooper
Josh Cooper
lethosor
pre-commit-ci[bot]