diff --git a/README.md b/README.md index 76ca22f..8f51546 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,34 @@ # unitscan_turtle -Target finding addon for Turtle WoW. +Unitscan addon modified for Turtle WoW. ## Credit [Shirsig](https://github.com/shirsig/unitscan-vanilla) ## Description -This fork extends [unitscan-vanilla](https://github.com/shirsig/unitscan-vanilla) by automatically adding predefined zone targets (rare or dangerous mobs) when you enter a zone. -The mobs are included with the addon - no need to add them manually. -You can add custom targets for instance to find players by using the command /unitscan *name* (please see commands below). +This fork extends [unitscan-vanilla](https://github.com/shirsig/unitscan-vanilla) by automatically managing active scan targets (rare or dangerous mobs) when you enter a zone. -- The zone targets are set by the included [lua file](https://github.com/GryllsAddons/unitscan-turtle/blob/master/zonetargets.lua) and cannot be modified in game. -- Unitscan will only look for zone targets specific to your current zone. The target list is reloaded when you change zones. -- Zone targets will be reloaded 90 seconds after you have found a target (to re-detect roaming targets). -- Unitscan will only alert you of NPC targets that are neutral or hostile and alive. You will always be alerted for player targets regardless. -- Unitscan will not auto target the target when it is found, please click the target in the unitscan window or use the macro command below. -- A macro command */unitscantarget* has been added to target the most recently found target. -- Custom targets added by the /unitscan command will keep the default unitscan behaviour (removed from targets after they are found). -- You can move the unitscan frame by holding ctrl and dragging. +The zone targets include all rare mobs in game - please see [zone targets](https://github.com/GryllsAddons/unitscan-turtle/blob/master/zonetargets.lua) for a list of the included targets. + +You can add custom targets to find players or targets not included in the zone targets list by using the command /unitscan *name*. + +Unitscan will only look for zone targets specific to your current zone. The target list is reloaded when you change zones. + +Zone targets will be reloaded 90 seconds after you have found a target (to re-detect roaming targets). + +Unitscan will alert you of NPC targets that you can attack and are alive. + +You will always be alerted for player targets regardless. + +Targets added by the /unitscan command will be removed from active scan targets after they are found. + +You can move the unitscan frame by holding ctrl and dragging. + +**Please note unitscan-turtle will not auto target the target when it is found.** +**Click the target in the unitscan window or use the macro /unitscantarget to target the mob.** ## Commands **/unitscan** *lists the active scan targets* -**/unitscan name** *adds/removes **name** to/from the scan targets* +**/unitscan name** *adds/removes **name** to/from the active scan targets* **/unitscantarget** *targets the most recently found target* ## Updating Zone Targets