DOTD Script Guide

by cryophallion with Matpmar and Steendor

tinyurl: http://tinyurl.com/dotd-script-guide-html

Also available here: http://leon-dotd.clanteam.com/guides/3-Kong+Script+Guide.htm

The Basics

What is the script?

Where can I get the script?

How do I install it?

How do I use it?

Any other changes to the main chat window?

Why can’t I see any raids in my [in-game] new raids tab?

What are the limitations?

Oh, and one more thing....

Using the Raid Tab

Where do I start?

What does Filtering do?

What does Sorting do?

What do the Actions do?

Selections

Buttons

Using the Pastebins Tab

How to Prune

How to Create Pastebins

Using the Options Tab

Unvisited Raid Pruning

Using the Sharing Tab

Sharing

Importing

Using the Filtering Tab

My God, it’s full of checkboxes...

What is the point of this tab?

Applicability of filters

Filters

Final Thoughts

The Basics

What is the script?

The script is an add-on for most popular browsers that greatly simplifies your ability to gather, filter, and join raids. The vast majority of higher level players use it, as it is a massive time-saver.

Its current revision was built by wpatter6 and JHunz, and it is written in javascript.

Where can I get the script?

http://userscripts.org/scripts/show/140080

How do I install it?

Depends on your browser. Look at the instructions on the script’s web page. I know you need to install Greasemonky from the Add-ons in Firefox. Tampermonkey or installing it natively can be done for Chrome. IE is right out. As cryo is a web developer, he tends to shudder at the thought of using IE, and may go crying into the corner if you don’t install a better browser (if you can; corporate IT insanity is not your fault, but causes cryo to go into spasms if he thinks about it too much).

How do I use it?

After it is installed, you will likely need to refresh the browser tab or restart the whole browser. After that there will be a new tab in the Kong chat window: “Raids”. This is the where you access the script raid portions of the script.

Highlighted on the picture is the “Raids” tab.

Additionally, you will notice that the formatting of raid links in main chat looks very different. It will list the raid name, the Fair Share (FS) and Optimal Share (OS) for the raid. You can also just click the link to join the raid, no inputting the url into the raid page required.

Any other changes to the main chat window?

There are a few really helpful commands you can use in the chat area. Simply type the command and hit enter. The script’s web page has a more comprehensive list, but these are some of the most used ones:

/reload: Will reload the game only, leaving chat intact. Especially useful when your friends are on and you just got back, and you missed a great conversation/debate/raving lunacy, but still want to do something in-game.

/clear: Clears just chat. When the raving lunacy will only make you go mad, and you want to forget.

/raid <raid name> <difficulty number(optional)>: This will display info in the main chat on the raids that match your raid name string. You can use full names such as “erebus the black” or partial names such as “lair” or “wex”. If multiple raids match, all will be displayed. Difficulty number means 1 for Normal raids all the way to 4 for Nightmare raids.

/ad: Posts the url for the script into chat.

/mute <username>: Pseudo-mutes the user. You won’t have to read their messages, but their raids are still added to the script.

/unmute <username>: This should be rather self-explanatory.

/stop: Stops posting of raid trains to the chat window. Handy for when you hit post instead of paste or join, or when you just want to give out a few raids.

Why can’t I see any raids in my [in-game] new raids tab?

Long story short, because you might still need to join them, or you need to refresh the raids. The next section of this guide will elaborate.

What are the limitations?

Long story long, the script is completely separate from the game. The script maintains its own raid list, and generally has no idea what is happening within the game. Aside from basic raid knowledge like max hp, total duration, and damage levels, the script doesn’t know much. It can’t tell you how much hp remains or how much time remains. Only when you use the script to join a raid will the script learn something about the raid, and the only thing it can learn is whether the raid is alive or dead at that time. It is important to reiterate this: the script cannot track raid status in real-time; it only knows the raid’s alive-or-dead status at the time you try to join it.

Oh, and one more thing....

There is a preset option that we recommend turning off. It will reload the game window every time you open raid link. This is really annoying when you are auto-joining a lot of raids and are doing other things in the game. We recommend you go to the script Raids tab, click the options tab, and uncheck “Refresh game to join raids”. This will let you do a mass auto-join without reloading the whole game. You can even do other things in-game while you wait. Since the game doesn’t reload, you will need to click the refresh button on the in-game raids tab to update the new raids list.

Using the Raid Tab

Where do I start?

When you first open the tab, you will see a few text filtering options, some buttons, and a list of raids that have been posted into chat or imported from pastebins (pasties). This is your main window. You can click on the listed raids and see information such as when it was posted, who posted it, and the FS and OS for the raid.

Raids galore! But I don’t want Tyrs or Cais right now...

What does Filtering do?

A lot of times you are looking for specific type of raid. Whether it be a specific crafting item, a lower level raid when you are a beginner, or even a specific zone of raids for farming. Click on the Raid Filtering text, and you will see a dropdown with the options. The top option is the most common. Typing in a keyword into the textbox will filter the raids listed below to only show the raids that match. More keywords may be added separated by commas or vertical bars -- this will work by showing raids that match any of the provided terms. You can additionally select a raid difficulty by using the select dropdown next to the textbox.

There are a whole variety of keywords. The most obvious is a string that matches a specific raid (you don’t have to type it all in, like with the /raid chat command). There are several other specific keywords as well. For example, z1 through z10 will show any raids from those zones, farm will return raids most frequently used for SP farming.

What does Sorting do?

Well, it sorts the raids. Honestly, most users never touch it. It can be handy to get the newest raids at the top I guess, but other than that, filtering does most of this for you already.

What do the Actions do?

The actions do quite a bit. Used with filtering, this is where the script is really powerful.

Selections

This is where you will filter a bit more.

All Raids: Overrides the filter, if you are too lazy to clear the text.

Visible/Hidden/Both: Visible is raids shown in the list below. Hidden is the raids not currently shown. So, this will basically let you filter out the raids listed in filtering. Both is the same as All Raids. You will generally leave this at Visible.

Visited/New/Both: Visited raids are ones that you have previously joined (this includes ones you joined, but x-ed out of in game, so sometimes you may want to rejoin this in-game, such as after leveling and you are out of other options for farming). New raids are ones you have not joined yet. Visited is good for when you want to rejoin some raids you x-ed out of or for pruning. New is good when you are looking for raids you haven’t hit yet. Both is obviously all raids, and is great for pruning.

Alive/Dead/Both: Well, this is a bit pointless if dead raids are auto-cleared. And if you have pruned, dead raids are not posted to pastebins or chat anyway. So, frankly, I have never used this option, since it doesn’t appear to help with pruning.

Update: current versions of the script now have this selection removed due to a new way of storing the dead raids.

Buttons

Join: Joins all selected raids. Also called autojoin. This is wonderful for getting a bunch of raids into your new raids tab in-game for farming. This is also how raids are pruned, as you have to rejoin raids to see if they are dead. Please, we beg you, prune your raids by trying to rejoin them before you share, post, or paste them. It may seem like a hassle, but in the long run, everyone benefits when you do this. It also helps keep your own script tab clean and up-to-date.

Share: Adds raids to the Share tab in the Script tabs. This is handy when you want to whisper a few raids to someone, instead of clogging up chat with repeat raids, say if someone just missed a train. More on sharing can be found later in this document.

Post: Posts the selected raids to chat. If more than one, it is known as a train. There should be some rules on trains. If you are just helping out one person looking for a more rare raid, limit the links to less than 5, whisper them, or make them a pastebin. If it is a very common raid type, and they are mostly new to the room (like room hopping trains, as players like Oracle do), then train away, but also provide a pastebin link. Otherwise, it is preferred you use a pastebin for raids grabbed within the room. Some people may not have the script to import, but if they ask, you can give them a whisper train or just post a few of the newer ones to chat.

Paste: Puts the selected raids into the pastebin link that is set in the Options tab. More on pastebins can be found later in this guide.

Delete: Deletes selected raids. Pretty self-explanatory. I tend to keep most raids around to help people who are looking for the odd item, but some people really don’t want certain raids in their database. Also helpful if you don’t have dead raids auto-removed.

Using the Pastebins Tab

The pastebins tab is where pastebins get stored. These default to being sorted by bookmarked, imported, then unimported. This can be adjusted in the pastebins sorting area.

The star next to a pastebin will let you bookmark a pastebin. Please note that some pastebins expire so there are not too many dead raids floating around, so only bookmark pastebins you know are regularly updated.

The name of the pastebin is the username of who posted the pastebin, and the timestamp of when it was seen by the script. Then you can import or delete the pastebin as well. (Note: deleting the pastebin from this list does not delete any raids that were imported from it.)

How to Prune

Pruning is the act of removing dead or otherwise useless raid links. The script will automatically remove links that it discovers to be dead, but the discovery process requires action on your part. It is absolutely essential that before you share raids, you should prune them. You may think it’s a hassle, because after all, the script automatically removes dead links. The problem with that line of reasoning is that when you share a dead raid, everybody has to send a request to the game server to find out if it’s dead. (This increases server lag!) If you take the time to prune, only one request has to be made—yours. Also, by pruning dead raids now, you reduce the likelihood of those raids finding their way back to your script. So, in the long run, everybody benefits—even you.

Once you have decided which raids you intend to share with the world, and configured your selections appropriately, you need to [re-] join them. While the script is joining raids, it will prune any useless links it encounters. When the join process is finished, you can share your raids with everyone. (If you are including raids you have not yet visited, you need to know that it will flood your in-game raid list. For this reason, it is recommended that you share raids that interest you personally.)

How to Create Pastebins

Please prune your raids first!

Creating pastebins is a relatively simple process. First, go to pastebin.com and create an account. Once logged in, click “Create a new paste” in the header of the page. A pastebin cannot be empty, so a lot of times I will just add one raid in by right-clicking the raid in the raid page and copying it to the clipboard, then pasting it into the pastebin. Then save it, setting any expiration options you may want. Then go to the Options tab of the script, and input the pastebin url into the textbox in the Pastebin settings area (you may need to minimize the chat and raid settings to see this). Now when you click the Paste button in the raid actions area of the raids tab, the raid urls you have selected will all be uploaded to your pastebin. Post the pastebin url into chat, and you have completed your pastebin!

NOTE: This is not the only way to create a pastebin, but it is the recommended way. If you are reusing your pastebin, this method should replace the old contents entirely. If you use some other method, please find a way to ensure your pastebin has at most very few dead raids.

Using the Options Tab

The main option that people commonly change, refresh, has already been highlighted. The rest are rather self explanatory, and are largely set up fine for most people. Asynchronous raid joining is faster, but way more process intensive and puts much larger strain on the bandwidth -- as a result it can make your whole browser unresponsive. Raid joining is relatively fast enough anyway (and if you don’t overload your browser you can still chat while the script does its job slowly but surely). The only other one that some players use is hiding seen or visited raids in chat, as it cuts down on seen spam from people who think it is really fun to post the same raid constantly (hint: it’s not. Please don’t repost a raid more often than every 15-20 min if you want new people to see it, and don’t want to get on the bad side of the other players in the room).

Unvisited Raid Pruning

This will automatically remove raids that you don’t join. (It is not unlike pruning raids in preparation for sharing, but this is fully-automatic.) The options let you control how long they can linger before they are removed. This is mostly a personal preference, but you probably don’t want to set it to “Aggressive” unless you plan to keep your eyes glued to the screen. If you prefer that raids never get removed automatically, set it to “None,” but be prepared for extreme slowdowns as the list grows.

Using the Sharing Tab

This tab actually serves two functions: either sharing or importing raids.

Sharing

Please prune your raids first!

To share raids you need to make sure they are properly formatted in the text field first and then click the “Post Links to Chat” button. This will keep posting all the necessary messages automatically at just the right pace as to not trigger the automatic Kongregate spam detection blocker -- for this reason it’s advised not to chat while sharing raids as this might and probably will trip the blocker and some of your messages will not show. You can stop sharing links at any time by clicking the “Cancel Posting” button, or using /stop command in chat.

Properly formatted list is either a list of rally-cry links separated by commas or semicolons (and possible spaces, tabs, etc.) or a result of clicking “share” button in raid actions of the “raids” tab.

By default the script will simply post one link after another with no additional information and in the same order as in the text field. This is recommended only if you post a handful of raids. You may also select either “simple formatting” which will prepend each link with the raid’s difficulty and short name, or “counting and sorting” which will group all raids of the same type into numbered lists. Rarely this can make the text too long, and post the raid link incorrectly.

Finally you can choose to send all the raids only to specific person by selecting “whisper to” box and typing the full name of the Kongregate user you wish to send the links to.

Importing

There are only two buttons in Importing. “Import to Raid Tab” will read all the raids from the text field as if reading an outside pastebin. Because of that any formatting that is allowed in pastebins will also work when using this option. Furthermore it is possible to import a pastebin using its URL here -- you just need to paste/type it in the text field and click “Import”.

The other button is “Delete and Import”. It will work exactly the same as regular import, except it will clear out all of the raids the script currently keeps in memory before importing new ones. Use with caution. This is useful when trying to clean out invalid raids if the script isn’t doing it properly.

Using the Filtering Tab

My God, it’s full of checkboxes...

This tab is certainly for people who love clicking their mouse. If you are relatively new to the game you might spend quite some time looking through the options listed in this tab only to learn that you don’t actually need to change anything. Default options set here are what you want to keep until you are sure you want to change them.

What is the point of this tab?

We’ve already covered filtering in the “Raids” tab. You might wonder why have more filters on top of filters? This system is set up in case you need to go deeper -- the filters set up here can exclude all raids you don’t care to see/join and hide them from your sight. If you ever feel like you don’t want to see some certain raids (of certain difficulties) posted in the chat, or even automatically exclude them from all your searches in the “Raids” tab, then you might want to visit this tab and tweak some options. Optionally, if you want to see guild raids posted in chat, then you also need to adjust filtering options since they’re disabled by default.

Applicability of filters

Currently there are two checkboxes that control where filters selected below will be applied. Choosing “Activate filtering on raid links” will hide all raids that are filtered here from appearing in chat, while “Activate filtering on raid list tab” will filter out said raids from any search results in your “Raids” tab.

Filters

Below those options is a series of drop-downs and clicking any of those will show a wide array of checkboxes. Each row corresponds to different raid, while each column corresponds to a difficulty level. By toggling the checkbox you can switch the filtering of the raid: box checked -- raid visible, box unchecked -- raid filtered out. Clicking the “All” checkbox will switch all boxes in the row on or off so that they match it.

Final Thoughts

That should cover the vast majority of use cases for the script. If you want further details, then we recommend visiting the script website (again, at http://userscripts.org/scripts/show/140080) and looking for more info there. The script certainly makes life easier for most players, and we highly recommend exploring it.

If you have any further questions, or have more information you would like to see included, please find one of us in chat room 5 (cryophallion, Matpmar, and Steendor), and we’d be happy to assist you further.