Tankpal Instructions

Overview:

Tankpal is designed to run in conjunction with El-Tank. It adds extra functionality to improve your macroing experience =). Basically it started as a return to base macro when I noticed eltank walking down hills in archer mode. Over time as I noticed things that I'd like added, or other plugins that some people had trouble getting to work I've kept adding till its gone way beyond the original concept. The main functionality people will like is the looting/salvaging. This is designed to work most of the time. Occasionally a corpse wont be opened, or a piece of salvage you pick up wont be salvaged, or perhaps it will start a second bag of salvage before finishing the first. This is basically due to being extra safe about messing something up. I figure a 95% successful safe script is better than a 100% successful script that goes haywire.

Tankpal is meant to be run afk. It regularly takes over your mouse and keyboard. Its safest to not touch either of these while its running, but I would at least recommend not trying to chat ingame while its doing a loot sequence. Wait until it turns El-Tank back on before continuing your conversation.

Warning:

I've done everything possible to ensure that nothing gets salvaged that shouldn't be. Every item that gets created near you gets a unique identifier. I check that the item you click your mouse on to drag into the ust has the exact same identifier that the item you picked up off the corpse has. This is AC however, lag spikes happen, freaky stuff occurs, theres no 100% guarantee something wont mess up. Be very wary of macroing with gear that you can't afford to lose. Stuff you wear should be that much safer, but bows/wands etc that you unequip should be considered at small risk.

Installing:

 If you have not already done so, please download the latest version of Skunkworks from http://skunkworks.sourceforge.net/ and install it.

Extract the files in  Tankpal.zip and copy into the c:\program files\skunkworks\Libraries folder.

When you are ingame you just select Tankpal from the dropdown list of projects in Skunkworks and click the go button. This starts the script running and brings up a decal style panel from which you choose the options you want to run.

Options:

Main page:

• Loot: This turns the entire looting process on or off. When this is checked, then any of the loot options on the loot page will work. When unchecked it turns off all looting.
• Stay in place: Basically a Return to Base functionality. El-tank in archer mode tends to wander a bit, and if you're looting you'll almost certainly move out of position. If this is checked it will return to where you were when you started the macro (note, not where you were when you clicked it, so if you plan to use this don't start the macro until your in position).
• Accept Fellow requests: Accepts anytime someone invites you into fellow. 
• Reply to comps request: If someone messages you with "Tankpal-CompsLeft" it will respond with the number of prismatic tapers and pyreal scarabs you have using the max tapers and max scarabs values.
• Max Tapers: When you respond to a comps request it tells the requestor that this is how many you like to have.
• Max Scarabs: When you respond to a comps request it tells the requestor that this is how many you like to have.
• Reply to XP request: If someone messages you with "Tankpal-XPMade" it will respond with the experience you've earned, how long you've been running for, and how many times you've been logged off.
• Reply to Coord request: If someone messages you with "Tankpal-Location" it will respond with your coordinates. Handy as pk's sometimes use the "coords" command with El-Tank to find you.
• Obey Restart request: If someone messages you with "Tankpal-RestartEltank" it will command El-Tank to stop, wait a second or two, then command it to start again. This allows fellow hunters to restart your El-Tank if it seems stuck. Please don't abuse!
• Obey Tankpal Logout request: If someone messages you with "Tankpal-Logout" it will log you off. Handy if things have gone haywire and the best solution all around is if you were logged off. Also if you happen to end up at the LS but not logged out perhaps this can do the trick.
• Obey Disband Fellow request: If someone messages you with "Tankpal-DisbandFellow" it will cause you to disband your fellowship.

Loot page:

• Salvage: When both this and Loot on the main page are checked, it will pick up and salvage any salvagable loot items. I'll include instructions further down on how to add/subtract material types to be salvaged.
• Loot Value items: When both this and Loot on the main page are checked, it will pick up any loot items that are greater than the value set in the min value option, and who's value/burden ration is greater than that set in the min value/burden option.
• Min Value: When looting value items, will only loot items higher in value than the number entered here.
• Min Ratio: When looting value items will only loot items whos Value/Burden ratio is higher than that entered here. For example if the Min Value/Burden is 20, then a 5,000p item will only be picked up if its burden is less than 250.
• High Value: Anything at all over this value is picked up regardless of its Value/Burden ratio.
• Peas: Picks up Scarab Peas and Pyreal Scarabs.
• Trophies: Picks up trophy items such as SIKs, Little Green Seeds, Singularity Keys, etc. If you have granite keyrings it will place the SIKs on them until they're full.
• Majors: Picks up any items with a Major Cantrip. Ignores your maximum burden setting.
• Minors: Picks up any items with a Minor Cantrip. Does not ignore maximum burden setting.
• Wards only: If ticked the only Minor Cantrips it will pick up are wards.
• Maximum Percent Burden: Will stop looting value items and minor cantrips if picking them up would push your percentage burden above this amount. This is to stop peoples melee d being messed up by burden reductions. Archers please take into account fletching new arrows.
• Minimum Corpses before looting: How many corpses need to be nearby before you stop and loot. In places like the tusker camps where you can conceivably drop them one at a time at your feet, it can really hurt xp to stop after every kill to loot. However if you're roaming or in a dungeon you may just want to loot any time theres no mobs nearby.

Logoff page:

• PK Logoff: Enables the PK Logoff settings. By default it will identify any players that come nearby and if they are not tagged Sagacious or Al Krieger it will cause you to logoff.
• Log on all: If ticked will log off when any other player comes nearby without identifying them. If you have Friends List ticked it will not log out on people on your friends list.
• Shit List: If ticked and anyone on the Shit List comes nearby you will log off immediately without attempting to identify them. With the identifying changes introduced by Turbine waiting to identify someone can take too long. Read below for instructions on how to edit the list.
• Friends List: If ticked and anyone on the Friends List comes nearby you wont even try identifying them. Means if someone other than BRN or HOS hunts in your macro spot but you trust them you can add them so it wont log from them. Read below for instructions on how to edit the list.
• Log back on: If you tick this and you get logged off, at some random time between 10 and 30 minutes it will log you back on. If decal crashes the game logging out or back on it will recover and relaunch AC.
• Anti Camper: If you tick this then anytime you're logged by the same person it will stay logged off for an extra 30 mins (i.e., 10-30, 30+(10-30), 60+(10-30), etc).
• Report to IRC: If you're logged onto Dircal and have this option ticked it will message IRC with your location and who you're logging from. It appends the Location text to your message.
• Location: A text description of your location that gets sent to IRC when you get logged.
• Logoff on death: If you die it will log you out at your lifestone.
• Logoff on low comps: If your comps drop below the defined limits you will log off.
• Pris: Logoff on low comps will occur if your prismatic tapers drop below this amount.
• Lead: Logoff on low comps will occur if your lead scarabs drop below this amount.
• Gold: Logoff on low comps will occur if your gold scarabs drop below this amount.
• Pyr: Logoff on low comps will occur if your pyreal scarabs drop below this amount.
• Plat: Logoff on low comps will occur if your platinum scarabs drop below this amount.

Modifying the script:

Since this script was basically developed for my own use then distributed to guild members/allies, there are some things in it that suit me, but may not suit you. I'll give instructions here on how you can make modifications to suit yourself. You may like to backup the script first by copying it to another directory so you can copy it back if need be. To edit the script, go to your c:\program files\Skunkworks\Libraries folder, right click on the tankpal.js file and select edit. This should open the script in a text editor of some kind.

Salvage Materials:

To add or remove materials to be salvaged, scroll down through the script until you get to the function Loot() section. If you scroll down through this section you'll see a part that begins:

MatType = " ";
switch(CurrentLoot.material) {

and then goes on to list a whole lot of case materialMaterialTypes: such as:

case materialBlackOpal: 
        MatType = "Black Opal";
        Salvage(CurrentLoot, MatType);
        break;

If you want to add a material I haven't got listed, copy and paste one of the lots of 4 lines after the last material, but before the default: line. Change the case to be the material you want, and change the MatType = to be the material type you want. If you're unsure about what the materialCode is for your material, then if you go to your Skunkworks folder in the start menu of your pc (i.e., like your going to start an application), you'll see it comes with documentation. Open this and select the API constants section, then the material section. You should find the material code you want in there.

Panel Defaults:

At the moment the script has a set of defaults that suits me, but may not suit you. To change any of the defaults, edit the tankpal.js file and you'll notice right at the top a long list of lines that each start with var. and end with a comment describing what that variable is for. There is one for each option on the panel, and it should be easy to find which one you want using the name and the comment. Just change the value after the = to what you want the default to be.

Friends List:

In the code section starting with:

function MyHandlers_OnObjectCreatePlayer(aco)

scroll down to the part that begins:

if (Friends)
{

and add another case similar to the existing ones using the name of your friend. This is case sensitive!

Shit List:

In the code section starting with:

function MyHandlers_OnObjectCreatePlayer(aco)

scroll down past the friends list (see above) and go to the next list of playernames and add another case with the name of the person you want added to the shit list.

Trophies:

Basically anything you want to pick up by name. Scroll down to the part of the file that begins:

function Trophy(CurrentLoot)
{

and add the item you want. To stop picking up an item just put a // in front of the case (such as Virindi Singularity Key). To start picking up an item remove the //.