MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #3089 from myk002/myk_unavailable 

rename "untested" tag to "unavailable"
develop
Myk 2023-03-25 12:36:52 -07:00 committed by GitHub
parent a532012a01 5cfa968b38
commit be96e0226c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
58 changed files with 58 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Tags.rst
Unescape Escape View File

@ -49,4 +49,4 @@ for the tag assignment spreadsheet.
"misc" tags
-----------
- `untested <untested-tag-index>`: Tools that are not yet tested with the current release.
- `unavailable <unavailable-tag-index>`: Tools that are not yet available for the current release.

1
docs/changelog.txt
Unescape Escape View File

@ -54,6 +54,7 @@ changelog.txt uses a syntax similar to RST, with a few special sequences:
- `enable`: can now interpret aliases defined with the `alias` command
## Documentation
- ``untested`` tag has been renamed to ``unavailable`` to better reflect the status of the remaining unavaialable tools. all of the simply "untested" tools have now been tested and marked as working. the remaining tools are known to need development work before they are available again.
## API

2
docs/plugins/3dveins.rst
Unescape Escape View File

@ -3,7 +3,7 @@
.. dfhack-tool::
:summary: Rewrite layer veins to expand in 3D space.
:tags: untested fort gameplay map
:tags: unavailable 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

2
docs/plugins/add-spatter.rst
Unescape Escape View File

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

2
docs/plugins/autogems.rst
Unescape Escape View File

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

2
docs/plugins/autotrade.rst
Unescape Escape View File

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

2
docs/plugins/building-hacks.rst
Unescape Escape View File

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

2
docs/plugins/burrows.rst
Unescape Escape View File

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

2
docs/plugins/changeitem.rst
Unescape Escape View File

@ -3,7 +3,7 @@ changeitem
.. dfhack-tool::
:summary: Change item material or base quality.
:tags: untested adventure fort armok items
:tags: unavailable adventure fort armok items
By default, a change is only allowed if the existing and desired item materials
are of the same subtype (for example wood -> wood, stone -> stone, etc). But

2
docs/plugins/channel-safely.rst
Unescape Escape View File

@ -3,7 +3,7 @@ channel-safely
.. dfhack-tool::
:summary: Auto-manage channel designations to keep dwarves safe.
:tags: untested fort auto
:tags: unavailable fort auto
Multi-level channel projects can be dangerous, and managing the safety of your
dwarves throughout the completion of such projects can be difficult and time

2
docs/plugins/createitem.rst
Unescape Escape View File

@ -3,7 +3,7 @@ createitem
.. dfhack-tool::
:summary: Create arbitrary items.
:tags: untested adventure fort armok items
:tags: unavailable adventure fort armok items
You can create new items of any type and made of any material. A unit must be
selected in-game to use this command. By default, items created are spawned at

2
docs/plugins/deramp.rst
Unescape Escape View File

@ -3,7 +3,7 @@ deramp
.. dfhack-tool::
:summary: Removes all ramps designated for removal from the map.
:tags: untested fort armok map
:tags: unavailable fort armok map
It also removes any "floating" down ramps that can remain after a cave-in.

2
docs/plugins/digFlood.rst
Unescape Escape View File

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

2
docs/plugins/diggingInvaders.rst
Unescape Escape View File

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

2
docs/plugins/dwarfmonitor.rst
Unescape Escape View File

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

2
docs/plugins/dwarfvet.rst
Unescape Escape View File

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

2
docs/plugins/embark-assistant.rst
Unescape Escape View File

@ -3,7 +3,7 @@ embark-assistant
.. dfhack-tool::
:summary: Embark site selection support.
:tags: untested embark fort interface
:tags: unavailable embark fort interface
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

2
docs/plugins/embark-tools.rst
Unescape Escape View File

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

2
docs/plugins/fix-unit-occupancy.rst
Unescape Escape View File

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

2
docs/plugins/fixveins.rst
Unescape Escape View File

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

2
docs/plugins/flows.rst
Unescape Escape View File

@ -3,7 +3,7 @@ flows
.. dfhack-tool::
:summary: Counts map blocks with flowing liquids.
:tags: untested fort inspection map
:tags: unavailable fort inspection map
If you suspect that your magma sea leaks into HFS, you can use this tool to be
sure without revealing the map.

2
docs/plugins/follow.rst
Unescape Escape View File

@ -3,7 +3,7 @@ follow
.. dfhack-tool::
:summary: Make the screen follow the selected unit.
:tags: untested fort interface units
:tags: unavailable fort interface units
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

2
docs/plugins/forceequip.rst
Unescape Escape View File

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

2
docs/plugins/generated-creature-renamer.rst
Unescape Escape View File

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

2
docs/plugins/getplants.rst
Unescape Escape View File

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

2
docs/plugins/infiniteSky.rst
Unescape Escape View File

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

2
docs/plugins/isoworldremote.rst
Unescape Escape View File

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

2
docs/plugins/jobutils.rst
Unescape Escape View File

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

2
docs/plugins/labormanager.rst
Unescape Escape View File

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

2
docs/plugins/lair.rst
Unescape Escape View File

@ -3,7 +3,7 @@ lair
.. dfhack-tool::
:summary: Mark the map as a monster lair.
:tags: untested fort armok map
:tags: unavailable fort armok map
This avoids item scatter when the fortress is abandoned.

2
docs/plugins/luasocket.rst
Unescape Escape View File

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

2
docs/plugins/manipulator.rst
Unescape Escape View File

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

2
docs/plugins/map-render.rst
Unescape Escape View File

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

2
docs/plugins/mode.rst
Unescape Escape View File

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

2
docs/plugins/mousequery.rst
Unescape Escape View File

@ -3,7 +3,7 @@ mousequery
.. dfhack-tool::
:summary: Adds mouse controls to the DF interface.
:tags: untested fort productivity interface
:tags: unavailable fort productivity interface
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

2
docs/plugins/petcapRemover.rst
Unescape Escape View File

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

2
docs/plugins/plants.rst
Unescape Escape View File

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

2
docs/plugins/power-meter.rst
Unescape Escape View File

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

2
docs/plugins/prospector.rst
Unescape Escape View File

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

2
docs/plugins/rename.rst
Unescape Escape View File

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

2
docs/plugins/rendermax.rst
Unescape Escape View File

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

2
docs/plugins/search.rst
Unescape Escape View File

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

2
docs/plugins/siege-engine.rst
Unescape Escape View File

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

2
docs/plugins/sort.rst
Unescape Escape View File

@ -3,7 +3,7 @@ sort
.. dfhack-tool::
:summary: Sort lists shown in the DF interface.
:tags: untested fort productivity interface
:tags: unavailable fort productivity interface
:no-command:
.. dfhack-command:: sort-items

2
docs/plugins/spectate.rst
Unescape Escape View File

@ -3,7 +3,7 @@ spectate
.. dfhack-tool::
:summary: Automatically follow productive dwarves.
:tags: untested fort interface
:tags: unavailable fort interface
Usage
-----

2
docs/plugins/steam-engine.rst
Unescape Escape View File

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

2
docs/plugins/stockflow.rst
Unescape Escape View File

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

2
docs/plugins/stocks.rst
Unescape Escape View File

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

2
docs/plugins/title-folder.rst
Unescape Escape View File

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

2
docs/plugins/title-version.rst
Unescape Escape View File

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

2
docs/plugins/trackstop.rst
Unescape Escape View File

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

2
docs/plugins/tubefill.rst
Unescape Escape View File

@ -3,7 +3,7 @@ tubefill
.. dfhack-tool::
:summary: Replenishes mined-out adamantine.
:tags: untested fort armok map
:tags: unavailable fort armok map
Veins that were originally hollow will be left alone.

2
docs/plugins/tweak.rst
Unescape Escape View File

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

2
docs/plugins/workNow.rst
Unescape Escape View File

@ -3,7 +3,7 @@ workNow
.. dfhack-tool::
:summary: Reduce the time that dwarves idle after completing a job.
:tags: untested fort auto labors
:tags: unavailable 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

2
docs/plugins/workflow.rst
Unescape Escape View File

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

2
docs/plugins/zone.rst
Unescape Escape View File

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

2
library/lua/dfhack.lua
Unescape Escape View File

@ -702,7 +702,7 @@ local warned_scripts = {}
function dfhack.run_script(name,...)
if not warned_scripts[name] then
local helpdb = require('helpdb')
if helpdb.is_entry(name) and helpdb.get_entry_tags(name).untested then
if helpdb.is_entry(name) and helpdb.get_entry_tags(name).unavailable then
warned_scripts[name] = true
dfhack.printerr(('UNTESTED WARNING: the "%s" script has not been validated to work well with this version of DF.'):format(name))
dfhack.printerr('It may not work as expected, or it may corrupt your game.')

2
scripts

@ -1 +1 @@
Subproject commit 0b37dcf996bf4b64423d2acb3e3ca224ad76c6bc
Subproject commit f637dc4bf18a7ca4968f45e79790893c6d22c3f5