Difference between revisions of "Virindi Tank Standard Options"

From VirindiPlugins
Jump to: navigation, search
(Meta tab)
(Route tab)
 
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
==Options tab==
 
==Options tab==
[[Image:Vtank_Main.jpg]]
+
[[Image:Vtank_Main.PNG]]
  
* '''Advanced options''': Displays the advanced options list, allowing control of all internal macro variables.
 
* '''Run macro''': Enables macro action. Since VTank is always thinking, turning it On/Off functions more like a Pause.
 
  
 +
* '''Advanced Options''': Displays the advanced options list, allowing control of all internal macro variables.
 +
* '''Run Macro''': Enables macro action. Turning tank On/Off functions more like a Pause.
  
*'''Force Buff''': Use this to force a rebuff, turn the macro On/Off to Pause the buffing sequence, it will resume where it left off.
 
* '''Monster range''': The maximum range at which the macro will attempt to engage targets.
 
* '''Ring range''': The range that ring damage is expected to carry.
 
* '''Approach range''': When navigation is enabled, the macro will run towards a monster that is within approach range until it is within monster range.
 
* '''Follow/Nav min''': The range from a waypoint at which the macro considers the waypoint to be reached.
 
  
 +
*'''Force Buff''': Use this to force a rebuff, turn the macro On/Off to Pause the buffing sequence, it will resume where it left off
 +
*'''Cancel Force Buff''': Cancels a Force Buff sequence.
  
* '''Use dispel items''': Causes the macro to use Gems of Stillness and/or Condensed Dispel Potions when a level 7 vuln is present on your character.
+
 
* '''Cast dispel self''': Causes the macro to cast Eradicate Life Magic Self when a level 7 vuln is present on your character.
+
* '''Monster Range''': The maximum range at which the macro will attempt to engage targets.
* '''Enable buffing''': Enables the buffing subsystem. When this is disabled, no self buffs will be cast.
+
* '''Ring Range''': The range that ring damage is expected to carry.
* '''Enable combat''': Enables macro combat. When this is disabled, the macro will not attack or debuff targets. HOWEVER, the macro will continue to heal itself, navigate, and loot.
+
* '''Approach Range''': When navigation is enabled, the macro will run towards a monster that is within approach range until it is within monster range.
* '''Auto Fellow Mgmt.''': Automatically Recruits when /t XP. See [[Virindi Tank Fellowship Commands]]
+
* '''Follow/Nav Min''': The range from a waypoint at which the macro considers the waypoint to be reached.
 +
 
 +
 
 +
* '''Enable Buffing''': Enables the buffing subsystem. When this is disabled, no self buffs will be cast.
 +
* '''Enable Combat''': Enables macro combat. When this is disabled, the macro will not attack or debuff targets. HOWEVER, the macro will continue to heal itself, navigate, and loot.
  
  
 
* '''Enable Autostack''': Automatically stacks stackable items in your inventory.
 
* '''Enable Autostack''': Automatically stacks stackable items in your inventory.
 
* '''Enable Autocram''': Automatically moves items from your main pack to side packs.
 
* '''Enable Autocram''': Automatically moves items from your main pack to side packs.
* '''Rebuff when idle''': Causes the macro to recast buffs that are running low early, when it is not doing anything else. This prevents buff timers from running out in the middle of combat.
+
* '''Use Dispel Items''': Causes the macro to use Gems of Stillness/Condensed Dispel/Society Dispel/Black Potions when a level 7 vuln is present on your character.
* '''Peace mode when idle''': Switches to peace mode when not attacking. Usually used to improve regeneration rates when waiting for a respawn.
+
* '''Cast dispel self''': Causes the macro to cast Eradicate Life Magic Self when a level 7 vuln is present on your character.
* '''Boost loot priority''': Loots corpses before attacking the next monster. Use this option when you care more about loot than kills, and you are not able to clear the spawn fast enough to finish looting everything.
+
 
 +
 
 +
* '''Auto Fellow Mgmt.''': Automatically Recruits when /t XP. See [[Virindi Tank Fellowship Commands]]
 
* '''M. Charges when off''': Allows Vtank to recharge Mana on items even if Vtank is Off.
 
* '''M. Charges when off''': Allows Vtank to recharge Mana on items even if Vtank is Off.
 +
 +
 +
* '''Boost Nav. Priority''': Causes the macro to navigate before attacking.
 +
* '''Boost Loot Priority''': Loots corpses before attacking the next monster. Use this option when you care more about loot than kills, and you are not able to clear the spawn fast enough to finish looting everything.
 +
* '''Peace Mode When Idle''': Switches to peace mode when not attacking. Usually used to improve regeneration rates when waiting for a respawn.
 +
* '''Rebuff When Idle''': Causes the macro to recast buffs that are running low early, when it is not doing anything else. This prevents buff timers from running out in the middle of combat.
 +
 +
 +
* '''Summon Pets''': Enables the SummonPets advanced option
 +
* '''Custom Pet Range''': When Enabled, summons pets at the custom range rather than Monster Range
 +
* '''Pet Min. Monsters''': The minimum number of allowed pet targets within pet range before a pet is summoned. (based on either Monster Range or Custom Pet Range)
  
 
== Profiles tab ==
 
== Profiles tab ==
[[Image:Vtank_Profiles.jpg]]
+
[[Image:Vtank_Profiles.PNG]]
  
 
''Whenever any setting is changed in Virindi Tank, it is immediately saved to the current profile (unless the current profile is default, which cannot be changed).
 
''Whenever any setting is changed in Virindi Tank, it is immediately saved to the current profile (unless the current profile is default, which cannot be changed).
Line 47: Line 61:
  
 
== Vitals tab ==
 
== Vitals tab ==
[[Image:vtguide-vitals.png]]
+
[[Image:Vtank_vitals.PNG]]
  
 
'''Top-off levels
 
'''Top-off levels
Line 57: Line 71:
  
 
== Monsters tab ==
 
== Monsters tab ==
[[Image:Monsters.PNG]]
+
[[Image:Vtank_monsters.PNG]]
  
 
This list defines what you want to do with each monster. You can put monster names in here, or define [[Virindi Tank Monster List Matching|Monster Expressions]].
 
This list defines what you want to do with each monster. You can put monster names in here, or define [[Virindi Tank Monster List Matching|Monster Expressions]].
Line 83: Line 97:
 
* '''Weapon''': The Weapon/Caster to use if added to the Items tab.
 
* '''Weapon''': The Weapon/Caster to use if added to the Items tab.
 
* '''Offhand''': the offhand weapon or shield, for melees.
 
* '''Offhand''': the offhand weapon or shield, for melees.
 +
* '''PetDmg''': Sets the elemental pet type to be summoned
  
 
== Items tab ==
 
== Items tab ==
[[Image:Vtank_Items.jpg]]
+
[[Image:Vtank_items.PNG]]
  
 
* '''Add''': Select an item in your inventory and press this button.
 
* '''Add''': Select an item in your inventory and press this button.
Line 93: Line 108:
 
'''Combat items go here. Allowed types include:
 
'''Combat items go here. Allowed types include:
  
* '''''Wands/Staves/Orbs
+
* ''Wands/Staves/Orbs
* '''''Melee Weapons
+
* ''Melee Weapons
* '''''Missile Weapons
+
* ''Missile Weapons
* '''''Shields
+
* ''Shields
 +
* ''Pets
  
 
== Consumables tab ==
 
== Consumables tab ==
[[Image:Vtank_Consumables.jpg]]
+
[[Image:Vtank_consumables.PNG]]
  
 
'''Types of Items the macro can use during the course of play:<br>
 
'''Types of Items the macro can use during the course of play:<br>
Line 112: Line 128:
  
 
== Buffs tab ==
 
== Buffs tab ==
[[Image:Vtank_Buffs.png]]
+
[[Image:Vtank_buffs.PNG]]
  
 
''By default, Virindi Tank automatically buffs every Attribute and Skill you have trained, as well as every Protection and Bane.
 
''By default, Virindi Tank automatically buffs every Attribute and Skill you have trained, as well as every Protection and Bane.
Line 118: Line 134:
  
 
* '''Use this tab to buff an additional skill you do not have trained, such as leadership.
 
* '''Use this tab to buff an additional skill you do not have trained, such as leadership.
* '''To modify the protections and banes that are cast, see entry #2.6 in the [[Virindi Plugins FAQ]].
+
* '''To modify the protections and banes that are cast, see entry #2.7 in the [[Virindi Plugins FAQ]].
  
 
== Route tab ==
 
== Route tab ==
[[Image:vtguide-route-new.png]]
+
[[Image:Vtank_route.PNG]]
  
 
'''The following types of routes are supported:
 
'''The following types of routes are supported:
Line 136: Line 152:
 
* '''Open Vendor''': Opens selected/named Vendor.
 
* '''Open Vendor''': Opens selected/named Vendor.
 
* '''Add Portal/NPC''': Opens/Uses selected Portal or NPC.
 
* '''Add Portal/NPC''': Opens/Uses selected Portal or NPC.
 +
* '''Add NPC Talk''': Tries to use an NPC until it sees a "tell" message from them.
 
* '''Add Recall''': Adds a recall waypoint to the waypoints list.
 
* '''Add Recall''': Adds a recall waypoint to the waypoints list.
 
* '''Add Pause''': X Seconds to add pause to Navroute.
 
* '''Add Pause''': X Seconds to add pause to Navroute.
* '''Add Chat''': / commands. (/ls for example)
+
* '''Add Chat''': / commands. (/ls for example) You can input any type of chat or /command, including other plugin commands.
  
  
'''''Command Line Commands:
+
'''Editing routes:
  
* '''/vt nav save filename - Saves the current waypoint list as a new navigation profile.
+
* Select the dropdown menu at the bottom of the page and select from "'''Add to End'''", "'''Insert Above'''", or "'''Insert Below'''"
* '''/vt nav load filename - Loads a navigation profile.
+
* Use the curly green arrow to set the current waypoint [[image:GreenTurnDownArrow.PNG]] ‎, or the up/down red and green arrows to change it.
* '''/vt addnavpt coords - Adds a navigation waypoint at the specified coordinates to the end of the current navigation profile
+
* Add your new waypoint
 
 
 
 
''Example Route:
 
  
''* [http://www.virindi.net/junk/Aerbax.nav Aerbax (The silly long tunnel)] - Right-click, Save-as. Place the file in your Virindi Tank folder inside the Virindi Plugins folder.
 
  
== Meta tab ==
+
'''Command Line:
[[Image:vtguide-meta.png]]
 
  
 +
  '''/vt nav save filename - Saves the current waypoint list as a new navigation profile.
 +
  '''/vt nav load filename - Loads a navigation profile.
 +
  '''/vt addnavpt coords - Adds a navigation waypoint at the specified coordinates to the end of the current navigation profile
 +
  '''/vt addnavcheckpoint - Adds a checkpoint waypoint at the current location. Checkpoints wait for the server to verify your location before continuing.
 +
  '''/vt jump [heading in degrees] [shift: true or false] [milliseconds to charge the power bar (0 is minimum, 1000 is maximum)]
 +
  '''/vt addnavjump [heading] [shift] [charge]
 +
  '''/vt addnavjump [heading] [shift] [charge] [strafeleft/straferight/forward]
 +
  '''/vt reverseroute [true/false] - Reverses the currently loaded navroute
 +
  '''/vt reverseroutequery - Returns the value of /vt reverseroute (true/false)
  
'''Options available: "Actions" (Left Side)
+
  '''example: "/vt jump 360 true 500 strafeleft"
  
* '''Never''': Never act upon.
 
* '''Always''': Always act upon.
 
* '''Any''': Act upon any.
 
* '''All''': Act upon all.
 
* '''Chat Message''': Act upon Chat Message.
 
* '''Pack Slots <=''': Act upon Pack Slots less than or equal to X.
 
* '''Seconds in State >=''': Act upon Seconds in State greater than or equal to X.
 
* '''Navroute Empty''': Act upon an empty Navroute.
 
* '''Character Death''': Act upon Character Death.
 
* '''Any Vendor Open''': Act upon Any Vendor Opened.
 
  
 +
''Example Route:
  
'''Options available: "Reactions" (Right Side)
+
''* [http://www.virindi.net/junk/Aerbax.nav Aerbax (The silly long tunnel)] - Right-click, Save-as. Place the file in your Virindi Tank folder inside the Virindi Plugins folder.
  
* '''Set Meta State''': Allows you to set/change Meta state after X Action has occurred.
+
== Meta tab ==
* '''Chat Command''': On Action do X Chat Command. (I.e. On Character Death do Chat Command /f I have died =( )
 
* '''All''': Allows multiple Reactions to Occur.
 
  
 +
See [[Virindi_Tank_Meta_System| Virindi Tank Meta System]]
  
'''Context/Variables available''': (Need a Variable list)
+
=== Introduction ===
  
* Reminds me of Tasker for Android
+
The Virindi Tank Meta system is a way to control what the macro is doing on a higher level than normal operations. The system allows you to implement a [http://en.wikipedia.org/wiki/Finite-state_machine Finite-state machine]. This machine consists of rules and states. For Meta to operate, the Enable Meta Actions checkbox on the Profiles tab must be checked.

Latest revision as of 13:23, 8 September 2016

Options tab

Vtank Main.PNG


  • Advanced Options: Displays the advanced options list, allowing control of all internal macro variables.
  • Run Macro: Enables macro action. Turning tank On/Off functions more like a Pause.


  • Force Buff: Use this to force a rebuff, turn the macro On/Off to Pause the buffing sequence, it will resume where it left off
  • Cancel Force Buff: Cancels a Force Buff sequence.


  • Monster Range: The maximum range at which the macro will attempt to engage targets.
  • Ring Range: The range that ring damage is expected to carry.
  • Approach Range: When navigation is enabled, the macro will run towards a monster that is within approach range until it is within monster range.
  • Follow/Nav Min: The range from a waypoint at which the macro considers the waypoint to be reached.


  • Enable Buffing: Enables the buffing subsystem. When this is disabled, no self buffs will be cast.
  • Enable Combat: Enables macro combat. When this is disabled, the macro will not attack or debuff targets. HOWEVER, the macro will continue to heal itself, navigate, and loot.


  • Enable Autostack: Automatically stacks stackable items in your inventory.
  • Enable Autocram: Automatically moves items from your main pack to side packs.
  • Use Dispel Items: Causes the macro to use Gems of Stillness/Condensed Dispel/Society Dispel/Black Potions when a level 7 vuln is present on your character.
  • Cast dispel self: Causes the macro to cast Eradicate Life Magic Self when a level 7 vuln is present on your character.


  • Auto Fellow Mgmt.: Automatically Recruits when /t XP. See Virindi Tank Fellowship Commands
  • M. Charges when off: Allows Vtank to recharge Mana on items even if Vtank is Off.


  • Boost Nav. Priority: Causes the macro to navigate before attacking.
  • Boost Loot Priority: Loots corpses before attacking the next monster. Use this option when you care more about loot than kills, and you are not able to clear the spawn fast enough to finish looting everything.
  • Peace Mode When Idle: Switches to peace mode when not attacking. Usually used to improve regeneration rates when waiting for a respawn.
  • Rebuff When Idle: Causes the macro to recast buffs that are running low early, when it is not doing anything else. This prevents buff timers from running out in the middle of combat.


  • Summon Pets: Enables the SummonPets advanced option
  • Custom Pet Range: When Enabled, summons pets at the custom range rather than Monster Range
  • Pet Min. Monsters: The minimum number of allowed pet targets within pet range before a pet is summoned. (based on either Monster Range or Custom Pet Range)

Profiles tab

Vtank Profiles.PNG

Whenever any setting is changed in Virindi Tank, it is immediately saved to the current profile (unless the current profile is default, which cannot be changed).


  • Macro Settings: Your current settings file that is active, can be changed using dropdown.
    • [By char]: Creates a profile for that character only, same as Toggling Mine Only.
    • [Char]: Character Only Profile.
    • To create a new profile, click save as, enter a new profile name (no spaces), and then change the settings appropriately.
  • Mine Only: Profile created only for that specific character.
  • Enable Auto-Navigation: Toggles Navigation on/off. Routes are Created on the Route Tab, and Saved on the Profile Tab.
  • Enable Looting: Toggles Looting on/off. Profiles are created using the VT Classic Looter or Using the Alinco3 connector File.
  • Show Editor: No Function/Depreciated.


Usage for Alinco3 Connector File:

/vt loot new Alinco.los

Vitals tab

Vtank vitals.PNG

Top-off levels

  • Levels to which the macro will recharge when there is no active combat target.


Note**
For helper to work, your Fellow Panel must be open, or be joined in a Virindi Integrator 2 fellowship.

Monsters tab

Vtank monsters.PNG

This list defines what you want to do with each monster. You can put monster names in here, or define Monster Expressions.

The columns mean the following:

  • F: Fester.
  • B: Broadside of a Barn.
  • G: Gravity Well.
  • I: Imperil.
  • Y: Yield.
  • V: Vuln.
  • A: Primary attack (aka war). Causes the monster to be attack via the primary attack method of the chosen weapon: war for wands, melee for melee weapons, etc. If this is not selected, the macro will debuff only unless the R box is checked (see below).
  • R: Ring. If WR are both selected, the macro will ring when 4 or more monsters are within ring range. If R is selected but not W, the macro will ring as long as any R monster is within ring range, but if no monsters are within ring range it will use standard war on ones outside of ring range.
  • S: Streak.
  • WC: Weakening Curse.
  • FC: Festering Curse.
  • Cp: Corruption.
  • DC: Destructive Curse.
  • Cs: Corrosion.
  • P: Priority. Priority -1 means ignore completely, while 0-4 are attack. (Higher Number = Higher Priority)


  • Damage Type: The Damage Type you would like to use, or set to <Auto> to have Vtank Decide.
  • Ex. Vuln: An additional element vuln of a user-specified type that will be cast in addition to the listed spells.
  • Weapon: The Weapon/Caster to use if added to the Items tab.
  • Offhand: the offhand weapon or shield, for melees.
  • PetDmg: Sets the elemental pet type to be summoned

Items tab

Vtank items.PNG

  • Add: Select an item in your inventory and press this button.
  • Add (No Buffs): To add the selected Item and have Vtank skip it when buffing.


Combat items go here. Allowed types include:

  • Wands/Staves/Orbs
  • Melee Weapons
  • Missile Weapons
  • Shields
  • Pets

Consumables tab

Vtank consumables.PNG

Types of Items the macro can use during the course of play:

  • Items the macro uses to cast buffs on you such as beers and foodstuffs.
  • Healing kits, stamina kits, healing foods, stamina foods, potions, etc.
  • Mana charges/mana stones
  • Alchemical grenades
  • Spell components for which peas should be split
  • Lockpicks for auto picking doors

Since all buff spells are recast when they go below 5 minutes, buff items that last less than 5 minutes are not allowed.

Buffs tab

Vtank buffs.PNG

By default, Virindi Tank automatically buffs every Attribute and Skill you have trained, as well as every Protection and Bane.


  • Use this tab to buff an additional skill you do not have trained, such as leadership.
  • To modify the protections and banes that are cast, see entry #2.7 in the Virindi Plugins FAQ.

Route tab

Vtank route.PNG

The following types of routes are supported:

  • Circular Route: Plugin traverses waypoints in the order ABC-ABC.(After last waypoint, will return to first waypoint)
  • Linear Route: Plugin traverses waypoints in the order ABC-CBA. (Will run back and forth from beginning to end)
  • Follow Route: Follows another Player.
  • Once Route: Runs a route just once. (Good for ToVendor/ToDungeon routes.)


Buttons:

  • Add: Adds the current location or selected portal as a waypoint, unless Follow mode is selected, in which case the follow target is set to the current selection.
  • Open Vendor: Opens selected/named Vendor.
  • Add Portal/NPC: Opens/Uses selected Portal or NPC.
  • Add NPC Talk: Tries to use an NPC until it sees a "tell" message from them.
  • Add Recall: Adds a recall waypoint to the waypoints list.
  • Add Pause: X Seconds to add pause to Navroute.
  • Add Chat: / commands. (/ls for example) You can input any type of chat or /command, including other plugin commands.


Editing routes:

  • Select the dropdown menu at the bottom of the page and select from "Add to End", "Insert Above", or "Insert Below"
  • Use the curly green arrow to set the current waypoint GreenTurnDownArrow.PNG ‎, or the up/down red and green arrows to change it.
  • Add your new waypoint


Command Line:

 /vt nav save filename - Saves the current waypoint list as a new navigation profile.
 /vt nav load filename - Loads a navigation profile. 
 /vt addnavpt coords - Adds a navigation waypoint at the specified coordinates to the end of the current navigation profile
 /vt addnavcheckpoint - Adds a checkpoint waypoint at the current location. Checkpoints wait for the server to verify your location before continuing. 
 /vt jump [heading in degrees] [shift: true or false] [milliseconds to charge the power bar (0 is minimum, 1000 is maximum)]
 /vt addnavjump [heading] [shift] [charge]
 /vt addnavjump [heading] [shift] [charge] [strafeleft/straferight/forward]
 /vt reverseroute [true/false] - Reverses the currently loaded navroute
 /vt reverseroutequery - Returns the value of /vt reverseroute (true/false)
 example: "/vt jump 360 true 500 strafeleft"


Example Route:

* Aerbax (The silly long tunnel) - Right-click, Save-as. Place the file in your Virindi Tank folder inside the Virindi Plugins folder.

Meta tab

See Virindi Tank Meta System

Introduction

The Virindi Tank Meta system is a way to control what the macro is doing on a higher level than normal operations. The system allows you to implement a Finite-state machine. This machine consists of rules and states. For Meta to operate, the Enable Meta Actions checkbox on the Profiles tab must be checked.