revise tag list and assignments

develop
myk002 2022-08-11 23:34:37 -07:00
parent f6699c0014
commit eb91feff7c
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
78 changed files with 78 additions and 78 deletions

@ -3,7 +3,7 @@ alias
.. dfhack-tool::
:summary: Configure helper aliases for other DFHack commands.
:tags: system
:tags: dfhack
Aliases are resolved immediately after built-in commands, which means that an
alias cannot override a built-in command, but can override a command implemented

@ -3,7 +3,7 @@ cls
.. dfhack-tool::
:summary: Clear the terminal screen.
:tags: system
:tags: dfhack
Can also be invoked as ``clear``. Note that this command does not delete command
history. It just clears the text on the screen.

@ -3,7 +3,7 @@ die
.. dfhack-tool::
:summary: Instantly exit DF without saving.
:tags: system
:tags: dfhack
Use to exit DF quickly and safely.

@ -3,7 +3,7 @@ disable
.. dfhack-tool::
:summary: Deactivate a DFHack tool that has some persistent effect.
:tags: system
:tags: dfhack
See the `enable` command for more info.

@ -3,7 +3,7 @@ enable
.. dfhack-tool::
:summary: Activate a DFHack tool that has some persistent effect.
:tags: system
:tags: dfhack
Many plugins and scripts can be in a distinct enabled or disabled state. Some
of them activate and deactivate automatically depending on the contents of the

@ -3,7 +3,7 @@ fpause
.. dfhack-tool::
:summary: Forces DF to pause.
:tags: system
:tags: dfhack
This is useful when your FPS drops below 1 and you lose control of the game.

@ -3,7 +3,7 @@ help
.. dfhack-tool::
:summary: Display help about a command or plugin.
:tags: system
:tags: dfhack
Can also be invoked as ``?`` or ``man`` (short for "manual").

@ -3,7 +3,7 @@ hide
.. dfhack-tool::
:summary: Hide the DFHack terminal window.
:tags: system
:tags: dfhack
You can show it again with the `show` command, though you'll need to use it from
a `keybinding` set beforehand or the in-game `command-prompt`.

@ -3,7 +3,7 @@ keybinding
.. dfhack-tool::
:summary: Create hotkeys that will run DFHack commands.
:tags: system
:tags: dfhack
Like any other command, it can be used at any time from the console, but
bindings are not remembered between runs of the game unless re-created in

@ -3,7 +3,7 @@ kill-lua
.. dfhack-tool::
:summary: Gracefully stop any currently-running Lua scripts.
:tags: system
:tags: dfhack
Use this command to stop a misbehaving script that appears to be stuck.

@ -3,7 +3,7 @@ load
.. dfhack-tool::
:summary: Load and register a plugin library.
:tags: system
:tags: dfhack
Also see `unload` and `reload` for related actions.

@ -3,7 +3,7 @@ ls
.. dfhack-tool::
:summary: List available DFHack commands.
:tags: system
:tags: dfhack
In order to group related commands, each command is associated with a list of
tags. You can filter the listed commands by a tag or a substring of the

@ -3,7 +3,7 @@ plug
.. dfhack-tool::
:summary: List available plugins and whether they are enabled.
:tags: system
:tags: dfhack
Usage::

@ -3,7 +3,7 @@ reload
.. dfhack-tool::
:summary: Reload a loaded plugin.
:tags: system
:tags: dfhack
Developers use this command to reload a plugin that they are actively modifying.
Also see `load` and `unload` for related actions.

@ -3,7 +3,7 @@ sc-script
.. dfhack-tool::
:summary: Run commands when game state changes occur.
:tags: system
:tags: dfhack
This is similar to the static `init-files` but is slightly more flexible since
it can be set dynamically.

@ -3,7 +3,7 @@ script
.. dfhack-tool::
:summary: Execute a batch file of DFHack commands.
:tags: system
:tags: dfhack
It reads a text file and runs each line as a DFHack command as if it had been
typed in by the user -- treating the input like `an init file <init-files>`.

@ -3,7 +3,7 @@ show
.. dfhack-tool::
:summary: Unhides the DFHack terminal window.
:tags: system
:tags: dfhack
Useful if you have hidden the terminal with `hide` and you want it back. Since
the terminal window won't be available to run this command, you'll need to use

@ -3,7 +3,7 @@ tags
.. dfhack-tool::
:summary: List the strings that DFHack tools can be tagged with.
:tags: system
:tags: dfhack
You can find groups of related tools by passing the tag name to the `ls`
command.

@ -3,7 +3,7 @@ type
.. dfhack-tool::
:summary: Describe how a command is implemented.
:tags: system
:tags: dfhack
DFHack commands can be provided by plugins, scripts, or by the core library
itself. The ``type`` command can tell you which is the source of a particular

@ -3,7 +3,7 @@ unload
.. dfhack-tool::
:summary: Unload a plugin from memory.
:tags: system
:tags: dfhack
Also see `load` and `reload` for related actions.

@ -3,7 +3,7 @@
.. dfhack-tool::
:summary: Rewrite layer veins to expand in 3D space.
:tags: fort mod map
:tags: fort gameplay map
Existing, flat veins are removed and new 3D veins that naturally span z-levels
are generated in their place. The transformation preserves the mineral counts

@ -3,7 +3,7 @@ RemoteFortressReader
.. dfhack-tool::
:summary: Backend for Armok Vision.
:tags: dev
:tags: dev graphics
:no-command:
.. dfhack-command:: RemoteFortressReader_version

@ -3,7 +3,7 @@ add-spatter
.. dfhack-tool::
:summary: Make tagged reactions produce contaminants.
:tags: adventure fort mod items
:tags: adventure fort gameplay items
:no-command:
Give some use to all those poisons that can be bought from caravans! The plugin

@ -3,7 +3,7 @@ autochop
.. dfhack-tool::
:summary: Auto-harvest trees when low on stockpiled logs.
:tags: fort auto
:tags: fort auto plants
:no-command:
This plugin can designate trees for chopping when your stocks are low on logs.

@ -3,7 +3,7 @@ autoclothing
.. dfhack-tool::
:summary: Automatically manage clothing work orders.
:tags: fort auto jobs
:tags: fort auto workorders
This command allows you to set how many of each clothing type every citizen
should have.

@ -3,7 +3,7 @@ autodump
.. dfhack-tool::
:summary: Automatically set items in a stockpile to be dumped.
:tags: fort auto fps items stockpiles
:tags: fort productivity fps armok stockpiles items
:no-command:
.. dfhack-command:: autodump

@ -3,7 +3,7 @@ autofarm
.. dfhack-tool::
:summary: Automatically manage farm crop selection.
:tags: fort auto buildings
:tags: fort auto plants
Periodically scan your plant stocks and assign crops to your farm plots based on
which plant stocks are low (as long as you have the appropriate seeds). The

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

@ -3,7 +3,7 @@ automelt
.. dfhack-tool::
:summary: Quickly designate items to be melted.
:tags: fort auto items stockpiles
:tags: fort productivity stockpiles items
:no-command:
When `enabled <enable>`, this plugin adds an option to the :kbd:`q` menu for

@ -3,7 +3,7 @@ autotrade
.. dfhack-tool::
:summary: Quickly designate items to be traded.
:tags: fort auto items stockpiles
:tags: fort productivity stockpiles items
:no-command:
When `enabled <enable>`, this plugin adds an option to the :kbd:`q` menu for

@ -3,7 +3,7 @@ blueprint
.. dfhack-tool::
:summary: Record a live game map in a quickfort blueprint.
:tags: fort design quickfort map
:tags: fort design buildings stockpiles map
With ``blueprint``, you can export the structure of a portion of your fortress
in a blueprint file that you (or anyone else) can later play back with

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

@ -3,7 +3,7 @@ buildingplan
.. dfhack-tool::
:summary: Plan building construction before you have materials.
:tags: fort design quickfort buildings map
:tags: fort design buildings
This plugin adds a planning mode for building placement. You can then place
furniture, constructions, and other buildings before the required materials are

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

@ -3,7 +3,7 @@ cleanconst
.. dfhack-tool::
:summary: Cleans up construction materials.
:tags: fort fps map
:tags: fort fps buildings
This tool alters all constructions on the map so that they spawn their building
component when they are disassembled, allowing their actual build items to be

@ -6,7 +6,7 @@ cleaners
.. dfhack-tool::
:summary: Provides commands for cleaning spatter from the map.
:tags: adventure fort fps items map units
:tags: adventure fort fps armok items map units
:no-command:
.. dfhack-command:: clean

@ -3,7 +3,7 @@ command-prompt
.. dfhack-tool::
:summary: An in-game DFHack terminal where you can run other commands.
:tags: system
:tags: dfhack
Usage::

@ -3,7 +3,7 @@ cursecheck
.. dfhack-tool::
:summary: Check for cursed creatures.
:tags: system interface
:tags: dev fps stockpiles
This command checks a single map tile (or the whole map/world) for cursed
creatures (ghosts, vampires, necromancers, werebeasts, zombies, etc.).

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

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

@ -3,7 +3,7 @@ dwarfvet
.. dfhack-tool::
:summary: Allows animals to be treated at animal hospitals.
:tags: fort mod animals
:tags: fort gameplay animals
Annoyed your dragons become useless after a minor injury? Well, with dwarfvet,
injured animals will be treated at an animal hospital, which is simply a hospital

@ -3,7 +3,7 @@ eventful
.. dfhack-tool::
:summary: Provides a Lua API for reacting to in-game events.
:tags: dev mod
:tags: dev gameplay
:no-command:
See `eventful-api` for details.

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

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

@ -3,7 +3,7 @@ forceequip
.. dfhack-tool::
:summary: Move items into a unit's inventory.
:tags: adventure fort items units
:tags: adventure fort animals items military units
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

@ -3,7 +3,7 @@ getplants
.. dfhack-tool::
:summary: Designate trees for chopping and shrubs for gathering.
:tags: fort productivity
:tags: fort productivity plants
Specify the types of trees to cut down and/or shrubs to gather by their plant
names.

@ -3,7 +3,7 @@ hotkeys
.. dfhack-tool::
:summary: Show all dfhack keybindings for the current context.
:tags: system productivity interface
:tags: dfhack
The command opens an in-game screen showing which DFHack keybindings are active
in the current context. See also `hotkey-notes`.

@ -3,7 +3,7 @@ infiniteSky
.. dfhack-tool::
:summary: Automatically allocates new z-levels of sky
:tags: fort map
:tags: fort design map
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

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

@ -3,7 +3,7 @@ luasocket
.. dfhack-tool::
:summary: Provides a Lua API for accessing network sockets.
:tags: dev mod
:tags: dev
:no-command:
See `luasocket-api` for details.

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

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

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

@ -3,7 +3,7 @@ orders
.. dfhack-tool::
:summary: Manage manager orders.
:tags: fort productivity jobs
:tags: fort productivity workorders
Usage:

@ -3,7 +3,7 @@ pathable
.. dfhack-tool::
:summary: Marks tiles that are reachable from the cursor.
:tags: dev inspection interface map
:tags: dev inspection map
:no-command:
This plugin provides a Lua API, but no direct commands. See `pathable-api` for

@ -3,7 +3,7 @@ petcapRemover
.. dfhack-tool::
:summary: Modify the pet population cap.
:tags: fort armok animals
:tags: fort animals
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

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

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

@ -3,7 +3,7 @@ probe
.. dfhack-tool::
:summary: Display low-level properties of the selected tile.
:tags: adventure fort inspection map
:tags: adventure fort inspection buildings map units
.. dfhack-command:: bprobe
:summary: Display low-level properties of the selected building.

@ -5,7 +5,7 @@ prospector
.. dfhack-tool::
:summary: Provides commands that help you analyze natural resources.
:tags: fort embark inspection map
:tags: fort embark inspection armok map
:no-command:
.. dfhack-command:: prospect

@ -3,7 +3,7 @@ regrass
.. dfhack-tool::
:summary: Regrows all the grass.
:tags: adventure fort armok animals
:tags: adventure fort armok animals map
Use this command if your grazers have eaten everything down to the dirt.

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

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

@ -3,7 +3,7 @@ resume
.. dfhack-tool::
:summary: Color planned buildings based on their suspend status.
:tags: fort productivity
:tags: fort productivity interface jobs
:no-command:
.. dfhack-command:: resume

@ -3,7 +3,7 @@ seedwatch
.. dfhack-tool::
:summary: Manages seed and plant cooking based on seed stock levels.
:tags: fort auto
:tags: fort auto plants
Each seed type can be assigned a target. If the number of seeds of that type
falls below that target, then the plants and seeds of that type will be excluded

@ -3,7 +3,7 @@ showmood
.. dfhack-tool::
:summary: Shows all items needed for the active strange mood.
:tags: fort inspection jobs
:tags: fort inspection armok jobs units
Usage::

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

@ -3,7 +3,7 @@ spectate
.. dfhack-tool::
:summary: Automatically follow exciting dwarves.
:tags: fort units
:tags: fort interface
:no-command:
Usage::

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

@ -3,7 +3,7 @@ stockflow
.. dfhack-tool::
:summary: Queue manager jobs based on free space in stockpiles.
:tags: fort auto jobs stockpiles
:tags: fort auto stockpiles workorders
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

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

@ -3,7 +3,7 @@ stonesense
.. dfhack-tool::
:summary: A 3D isometric visualizer.
:tags: adventure fort interface map
:tags: adventure fort map graphics
.. dfhack-command:: ssense
:summary: An alias for stonesense.

@ -3,7 +3,7 @@ tailor
.. dfhack-tool::
:summary: Automatically keep your dwarves in fresh clothing.
:tags: fort auto jobs
:tags: fort auto workorders
Whenever the bookkeeper updates stockpile records, this plugin will scan the
fort. If there are fresh cloths available, dwarves who are wearing tattered

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

@ -3,7 +3,7 @@ title-version
.. dfhack-tool::
:summary: Displays the DFHack version on DF's title screen.
:tags: system interface
:tags: interface
:no-command:
Usage::

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

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

@ -3,7 +3,7 @@ workNow
.. dfhack-tool::
:summary: Reduce the time that dwarves idle after completing a job.
:tags: fort auto jobs
:tags: fort auto labors
After finishing a job, dwarves will wander away for a while before picking up a
new job. This plugin will automatically poke the game to assign dwarves to new