Kongregate Legacy of a Thousand Suns Raid Link Helper for Chat
Official Documentation
Last Modified: March 20, 2013
Current script version: 1.1.21 - Document currently being edited to bring it up to date
To report a bug or request a feature, you can use the privately whisper doomcat on Kongregate or publicly join the Chatzy discussion.
Script page: http://tinyurl.com/doomscript
This page: http://tinyurl.com/doomscript-docs
Table of Contents
3.1 Read this before installing
4.2.4 /raid [name] [difficulty]
4.3.1 Bookmarklets for frequently used commands
5.1 Script entirely not working
5.1.3 Make sure the script is actually installed
5.2 Raid links are not being marked visited
Kongregate Legacy of a Thousand Suns Raid Link Helper for Chat (“the script” or “doomscript”, available from http://userscripts.org/scripts/show/124753) is the majority work of doomcat (“the author”) and is offered free of charge without any guarantees or assurances that it will work as desired or described. Derivative works are allowed so long as the author is notified, and modifications may be inspected and might potentially be added as changes to this script as well. Neither the script nor the author are in any way affiliated with 5th Planet Games who owns all rights to the name Legacy of a Thousand Suns and associated intellectual property. Neither the script nor the author are in any way affiliated with Kongregate, inc. who owns all rights to the name Kongregate and associated intellectual property.
The script does not in anyway enhance, alter, or automate game play, but rather provides quick access to publicly compiled information as well as some minor cosmetic alterations to the Kongregate interface. To the best of the author’s knowledge, the script does not violate any TOS or EULA terms players must agree to before playing.
To report a bug, request a feature, or discuss the script you can privately whisper doomcat on Kongregate or publicly join the Chatzy discussion.
The script currently supports the latest versions of Firefox, Chrome, and Opera on OS X 10.5+ and Windows XP/Vista/7. You may find that the script will work on other configurations, but there are no guarantees that it will continue to work for any time in the foreseeable future, and providing troubleshooting support for such a wide variety of platforms for this product would make continued development markedly difficult. The script definitely does not work in Internet Explorer, and there are currently no plans to support it. Consider choosing a browser that supports GreaseMonkey Scripts or Userscripts.
Installation procedures vary by browser, but should be the same on Windows and OS X (and probably *nix). After correctly installing the script per the directions below, YOU MUST REFRESH YOUR GAME PAGE FOR THE SCRIPT TO TAKE EFFECT. Once installed and refreshed, using the command /w RaidBot help will display basic information about the script. If you instead receive a response like Kong Bot: RaidBot cannot be reached. Please try again later. you should refer to the Simple Troubleshooting section of this document.
To install the script in Firefox, you must:
To install the script in Chrome, you must:
To install the script in Opera, you must:
The script has been confirmed not to work in Internet Explorer, and it’s unlikely to be supported in the future. Since Safari is not altogether unlike Chrome internally, there’s a non-zero chance that the script could work there, though it’s been suggested that you’ll need some additional software to get Safari user scripts running. If you find the script working, partly working, or totally broken in any other browsers, feel free to report them so we at least know what works and what doesn’t.
Script usage is relatively simple as of version 1.1.21. Kongregate allows the use of / commands (“slash commands”) to execute user actions. Without any special scripts, Kongregate offers /afk, /back, /invite, /kick, /msg, and /w. These commands are executed by typing them into the chat box and pressing enter as if to send the command as a message, similar to how most IRC clients handle commands. The script adds 28 additional commands:
/autoupdate [on/off]
/checkload
/clearchat
/clearraids all/filter
/exportraids [filter]
/farmvalue
/fetchraids url [filter]
/linkstate url [newState]
/linktools
/loadall [filter]
/loadcconoly [filter]
/loadpastebin url [filter]
/loadraid url
/markall [filter] state
/pasteraids [filter]
/raid [raidName] [raidDifficulty]
/raidformat [newFormat]
/raidhelp
/raidstyle style
/refreshlinks
/reload
/seenraids [filter]
/time
/update
/updateraiddata
/version
/wiki query
These commands can also be whispered to the RaidBot to ensure that typographical errors don’t make it into public chat like /w RaidBot seenraids tele 1. In addition to the added commands, the script also:
The command format is shown below as /command reqParam1 reqParam2 [optParam1] [optParam2] where reqParams are required to make the command work, and optParams may be omitted. All commands can take the parameter help, as in /seenraids help, to get more info about that command.
Sets whether or not doomscript should automatically check for updates.
where toggle (optional) is on or off
If [on/off] is omitted, then the current status of on or off will be shown
If there is an update to install and autoupdate is on, then when the page loads, a bar will appear at the top of the screen offering the option to update.
Default: on
Required Parameters: None.
Optional Parameters:
[on/off]- Should be on or off. If omitted, this command will tell you the current setting of autoupdate.
Aliases: None
While a large load is running, for example from /lcc or /lpb, use this command to check the progress of said load.
Required Parameters: None.
Optional Parameters: None.
Aliases: None
The clear chat command will remove all current messages and links from the chat window. It has no affect on your seen raids in memory, however.
Required Parameters: None.
Optional Parameters: None.
Aliases: /cc, /cls
The clear raids command will clear raids from the scripts memory based on the parameters it’s given. If no parameters are given, the script will not do anything as a safety mechanism. To clear all raids from memory, use /clearraids all. Otherwise, use a standard doomscript raid filter to select the raids you want cleared. For example, to clear all Normal Telemachus raids that were first seen more than 15 hours ago, you could /clearraids tele 1 {age:>15h}
Required Parameters: All or a filter.
Optional Parameters: None.
Aliases: /clearraid, /raidclear, /raidsclear, /clearcache
The export raids command will dump all links from memory into a textbox so that it can be copied and pasted to various other sites or for use in other scripts. If no filter is provided, all raids in memory that are not visited or completed will be exported. Otherwise, use a standard doomscript raid filter to select the raids you want exported. For example, to export all Normal Telemachus raids that were first seen more than 15 hours ago, you could /exportraids tele 1 {age:>15h}. To export all raids including visited ones, use /exportraids {state: !completed}
Required Parameters: All or a filter.
Optional Parameters: None.
Aliases: /clearraid, /raidclear, /raidsclear, /clearcache
The clearraids command will clear raids from the scripts memory based on the parameters it’s given. If no parameters are given, the script will not do anything as a safety mechanism. To clear all raids from memory, use /clearraids all. Otherwise, use a standard doomscript raid filter to select the raids you want cleared. For example, to clear all Normal Telemachus raids that were first seen more than 15 hours ago, you could /clearraids tele 1 {age:>15h}
Required Parameters: All or a filter.
Optional Parameters: None.
Aliases: /clearraid, /raidclear, /raidsclear, /clearcache
The clearraids command will clear raids from the scripts memory based on the parameters it’s given. If no parameters are given, the script will not do anything as a safety mechanism. To clear all raids from memory, use /clearraids all. Otherwise, use a standard doomscript raid filter to select the raids you want cleared. For example, to clear all Normal Telemachus raids that were first seen more than 15 hours ago, you could /clearraids tele 1 {age:>15h}
Required Parameters: All or a filter.
Optional Parameters: None.
Aliases: /clearraid, /raidclear, /raidsclear, /clearcache
The clearraids command will clear raids from the scripts memory based on the parameters it’s given. If no parameters are given, the script will not do anything as a safety mechanism. To clear all raids from memory, use /clearraids all. Otherwise, use a standard doomscript raid filter to select the raids you want cleared. For example, to clear all Normal Telemachus raids that were first seen more than 15 hours ago, you could /clearraids tele 1 {age:>15h}
Required Parameters: All or a filter.
Optional Parameters: None.
Aliases: /clearraid, /raidclear, /raidsclear, /clearcache
The clearraids command will clear raids from the scripts memory based on the parameters it’s given. If no parameters are given, the script will not do anything as a safety mechanism. To clear all raids from memory, use /clearraids all. Otherwise, use a standard doomscript raid filter to select the raids you want cleared. For example, to clear all Normal Telemachus raids that were first seen more than 15 hours ago, you could /clearraids tele 1 {age:>15h}
Required Parameters: All or a filter.
Optional Parameters: None.
Aliases: /clearraid, /raidclear, /raidsclear, /clearcache
The clearraids command will clear raids from the scripts memory based on the parameters it’s given. If no parameters are given, the script will not do anything as a safety mechanism. To clear all raids from memory, use /clearraids all. Otherwise, use a standard doomscript raid filter to select the raids you want cleared. For example, to clear all Normal Telemachus raids that were first seen more than 15 hours ago, you could /clearraids tele 1 {age:>15h}
Required Parameters: All or a filter.
Optional Parameters: None.
Aliases: /clearraid, /raidclear, /raidsclear, /clearcache
The clearraids command will clear raids from the scripts memory based on the parameters it’s given. If no parameters are given, the script will not do anything as a safety mechanism. To clear all raids from memory, use /clearraids all. Otherwise, use a standard doomscript raid filter to select the raids you want cleared. For example, to clear all Normal Telemachus raids that were first seen more than 15 hours ago, you could /clearraids tele 1 {age:>15h}
Required Parameters: All or a filter.
Optional Parameters: None.
Aliases: /clearraid, /raidclear, /raidsclear, /clearcache
The clearraids command will clear raids from the scripts memory based on the parameters it’s given. If no parameters are given, the script will not do anything as a safety mechanism. To clear all raids from memory, use /clearraids all. Otherwise, use a standard doomscript raid filter to select the raids you want cleared. For example, to clear all Normal Telemachus raids that were first seen more than 15 hours ago, you could /clearraids tele 1 {age:>15h}
Required Parameters: All or a filter.
Optional Parameters: None.
Aliases: /clearraid, /raidclear, /raidsclear, /clearcache
The clearraids command will clear raids from the scripts memory based on the parameters it’s given. If no parameters are given, the script will not do anything as a safety mechanism. To clear all raids from memory, use /clearraids all. Otherwise, use a standard doomscript raid filter to select the raids you want cleared. For example, to clear all Normal Telemachus raids that were first seen more than 15 hours ago, you could /clearraids tele 1 {age:>15h}
Required Parameters: All or a filter.
Optional Parameters: None.
Aliases: /clearraid, /raidclear, /raidsclear, /clearcache
The loadraid command will cause your game (not page) to reload and join in the raid for the specified url.
Required Parameters:
url - A complete, functional valid raid url.
Optional Parameters: None.
Aliases: /addraid, /joinraid, /loadraids
Prints out basic information about a raid such as Name, Size, Health, FS, and Target (Optimal) damage.
Required Parameters: None.
Optional Paramters:
name - A full or partial name for the raids. Can also get multiple names by using a | as in /raid tele|rage
difficulty - A number 1 to 4 where 1 means Normal and 4 means Nightmare
Aliases: /raids
Displays script version, allows user to check for updates, and lists available commands.
Required Parameters: None.
Optional Parameters: None.
Aliases: /raidabout
Reloads the game without reloading the page
Required Parameters: None.
Optional Parameters: None.
Aliases: /refresh
The seenraids command will show seen raids from the scripts memory based on the parameters it’s given. If no parameters are given, the script will list all raids in memory. You could find 10 nightmare zone 4 raids that you’ve not visited before by using /seenraids nat|kel|gang 4 {state: seen} {count: 10}
Required Parameters: None.
Optional Parameters:
name - A full or partial name for the raids. Can also get multiple names by using a | as in /seenraids tele|colonel|void|rage
difficulty - A number 1 to 4 where 1 means Normal and 4 means Nightmare
stateType - Should be seen or visited
ageExp - Limits to just raids that you first saw in a given time frame. Should be similar to <48H, >1d, or <=25m.
fsExp - Limits to just raids whose FS matches the given expression. Should be similar to <=1M, >5M, or =450K
cnum - The total number of results to return at most. Could return less based on other filters
pnum - If the cnum is set, then the pnum will limit to the different pages of results of where each result page contains cnum results.
Aliases: /seenraid, /raidseen, /raidsseen
Shows or changes the format in which raid links are shown in chat.
Required Parameters: None.
Optional Parameters:
newFormat - The new format to show raid links in. If omitted, it will tell you your current format. If the format is reset as in /raidformat reset, you will be set back to the default format listed below.
Format Options:
cache-state - seen or visited
difficulty - Normal, Hard, Legendary, or Nightmare
diff - N, H, L, or NM
fs - Fair Share of damage for the raid. Can be fs*2 or fs*1.4 or similar math
id - Unique numeric id of the raid
image - The small Legacy of a Thousand Suns icon
line - A line break. Everything after this will be on the next line. Can use multiple.
name - Full raid name
os - Same as target
optimal - Same as target
size - Number of participants the raid can hold
target - The target or optimal damage for the raid from Raid Value Calculator: https://docs.google.com/spreadsheet/ccc?key=0AoPyAHGDsRjhdGYzalZZdTBpYk1DS1M3TjVvYWRwcGc&hl=en_US#gid=4
stat - S, E, H, (meaning Stamina, Energy, or Honor) or whichever combination of stats are used on the raids. Most in chat will be S.
visited - Will display Visited if the raid is visited or nothing if it hasn’t been visited
Options should be placed in {}
Default:
/raidformat {image} {visited} Raid: [{size}-{stat}-{difficulty}-{fs}] {name}
(/raidformat reset will set your format back to this)
Alternate Default:
/raidformat {image} {visited} Raid: [{size}-{stat}-{difficulty}-{target}] {name}
Short:
/raidformat {visited} {difficulty} {name}
This is the best way to test if the script is properly installed, and is essentially an alias to /raidhelp, but if the script is broken, your command won’t get posted to public chat.
This is the best way to test one of the previously given commands for the first time. Simply whisper the command to the RaidBot, and if it fails, you’ll just get a simple failure message rather than having your failed command posted to chat. For example, you could /w RaidBot seenraids tele or /w RaidBot /seenraids tele (/ is optional when whispering to RaidBot).
Due to the way the script is put together, it is possible to execute any of the commands from a bookmarklet (What is a bookmarklet?) for quick access to frequently used commands. A bookmarklet is going to be constructed like javascript: (function(){holodeck.processChatCommand(“/seenraids tel|psy|carn {state:seen}”)})(); or javascript: (function(){holodeck.processChatCommand(“/reload”);})(). The bookmarklet will look like a bookmark on your toolbar or in your menu, but instead of loading a page when clicked, they will execute your desired raid command.
To create a bookmarklet in Firefox:
To create a bookmarklet in Chrome
To create a bookmarklet in Opera:
If none of these steps work for you, please consider reporting this bug.
Once installing or updating the script, you’ll need to refresh the game page entirely. Sometimes if you’re having trouble or the script seems to be running slowly, this is a good option.
It seems especially true that Firefox can have trouble updating the version number and other features after installing or updating, and can perform better after restarting the browser. As far as I’m aware, this is not a script bug, but rather a shortcoming of GreaseMonkey.
While it seems obvious, the script may potentially not be installed. If you’ve refreshed and /w RaidBot help does not produce the script about page, it may be time to double check that it’s actually installed.
In Firefox, you should be able to find your script in Tools > GreaseMonkey > Manage User Scripts. If you can’t find GreaseMonkey, make sure you have GreaseMonkey installed first in Tools > Addons. In the Manage User Scripts menu, you should be able to find Kongregate Legacy of a Thousand Suns Raid Link Helper and its version number. If it’s not there, the script is not installed.
In Chrome, you should be able to find your script in Wrench > Tools > Extensions as Kongregate Legacy of a Thousand Suns Raid Link Helper with the current version. If it’s not there, the script is not installed.
In Opera, you should be able find your script in your User Javascript folder. You can figure out where that folder is in Preferences > Advanced > Content > Javascript options > User Javascript Folder. If the folder is not set, then script could not possibly be installed. If the folder is set, navigate there in your system file browser. The script file will most likely be named 124753.user.js, though it depends on how you saved it. If you open the file in a text editor (don’t double click the file on Windows), you should be able to tell if the file is in fact the current version of the script. If you can’t find the script file, it’s not installed.
Generally, this means that {visited} is not in your raidformat. Enter /raidformat into your chat box and press enter. The script should tell you your current raid format. If that format doesn’t have {visited}, then you won’t ever see raids marked visited. Enter /raidformat once again into your chat box, but this time paste the current format after it. Then, add {visited} somewhere in the format before pressing enter.
If your format contains {visited} and raids you’ve clicked are not getting marked, there may be a larger problem, and it should be reported as a bug.
This is something I’m extremely conscious of, and performance tuning is an ongoing process. Some steps you can take to mitigate some slowness are to periodically clear raids and refresh the page. If the script is running painfully slow, consider reporting a bug.
Debugging is an advanced form of trouble shooting to help identify problems that you’re having but that I can’t seem to reproduce. While this is really helpful to solving your problem, it may be difficult for the inexperienced user.
Version 1.0.14 debug script: http://dl.dropbox.com/u/2183424/124753_debug.user.js
The debugging script sacrifices performance in order to catch more errors, so it isn’t recommended for continuous use. However, it will report more errors, and is therefore recommended for debugging use. This script will overwrite your normal script. Simply reinstall the public version of the script to get rid of the debug version. The script will say DEBUG in /raidhelp if it’s the debug version.
In order to debug in Firefox, you’ll need to:
In order to debug in Chrome, you’ll need to:
Currently, I’m not especially finding any errors in Opera that I’m not able to debug entirely myself, so just report any bugs you’re finding in Opera, and I’ll track them down. If there comes a time where this is no longer feasible, I’ll update this section.