Merge pull request #2590 from myk002/myk_untested

add untested tag to plugins
develop
Myk 2023-01-11 21:24:58 -08:00 committed by GitHub
commit d9a2b6e40c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
85 changed files with 97 additions and 84 deletions

@ -14,7 +14,7 @@ for the tag assignment spreadsheet.
"when" tags
-----------
- `adventure <adventure-tag-index>`: Tools that are useful while in adventure mode. Note that some tools only tagged with "fort" might also work in adventure mode, but not always in expected ways. Feel free to experiment, though!
- `dfhack <dfhack-tag-index>`: Tools that you use to run DFHack commands or interact with the DFHack library. This tag also includes tools that help you manage the DF game itself (e.g. settings, saving, etc.)
- `dfhack <dfhack-tag-index>`: Tools that you use to run DFHack commands or interact with the DFHack library. This tag also includes tools that help you manage the DF game itself (e.g. quicksave, etc.)
- `embark <embark-tag-index>`: Tools that are useful while on the fort embark screen or while creating an adventurer.
- `fort <fort-tag-index>`: Tools that are useful while in fort mode.
- `legends <legends-tag-index>`: Tools that are useful while in legends mode.
@ -46,3 +46,7 @@ for the tag assignment spreadsheet.
- `stockpiles <stockpiles-tag-index>`: Tools that interact with stockpiles.
- `units <units-tag-index>`: Tools that interact with units.
- `workorders <workorders-tag-index>`: Tools that interact with workorders.
"misc" tags
-----------
- `untested <untested-tag-index>`: Tools that are not yet tested with the current release.

@ -3,7 +3,7 @@
.. dfhack-tool::
:summary: Rewrite layer veins to expand in 3D space.
:tags: fort gameplay map
:tags: untested 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 graphics
:tags: untested 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 gameplay items
:tags: untested 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 @@ autoclothing
.. dfhack-tool::
:summary: Automatically manage clothing work orders.
:tags: fort auto workorders
:tags: untested 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 armok fps productivity items stockpiles
:tags: untested fort armok fps productivity items stockpiles
:no-command:
.. dfhack-command:: autodump

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

@ -3,7 +3,7 @@ autohauler
.. dfhack-tool::
:summary: Automatically manage hauling labors.
:tags: fort auto labors
:tags: untested fort auto labors
Similar to `autolabor`, but instead of managing all labors, autohauler only
addresses hauling labors, leaving the assignment of skilled labors entirely up

@ -3,7 +3,7 @@ autolabor
.. dfhack-tool::
:summary: Automatically manage dwarf labors.
:tags: fort auto labors
:tags: untested fort auto labors
Autolabor attempts to keep as many dwarves as possible busy while allowing
dwarves to specialize in specific skills.

@ -3,7 +3,7 @@ automaterial
.. dfhack-tool::
:summary: Sorts building materials by recent usage.
:tags: fort design productivity buildings map
:tags: untested fort design productivity buildings map
:no-command:
This plugin makes building constructions (walls, floors, fortifications, etc)

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

@ -3,7 +3,7 @@ autonestbox
.. dfhack-tool::
:summary: Auto-assign egg-laying female pets to nestbox zones.
:tags: fort auto animals
:tags: untested fort auto animals
To use this feature, you must create pen/pasture zones on the same tiles as
built nestboxes. If the pen is bigger than 1x1, the nestbox must be in the top

@ -3,7 +3,7 @@ autotrade
.. dfhack-tool::
:summary: Quickly designate items to be traded.
:tags: fort productivity items stockpiles
:tags: untested fort productivity items stockpiles
: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 buildings map stockpiles
:tags: untested fort design buildings map stockpiles
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 gameplay buildings
:tags: untested 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 buildings
:tags: untested 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 design productivity map units
:tags: untested fort auto design productivity map units
:no-command:
.. dfhack-command:: burrow

@ -3,7 +3,7 @@ changeitem
.. dfhack-tool::
:summary: Change item material or base quality.
:tags: adventure fort armok items
:tags: untested 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

@ -3,7 +3,7 @@ changelayer
.. dfhack-tool::
:summary: Change the material of an entire geology layer.
:tags: fort armok map
:tags: untested fort armok map
Note that one layer can stretch across many z-levels, and changes to the geology
layer will affect all surrounding regions, not just your embark! Mineral veins

@ -3,7 +3,7 @@ changevein
.. dfhack-tool::
:summary: Change the material of a mineral inclusion.
:tags: fort armok map
:tags: untested fort armok map
You can change a vein to any inorganic material RAW id. Note that this command
only affects tiles within the current 16x16 block - for large veins and

@ -3,7 +3,7 @@ channel-safely
.. dfhack-tool::
:summary: Auto-manage channel designations to keep dwarves safe.
:tags: fort auto
:tags: untested 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

@ -3,7 +3,7 @@ cleanconst
.. dfhack-tool::
:summary: Cleans up construction materials.
:tags: fort fps buildings
:tags: untested 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 armok fps items map units
:tags: untested adventure fort armok fps items map units
:no-command:
.. dfhack-command:: clean

@ -3,7 +3,7 @@ confirm
.. dfhack-tool::
:summary: Adds confirmation dialogs for destructive actions.
:tags: fort interface
:tags: untested fort interface
Now you can get the chance to avoid seizing goods from traders or deleting a
hauling route in case you hit the key accidentally.

@ -3,7 +3,7 @@ createitem
.. dfhack-tool::
:summary: Create arbitrary items.
:tags: adventure fort armok items
:tags: untested 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

@ -3,7 +3,7 @@ cursecheck
.. dfhack-tool::
:summary: Check for cursed creatures.
:tags: fort armok inspection units
:tags: untested fort armok inspection units
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 @@ cxxrandom
.. dfhack-tool::
:summary: Provides a Lua API for random distributions.
:tags: dev
:tags: untested dev
:no-command:
See `cxxrandom-api` for details.

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

@ -3,7 +3,7 @@ dig-now
.. dfhack-tool::
:summary: Instantly complete dig designations.
:tags: fort armok map
:tags: untested fort armok map
This tool will magically complete non-marker dig designations, modifying tile
shapes and creating boulders, ores, and gems as if a miner were doing the mining

@ -6,7 +6,7 @@ dig
.. dfhack-tool::
:summary: Provides commands for designating tiles for digging.
:tags: fort design productivity map
:tags: untested fort design productivity map
:no-command:
.. dfhack-command:: digv

@ -3,7 +3,7 @@ digFlood
.. dfhack-tool::
:summary: Digs out veins as they are discovered.
:tags: fort auto map
:tags: untested 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

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

@ -3,7 +3,7 @@ dwarfmonitor
.. dfhack-tool::
:summary: Report on dwarf preferences and efficiency.
:tags: fort inspection jobs units
:tags: untested 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 gameplay animals
:tags: untested 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

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

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

@ -3,7 +3,7 @@ fastdwarf
.. dfhack-tool::
:summary: Dwarves teleport and/or finish jobs instantly.
:tags: fort armok units
:tags: untested fort armok units
Usage
-----

@ -6,7 +6,7 @@ filltraffic
.. dfhack-tool::
:summary: Set traffic designations using flood-fill starting at the cursor.
:tags: fort design productivity map
:tags: untested fort design productivity map
.. dfhack-command:: alltraffic
:summary: Set traffic designations for every single tile of the map.

@ -3,7 +3,7 @@ fix-unit-occupancy
.. dfhack-tool::
:summary: Fix phantom unit occupancy issues.
:tags: fort bugfix map
:tags: untested 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 bugfix map
:tags: untested 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 @@ flows
.. dfhack-tool::
:summary: Counts map blocks with flowing liquids.
:tags: fort inspection map
:tags: untested 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.

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

@ -3,7 +3,7 @@ forceequip
.. dfhack-tool::
:summary: Move items into a unit's inventory.
:tags: adventure fort animals items military units
:tags: untested 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 @@ generated-creature-renamer
.. dfhack-tool::
:summary: Automatically renames generated creatures.
:tags: adventure fort legends units
:tags: untested adventure fort legends units
:no-command:
.. dfhack-command:: list-generated

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

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

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

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

@ -3,7 +3,7 @@ labormanager
.. dfhack-tool::
:summary: Automatically manage dwarf labors.
:tags: fort auto labors
:tags: untested 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

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

@ -5,7 +5,7 @@ liquids
.. dfhack-tool::
:summary: Place magma, water or obsidian.
:tags: adventure fort armok map
:tags: untested adventure fort armok map
.. dfhack-command:: liquids-here
:summary: Spawn liquids on the selected tile.

@ -3,7 +3,7 @@ luasocket
.. dfhack-tool::
:summary: Provides a Lua API for accessing network sockets.
:tags: dev
:tags: untested 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 labors
:tags: untested 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 re-rendering portions of the map.
:tags: dev graphics
:tags: untested dev graphics
:no-command:
See `map-render-api` for details.

@ -3,7 +3,7 @@ misery
.. dfhack-tool::
:summary: Increase the intensity of negative dwarven thoughts.
:tags: fort armok units
:tags: untested fort armok auto units
When enabled, negative thoughts that your dwarves have will multiply by the
specified factor.

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

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

@ -3,7 +3,7 @@ nestboxes
.. dfhack-tool::
:summary: Protect fertile eggs incubating in a nestbox.
:tags: fort auto animals
:tags: untested fort auto animals
:no-command:
This plugin will automatically scan for and forbid fertile eggs incubating in a

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

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

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

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

@ -3,7 +3,7 @@ rename
.. dfhack-tool::
:summary: Easily rename things.
:tags: adventure fort productivity buildings stockpiles units
:tags: untested 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 gameplay graphics
:tags: untested adventure fort gameplay graphics
This plugin provides a collection of OpenGL lighting filters that affect how the
map is drawn to the screen.

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

@ -3,7 +3,7 @@ siege-engine
.. dfhack-tool::
:summary: Extend the functionality and usability of siege engines.
:tags: fort gameplay buildings
:tags: untested 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 @@ sort
.. dfhack-tool::
:summary: Sort lists shown in the DF interface.
:tags: fort productivity interface
:tags: untested fort productivity interface
:no-command:
.. dfhack-command:: sort-items

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

@ -3,7 +3,7 @@ steam-engine
.. dfhack-tool::
:summary: Allow modded steam engine buildings to function.
:tags: fort gameplay buildings
:tags: untested 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 stockpiles workorders
:tags: untested 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

@ -5,7 +5,7 @@ stockpiles
.. dfhack-tool::
:summary: Import and export stockpile settings.
:tags: fort design productivity stockpiles
:tags: untested fort design productivity stockpiles
:no-command:
.. dfhack-command:: copystock

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

@ -3,7 +3,7 @@ strangemood
.. dfhack-tool::
:summary: Trigger a strange mood.
:tags: fort armok units
:tags: untested fort armok units
Usage
-----

@ -3,7 +3,7 @@ tailor
.. dfhack-tool::
:summary: Automatically keep your dwarves in fresh clothing.
:tags: fort auto workorders
:tags: untested 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

@ -6,7 +6,7 @@ tiletypes
.. dfhack-tool::
:summary: Paints tiles of specified types onto the map.
:tags: adventure fort armok map
:tags: untested adventure fort armok map
.. dfhack-command:: tiletypes-command
:summary: Run tiletypes commands.

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

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

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

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

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

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

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

@ -3,7 +3,7 @@ xlsxreader
.. dfhack-tool::
:summary: Provides a Lua API for reading xlsx files.
:tags: dev
:tags: untested dev
:no-command:
See `xlsxreader-api` for details.

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

@ -729,7 +729,16 @@ function dfhack.script_environment(name, strict)
end
end
local warned_scripts = {}
function dfhack.run_script_with_env(envVars, name, flags, ...)
if not warned_scripts[name] and require('helpdb').get_entry_tags(name).untested 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.')
qerror('Please run the command again to ignore this warning and proceed.')
end
if type(flags) ~= 'table' then flags = {} end
local file = dfhack.findScript(name)
if not file then