Merge pull request DFHack#912 from myk002/myk_unstick

reinstate uniform-unstick

changelog.txt

@@ -28,8 +28,10 @@ Template for new versions:
 
 ## New Tools
 - `control-panel`: new commandline interface for control panel functions
+- `uniform-unstick`: (reinstated) force squad members to drop items that they picked up in the wrong order so they can get everything equipped properly
 
 ## New Features
+- `uniform-unstick`: add overlay to the squad equipment screen to show a equipment conflict report and give you a one-click button to fix
 
 ## Fixes
 - `warn-stranded`: Automatically ignore citizens who are gathering plants or digging to avoid issues with gathering fruit via stepladders and weird issues with digging

docs/uniform-unstick.rst

@@ -3,10 +3,14 @@ uniform-unstick
 
 .. dfhack-tool::
     :summary: Make military units reevaluate their uniforms.
-    :tags: unavailable
+    :tags: fort bugfix military
 
 This tool prompts military units to reevaluate their uniform, making them
-remove and drop potentially conflicting worn items.
+remove and drop potentially conflicting worn items. If multiple units claim the
+same item, the item will be unassigned from all units that are not already
+wearing the item. If this happens, you'll have to click the "Update equipment"
+button on the Squads "Equip" screen in order for them to get new equipment
+assigned.
 
 Unlike a "replace clothing" designation, it won't remove additional clothing if
 it's coexisting with a uniform item already on that body part. It also won't
@@ -39,6 +43,19 @@ Strategy options
     Force the unit to drop conflicting worn items onto the ground, where they
     can then be reclaimed in the correct order.
 ``--free``
-    Remove to-equip items from containers or other's inventories and place them
-    on the ground, ready to be claimed. This is most useful when someone else
-    is wearing/holding the required items.
+    Remove items from the uniform assignment if someone else has a claim on
+    them. This will also remove items from containers and place them on the
+    ground, ready to be claimed.
+``--multi``
+    Attempt to fix issues with uniforms that allow multiple items per body part.
+
+Overlay
+-------
+
+This script adds a small link to the squad equipment page that will run
+``uniform-unstick --all`` and show the report when clicked. After reviewing the
+report, you can right click to exit and do nothing or you can click the "Try to
+resolve conflicts" button, which runs the equivalent of
+``uniform-unstick --all --drop --free``. If any items are unassigned (they'll
+turn red on the equipment screen), hit the "Update Equipment" button to
+reassign equipment.