Merge pull request #3880 from myk002/myksnothereman

remove tags from unavailable tools
develop
Myk 2023-10-14 14:54:17 -07:00 committed by GitHub
commit 6a3fb8e1ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
39 changed files with 47 additions and 39 deletions

@ -3,8 +3,8 @@
DFHack tools DFHack tools
============ ============
DFHack has **a lot** of tools. This page attempts to make it clearer what they DFHack comes with **a lot** of tools. This page attempts to make it clearer
are, how they work, and how to find the ones you want. what they are, how they work, and how to find the ones you want.
.. contents:: Contents .. contents:: Contents
:local: :local:
@ -36,6 +36,12 @@ more than one category. If you already know what you're looking for, try the
`search` or Ctrl-F on this page. If you'd like to see the full list of tools in `search` or Ctrl-F on this page. If you'd like to see the full list of tools in
one flat list, please refer to the `annotated index <all-tag-index>`. one flat list, please refer to the `annotated index <all-tag-index>`.
Some tools are part of our back catalog and haven't been updated yet for v50 of
Dwarf Fortress. These tools are tagged as
`unavailable <unavailable-tag-index>`. They will still appear in the
alphabetical list at the bottom of this page, but unavailable tools will not
listed in any of the indices.
DFHack tools by game mode DFHack tools by game mode
------------------------- -------------------------

@ -75,6 +75,7 @@ Template for new versions:
- `zone`: animals trained for war or hunting are now labeled as such in animal assignment screens - `zone`: animals trained for war or hunting are now labeled as such in animal assignment screens
## Documentation ## Documentation
- unavailable tools are no longer listed in the tag indices in the online docs
## API ## API
- Translate: will use DF's ``translate_name`` function, if available, instead of the DFHack emulation - Translate: will use DF's ``translate_name`` function, if available, instead of the DFHack emulation

@ -3,7 +3,7 @@ autogems
.. dfhack-tool:: .. dfhack-tool::
:summary: Automatically cut rough gems. :summary: Automatically cut rough gems.
:tags: unavailable fort auto workorders :tags: unavailable
:no-command: :no-command:
.. dfhack-command:: autogems-reload .. dfhack-command:: autogems-reload

@ -3,7 +3,7 @@ building-hacks
.. dfhack-tool:: .. dfhack-tool::
:summary: Provides a Lua API for creating powered workshops. :summary: Provides a Lua API for creating powered workshops.
:tags: unavailable fort gameplay buildings :tags: unavailable
:no-command: :no-command:
See `building-hacks-api` for more details. See `building-hacks-api` for more details.

@ -3,7 +3,7 @@ burrows
.. dfhack-tool:: .. dfhack-tool::
:summary: Auto-expand burrows as you dig. :summary: Auto-expand burrows as you dig.
:tags: unavailable fort auto design productivity map units :tags: unavailable
:no-command: :no-command:
.. dfhack-command:: burrow .. dfhack-command:: burrow

@ -3,7 +3,7 @@ digFlood
.. dfhack-tool:: .. dfhack-tool::
:summary: Digs out veins as they are discovered. :summary: Digs out veins as they are discovered.
:tags: unavailable fort auto map :tags: unavailable
Once you register specific vein types, this tool will automatically designate Once you register specific vein types, this tool will automatically designate
tiles of those types of veins for digging as your miners complete adjacent tiles of those types of veins for digging as your miners complete adjacent

@ -3,7 +3,7 @@ diggingInvaders
.. dfhack-tool:: .. dfhack-tool::
:summary: Invaders dig and destroy to get to your dwarves. :summary: Invaders dig and destroy to get to your dwarves.
:tags: unavailable fort gameplay military units :tags: unavailable
Usage Usage
----- -----

@ -3,7 +3,7 @@ dwarfmonitor
.. dfhack-tool:: .. dfhack-tool::
:summary: Report on dwarf preferences and efficiency. :summary: Report on dwarf preferences and efficiency.
:tags: unavailable fort inspection jobs units :tags: unavailable
It can also show heads-up display widgets with live fort statistics. It can also show heads-up display widgets with live fort statistics.

@ -3,7 +3,7 @@ embark-assistant
.. dfhack-tool:: .. dfhack-tool::
:summary: Embark site selection support. :summary: Embark site selection support.
:tags: unavailable embark fort interface :tags: unavailable
Run this command while the pre-embark screen is displayed to show extended (and Run this command while the pre-embark screen is displayed to show extended (and
reasonably correct) resource information for the embark rectangle as well as reasonably correct) resource information for the embark rectangle as well as

@ -3,7 +3,7 @@ embark-tools
.. dfhack-tool:: .. dfhack-tool::
:summary: Extend the embark screen functionality. :summary: Extend the embark screen functionality.
:tags: unavailable embark fort interface :tags: unavailable
Usage Usage
----- -----

@ -3,7 +3,7 @@ fix-unit-occupancy
.. dfhack-tool:: .. dfhack-tool::
:summary: Fix phantom unit occupancy issues. :summary: Fix phantom unit occupancy issues.
:tags: unavailable fort bugfix map :tags: unavailable
If you see "unit blocking tile" messages that you can't account for If you see "unit blocking tile" messages that you can't account for
(:bug:`3499`), this tool can help. (:bug:`3499`), this tool can help.

@ -3,7 +3,7 @@ fixveins
.. dfhack-tool:: .. dfhack-tool::
:summary: Restore missing mineral inclusions. :summary: Restore missing mineral inclusions.
:tags: unavailable fort bugfix map :tags: unavailable
This tool can also remove invalid references to mineral inclusions if you broke This tool can also remove invalid references to mineral inclusions if you broke
your embark with tools like `tiletypes`. your embark with tools like `tiletypes`.

@ -3,7 +3,7 @@ follow
.. dfhack-tool:: .. dfhack-tool::
:summary: Make the screen follow the selected unit. :summary: Make the screen follow the selected unit.
:tags: unavailable fort interface units :tags: unavailable
Once you exit from the current menu or cursor mode, the screen will stay Once you exit from the current menu or cursor mode, the screen will stay
centered on the unit. Handy for watching dwarves running around. Deactivated by centered on the unit. Handy for watching dwarves running around. Deactivated by

@ -3,7 +3,7 @@ forceequip
.. dfhack-tool:: .. dfhack-tool::
:summary: Move items into a unit's inventory. :summary: Move items into a unit's inventory.
:tags: unavailable adventure fort animals items military units :tags: unavailable
This tool is typically used to equip specific clothing/armor items onto a dwarf, This tool is typically used to equip specific clothing/armor items onto a dwarf,
but can also be used to put armor onto a war animal or to add unusual items but can also be used to put armor onto a war animal or to add unusual items

@ -3,7 +3,7 @@ generated-creature-renamer
.. dfhack-tool:: .. dfhack-tool::
:summary: Automatically renames generated creatures. :summary: Automatically renames generated creatures.
:tags: unavailable adventure fort legends units :tags: unavailable
:no-command: :no-command:
.. dfhack-command:: list-generated .. dfhack-command:: list-generated

@ -3,7 +3,7 @@ infiniteSky
.. dfhack-tool:: .. dfhack-tool::
:summary: Automatically allocate new z-levels of sky :summary: Automatically allocate new z-levels of sky
:tags: unavailable fort auto design map :tags: unavailable
If enabled, this plugin will automatically allocate new z-levels of sky at the If enabled, this plugin will automatically allocate new z-levels of sky at the
top of the map as you build up. Or it can allocate one or many additional levels top of the map as you build up. Or it can allocate one or many additional levels

@ -3,7 +3,7 @@ isoworldremote
.. dfhack-tool:: .. dfhack-tool::
:summary: Provides a remote API used by Isoworld. :summary: Provides a remote API used by Isoworld.
:tags: unavailable dev graphics :tags: unavailable
:no-command: :no-command:
See `remote` for related remote APIs. See `remote` for related remote APIs.

@ -5,7 +5,7 @@ jobutils
.. dfhack-tool:: .. dfhack-tool::
:summary: Provides commands for interacting with jobs. :summary: Provides commands for interacting with jobs.
:tags: unavailable fort inspection jobs :tags: unavailable
:no-command: :no-command:
.. dfhack-command:: job .. dfhack-command:: job

@ -3,7 +3,7 @@ labormanager
.. dfhack-tool:: .. dfhack-tool::
:summary: Automatically manage dwarf labors. :summary: Automatically manage dwarf labors.
:tags: unavailable fort auto labors :tags: unavailable
Labormanager is derived from `autolabor` but uses a completely different Labormanager is derived from `autolabor` but uses a completely different
approach to assigning jobs to dwarves. While autolabor tries to keep as many approach to assigning jobs to dwarves. While autolabor tries to keep as many

@ -3,7 +3,7 @@ manipulator
.. dfhack-tool:: .. dfhack-tool::
:summary: An in-game labor management interface. :summary: An in-game labor management interface.
:tags: unavailable fort productivity labors :tags: unavailable
:no-command: :no-command:
It is equivalent to the popular Dwarf Therapist utility. It is equivalent to the popular Dwarf Therapist utility.

@ -3,7 +3,7 @@ map-render
.. dfhack-tool:: .. dfhack-tool::
:summary: Provides a Lua API for re-rendering portions of the map. :summary: Provides a Lua API for re-rendering portions of the map.
:tags: unavailable dev graphics :tags: unavailable
:no-command: :no-command:
See `map-render-api` for details. See `map-render-api` for details.

@ -3,7 +3,7 @@ mode
.. dfhack-tool:: .. dfhack-tool::
:summary: See and change the game mode. :summary: See and change the game mode.
:tags: unavailable armok dev gameplay :tags: unavailable
.. warning:: .. warning::

@ -3,7 +3,7 @@ mousequery
.. dfhack-tool:: .. dfhack-tool::
:summary: Adds mouse controls to the DF interface. :summary: Adds mouse controls to the DF interface.
:tags: unavailable fort productivity interface :tags: unavailable
Adds mouse controls to the DF interface. For example, with ``mousequery`` you Adds mouse controls to the DF interface. For example, with ``mousequery`` you
can click on buildings to configure them, hold the mouse button to draw dig can click on buildings to configure them, hold the mouse button to draw dig

@ -3,7 +3,7 @@ petcapRemover
.. dfhack-tool:: .. dfhack-tool::
:summary: Modify the pet population cap. :summary: Modify the pet population cap.
:tags: unavailable fort auto animals :tags: unavailable
In vanilla DF, pets will not reproduce unless the population is below 50 and the In vanilla DF, pets will not reproduce unless the population is below 50 and the
number of children of that species is below a certain percentage. This plugin number of children of that species is below a certain percentage. This plugin

@ -5,7 +5,7 @@ plants
.. dfhack-tool:: .. dfhack-tool::
:summary: Provides commands that interact with plants. :summary: Provides commands that interact with plants.
:tags: unavailable adventure fort armok map plants :tags: unavailable
:no-command: :no-command:
.. dfhack-command:: plant .. dfhack-command:: plant

@ -3,7 +3,7 @@ power-meter
.. dfhack-tool:: .. dfhack-tool::
:summary: Allow pressure plates to measure power. :summary: Allow pressure plates to measure power.
:tags: unavailable fort gameplay buildings :tags: unavailable
:no-command: :no-command:
If you run `gui/power-meter` while building a pressure plate, the pressure If you run `gui/power-meter` while building a pressure plate, the pressure

@ -3,7 +3,7 @@ rename
.. dfhack-tool:: .. dfhack-tool::
:summary: Easily rename things. :summary: Easily rename things.
:tags: unavailable adventure fort productivity buildings stockpiles units :tags: unavailable
Use `gui/rename` for an in-game interface. Use `gui/rename` for an in-game interface.

@ -3,7 +3,7 @@ rendermax
.. dfhack-tool:: .. dfhack-tool::
:summary: Modify the map lighting. :summary: Modify the map lighting.
:tags: unavailable adventure fort gameplay graphics :tags: unavailable
This plugin provides a collection of OpenGL lighting filters that affect how the This plugin provides a collection of OpenGL lighting filters that affect how the
map is drawn to the screen. map is drawn to the screen.

@ -5,7 +5,7 @@ search
.. dfhack-tool:: .. dfhack-tool::
:summary: Adds search capabilities to the UI. :summary: Adds search capabilities to the UI.
:tags: unavailable fort productivity interface :tags: unavailable
:no-command: :no-command:
Search options are added to the Stocks, Animals, Trading, Stockpile, Noble Search options are added to the Stocks, Animals, Trading, Stockpile, Noble

@ -3,7 +3,7 @@ siege-engine
.. dfhack-tool:: .. dfhack-tool::
:summary: Extend the functionality and usability of siege engines. :summary: Extend the functionality and usability of siege engines.
:tags: unavailable fort gameplay buildings :tags: unavailable
:no-command: :no-command:
Siege engines in DF haven't been updated since the game was 2D, and can only aim Siege engines in DF haven't been updated since the game was 2D, and can only aim

@ -3,7 +3,7 @@ steam-engine
.. dfhack-tool:: .. dfhack-tool::
:summary: Allow modded steam engine buildings to function. :summary: Allow modded steam engine buildings to function.
:tags: unavailable fort gameplay buildings :tags: unavailable
:no-command: :no-command:
The steam-engine plugin detects custom workshops with the string The steam-engine plugin detects custom workshops with the string

@ -3,7 +3,7 @@ stockflow
.. dfhack-tool:: .. dfhack-tool::
:summary: Queue manager jobs based on free space in stockpiles. :summary: Queue manager jobs based on free space in stockpiles.
:tags: unavailable fort auto stockpiles workorders :tags: unavailable
With this plugin, the fortress bookkeeper can tally up free space in specific With this plugin, the fortress bookkeeper can tally up free space in specific
stockpiles and queue jobs through the manager to produce items to fill the free stockpiles and queue jobs through the manager to produce items to fill the free

@ -3,7 +3,7 @@ stocks
.. dfhack-tool:: .. dfhack-tool::
:summary: Enhanced fortress stock management interface. :summary: Enhanced fortress stock management interface.
:tags: unavailable fort productivity items :tags: unavailable
When the plugin is enabled, two new hotkeys become available: When the plugin is enabled, two new hotkeys become available:

@ -3,7 +3,7 @@ title-folder
.. dfhack-tool:: .. dfhack-tool::
:summary: Displays the DF folder name in the window title bar. :summary: Displays the DF folder name in the window title bar.
:tags: unavailable interface :tags: unavailable
:no-command: :no-command:
Usage Usage

@ -3,7 +3,7 @@ trackstop
.. dfhack-tool:: .. dfhack-tool::
:summary: Add dynamic configuration options for track stops. :summary: Add dynamic configuration options for track stops.
:tags: unavailable fort gameplay buildings :tags: unavailable
:no-command: :no-command:
When enabled, this plugin adds a :kbd:`q` menu for track stops, which is When enabled, this plugin adds a :kbd:`q` menu for track stops, which is

@ -3,7 +3,7 @@ tweak
.. dfhack-tool:: .. dfhack-tool::
:summary: A collection of tweaks and bugfixes. :summary: A collection of tweaks and bugfixes.
:tags: unavailable adventure fort armok bugfix fps interface :tags: unavailable
Usage Usage
----- -----

@ -3,7 +3,7 @@ workflow
.. dfhack-tool:: .. dfhack-tool::
:summary: Manage automated item production rules. :summary: Manage automated item production rules.
:tags: unavailable fort auto jobs :tags: unavailable
Manage repeat jobs according to stock levels. `gui/workflow` provides a simple Manage repeat jobs according to stock levels. `gui/workflow` provides a simple
front-end integrated in the game UI. front-end integrated in the game UI.

@ -3,7 +3,7 @@ zone
.. dfhack-tool:: .. dfhack-tool::
:summary: Manage activity zones, cages, and the animals therein. :summary: Manage activity zones, cages, and the animals therein.
:tags: unavailable fort productivity animals buildings interface :tags: unavailable
Usage Usage
----- -----

@ -140,7 +140,8 @@ class DFHackToolDirectiveBase(sphinx.directives.ObjectDescription):
anchor = to_anchor(self.get_tool_name_from_docname()) anchor = to_anchor(self.get_tool_name_from_docname())
tags = self.env.domaindata['tag-repo']['doctags'][docname] tags = self.env.domaindata['tag-repo']['doctags'][docname]
indexdata = (name, self.options.get('summary', ''), '', docname, anchor, 0) indexdata = (name, self.options.get('summary', ''), '', docname, anchor, 0)
self.env.domaindata['all']['objects'].append(indexdata) if 'unavailable' not in tags:
self.env.domaindata['all']['objects'].append(indexdata)
for tag in tags: for tag in tags:
self.env.domaindata[tag]['objects'].append(indexdata) self.env.domaindata[tag]['objects'].append(indexdata)