forked from DFHack/dfhack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathReadme.html
More file actions
4043 lines (3963 loc) · 207 KB
/
Readme.html
File metadata and controls
4043 lines (3963 loc) · 207 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
<title>DFHack Readme</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="dfhack-readme">
<h1 class="title">DFHack Readme</h1>
<div class="section" id="introduction">
<h1><a class="toc-backref" href="#id5">Introduction</a></h1>
<p>DFHack is a Dwarf Fortress memory access library, distributed with scripts
and plugins implementing a wide variety of useful functions and tools.</p>
<p>For users, it provides a significant suite of bugfixes and interface
enhancements by default, and more can be enabled. There are also many tools
(such as <tt class="docutils literal">workflow</tt> or <tt class="docutils literal">autodump</tt>) which can make life easier. You can
even add third-party scripts and plugins to do almost anything!</p>
<p>For modders, DFHack makes many things possible. Custom reactions, new
interactions, magic creature abilities, and more can be set through scripts
and custom raws. Non-standard DFHack scripts and inits can be stored in the
raw directory, making raws or saves fully self-contained for distribution -
or for coexistence in a single DF install, even with incompatible components.</p>
<p>For developers, DFHack unites the various ways tools access DF memory and
allows easier development of new tools. As an open-source project under
various copyleft licences, contributions are welcome.</p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#introduction" id="id5">Introduction</a></li>
<li><a class="reference internal" href="#getting-dfhack" id="id6">Getting DFHack</a></li>
<li><a class="reference internal" href="#compatibility" id="id7">Compatibility</a></li>
<li><a class="reference internal" href="#installation-removal" id="id8">Installation/Removal</a><ul>
<li><a class="reference internal" href="#getting-started" id="id9">Getting started</a></li>
</ul>
</li>
<li><a class="reference internal" href="#using-dfhack" id="id10">Using DFHack</a><ul>
<li><a class="reference internal" href="#patched-binaries" id="id11">Patched binaries</a><ul>
<li><a class="reference internal" href="#live-patching" id="id12">Live patching</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#something-doesn-t-work-help" id="id13">Something doesn't work, help!</a></li>
<li><a class="reference internal" href="#the-init-file" id="id14">The init file</a><ul>
<li><a class="reference internal" href="#setting-keybindings" id="id15">Setting keybindings</a></li>
<li><a class="reference internal" href="#enabling-plugins" id="id16">Enabling plugins</a></li>
</ul>
</li>
<li><a class="reference internal" href="#commands" id="id17">Commands</a><ul>
<li><a class="reference internal" href="#game-progress" id="id18">Game progress</a><ul>
<li><a class="reference internal" href="#die" id="id19">die</a></li>
<li><a class="reference internal" href="#forcepause" id="id20">forcepause</a></li>
<li><a class="reference internal" href="#nopause" id="id21">nopause</a></li>
<li><a class="reference internal" href="#fastdwarf" id="id22">fastdwarf</a></li>
</ul>
</li>
<li><a class="reference internal" href="#game-interface" id="id23">Game interface</a><ul>
<li><a class="reference internal" href="#follow" id="id24">follow</a></li>
<li><a class="reference internal" href="#tidlers" id="id25">tidlers</a></li>
<li><a class="reference internal" href="#twaterlvl" id="id26">twaterlvl</a></li>
<li><a class="reference internal" href="#stockpile-settings-management" id="id27">stockpile settings management</a><ul>
<li><a class="reference internal" href="#copystock" id="id28">copystock</a></li>
<li><a class="reference internal" href="#savestock" id="id29">savestock</a></li>
<li><a class="reference internal" href="#loadstock" id="id30">loadstock</a></li>
</ul>
</li>
<li><a class="reference internal" href="#rename" id="id31">rename</a></li>
<li><a class="reference internal" href="#command-prompt" id="id32">command-prompt</a></li>
<li><a class="reference internal" href="#rendermax" id="id33">rendermax</a></li>
</ul>
</li>
<li><a class="reference internal" href="#adventure-mode" id="id34">Adventure mode</a><ul>
<li><a class="reference internal" href="#adv-bodyswap" id="id35">adv-bodyswap</a></li>
<li><a class="reference internal" href="#advtools" id="id36">advtools</a></li>
</ul>
</li>
<li><a class="reference internal" href="#map-modification" id="id37">Map modification</a><ul>
<li><a class="reference internal" href="#dveins" id="id38">3dveins</a></li>
<li><a class="reference internal" href="#changelayer" id="id39">changelayer</a></li>
<li><a class="reference internal" href="#changevein" id="id40">changevein</a></li>
<li><a class="reference internal" href="#changeitem" id="id41">changeitem</a></li>
<li><a class="reference internal" href="#colonies" id="id42">colonies</a></li>
<li><a class="reference internal" href="#createitem" id="id43">createitem</a></li>
<li><a class="reference internal" href="#deramp" id="id44">deramp</a></li>
<li><a class="reference internal" href="#feature" id="id45">feature</a></li>
<li><a class="reference internal" href="#infinitesky" id="id46">infiniteSky</a></li>
<li><a class="reference internal" href="#liquids" id="id47">liquids</a></li>
<li><a class="reference internal" href="#liquids-here" id="id48">liquids-here</a></li>
<li><a class="reference internal" href="#tiletypes" id="id49">tiletypes</a></li>
<li><a class="reference internal" href="#tiletypes-commands" id="id50">tiletypes-commands</a></li>
<li><a class="reference internal" href="#tiletypes-here" id="id51">tiletypes-here</a></li>
<li><a class="reference internal" href="#tiletypes-here-point" id="id52">tiletypes-here-point</a></li>
<li><a class="reference internal" href="#tubefill" id="id53">tubefill</a></li>
<li><a class="reference internal" href="#plant" id="id54">plant</a></li>
<li><a class="reference internal" href="#regrass" id="id55">regrass</a></li>
<li><a class="reference internal" href="#weather" id="id56">weather</a></li>
</ul>
</li>
<li><a class="reference internal" href="#map-inspection" id="id57">Map inspection</a><ul>
<li><a class="reference internal" href="#cursecheck" id="id58">cursecheck</a></li>
<li><a class="reference internal" href="#flows" id="id59">flows</a></li>
<li><a class="reference internal" href="#probe" id="id60">probe</a></li>
<li><a class="reference internal" href="#prospect" id="id61">prospect</a><ul>
<li><a class="reference internal" href="#pre-embark-estimate" id="id62">Pre-embark estimate</a></li>
</ul>
</li>
<li><a class="reference internal" href="#reveal" id="id63">reveal</a></li>
<li><a class="reference internal" href="#unreveal" id="id64">unreveal</a></li>
<li><a class="reference internal" href="#revtoggle" id="id65">revtoggle</a></li>
<li><a class="reference internal" href="#revflood" id="id66">revflood</a></li>
<li><a class="reference internal" href="#revforget" id="id67">revforget</a></li>
<li><a class="reference internal" href="#showmood" id="id68">showmood</a></li>
</ul>
</li>
<li><a class="reference internal" href="#designations" id="id69">Designations</a><ul>
<li><a class="reference internal" href="#burrow" id="id70">burrow</a></li>
<li><a class="reference internal" href="#digv" id="id71">digv</a></li>
<li><a class="reference internal" href="#digvx" id="id72">digvx</a></li>
<li><a class="reference internal" href="#digl" id="id73">digl</a></li>
<li><a class="reference internal" href="#diglx" id="id74">diglx</a></li>
<li><a class="reference internal" href="#digexp" id="id75">digexp</a></li>
<li><a class="reference internal" href="#digcircle" id="id76">digcircle</a></li>
<li><a class="reference internal" href="#digtype" id="id77">digtype</a></li>
<li><a class="reference internal" href="#digflood" id="id78">digFlood</a></li>
<li><a class="reference internal" href="#filltraffic" id="id79">filltraffic</a></li>
<li><a class="reference internal" href="#alltraffic" id="id80">alltraffic</a></li>
<li><a class="reference internal" href="#restrictliquid" id="id81">restrictliquid</a></li>
<li><a class="reference internal" href="#restrictice" id="id82">restrictice</a></li>
<li><a class="reference internal" href="#getplants" id="id83">getplants</a></li>
</ul>
</li>
<li><a class="reference internal" href="#cleanup-and-garbage-disposal" id="id84">Cleanup and garbage disposal</a><ul>
<li><a class="reference internal" href="#clean" id="id85">clean</a></li>
<li><a class="reference internal" href="#spotclean" id="id86">spotclean</a></li>
<li><a class="reference internal" href="#autodump" id="id87">autodump</a></li>
<li><a class="reference internal" href="#autodump-destroy-item" id="id88">autodump-destroy-item</a></li>
<li><a class="reference internal" href="#cleanowned" id="id89">cleanowned</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bugfixes" id="id90">Bugfixes</a><ul>
<li><a class="reference internal" href="#drybuckets" id="id91">drybuckets</a></li>
<li><a class="reference internal" href="#fixdiplomats" id="id92">fixdiplomats</a></li>
<li><a class="reference internal" href="#fixmerchants" id="id93">fixmerchants</a></li>
<li><a class="reference internal" href="#fixveins" id="id94">fixveins</a></li>
<li><a class="reference internal" href="#tweak" id="id95">tweak</a></li>
<li><a class="reference internal" href="#fix-armory" id="id96">fix-armory</a></li>
</ul>
</li>
<li><a class="reference internal" href="#mode-switch-and-reclaim" id="id97">Mode switch and reclaim</a><ul>
<li><a class="reference internal" href="#lair" id="id98">lair</a></li>
<li><a class="reference internal" href="#mode" id="id99">mode</a></li>
</ul>
</li>
<li><a class="reference internal" href="#visualizer-and-data-export" id="id100">Visualizer and data export</a><ul>
<li><a class="reference internal" href="#stonesense" id="id101">stonesense</a></li>
<li><a class="reference internal" href="#mapexport" id="id102">mapexport</a></li>
<li><a class="reference internal" href="#dwarfexport" id="id103">dwarfexport</a></li>
<li><a class="reference internal" href="#exportlegends" id="id104">exportlegends</a></li>
<li><a class="reference internal" href="#blueprint" id="id105">blueprint</a></li>
</ul>
</li>
<li><a class="reference internal" href="#job-management" id="id106">Job management</a><ul>
<li><a class="reference internal" href="#job" id="id107">job</a></li>
<li><a class="reference internal" href="#job-material" id="id108">job-material</a></li>
<li><a class="reference internal" href="#job-duplicate" id="id109">job-duplicate</a></li>
<li><a class="reference internal" href="#stockflow" id="id110">stockflow</a></li>
<li><a class="reference internal" href="#workflow" id="id111">workflow</a><ul>
<li><a class="reference internal" href="#function" id="id112">Function</a></li>
<li><a class="reference internal" href="#constraint-format" id="id113">Constraint format</a></li>
<li><a class="reference internal" href="#constraint-examples" id="id114">Constraint examples</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#fortress-activity-management" id="id115">Fortress activity management</a><ul>
<li><a class="reference internal" href="#seedwatch" id="id116">seedwatch</a></li>
<li><a class="reference internal" href="#zone" id="id117">zone</a><ul>
<li><a class="reference internal" href="#usage-with-single-units" id="id118">Usage with single units</a></li>
<li><a class="reference internal" href="#usage-with-filters" id="id119">Usage with filters</a></li>
<li><a class="reference internal" href="#mass-renaming" id="id120">Mass-renaming</a></li>
<li><a class="reference internal" href="#cage-zones" id="id121">Cage zones</a></li>
<li><a class="reference internal" href="#examples" id="id122">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#autonestbox" id="id123">autonestbox</a></li>
<li><a class="reference internal" href="#autobutcher" id="id124">autobutcher</a></li>
<li><a class="reference internal" href="#autochop" id="id125">autochop</a></li>
<li><a class="reference internal" href="#autolabor" id="id126">autolabor</a></li>
</ul>
</li>
<li><a class="reference internal" href="#other" id="id127">Other</a><ul>
<li><a class="reference internal" href="#catsplosion" id="id128">catsplosion</a></li>
<li><a class="reference internal" href="#dfusion" id="id129">dfusion</a></li>
<li><a class="reference internal" href="#embark-tools" id="id130">embark-tools</a></li>
<li><a class="reference internal" href="#petcapremover" id="id131">petcapRemover</a></li>
<li><a class="reference internal" href="#misery" id="id132">misery</a></li>
<li><a class="reference internal" href="#strangemood" id="id133">strangemood</a></li>
<li><a class="reference internal" href="#log-region" id="id134">log-region</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#scripts" id="id135">Scripts</a><ul>
<li><a class="reference internal" href="#fix" id="id136">fix/*</a></li>
<li><a class="reference internal" href="#gui" id="id137">gui/*</a></li>
<li><a class="reference internal" href="#binpatch" id="id138">binpatch</a></li>
<li><a class="reference internal" href="#create-items" id="id139">create-items</a></li>
<li><a class="reference internal" href="#digfort" id="id140">digfort</a></li>
<li><a class="reference internal" href="#drain-aquifer" id="id141">drain-aquifer</a></li>
<li><a class="reference internal" href="#deathcause" id="id142">deathcause</a></li>
<li><a class="reference internal" href="#dfstatus" id="id143">dfstatus</a></li>
<li><a class="reference internal" href="#exterminate" id="id144">exterminate</a></li>
<li><a class="reference internal" href="#fortplan" id="id145">fortplan</a></li>
<li><a class="reference internal" href="#growcrops" id="id146">growcrops</a></li>
<li><a class="reference internal" href="#hfs-pit" id="id147">hfs-pit</a></li>
<li><a class="reference internal" href="#hotkey-notes" id="id148">hotkey-notes</a></li>
<li><a class="reference internal" href="#lever" id="id149">lever</a></li>
<li><a class="reference internal" href="#locate-ore" id="id150">locate-ore</a></li>
<li><a class="reference internal" href="#lua" id="id151">lua</a></li>
<li><a class="reference internal" href="#masspit" id="id152">masspit</a></li>
<li><a class="reference internal" href="#multicmd" id="id153">multicmd</a></li>
<li><a class="reference internal" href="#position" id="id154">position</a></li>
<li><a class="reference internal" href="#putontable" id="id155">putontable</a></li>
<li><a class="reference internal" href="#quicksave" id="id156">quicksave</a></li>
<li><a class="reference internal" href="#remove-stress" id="id157">remove-stress</a></li>
<li><a class="reference internal" href="#setfps" id="id158">setfps</a></li>
<li><a class="reference internal" href="#siren" id="id159">siren</a></li>
<li><a class="reference internal" href="#soundsense-season" id="id160">soundsense-season</a></li>
<li><a class="reference internal" href="#source" id="id161">source</a></li>
<li><a class="reference internal" href="#superdwarf" id="id162">superdwarf</a></li>
<li><a class="reference internal" href="#stripcaged" id="id163">stripcaged</a></li>
<li><a class="reference internal" href="#teleport" id="id164">teleport</a></li>
<li><a class="reference internal" href="#undump-buildings" id="id165">undump-buildings</a></li>
</ul>
</li>
<li><a class="reference internal" href="#modtools" id="id166">modtools</a></li>
<li><a class="reference internal" href="#in-game-interface-tools" id="id167">In-game interface tools</a><ul>
<li><a class="reference internal" href="#dwarf-manipulator" id="id168">Dwarf Manipulator</a></li>
<li><a class="reference internal" href="#search" id="id169">Search</a></li>
<li><a class="reference internal" href="#automaterial" id="id170">AutoMaterial</a></li>
<li><a class="reference internal" href="#stockpile-automation" id="id171">Stockpile Automation</a></li>
<li><a class="reference internal" href="#track-stop-menu" id="id172">Track Stop Menu</a></li>
<li><a class="reference internal" href="#gui-advfort" id="id173">gui/advfort</a></li>
<li><a class="reference internal" href="#gui-assign-rack" id="id174">gui/assign-rack</a></li>
<li><a class="reference internal" href="#gui-choose-weapons" id="id175">gui/choose-weapons</a></li>
<li><a class="reference internal" href="#gui-clone-uniform" id="id176">gui/clone-uniform</a></li>
<li><a class="reference internal" href="#gui-companion-order" id="id177">gui/companion-order</a></li>
<li><a class="reference internal" href="#gui-gm-editor" id="id178">gui/gm-editor</a></li>
<li><a class="reference internal" href="#hotkeys" id="id179">Hotkeys</a></li>
<li><a class="reference internal" href="#id3" id="id180">Stockpile Automation</a></li>
<li><a class="reference internal" href="#gui-liquids" id="id181">gui/liquids</a></li>
<li><a class="reference internal" href="#gui-mechanisms" id="id182">gui/mechanisms</a></li>
<li><a class="reference internal" href="#gui-mod-manager" id="id183">gui/mod-manager</a></li>
<li><a class="reference internal" href="#gui-rename" id="id184">gui/rename</a></li>
<li><a class="reference internal" href="#gui-room-list" id="id185">gui/room-list</a></li>
<li><a class="reference internal" href="#gui-guide-path" id="id186">gui/guide-path</a></li>
<li><a class="reference internal" href="#gui-workflow" id="id187">gui/workflow</a></li>
<li><a class="reference internal" href="#gui-workshop-job" id="id188">gui/workshop-job</a></li>
</ul>
</li>
<li><a class="reference internal" href="#behavior-mods" id="id189">Behavior Mods</a><ul>
<li><a class="reference internal" href="#siege-engine" id="id190">Siege Engine</a><ul>
<li><a class="reference internal" href="#rationale" id="id191">Rationale</a></li>
<li><a class="reference internal" href="#configuration-ui" id="id192">Configuration UI</a></li>
</ul>
</li>
<li><a class="reference internal" href="#power-meter" id="id193">Power Meter</a></li>
<li><a class="reference internal" href="#steam-engine" id="id194">Steam Engine</a><ul>
<li><a class="reference internal" href="#id4" id="id195">Rationale</a></li>
<li><a class="reference internal" href="#construction" id="id196">Construction</a></li>
<li><a class="reference internal" href="#operation" id="id197">Operation</a></li>
<li><a class="reference internal" href="#explosions" id="id198">Explosions</a></li>
<li><a class="reference internal" href="#save-files" id="id199">Save files</a></li>
</ul>
</li>
<li><a class="reference internal" href="#add-spatter" id="id200">Add Spatter</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="getting-dfhack">
<h1><a class="toc-backref" href="#id6">Getting DFHack</a></h1>
<p>The project is currently hosted at <a class="reference external" href="http://www.github.com/">http://www.github.com/</a></p>
<p>Recent releases are available in source and binary formats <a class="reference external" href="http://github.com/DFHack/dfhack/releases">on the releases
page</a>, while the binaries for releases 0.40.15-r1 to 0.34.11-r4 are on <a class="reference external" href="http://dffd.bay12games.com/search.php?string=DFHack&id=15">DFFD</a>.
Even older versions are available <a class="reference external" href="http://dethware.org/dfhack/download">here</a>.</p>
<p>All new releases are announced in <a class="reference external" href="http://www.bay12forums.com/smf/index.php?topic=139553">the bay12 forums thread</a>, which is also a
good place for discussion and questions.</p>
</div>
<div class="section" id="compatibility">
<h1><a class="toc-backref" href="#id7">Compatibility</a></h1>
<p>DFHack is available for Windows (XP or later), Linux (any modern distribution),
or OS X (10.6.8 to 10.9).</p>
<p>Most releases only support the version of DF mentioned in their title - for
example, DFHack 0.40.24-r2 only supports DF 0.40.24 - but some releases
support earlier DF versions as well. Wherever possible, use the latest version
built for the target version of DF.</p>
<p>On Windows, DFHack is compatible with the SDL version of DF, but not the legacy version.</p>
<p>It is also possible to use the Windows DFHack with Wine under Linux and OS X.</p>
</div>
<div class="section" id="installation-removal">
<h1><a class="toc-backref" href="#id8">Installation/Removal</a></h1>
<p>Installing DFhack involves copying files into your DF folder.
Copy the files from a release archive so that:</p>
<ul class="simple">
<li>On Windows, SDL.dll is replaced</li>
<li>On Linux, the 'dfhack' script is placed in the same folder as the 'df' script</li>
</ul>
<p>Uninstalling is basically the same, in reverse:</p>
<ul class="simple">
<li>On Windows, first delete SDL.dll and rename SDLreal.dll to SDL.dll. Then
remove the other DFHack files</li>
<li>On Linux, Remove the DFHack files.</li>
</ul>
<p>The stonesense plugin might require some additional libraries on Linux.</p>
<p>If any of the plugins or dfhack itself refuses to load, check the stderr.log
file created in your DF folder.</p>
<div class="section" id="getting-started">
<h2><a class="toc-backref" href="#id9">Getting started</a></h2>
<p>If DFHack is installed correctly, it will automatically pop up a console
window once DF is started as usual on windows. Linux and Mac OS X require
running the dfhack script from the terminal, and will use that terminal for
the console.</p>
<p><strong>NOTE</strong>: The dfhack-run executable is there for calling DFHack commands in
an already running DF+DFHack instance from external OS scripts and programs,
and is <em>not</em> the way how you use DFHack normally.</p>
<p>DFHack has a lot of features, which can be accessed by typing commands in the
console, or by mapping them to keyboard shortcuts. Most of the newer and more
user-friendly tools are designed to be at least partially used via the latter
way.</p>
<p>In order to set keybindings, you have to create a text configuration file
called <tt class="docutils literal">dfhack.init</tt>; the installation comes with an example version called
<tt class="docutils literal"><span class="pre">dfhack.init-example</span></tt>, which is fully functional, covers all of the recent
features and can be simply renamed to <tt class="docutils literal">dfhack.init</tt>. You are encouraged to look
through it to learn which features it makes available under which key combinations.</p>
<p>For more information, refer to the rest of this document.</p>
</div>
</div>
<div class="section" id="using-dfhack">
<h1><a class="toc-backref" href="#id10">Using DFHack</a></h1>
<p>DFHack basically extends what DF can do with something similar to the drop-down
console found in Quake engine games. On Windows, this is a separate command line
window. On linux, the terminal used to launch the dfhack script is taken over
(so, make sure you start from a terminal). Basic interaction with dfhack
involves entering commands into the console. For some basic instructions,
use the 'help' command. To list all possible commands, use the 'ls' command.
Many commands have their own help or detailed description. You can use
'command help' or 'command ?' to show that.</p>
<p>The command line has some nice line editing capabilities, including history
that's preserved between different runs of DF (use up/down keys to go through
the history).</p>
<p>The second way to interact with DFHack is to bind the available commands
to in-game hotkeys. The old way to do this is via the hotkey/zoom menu (normally
opened with the 'h' key). Binding the commands is done by assigning a command as
a hotkey name (with 'n').</p>
<p>A new and more flexible way is the keybinding command in the dfhack console.
However, bindings created this way are not automatically remembered between runs
of the game, so it becomes necessary to use the dfhack.init file to ensure that
they are re-created every time it is loaded.</p>
<p>Interactive commands like 'liquids' cannot be used as hotkeys.</p>
<p>Most of the commands come from plugins. Those reside in 'hack/plugins/'.</p>
<div class="section" id="patched-binaries">
<h2><a class="toc-backref" href="#id11">Patched binaries</a></h2>
<p>On linux and OSX, users of patched binaries may have to find the relevant
section in symbols.xml, and add a new line with the checksum of their
executable:</p>
<pre class="literal-block">
<md5-hash value='????????????????????????????????'/>
</pre>
<p>In order to find the correct value of the hash, look into stderr.log;
DFHack prints an error there if it does not recognize the hash.</p>
<p>DFHack includes a small stand-alone utility for applying and removing
binary patches from the game executable. Use it from the regular operating
system console:</p>
<dl class="docutils">
<dt><tt class="docutils literal">binpatch check "Dwarf Fortress.exe" patch.dif</tt></dt>
<dd>Checks and prints if the patch is currently applied.</dd>
<dt><tt class="docutils literal">binpatch apply "Dwarf Fortress.exe" patch.dif</tt></dt>
<dd>Applies the patch, unless it is already applied or in conflict.</dd>
<dt><tt class="docutils literal">binpatch remove "Dwarf Fortress.exe" patch.dif</tt></dt>
<dd>Removes the patch, unless it is already removed.</dd>
</dl>
<p>The patches are expected to be encoded in text format used by IDA.</p>
<div class="section" id="live-patching">
<h3><a class="toc-backref" href="#id12">Live patching</a></h3>
<p>As an alternative, you can use the <tt class="docutils literal">binpatch</tt> dfhack command to apply/remove
patches live in memory during a DF session.</p>
<p>In this case, updating symbols.xml is not necessary.</p>
</div>
</div>
</div>
<div class="section" id="something-doesn-t-work-help">
<h1><a class="toc-backref" href="#id13">Something doesn't work, help!</a></h1>
<p>First, don't panic :)</p>
<p>Second, dfhack keeps a few log files in DF's folder (<tt class="docutils literal">stderr.log</tt> and
<tt class="docutils literal">stdout.log</tt>). Looking at these might help you solve the problem.
If it doesn't, you can ask for help in the forum thread or on IRC.</p>
<p>If you found a bug, you can report it in the Bay12 DFHack thread, the issues
tracker on github, or visit the #dfhack IRC channel on freenode.</p>
</div>
<div class="section" id="the-init-file">
<h1><a class="toc-backref" href="#id14">The init file</a></h1>
<p>If your DF folder contains a file named <tt class="docutils literal">dfhack.init</tt>, its contents will be
run every time you start DF. This allows keybindings and other settings to
persist across runs. An example file is provided as <tt class="docutils literal"><span class="pre">dfhack.init-example</span></tt> -
you can tweak it and rename to <tt class="docutils literal">dfhack.init</tt> if you want to use this
functionality. If only the example init file is found, will be used and a
warning will be shown.</p>
<p>When a savegame is loaded, an <tt class="docutils literal">onLoad.init</tt> file in its raw folder is run,
as a save-portable alternative to <tt class="docutils literal">dfhack.init</tt>. It is recommended that
modders use this to improve mobility of save games and compatibility of mods.</p>
<div class="section" id="setting-keybindings">
<h2><a class="toc-backref" href="#id15">Setting keybindings</a></h2>
<p>To set keybindings, use the built-in <tt class="docutils literal">keybinding</tt> command. Like any other
command it can be used at any time from the console, but it is also meaningful
in the DFHack init file.</p>
<p>Currently it supports any combination of Ctrl/Alt/Shift with F1-F9, or A-Z.</p>
<p>Possible ways to call the command:</p>
<dl class="docutils">
<dt><tt class="docutils literal">keybinding list <key></tt></dt>
<dd>List bindings active for the key combination.</dd>
<dt><tt class="docutils literal">keybinding clear <key> <span class="pre"><key>...</span></tt></dt>
<dd>Remove bindings for the specified keys.</dd>
<dt><tt class="docutils literal">keybinding add <key> "cmdline" <span class="pre">"cmdline"...</span></tt></dt>
<dd>Add bindings for the specified key.</dd>
<dt><tt class="docutils literal">keybinding set <key> "cmdline" <span class="pre">"cmdline"...</span></tt></dt>
<dd>Clear, and then add bindings for the specified key.</dd>
</dl>
<p>The <em><key></em> parameter above has the following <em>case-sensitive</em> syntax:</p>
<pre class="literal-block">
[Ctrl-][Alt-][Shift-]KEY[@context]
</pre>
<p>where the <em>KEY</em> part can be F1-F9 or A-Z, and [] denote optional parts.</p>
<p>When multiple commands are bound to the same key combination, DFHack selects
the first applicable one. Later 'add' commands, and earlier entries within one
'add' command have priority. Commands that are not specifically intended for use
as a hotkey are always considered applicable.</p>
<p>The <em>context</em> part in the key specifier above can be used to explicitly restrict
the UI state where the binding would be applicable. If called without parameters,
the <tt class="docutils literal">keybinding</tt> command among other things prints the current context string.
Only bindings with a <em>context</em> tag that either matches the current context fully,
or is a prefix ending at a '/' boundary would be considered for execution, i.e.
for context <tt class="docutils literal">foo/bar/baz</tt>, possible matches are any of <tt class="docutils literal">@foo/bar/baz</tt>, <tt class="docutils literal">@foo/bar</tt>,
<tt class="docutils literal">@foo</tt> or none.</p>
</div>
<div class="section" id="enabling-plugins">
<h2><a class="toc-backref" href="#id16">Enabling plugins</a></h2>
<p>Many plugins can be in a distinct enabled or disabled state. Some of
them activate and deactivate automatically depending on the contents
of the world raws. Others store their state in world data. However a
number of them have to be enabled globally, and the init file is the
right place to do it.</p>
<p>Most of such plugins support the built-in <tt class="docutils literal">enable</tt> and <tt class="docutils literal">disable</tt>
commands. Calling them at any time without arguments prints a list
of enabled and disabled plugins, and shows whether that can be changed
through the same commands.</p>
<p>To enable or disable plugins that support this, use their names as
arguments for the command:</p>
<pre class="literal-block">
enable manipulator search
</pre>
</div>
</div>
<div class="section" id="commands">
<h1><a class="toc-backref" href="#id17">Commands</a></h1>
<p>DFHack command syntax consists of a command name, followed by arguments separated
by whitespace. To include whitespace in an argument, quote it in double quotes.
To include a double quote character, use <tt class="docutils literal">\"</tt> inside double quotes.</p>
<p>If the first non-whitespace character of a line is <tt class="docutils literal">#</tt>, the line is treated
as a comment, i.e. a silent no-op command.</p>
<p>When reading commands from dfhack.init or with the <tt class="docutils literal">script</tt> command, if the final character on a line is a backslash then the next uncommented line is considered a continuation of that line, with the backslash deleted.
Commented lines are skipped, so it is possible to comment out parts of a command with the <tt class="docutils literal">#</tt> character.</p>
<p>If the first non-whitespace character is <tt class="docutils literal">:</tt>, the command is parsed in a special
alternative mode: first, non-whitespace characters immediately following the <tt class="docutils literal">:</tt>
are used as the command name; the remaining part of the line, starting with the first
non-whitespace character <em>after</em> the command name, is used verbatim as the first argument.
The following two command lines are exactly equivalent:</p>
<pre class="literal-block">
:foo a b "c d" e f
foo "a b \"c d\" e f"
</pre>
<p>This is intended for commands like <tt class="docutils literal">rb_eval</tt> that evaluate script language statements.</p>
<p>Almost all the commands support using the 'help <command-name>' built-in command
to retrieve further help without having to look at this document. Alternatively,
some accept a 'help'/'?' option on their command line.</p>
<div class="section" id="game-progress">
<h2><a class="toc-backref" href="#id18">Game progress</a></h2>
<div class="section" id="die">
<h3><a class="toc-backref" href="#id19">die</a></h3>
<p>Instantly kills DF without saving.</p>
</div>
<div class="section" id="forcepause">
<h3><a class="toc-backref" href="#id20">forcepause</a></h3>
<p>Forces DF to pause. This is useful when your FPS drops below 1 and you lose
control of the game.</p>
<ul class="simple">
<li>Activate with 'forcepause 1'</li>
<li>Deactivate with 'forcepause 0'</li>
</ul>
</div>
<div class="section" id="nopause">
<h3><a class="toc-backref" href="#id21">nopause</a></h3>
<p>Disables pausing (both manual and automatic) with the exception of pause forced
by 'reveal hell'. This is nice for digging under rivers.</p>
</div>
<div class="section" id="fastdwarf">
<h3><a class="toc-backref" href="#id22">fastdwarf</a></h3>
<p>Controls speedydwarf and teledwarf. Speedydwarf makes dwarves move quickly and perform tasks quickly. Teledwarf makes dwarves move instantaneously, but do jobs at the same speed.</p>
<ul class="simple">
<li>'fastdwarf 0 0' disables both</li>
<li>'fastdwarf 0 1' disables speedydwarf and enables teledwarf</li>
<li>'fastdwarf 1 0' enables speedydwarf and disables teledwarf</li>
<li>'fastdwarf 1 1' enables both</li>
<li>'fastdwarf 0' disables both</li>
<li>'fastdwarf 1' enables speedydwarf and disables teledwarf</li>
<li>'fastdwarf 2 ...' sets a native debug flag in the game memory
that implements an even more aggressive version of speedydwarf.</li>
</ul>
</div>
</div>
<div class="section" id="game-interface">
<h2><a class="toc-backref" href="#id23">Game interface</a></h2>
<div class="section" id="follow">
<h3><a class="toc-backref" href="#id24">follow</a></h3>
<p>Makes the game view follow the currently highlighted unit after you exit from
current menu/cursor mode. Handy for watching dwarves running around. Deactivated
by moving the view manually.</p>
</div>
<div class="section" id="tidlers">
<h3><a class="toc-backref" href="#id25">tidlers</a></h3>
<p>Toggle between all possible positions where the idlers count can be placed.</p>
</div>
<div class="section" id="twaterlvl">
<h3><a class="toc-backref" href="#id26">twaterlvl</a></h3>
<p>Toggle between displaying/not displaying liquid depth as numbers.</p>
</div>
<div class="section" id="stockpile-settings-management">
<h3><a class="toc-backref" href="#id27">stockpile settings management</a></h3>
<p>Save and load stockpile settings. See the gui/stockpiles for an in-game GUI to
this plugin.</p>
<div class="section" id="copystock">
<h4><a class="toc-backref" href="#id28">copystock</a></h4>
<p>Copies the parameters of the currently highlighted stockpile to the custom
stockpile settings and switches to custom stockpile placement mode, effectively
allowing you to copy/paste stockpiles easily.</p>
</div>
<div class="section" id="savestock">
<h4><a class="toc-backref" href="#id29">savestock</a></h4>
<p>Saves the currently highlighted stockpile's settings to a file in your Dwarf
Fortress folder. This file can be used to copy settings between game saves or
players.</p>
<p>example:</p>
<pre class="literal-block">
savestock food_settings.dfstock
</pre>
</div>
<div class="section" id="loadstock">
<h4><a class="toc-backref" href="#id30">loadstock</a></h4>
<p>Loads a saved stockpile settings file and applies it to the currently selected
stockpile.</p>
<p>example:</p>
<pre class="literal-block">
loadstock food_settings.dfstock
</pre>
<p>To use savestock and loadstock, use the 'q' command to highlight a stockpile.
Then run savestock giving it a descriptive filename. Then, in a different (or
same!) gameworld, you can highlight any stockpile with 'q' then execute the
'loadstock' command passing it the name of that file. The settings will be
applied to that stockpile.</p>
<p><strong>Notes:</strong> It saves and loads files relative to the DF folder, so put your files
there or in a subfolder for easy access. Filenames should not have spaces.</p>
<p><strong>Limitations:</strong> Generated materials, divine metals, etc are not saved as they
are different in every world.</p>
</div>
</div>
<div class="section" id="rename">
<h3><a class="toc-backref" href="#id31">rename</a></h3>
<p>Allows renaming various things.</p>
<p>Options:</p>
<dl class="docutils">
<dt><tt class="docutils literal">rename squad <index> "name"</tt></dt>
<dd>Rename squad by index to 'name'.</dd>
<dt><tt class="docutils literal">rename hotkey <index> \"name\"</tt></dt>
<dd>Rename hotkey by index. This allows assigning
longer commands to the DF hotkeys.</dd>
<dt><tt class="docutils literal">rename unit "nickname"</tt></dt>
<dd>Rename a unit/creature highlighted in the DF user interface.</dd>
<dt><tt class="docutils literal">rename <span class="pre">unit-profession</span> "custom profession"</tt></dt>
<dd>Change proffession name of the highlighted unit/creature.</dd>
<dt><tt class="docutils literal">rename building "name"</tt></dt>
<dd>Set a custom name for the selected building.
The building must be one of stockpile, workshop, furnace, trap,
siege engine or an activity zone.</dd>
</dl>
</div>
<div class="section" id="command-prompt">
<h3><a class="toc-backref" href="#id32">command-prompt</a></h3>
<p>A one line command prompt in df. Same as entering command into dfhack console. Best
used as a keybinding. Can be called with optional "entry" that will start prompt with
that pre-filled.</p>
<img alt="images/command-prompt.png" src="images/command-prompt.png" />
</div>
<div class="section" id="rendermax">
<h3><a class="toc-backref" href="#id33">rendermax</a></h3>
<p>A collection of renderer replacing/enhancing filters. For better effect try changing the
black color in palette to non totally black. For more info see <a class="reference external" href="http://www.bay12forums.com/smf/index.php?topic=128487">the Bay12 forum thread</a>.</p>
<p>Options:</p>
<dl class="docutils">
<dt><tt class="docutils literal">rendermax trippy</tt></dt>
<dd>Randomizes the color of each tiles. Used for fun, or testing.</dd>
<dt><tt class="docutils literal">rendermax light</tt></dt>
<dd>Enable lighting engine.</dd>
<dt><tt class="docutils literal">rendermax light reload</tt></dt>
<dd>Reload the settings file.</dd>
<dt><tt class="docutils literal">rendermax light sun <span class="pre"><x>|cycle</span></tt></dt>
<dd>Set time to <x> (in hours) or set it to df time cycle.</dd>
<dt><tt class="docutils literal">rendermax occlusionON|occlusionOFF</tt></dt>
<dd>Show debug occlusion info.</dd>
<dt><tt class="docutils literal">rendermax disable</tt></dt>
<dd>Disable any filter that is enabled.</dd>
</dl>
<p>An image showing lava and dragon breath. Not pictured here: sunlight, shining items/plants,
materials that color the light etc...</p>
<img alt="images/rendermax.png" src="images/rendermax.png" />
</div>
</div>
<div class="section" id="adventure-mode">
<h2><a class="toc-backref" href="#id34">Adventure mode</a></h2>
<div class="section" id="adv-bodyswap">
<h3><a class="toc-backref" href="#id35">adv-bodyswap</a></h3>
<p>This allows taking control over your followers and other creatures in adventure
mode. For example, you can make them pick up new arms and armor and equip them
properly.</p>
<p>Usage:</p>
<ul class="simple">
<li>When viewing unit details, body-swaps into that unit.</li>
<li>In the main adventure mode screen, reverts transient swap.</li>
</ul>
</div>
<div class="section" id="advtools">
<h3><a class="toc-backref" href="#id36">advtools</a></h3>
<p>A package of different adventure mode tools.</p>
<p>Usage:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">list-equipped</span> [all]</tt></dt>
<dd>List armor and weapons equipped by your companions.
If all is specified, also lists non-metal clothing.</dd>
<dt><tt class="docutils literal"><span class="pre">metal-detector</span> <span class="pre">[all-types]</span> <span class="pre">[non-trader]</span></tt></dt>
<dd>Reveal metal armor and weapons in
shops. The options disable the checks
on item type and being in shop.</dd>
</dl>
</div>
</div>
<div class="section" id="map-modification">
<h2><a class="toc-backref" href="#id37">Map modification</a></h2>
<div class="section" id="dveins">
<h3><a class="toc-backref" href="#id38">3dveins</a></h3>
<p>Removes all existing veins from the map and generates new ones using
3D Perlin noise, in order to produce a layout that smoothly flows between
Z levels. The vein distribution is based on the world seed, so running
the command for the second time should produce no change. It is best to
run it just once immediately after embark.</p>
<p>This command is intended as only a cosmetic change, so it takes
care to exactly preserve the mineral counts reported by <tt class="docutils literal">prospect all</tt>.