Kolmafia - User contributions [en]

Auto-stops

2010-06-29T20:45:53Z

Spiny Twizzler:

Auto-stops are places where mafia's automation will automatically stop, just as the name suggests. These are all KoL non-combats. If mafia detects one of these auto-stop non-combats then automation will cease immediately after the encounter.

There is just one trick to using auto-stops: mafia will only stop for auto-stops when there are no conditions set. If conditions are set then mafia will continue automation until it reaches those conditions and stop normally. This is to prevent auto-stops from interfering with regular automation.

* Sleazy Back Alley: [http://kol.coldfront.net/thekolwiki/index.php/Under_the_Knife Under the Knife]
* Misspelled Cemetary: [http://kol.coldfront.net/thekolwiki/index.php/A_Grave_Situation A Grave Situation]
* Haunted Library: Either version of Take a Look, it's in a Book!
* Whitey's Grove: [http://kol.coldfront.net/thekolwiki/index.php/It's_A_Sign! It's A Sign!]
* Teleportitis: [http://kol.coldfront.net/thekolwiki/index.php/The_Oracle_Will_See_You_Now The Oracle Will See You Now]
* Barrrney's Barrr: [http://kol.coldfront.net/thekolwiki/index.php/Step_Up_to_the_Table%2C_Put_the_Ball_in_Play Step Up to the Table, Put the Ball in Play]
* Arid, Extra-Dry Desert: Auto-stops every time you want to start adventuring at the Oasis or if you need to get an item:
*# [http://kol.coldfront.net/thekolwiki/index.php/A_Sietch_in_Time A Sietch in Time]
*# [http://kol.coldfront.net/thekolwiki/index.php/No_Colors_Anymore No Colors Anymore] (without can of black paint). With paint, adventuring continues to Walk Without Rhythm.
*# [http://kol.coldfront.net/thekolwiki/index.php/Walk_Without_Rhythm Walk Without Rhythm]
*# [http://kol.coldfront.net/thekolwiki/index.php/Walk_Without_Rhythm_2 Walk Without Rhythm 2] (Only occurs if you didn't have a drum machine at previous auto-stop.)
*# [http://kol.coldfront.net/thekolwiki/index.php/The_Sleeper_Has_Awakened The Sleeper Has Awakened]
* agua de vida: Auto-stop when a bottle is consumed.
* Auto-stop when a demon name is learned and opens mini-browser to display it.
* Auto-stop when a hobo code is learned and opens mini-browser to display it.
* Auto-stop when an Ultra Rare adventure is encountered and opens mini-browser to display it.

{{CodeSample|description=Unlocking the White Citadel can make use of the auto-stop to be this simple.|
code=<syntaxhighlight>
adventure( my_adventures(), $location[whitey's grove] );
adventure( my_adventures(), $location[white citadel );
</syntaxhighlight>}}
{{CodeSample|description=Unlocking the Pyramid, using the magic of auto-stops. Note that this assumes you have enough adventures to complete it. A better script would check the questlog to verify current quest progress before beginning adventuring.|
code=<syntaxhighlight>
cli_execute("condition clear"); # conditions must be clear or stops won't be automatic.
# Adventure until: A Sietch in Time
adventure( my_adventures(), $location[Desert (Ultrahydrated)] );
cli_execute("condition set 1 stone rose, 1 drum machine");
adventure( my_adventures(), $location[Oasis] );
# Adventure until: Walk Without Rhythm
retrieve_item(1, $item[can of black paint]);
adventure( my_adventures(), $location[Desert (Ultrahydrated)] );
cli_execute("condition set worm-riding manual pages 3-15");
adventure( my_adventures(), $location[Oasis] );
# Adventure until: The Sleeper Has Awakened
adventure( my_adventures(), $location[Desert (Ultrahydrated)] );
# Equip wormhooks, use drum machine and then re-equip original weapon.
cli_execute("checkpoint; equip worm hooks; use drum machine; outfit checkpoint");
</syntaxhighlight>}}

[[Category:Automation]]

User talk:Bale

2010-06-11T04:49:08Z

Spiny Twizzler:

Bale;

Sorry, I was called away & didn't get back till you were gone, so I thought I'd answer your questions here before I lost 'em.

RE: Consult Scripts. How many rounds does the consult script act for? Does a consult script keep running until combat is over? Just for rounds it's specifically called? I totally don't understand how that works...

RE: appearance_rates() & ultra-rares; when using said function on the treasury, it returned -42.5 for that UR monster. It just seems a point worth mentioning, in case anyone wants to parse UR availability by location; wouldn't want them to assume a STATIC negative number.

Thanks, --[[User:StDoodle|StDoodle]] 23:52, 4 March 2010 (UTC)

Note:

I've updated the front page (again); it now includes a link to [[Help:Editing]], where I will try to keep all relevant information on what needs work on the wiki. --[[User:StDoodle|StDoodle]] 13:32, 4 March 2010 (UTC)

Nice job on [[Custom Combat Script]]! I fixed two minor typos, but otherwise it looks great. There are a few things I'd like to flesh out eventually, such as formatting (make sure to have a space on each side of monster / location name), mention that locations are acceptable, how to specify 2nd funksling item, etc. But most of that is "Regular Mafia" stuff, which, while I intend to get to, is after ash on my to-do list.

For now, I'm ''trying'' to keep up with tagging articles that need specific help, so keep an eye on: 
* [[:Category:Request_For_Information]]
* [[:Category:Needs_Code_Sample]]
if you want to know where I need the most help.

Also, I want to eventually redo a lot of the regular-mafia stuff as well. I think it deserves its own section similar to "Quick Links for ASH Scripters" on the main page, with links to a page for each mafia tab / window. For page naming, I'd like to go with "Adventuring Tab," "Graphical CLI Tab," etc. to avoid any collision with function names. I imagine that a lot of the info on these pages will either be stolen from, or added in by Sally.

While in general this is a lower priority from my POV, I'd like to get the pages set up so that others can work on them.

If you want to tackle something more ASH-related, one thing that bugs me is the rather arbitrary (and in many cases outdated) categorization of ASH functions. If you'd like to go through the list & break them up more sensibly, that would be much appreciated!

Thanks! --[[User:StDoodle|StDoodle]] 14:56, 3 March 2010 (UTC)

As you may have noticed me mentioning on the forum, I've given you admin powers. Mostly, this makes it easier to quickly revert undesired changes, and to protect pages if needed. But also! you should no longer see nearly as many captcha's & such. --[[User:StDoodle|StDoodle (#1059825)]] 07:41, 22 April 2010 (UTC)

Regarding wiki-style lists (using * for bullet points): I generally find it easier to just add a non-breaking space (&nbsp;) on the line after the list rather than add in HTML (see the source of [[to_slot]] to see what I mean -- I can't really articulate these things too well) --[[User:Heeheehee|Heeheehee]] 06:10, 28 April 2010 (UTC)

drive-by. :P --[[User:StDoodle|StDoodle (#1059825)]] 04:30, 7 May 2010 (UTC)

Is this the right place to respond to your message to me here? If not, my apologies. In any event, yes, apparently I did have an account here and couldn't remember my password and had to get a temporary one sent to me. I'll probably forget the password that I changed it to if I get logged out of this and will have to get another temp password. I'm terrible like that lol. --[[User:Spiny Twizzler|Spiny Twizzler]] 04:49, 11 June 2010 (UTC)

Helpful Scripts

2010-06-10T20:15:57Z

Spiny Twizzler:

{{TOCright}}
This is a list of well written scripts that are currently being maintained for the latest version of KoL and KolMafia. All scripts on this list are free and certified safe for use without any hidden costs or malicious code. If these scripts become outdated for very long or any security risks are found they will be removed from this list, so users should feel free to make use of them.

Of course it is possible that one of these scripts can cause trouble for the user if they are not used properly, so please read the opening post in each thread linked before using that script.

==Turn-Burning Scripts==

'''autoBasement''' - ([http://kolmafia.us/showthread.php?3113 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Automates delving into Fernswarthy's Basement.

'''bounty''' - ([http://kolmafia.us/showthread.php?1023-auto-BHH-and-friends&p=15204&viewfull=1#post15204 download here]) '''Author:''' [http://kolmafia.us/member.php?197-izchak izchak], [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Automates the bounty gathering quest.
* In conjunction with SmartStasis combat script (below) it will also olfact the monster for the bounty.

'''CounterChecker''' - ([http://kolmafia.us/showthread.php?2519 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Automates semi-rare acquisition, use of dance cards and a few other counter related activities.

'''Dwarven Factory''' - ([http://kolmafia.us/showthread.php?2884 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja]
* Automates the optional Dwarven Factory quest.

'''MacGuffin''' - ([http://kolmafia.us/showthread.php?1965 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Automation for the L11 MacGuffin Quest.

'''One-Click Wossname''' - ([http://kolmafia.us/showthread.php?960 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* A complete script for completing the L12 Island War quest.
* It allows you to chose the medal you are rewarded with, including a Wossname.

'''Rinn's Quest Scripts''' - ([http://kolmafia.us/showthread.php?2584 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Automation for most of the game's quests.

'''Slime Tube Adventuring Script''' - ([http://kolmafia.us/showthread.php?2596 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=alhifar Alhifar]
* Complete automation for the Slime Tube.
* You set up the outfits for maximum ML and minimum ML. The script then switches between them.
* It even allows you to chose to kill or tatter slimes.
* The variety of options allows every type of Slime Tube play, even a slimeling run, to be automated.

==Relay Override Scripts==

'''clan_basement.ash''' - ([http://kolmafia.us/showthread.php?4137 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
* Sorts dungeon loot by boss, presenting Hobopolis loot before Slime Tube loot.

'''pyramid.ash''' - ([http://kolmafia.us/showthread.php?3922 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
* Disables potentially harmful links in the Pyramid.

'''shore.ash''' - ([http://kolmafia.us/showthread.php?2813 download here]) '''Author:''' [http://kolmafia.us/member.php?872-lostcalpolydude lostcalpolydude] and [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* When you take a vacation it reminds you of which shore items you might need for floor 6 of the Sorceress' Tower.
* It uses the telescope to determine the exact item needed if you have a full scope.
* It also keeps you from taking a vacation when you need the the forged documents 'cause it sucks to accidently lose those 3 adventures.

'''Telescope Information''' - ([http://kolmafia.us/showthread.php?4057 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* When you look through the telescope at your campsite it will explain what monsters you will meet at the lair and the item to defeat them.
* Tells you if you have the items. If you need any items it tells you where to find them.

'''woods.ash''' - ([http://kolmafia.us/showthread.php?4199-Acquire-Continuum-Transfunctioner&p=29908&viewfull=1#post29908 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Gets the Continuum Transfunctioner automatically on your first visit to the woods. You will not need to click anything, it just happens.

===User Interface Scripts===

These scripts are a special type of relay override scripts in that they create pages that do not exist as part of KoL. They are prefixed by "relay_" and must be placed in the user's \relay directory. These scripts are accessed via the "-run script-" dropdown menu in the relay browser.

'''Daily Info''' - ([http://kolmafia.us/showthread.php?4248 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=icon315 Icon315]
*This script shows you the daily information such as the moons' effects on various modifiers, current stat day and Daily Dungeon rooms.

'''relay_SlimeTube''' - ([http://kolmafia.us/showthread.php?2596-Slime-Tube-Adventuring-Script&p=29687&viewfull=1#post29687 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Adapted from Alhifar's Slime Tube Adventuring Script; does everything the original script does.
* Adds a UI to enable the user to easily configure the Slime Tube script without having to modify the base script.

'''ZLib Variable Editor''' - ([http://kolmafia.us/showthread.php?4081 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
*This script provides a more user-friendly interface for modifying [http://kolmafia.us/showthread.php?2072 ZLib] variables.

==Custom Combat Scripts==

'''First Things First''' - ([http://kolmafia.us/showthread.php?1255 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Takes care of the first few things needed in a fight: pickpocketing, entangling noodles, olfaction, spooky putty, etc
* Includes quest related events: insulting pirates, throwing flyers, driving away clingy pirates if clingfilm is not needed, etc.

'''SmartStasis''' - ([http://kolmafia.us/showthread.php?1715 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Includes everything from First Things First. (Requires that to be downloaded also.)
* Stasis monsters for a variety of reasons: starfishing, hobo monkey meat.
* Notices when the monkey steals and recognizes if your slimeling or other chargeable starfish is out of juice and ends stasis.
* Quest related stasis: Using molybdenum magnet on the correct gremlin, getting essences in Seaside Megalopolis, learning rave dance moves Outside the Club.
* Uses disco combos and rave combos when they improve your profit.

==Buff Upkeep Scripts==

'''acquireBuff''' - ([http://kolmafia.us/showthread.php?4048 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Gets a buff from a buffbot without needing to know the bot's name or pricelist.

'''Best Between Battle Script Ever''' - ([http://kolmafia.us/showthread.php?1240 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Executes between battles in automatic adventuring.
* Adjusts choice adventures, adjusts MCD for current moxie, auto-tames turtles.

'''hatter.ash''' - ([http://kolmafia.us/showthread.php?4262 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja]
* To get a specific Mad Hatter buff painlessly.

'''Universal Recovery''' - ([http://kolmafia.us/showthread.php?1780 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Improves mafia's automated recovery to make best use of all items in hardcore/ronin or conserve meat if you have mall access.
* Keeps spare mp healing items on-hand in case they are needed in combat.
* Conserves healing items for use against your Shadow.
* Removes poison and keeps some extra antidotes for use in combat.

'''VIP Hopping''' - ([http://kolmafia.us/showthread.php?3620-VIP-Hopping!-Quick-clanhop-to-BAfH-for-all-VIP-room-goodies! download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Hops over the clan Bonus Adventures from Hell to get something from their VIP Lounge, then it hops back to your regular clan.
* Enables access to all VIP Lounge amenities and the ballpit without needing to spend time in BaFH.
* If you don't have a membership in Bonus Adventures from Hell, it submits a request to join the clan so that you can get access to a fully stocked VIP Lounge for free.

==Item Handling Scripts==

'''Misshappen Animal Skeleton Familiar/Checker/Buyer''' - ([http://kolmafia.us/showthread.php?p=30995 download here]) '''Author:''' [http://kolmafia.us/member.php?1789-eitak eitak]
* This script uses framework from Spiny Twizzler's Tiny Plastic Series 1 & 2 Checker script and facilitates the automated acquisition of the Misshapen Animal Skeleton. There are some settings you can tweak within the script itself to suit your needs.

'''PriceAdvisor''' - ([http://kolmafia.us/showthread.php?3110 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=aqualectrix aqualectrix]
* Gives advice on how to maximize profit from an item.

'''Rainbow Gravitation made easy''' - ([http://kolmafia.us/showthread.php?1929 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* In hardcore/ronin it handles automatic wad transmutation to enable easy creation of Rainbow Wads.
* With mall access, it will purchase necessary wads to use daily casts of Rainbow Gravitation.

'''Scripting the birth of a new life''' - ([http://kolmafia.us/showthread.php?2769 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Sets optimal choice adventures based on current class for your ascension. Perfect to run at the beginning of a new life.
* Automates simple tasks that are always run at the beginning of a new life like pulling your VIP Lounge Key and visiting the Toot Oriole.

==Informational Scripts==

'''bumcheekcity's Easy Wiki Snapshot Maker''' - ([http://kolmafia.us/showthread.php?3001 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bumcheekcity bumcheekcity]
* This script will collect information about your character and generate a profile to display on [http://bumcheekcity.com/kol/profile.php bumcheekcity's website].

'''EatDrink.ash: Optimize your daily diet''' - ([http://kolmafia.us/showthread.php?4202-The-Unofficial-Ascend.ash-support-thread.&p=30725&viewfull=1#post30725 best download here]) - ([http://kolmafia.us/showthread.php?1519 outdated official thread here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=fronobulax fronobulax]
* Tries to find an optimal diet for a given value of an adventure.
* Can be run in simulation mode, just to see what it would do.
* Since dj_d is taking a leave of absence, fronobulax has temporarily taken up maintenance of this script.

'''StDoodle's Custom Daily Deeds''' - ([http://kolmafia.us/showthread.php?3443 download here]) '''Author:''' [http://kolmafia.us/member.php?720-StDoodle StDoodle]
* Tracks all events that have limited uses, from pool table to pasta summoning.

'''Slime Vial Recipes''' - ([http://kolmafia.us/showthread.php?3544-Slime-vial-recipes&p=25337&viewfull=1#post25337 download here]) '''Author:''' [http://kolmafia.us/member.php?1017-jasonharper jasonharper]
* This script will help you get the [http://kol.coldfront.net/thekolwiki/index.php/Color_Wheel_of_Yuck Color Wheel of Yuck] trophy by checking your discoveries list and mixing the vials in your inventory to create slime potions you do not know.

'''Tiny Plastic Series 1 & 2 Checker''' - ([http://kolmafia.us/showthread.php?goto=newpost&t=2587 download here]) '''Author:''' [http://kolmafia.us/member.php?1897-Spiny Spiny Twizzler]
* Its default behaviour is informational to help you acquire your Tiny Plastic Trophy and/or Two-Tiered Tiny Plastic Trophy. You may optionally edit the preferences in the script to shop for missing trophies for you with a budget that you set yourself.

'''What are you worth?''' - ([http://kolmafia.us/showthread.php?2628-What-are-you-worth-networth.ash-will-tell-you.&p=24990&viewfull=1#post24990 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* This calculates the current value of all items you own and informs you of what you are worth.

==Script Libraries==
These scripts are libraries of functions that are required components of other scripts. By themselves they do little or nothing. Expect to download them when directed in a script's instructions, or if you want to be a scripter, then study them and learn.

'''HTMLform''' - ([http://kolmafia.us/showthread.php?3842 download here]) '''Author:''' [http://kolmafia.us/member.php?1017-jasonharper jasonharper]
* Library of functions used for creating forms in [[Relay_Override_Scripting#User_Interface_Script|relay interface scripts]].

'''SmashLib''' - ([http://kolmafia.us/showthread.php?3065 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=aqualectrix aqualectrix]
* Determines the results of pulverizing equipment and reports it for use by scripts or aliases.

'''ZLib''' - ([http://kolmafia.us/showthread.php?2072 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Ultimate toolbox of scripting functions for math, string manipulation, version checking, automatic mapfile updating, persistent variables, adventuring, kmailing and so much more. ''Many scripts require this.''

==Misc==

'''Clan Hopping''' - ([http://kolmafia.us/showthread.php?2071 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Hop to a whitelisted clan quickly and easily from the CLI.

Helpful Scripts

2010-06-10T20:13:28Z

Spiny Twizzler: /* Item Handling Scripts */

{{TOCright}}
This is a list of well written scripts that are currently being maintained for the latest version of KoL and KolMafia. All scripts on this list are free and certified safe for use without any hidden costs or malicious code. If these scripts become outdated for very long or any security risks are found they will be removed from this list, so users should feel free to make use of them.

Of course it is possible that one of these scripts can cause trouble for the user if they are not used properly, so please read the opening post in each thread linked before using that script.

==Turn-Burning Scripts==

'''autoBasement''' - ([http://kolmafia.us/showthread.php?3113 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Automates delving into Fernswarthy's Basement.

'''bounty''' - ([http://kolmafia.us/showthread.php?1023-auto-BHH-and-friends&p=15204&viewfull=1#post15204 download here]) '''Author:''' [http://kolmafia.us/member.php?197-izchak izchak], [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Automates the bounty gathering quest.
* In conjunction with SmartStasis combat script (below) it will also olfact the monster for the bounty.

'''CounterChecker''' - ([http://kolmafia.us/showthread.php?2519 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Automates semi-rare acquisition, use of dance cards and a few other counter related activities.

'''Dwarven Factory''' - ([http://kolmafia.us/showthread.php?2884 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja]
* Automates the optional Dwarven Factory quest.

'''MacGuffin''' - ([http://kolmafia.us/showthread.php?1965 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Automation for the L11 MacGuffin Quest.

'''One-Click Wossname''' - ([http://kolmafia.us/showthread.php?960 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* A complete script for completing the L12 Island War quest.
* It allows you to chose the medal you are rewarded with, including a Wossname.

'''Rinn's Quest Scripts''' - ([http://kolmafia.us/showthread.php?2584 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Automation for most of the game's quests.

'''Slime Tube Adventuring Script''' - ([http://kolmafia.us/showthread.php?2596 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=alhifar Alhifar]
* Complete automation for the Slime Tube.
* You set up the outfits for maximum ML and minimum ML. The script then switches between them.
* It even allows you to chose to kill or tatter slimes.
* The variety of options allows every type of Slime Tube play, even a slimeling run, to be automated.

==Relay Override Scripts==

'''clan_basement.ash''' - ([http://kolmafia.us/showthread.php?4137 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
* Sorts dungeon loot by boss, presenting Hobopolis loot before Slime Tube loot.

'''pyramid.ash''' - ([http://kolmafia.us/showthread.php?3922 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
* Disables potentially harmful links in the Pyramid.

'''shore.ash''' - ([http://kolmafia.us/showthread.php?2813 download here]) '''Author:''' [http://kolmafia.us/member.php?872-lostcalpolydude lostcalpolydude] and [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* When you take a vacation it reminds you of which shore items you might need for floor 6 of the Sorceress' Tower.
* It uses the telescope to determine the exact item needed if you have a full scope.
* It also keeps you from taking a vacation when you need the the forged documents 'cause it sucks to accidently lose those 3 adventures.

'''Telescope Information''' - ([http://kolmafia.us/showthread.php?4057 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* When you look through the telescope at your campsite it will explain what monsters you will meet at the lair and the item to defeat them.
* Tells you if you have the items. If you need any items it tells you where to find them.

'''woods.ash''' - ([http://kolmafia.us/showthread.php?4199-Acquire-Continuum-Transfunctioner&p=29908&viewfull=1#post29908 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Gets the Continuum Transfunctioner automatically on your first visit to the woods. You will not need to click anything, it just happens.

===User Interface Scripts===

These scripts are a special type of relay override scripts in that they create pages that do not exist as part of KoL. They are prefixed by "relay_" and must be placed in the user's \relay directory. These scripts are accessed via the "-run script-" dropdown menu in the relay browser.

'''Daily Info''' - ([http://kolmafia.us/showthread.php?4248 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=icon315 Icon315]
*This script shows you the daily information such as the moons' effects on various modifiers, current stat day and Daily Dungeon rooms.

'''relay_SlimeTube''' - ([http://kolmafia.us/showthread.php?2596-Slime-Tube-Adventuring-Script&p=29687&viewfull=1#post29687 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Adapted from Alhifar's Slime Tube Adventuring Script; does everything the original script does.
* Adds a UI to enable the user to easily configure the Slime Tube script without having to modify the base script.

'''ZLib Variable Editor''' - ([http://kolmafia.us/showthread.php?4081 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
*This script provides a more user-friendly interface for modifying [http://kolmafia.us/showthread.php?2072 ZLib] variables.

==Custom Combat Scripts==

'''First Things First''' - ([http://kolmafia.us/showthread.php?1255 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Takes care of the first few things needed in a fight: pickpocketing, entangling noodles, olfaction, spooky putty, etc
* Includes quest related events: insulting pirates, throwing flyers, driving away clingy pirates if clingfilm is not needed, etc.

'''SmartStasis''' - ([http://kolmafia.us/showthread.php?1715 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Includes everything from First Things First. (Requires that to be downloaded also.)
* Stasis monsters for a variety of reasons: starfishing, hobo monkey meat.
* Notices when the monkey steals and recognizes if your slimeling or other chargeable starfish is out of juice and ends stasis.
* Quest related stasis: Using molybdenum magnet on the correct gremlin, getting essences in Seaside Megalopolis, learning rave dance moves Outside the Club.
* Uses disco combos and rave combos when they improve your profit.

==Buff Upkeep Scripts==

'''acquireBuff''' - ([http://kolmafia.us/showthread.php?4048 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Gets a buff from a buffbot without needing to know the bot's name or pricelist.

'''Best Between Battle Script Ever''' - ([http://kolmafia.us/showthread.php?1240 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Executes between battles in automatic adventuring.
* Adjusts choice adventures, adjusts MCD for current moxie, auto-tames turtles.

'''hatter.ash''' - ([http://kolmafia.us/showthread.php?4262 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja]
* To get a specific Mad Hatter buff painlessly.

'''Universal Recovery''' - ([http://kolmafia.us/showthread.php?1780 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Improves mafia's automated recovery to make best use of all items in hardcore/ronin or conserve meat if you have mall access.
* Keeps spare mp healing items on-hand in case they are needed in combat.
* Conserves healing items for use against your Shadow.
* Removes poison and keeps some extra antidotes for use in combat.

'''VIP Hopping''' - ([http://kolmafia.us/showthread.php?3620-VIP-Hopping!-Quick-clanhop-to-BAfH-for-all-VIP-room-goodies! download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Hops over the clan Bonus Adventures from Hell to get something from their VIP Lounge, then it hops back to your regular clan.
* Enables access to all VIP Lounge amenities and the ballpit without needing to spend time in BaFH.
* If you don't have a membership in Bonus Adventures from Hell, it submits a request to join the clan so that you can get access to a fully stocked VIP Lounge for free.

==Item Handling Scripts==

'''Misshappen Animal Skeleton Familiar/Checker/Buyer''' - ([http://kolmafia.us/showthread.php?p=30995 download here]) '''Author:''' [http://kolmafia.us/member.php?1789-eitak eitak]
* Using framework from Spiny's Tiny Plastic Checker script, this script facilitates the automated acquisition of the Misshapen Animal Skeleton. There are some settings you can tweak within the script itself to suit your needs.

'''PriceAdvisor''' - ([http://kolmafia.us/showthread.php?3110 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=aqualectrix aqualectrix]
* Gives advice on how to maximize profit from an item.

'''Rainbow Gravitation made easy''' - ([http://kolmafia.us/showthread.php?1929 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* In hardcore/ronin it handles automatic wad transmutation to enable easy creation of Rainbow Wads.
* With mall access, it will purchase necessary wads to use daily casts of Rainbow Gravitation.

'''Scripting the birth of a new life''' - ([http://kolmafia.us/showthread.php?2769 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Sets optimal choice adventures based on current class for your ascension. Perfect to run at the beginning of a new life.
* Automates simple tasks that are always run at the beginning of a new life like pulling your VIP Lounge Key and visiting the Toot Oriole.

==Informational Scripts==

'''bumcheekcity's Easy Wiki Snapshot Maker''' - ([http://kolmafia.us/showthread.php?3001 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bumcheekcity bumcheekcity]
* This script will collect information about your character and generate a profile to display on [http://bumcheekcity.com/kol/profile.php bumcheekcity's website].

'''EatDrink.ash: Optimize your daily diet''' - ([http://kolmafia.us/showthread.php?4202-The-Unofficial-Ascend.ash-support-thread.&p=30725&viewfull=1#post30725 best download here]) - ([http://kolmafia.us/showthread.php?1519 outdated official thread here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=fronobulax fronobulax]
* Tries to find an optimal diet for a given value of an adventure.
* Can be run in simulation mode, just to see what it would do.
* Since dj_d is taking a leave of absence, fronobulax has temporarily taken up maintenance of this script.

'''StDoodle's Custom Daily Deeds''' - ([http://kolmafia.us/showthread.php?3443 download here]) '''Author:''' [http://kolmafia.us/member.php?720-StDoodle StDoodle]
* Tracks all events that have limited uses, from pool table to pasta summoning.

'''Slime Vial Recipes''' - ([http://kolmafia.us/showthread.php?3544-Slime-vial-recipes&p=25337&viewfull=1#post25337 download here]) '''Author:''' [http://kolmafia.us/member.php?1017-jasonharper jasonharper]
* This script will help you get the [http://kol.coldfront.net/thekolwiki/index.php/Color_Wheel_of_Yuck Color Wheel of Yuck] trophy by checking your discoveries list and mixing the vials in your inventory to create slime potions you do not know.

'''Tiny Plastic Series 1 & 2 Checker''' - ([http://kolmafia.us/showthread.php?goto=newpost&t=2587 download here]) '''Author:''' [http://kolmafia.us/member.php?1897-Spiny Spiny Twizzler]
* Its default behaviour is informational to help you acquire your Tiny Plastic Trophy and/or Two-Tiered Tiny Plastic Trophy. You may optionally edit the preferences in the script to shop for missing trophies for you with a budget that you set yourself.

'''What are you worth?''' - ([http://kolmafia.us/showthread.php?2628-What-are-you-worth-networth.ash-will-tell-you.&p=24990&viewfull=1#post24990 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* This calculates the current value of all items you own and informs you of what you are worth.

==Script Libraries==
These scripts are libraries of functions that are required components of other scripts. By themselves they do little or nothing. Expect to download them when directed in a script's instructions, or if you want to be a scripter, then study them and learn.

'''HTMLform''' - ([http://kolmafia.us/showthread.php?3842 download here]) '''Author:''' [http://kolmafia.us/member.php?1017-jasonharper jasonharper]
* Library of functions used for creating forms in [[Relay_Override_Scripting#User_Interface_Script|relay interface scripts]].

'''SmashLib''' - ([http://kolmafia.us/showthread.php?3065 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=aqualectrix aqualectrix]
* Determines the results of pulverizing equipment and reports it for use by scripts or aliases.

'''ZLib''' - ([http://kolmafia.us/showthread.php?2072 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Ultimate toolbox of scripting functions for math, string manipulation, version checking, automatic mapfile updating, persistent variables, adventuring, kmailing and so much more. ''Many scripts require this.''

==Misc==

'''Clan Hopping''' - ([http://kolmafia.us/showthread.php?2071 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Hop to a whitelisted clan quickly and easily from the CLI.

Helpful Scripts

2010-06-10T01:01:38Z

Spiny Twizzler: /* Informational Scripts */

{{TOCright}}
This is a list of well written scripts that are currently being maintained for the latest version of KoL and KolMafia. All scripts on this list are free and certified safe for use without any hidden costs or malicious code. If these scripts become outdated for very long or any security risks are found they will be removed from this list, so users should feel free to make use of them.

Of course it is possible that one of these scripts can cause trouble for the user if they are not used properly, so please read the opening post in each thread linked before using that script.

==Turn-Burning Scripts==

'''autoBasement''' - ([http://kolmafia.us/showthread.php?3113 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Automates delving into Fernswarthy's Basement.

'''bounty''' - ([http://kolmafia.us/showthread.php?1023-auto-BHH-and-friends&p=15204&viewfull=1#post15204 download here]) '''Author:''' [http://kolmafia.us/member.php?197-izchak izchak], [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Automates the bounty gathering quest.
* In conjunction with SmartStasis combat script (below) it will also olfact the monster for the bounty.

'''CounterChecker''' - ([http://kolmafia.us/showthread.php?2519 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Automates semi-rare acquisition, use of dance cards and a few other counter related activities.

'''Dwarven Factory''' - ([http://kolmafia.us/showthread.php?2884 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja]
* Automates the optional Dwarven Factory quest.

'''MacGuffin''' - ([http://kolmafia.us/showthread.php?1965 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Automation for the L11 MacGuffin Quest.

'''One-Click Wossname''' - ([http://kolmafia.us/showthread.php?960 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* A complete script for completing the L12 Island War quest.
* It allows you to chose the medal you are rewarded with, including a Wossname.

'''Rinn's Quest Scripts''' - ([http://kolmafia.us/showthread.php?2584 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Automation for most of the game's quests.

'''Slime Tube Adventuring Script''' - ([http://kolmafia.us/showthread.php?2596 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=alhifar Alhifar]
* Complete automation for the Slime Tube.
* You set up the outfits for maximum ML and minimum ML. The script then switches between them.
* It even allows you to chose to kill or tatter slimes.
* The variety of options allows every type of Slime Tube play, even a slimeling run, to be automated.

==Relay Override Scripts==

'''clan_basement.ash''' - ([http://kolmafia.us/showthread.php?4137 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
* Sorts dungeon loot by boss, presenting Hobopolis loot before Slime Tube loot.

'''pyramid.ash''' - ([http://kolmafia.us/showthread.php?3922 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
* Disables potentially harmful links in the Pyramid.

'''shore.ash''' - ([http://kolmafia.us/showthread.php?2813 download here]) '''Author:''' [http://kolmafia.us/member.php?872-lostcalpolydude lostcalpolydude] and [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* When you take a vacation it reminds you of which shore items you might need for floor 6 of the Sorceress' Tower.
* It uses the telescope to determine the exact item needed if you have a full scope.
* It also keeps you from taking a vacation when you need the the forged documents 'cause it sucks to accidently lose those 3 adventures.

'''Telescope Information''' - ([http://kolmafia.us/showthread.php?4057 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* When you look through the telescope at your campsite it will explain what monsters you will meet at the lair and the item to defeat them.
* Tells you if you have the items. If you need any items it tells you where to find them.

'''woods.ash''' - ([http://kolmafia.us/showthread.php?4199-Acquire-Continuum-Transfunctioner&p=29908&viewfull=1#post29908 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Gets the Continuum Transfunctioner automatically on your first visit to the woods. You will not need to click anything, it just happens.

===User Interface Scripts===

These scripts are a special type of relay override scripts in that they create pages that do not exist as part of KoL. They are prefixed by "relay_" and must be placed in the user's \relay directory. These scripts are accessed via the "-run script-" dropdown menu in the relay browser.

'''Daily Info''' - ([http://kolmafia.us/showthread.php?4248 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=icon315 Icon315]
*This script shows you the daily information such as the moons' effects on various modifiers, current stat day and Daily Dungeon rooms.

'''relay_SlimeTube''' - ([http://kolmafia.us/showthread.php?2596-Slime-Tube-Adventuring-Script&p=29687&viewfull=1#post29687 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Adapted from Alhifar's Slime Tube Adventuring Script; does everything the original script does.
* Adds a UI to enable the user to easily configure the Slime Tube script without having to modify the base script.

'''ZLib Variable Editor''' - ([http://kolmafia.us/showthread.php?4081 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
*This script provides a more user-friendly interface for modifying [http://kolmafia.us/showthread.php?2072 ZLib] variables.

==Custom Combat Scripts==

'''First Things First''' - ([http://kolmafia.us/showthread.php?1255 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Takes care of the first few things needed in a fight: pickpocketing, entangling noodles, olfaction, spooky putty, etc
* Includes quest related events: insulting pirates, throwing flyers, driving away clingy pirates if clingfilm is not needed, etc.

'''SmartStasis''' - ([http://kolmafia.us/showthread.php?1715 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Includes everything from First Things First. (Requires that to be downloaded also.)
* Stasis monsters for a variety of reasons: starfishing, hobo monkey meat.
* Notices when the monkey steals and recognizes if your slimeling or other chargeable starfish is out of juice and ends stasis.
* Quest related stasis: Using molybdenum magnet on the correct gremlin, getting essences in Seaside Megalopolis, learning rave dance moves Outside the Club.
* Uses disco combos and rave combos when they improve your profit.

==Buff Upkeep Scripts==

'''acquireBuff''' - ([http://kolmafia.us/showthread.php?4048 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Gets a buff from a buffbot without needing to know the bot's name or pricelist.

'''Best Between Battle Script Ever''' - ([http://kolmafia.us/showthread.php?1240 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Executes between battles in automatic adventuring.
* Adjusts choice adventures, adjusts MCD for current moxie, auto-tames turtles.

'''hatter.ash''' - ([http://kolmafia.us/showthread.php?4262 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja]
* To get a specific Mad Hatter buff painlessly.

'''Universal Recovery''' - ([http://kolmafia.us/showthread.php?1780 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Improves mafia's automated recovery to make best use of all items in hardcore/ronin or conserve meat if you have mall access.
* Keeps spare mp healing items on-hand in case they are needed in combat.
* Conserves healing items for use against your Shadow.
* Removes poison and keeps some extra antidotes for use in combat.

'''VIP Hopping''' - ([http://kolmafia.us/showthread.php?3620-VIP-Hopping!-Quick-clanhop-to-BAfH-for-all-VIP-room-goodies! download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Hops over the clan Bonus Adventures from Hell to get something from their VIP Lounge, then it hops back to your regular clan.
* Enables access to all VIP Lounge amenities and the ballpit without needing to spend time in BaFH.
* If you don't have a membership in Bonus Adventures from Hell, it submits a request to join the clan so that you can get access to a fully stocked VIP Lounge for free.

==Item Handling Scripts==

'''PriceAdvisor''' - ([http://kolmafia.us/showthread.php?3110 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=aqualectrix aqualectrix]
* Gives advice on how to maximize profit from an item.

'''Rainbow Gravitation made easy''' - ([http://kolmafia.us/showthread.php?1929 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* In hardcore/ronin it handles automatic wad transmutation to enable easy creation of Rainbow Wads.
* With mall access, it will purchase necessary wads to use daily casts of Rainbow Gravitation.

'''Scripting the birth of a new life''' - ([http://kolmafia.us/showthread.php?2769 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Sets optimal choice adventures based on current class for your ascension. Perfect to run at the beginning of a new life.
* Automates simple tasks that are always run at the beginning of a new life like pulling your VIP Lounge Key and visiting the Toot Oriole.

==Informational Scripts==

'''bumcheekcity's Easy Wiki Snapshot Maker''' - ([http://kolmafia.us/showthread.php?3001 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bumcheekcity bumcheekcity]
* This script will collect information about your character and generate a profile to display on [http://bumcheekcity.com/kol/profile.php bumcheekcity's website].

'''EatDrink.ash: Optimize your daily diet''' - ([http://kolmafia.us/showthread.php?4202-The-Unofficial-Ascend.ash-support-thread.&p=30725&viewfull=1#post30725 best download here]) - ([http://kolmafia.us/showthread.php?1519 outdated official thread here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=fronobulax fronobulax]
* Tries to find an optimal diet for a given value of an adventure.
* Can be run in simulation mode, just to see what it would do.
* Since dj_d is taking a leave of absence, fronobulax has temporarily taken up maintenance of this script.

'''StDoodle's Custom Daily Deeds''' - ([http://kolmafia.us/showthread.php?3443 download here]) '''Author:''' [http://kolmafia.us/member.php?720-StDoodle StDoodle]
* Tracks all events that have limited uses, from pool table to pasta summoning.

'''Slime Vial Recipes''' - ([http://kolmafia.us/showthread.php?3544-Slime-vial-recipes&p=25337&viewfull=1#post25337 download here]) '''Author:''' [http://kolmafia.us/member.php?1017-jasonharper jasonharper]
* This script will help you get the [http://kol.coldfront.net/thekolwiki/index.php/Color_Wheel_of_Yuck Color Wheel of Yuck] trophy by checking your discoveries list and mixing the vials in your inventory to create slime potions you do not know.

'''Tiny Plastic Series 1 & 2 Checker''' - ([http://kolmafia.us/showthread.php?goto=newpost&t=2587 download here]) '''Author:''' [http://kolmafia.us/member.php?1897-Spiny Spiny Twizzler]
* Its default behaviour is informational to help you acquire your Tiny Plastic Trophy and/or Two-Tiered Tiny Plastic Trophy. You may optionally edit the preferences in the script to shop for missing trophies for you with a budget that you set yourself.

'''What are you worth?''' - ([http://kolmafia.us/showthread.php?2628-What-are-you-worth-networth.ash-will-tell-you.&p=24990&viewfull=1#post24990 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* This calculates the current value of all items you own and informs you of what you are worth.

==Script Libraries==
These scripts are libraries of functions that are required components of other scripts. By themselves they do little or nothing. Expect to download them when directed in a script's instructions, or if you want to be a scripter, then study them and learn.

'''HTMLform''' - ([http://kolmafia.us/showthread.php?3842 download here]) '''Author:''' [http://kolmafia.us/member.php?1017-jasonharper jasonharper]
* Library of functions used for creating forms in [[Relay_Override_Scripting#User_Interface_Script|relay interface scripts]].

'''SmashLib''' - ([http://kolmafia.us/showthread.php?3065 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=aqualectrix aqualectrix]
* Determines the results of pulverizing equipment and reports it for use by scripts or aliases.

'''ZLib''' - ([http://kolmafia.us/showthread.php?2072 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Ultimate toolbox of scripting functions for math, string manipulation, version checking, automatic mapfile updating, persistent variables, adventuring, kmailing and so much more. ''Many scripts require this.''

==Misc==

'''Clan Hopping''' - ([http://kolmafia.us/showthread.php?2071 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Hop to a whitelisted clan quickly and easily from the CLI.

Helpful Scripts

2010-06-10T00:55:51Z

Spiny Twizzler: /* Informational Scripts */

{{TOCright}}
This is a list of well written scripts that are currently being maintained for the latest version of KoL and KolMafia. All scripts on this list are free and certified safe for use without any hidden costs or malicious code. If these scripts become outdated for very long or any security risks are found they will be removed from this list, so users should feel free to make use of them.

Of course it is possible that one of these scripts can cause trouble for the user if they are not used properly, so please read the opening post in each thread linked before using that script.

==Turn-Burning Scripts==

'''autoBasement''' - ([http://kolmafia.us/showthread.php?3113 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Automates delving into Fernswarthy's Basement.

'''bounty''' - ([http://kolmafia.us/showthread.php?1023-auto-BHH-and-friends&p=15204&viewfull=1#post15204 download here]) '''Author:''' [http://kolmafia.us/member.php?197-izchak izchak], [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Automates the bounty gathering quest.
* In conjunction with SmartStasis combat script (below) it will also olfact the monster for the bounty.

'''CounterChecker''' - ([http://kolmafia.us/showthread.php?2519 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Automates semi-rare acquisition, use of dance cards and a few other counter related activities.

'''Dwarven Factory''' - ([http://kolmafia.us/showthread.php?2884 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja]
* Automates the optional Dwarven Factory quest.

'''MacGuffin''' - ([http://kolmafia.us/showthread.php?1965 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Automation for the L11 MacGuffin Quest.

'''One-Click Wossname''' - ([http://kolmafia.us/showthread.php?960 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* A complete script for completing the L12 Island War quest.
* It allows you to chose the medal you are rewarded with, including a Wossname.

'''Rinn's Quest Scripts''' - ([http://kolmafia.us/showthread.php?2584 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Automation for most of the game's quests.

'''Slime Tube Adventuring Script''' - ([http://kolmafia.us/showthread.php?2596 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=alhifar Alhifar]
* Complete automation for the Slime Tube.
* You set up the outfits for maximum ML and minimum ML. The script then switches between them.
* It even allows you to chose to kill or tatter slimes.
* The variety of options allows every type of Slime Tube play, even a slimeling run, to be automated.

==Relay Override Scripts==

'''clan_basement.ash''' - ([http://kolmafia.us/showthread.php?4137 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
* Sorts dungeon loot by boss, presenting Hobopolis loot before Slime Tube loot.

'''pyramid.ash''' - ([http://kolmafia.us/showthread.php?3922 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
* Disables potentially harmful links in the Pyramid.

'''shore.ash''' - ([http://kolmafia.us/showthread.php?2813 download here]) '''Author:''' [http://kolmafia.us/member.php?872-lostcalpolydude lostcalpolydude] and [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* When you take a vacation it reminds you of which shore items you might need for floor 6 of the Sorceress' Tower.
* It uses the telescope to determine the exact item needed if you have a full scope.
* It also keeps you from taking a vacation when you need the the forged documents 'cause it sucks to accidently lose those 3 adventures.

'''Telescope Information''' - ([http://kolmafia.us/showthread.php?4057 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* When you look through the telescope at your campsite it will explain what monsters you will meet at the lair and the item to defeat them.
* Tells you if you have the items. If you need any items it tells you where to find them.

'''woods.ash''' - ([http://kolmafia.us/showthread.php?4199-Acquire-Continuum-Transfunctioner&p=29908&viewfull=1#post29908 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Gets the Continuum Transfunctioner automatically on your first visit to the woods. You will not need to click anything, it just happens.

===User Interface Scripts===

These scripts are a special type of relay override scripts in that they create pages that do not exist as part of KoL. They are prefixed by "relay_" and must be placed in the user's \relay directory. These scripts are accessed via the "-run script-" dropdown menu in the relay browser.

'''Daily Info''' - ([http://kolmafia.us/showthread.php?4248 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=icon315 Icon315]
*This script shows you the daily information such as the moons' effects on various modifiers, current stat day and Daily Dungeon rooms.

'''relay_SlimeTube''' - ([http://kolmafia.us/showthread.php?2596-Slime-Tube-Adventuring-Script&p=29687&viewfull=1#post29687 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Adapted from Alhifar's Slime Tube Adventuring Script; does everything the original script does.
* Adds a UI to enable the user to easily configure the Slime Tube script without having to modify the base script.

'''ZLib Variable Editor''' - ([http://kolmafia.us/showthread.php?4081 download here]) '''Author:''' [http://kolmafia.us/member.php?2984-heeheehee Heeheehee]
*This script provides a more user-friendly interface for modifying [http://kolmafia.us/showthread.php?2072 ZLib] variables.

==Custom Combat Scripts==

'''First Things First''' - ([http://kolmafia.us/showthread.php?1255 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Takes care of the first few things needed in a fight: pickpocketing, entangling noodles, olfaction, spooky putty, etc
* Includes quest related events: insulting pirates, throwing flyers, driving away clingy pirates if clingfilm is not needed, etc.

'''SmartStasis''' - ([http://kolmafia.us/showthread.php?1715 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Includes everything from First Things First. (Requires that to be downloaded also.)
* Stasis monsters for a variety of reasons: starfishing, hobo monkey meat.
* Notices when the monkey steals and recognizes if your slimeling or other chargeable starfish is out of juice and ends stasis.
* Quest related stasis: Using molybdenum magnet on the correct gremlin, getting essences in Seaside Megalopolis, learning rave dance moves Outside the Club.
* Uses disco combos and rave combos when they improve your profit.

==Buff Upkeep Scripts==

'''acquireBuff''' - ([http://kolmafia.us/showthread.php?4048 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Gets a buff from a buffbot without needing to know the bot's name or pricelist.

'''Best Between Battle Script Ever''' - ([http://kolmafia.us/showthread.php?1240 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Executes between battles in automatic adventuring.
* Adjusts choice adventures, adjusts MCD for current moxie, auto-tames turtles.

'''hatter.ash''' - ([http://kolmafia.us/showthread.php?4262 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja]
* To get a specific Mad Hatter buff painlessly.

'''Universal Recovery''' - ([http://kolmafia.us/showthread.php?1780 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Improves mafia's automated recovery to make best use of all items in hardcore/ronin or conserve meat if you have mall access.
* Keeps spare mp healing items on-hand in case they are needed in combat.
* Conserves healing items for use against your Shadow.
* Removes poison and keeps some extra antidotes for use in combat.

'''VIP Hopping''' - ([http://kolmafia.us/showthread.php?3620-VIP-Hopping!-Quick-clanhop-to-BAfH-for-all-VIP-room-goodies! download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Hops over the clan Bonus Adventures from Hell to get something from their VIP Lounge, then it hops back to your regular clan.
* Enables access to all VIP Lounge amenities and the ballpit without needing to spend time in BaFH.
* If you don't have a membership in Bonus Adventures from Hell, it submits a request to join the clan so that you can get access to a fully stocked VIP Lounge for free.

==Item Handling Scripts==

'''PriceAdvisor''' - ([http://kolmafia.us/showthread.php?3110 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=aqualectrix aqualectrix]
* Gives advice on how to maximize profit from an item.

'''Rainbow Gravitation made easy''' - ([http://kolmafia.us/showthread.php?1929 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* In hardcore/ronin it handles automatic wad transmutation to enable easy creation of Rainbow Wads.
* With mall access, it will purchase necessary wads to use daily casts of Rainbow Gravitation.

'''Scripting the birth of a new life''' - ([http://kolmafia.us/showthread.php?2769 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Sets optimal choice adventures based on current class for your ascension. Perfect to run at the beginning of a new life.
* Automates simple tasks that are always run at the beginning of a new life like pulling your VIP Lounge Key and visiting the Toot Oriole.

==Informational Scripts==

'''bumcheekcity's Easy Wiki Snapshot Maker''' - ([http://kolmafia.us/showthread.php?3001 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bumcheekcity bumcheekcity]
* This script will collect information about your character and generate a profile to display on [http://bumcheekcity.com/kol/profile.php bumcheekcity's website].

'''EatDrink.ash: Optimize your daily diet''' - ([http://kolmafia.us/showthread.php?4202-The-Unofficial-Ascend.ash-support-thread.&p=30725&viewfull=1#post30725 best download here]) - ([http://kolmafia.us/showthread.php?1519 outdated official thread here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=fronobulax fronobulax]
* Tries to find an optimal diet for a given value of an adventure.
* Can be run in simulation mode, just to see what it would do.
* Since dj_d is taking a leave of absence, fronobulax has temporarily taken up maintenance of this script.

'''StDoodle's Custom Daily Deeds''' - ([http://kolmafia.us/showthread.php?3443 download here]) '''Author:''' [http://kolmafia.us/member.php?720-StDoodle StDoodle]
* Tracks all events that have limited uses, from pool table to pasta summoning.

'''Slime Vial Recipes''' - ([http://kolmafia.us/showthread.php?3544-Slime-vial-recipes&p=25337&viewfull=1#post25337 download here]) '''Author:''' [http://kolmafia.us/member.php?1017-jasonharper jasonharper]
* This script will help you get the [http://kol.coldfront.net/thekolwiki/index.php/Color_Wheel_of_Yuck Color Wheel of Yuck] trophy by checking your discoveries list and mixing the vials in your inventory to create slime potions you do not know.

'''Tiny Plastic Series 1 & 2 Checker''' - ([http://kolmafia.us/showthread.php?goto=newpost&t=2587 download here]) '''Author:''' [http://kolmafia.us/member.php?1897-Spiny Spiny Twizzler]
* It's default behaviour is informational to help you acquire your Tiny Plastic Trophy and/or Two-Tiered Tiny Plastic Trophy. You may optionally edit the preferences in the script to shop for missing trophies for you with a budget that you set yourself.

'''What are you worth?''' - ([http://kolmafia.us/showthread.php?2628-What-are-you-worth-networth.ash-will-tell-you.&p=24990&viewfull=1#post24990 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* This calculates the current value of all items you own and informs you of what you are worth.

==Script Libraries==
These scripts are libraries of functions that are required components of other scripts. By themselves they do little or nothing. Expect to download them when directed in a script's instructions, or if you want to be a scripter, then study them and learn.

'''HTMLform''' - ([http://kolmafia.us/showthread.php?3842 download here]) '''Author:''' [http://kolmafia.us/member.php?1017-jasonharper jasonharper]
* Library of functions used for creating forms in [[Relay_Override_Scripting#User_Interface_Script|relay interface scripts]].

'''SmashLib''' - ([http://kolmafia.us/showthread.php?3065 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=aqualectrix aqualectrix]
* Determines the results of pulverizing equipment and reports it for use by scripts or aliases.

'''ZLib''' - ([http://kolmafia.us/showthread.php?2072 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Ultimate toolbox of scripting functions for math, string manipulation, version checking, automatic mapfile updating, persistent variables, adventuring, kmailing and so much more. ''Many scripts require this.''

==Misc==

'''Clan Hopping''' - ([http://kolmafia.us/showthread.php?2071 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Hop to a whitelisted clan quickly and easily from the CLI.

String Handling Routines

2009-09-29T05:00:32Z

Spiny Twizzler: /* Part 8 - String Handling Routines */

== Part 8 - String Handling Routines ==
Under Construction
void print( string helloworld ) 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window.
string [[visit_url alpha|visit_url( string url )]] 
Accesses the specified URL, manages any applicable redirects (including if the page offered a choice adventure), and returns the HTML of the final response page.
string location_to_url( location place ) 

Returns the URL that would need to be accessed to visit the specified location.
boolean contains_text( string source, string query ) 
Reveals if the query string is a substring of the source string.
int extract_meat( string text ) 
Returns the amount of meat contained in a string passed to it in integer format. For use in k-mail parsing. *Not for use on pending trades.*
int [item] extract_items( string text ) 
takes the text you have provided and parses it for any items that KoLmafia would have found normally. This means you have access to the built-in pluralization handler as well as the ability to NOT have to lookup description IDs or whatever other loops you had to use to access that information. For use in k-mail parsing. *Not for use on pending trades.*
int length( string text ) 
Returns the length of the given string.

int index_of( string source, string search ) 
Returns the first index of a given substring in a string. 
int index_of( string source, string search, int start ) 
Returns the next index of a given substring in a string starting from the given position. 
int last_index_of( string source, string search ) 
Returns the last index of a given substring in a string.
string substring( string source, int startfrom ) 
Returns the substring of the given string starting from the given character position in the string, and ending at the last character. 
string substring( string source, int start, int end ) 

Returns the substring of the given string starting from the character position indicated by start in the string, and ending at the character position indicated by end.
string replace_string( string source, string search, string replace ) 
searches the source string for the search string and replaces all instances with the replace string
string url_encode( string text ) 
string url_decode( string text ) 
Converts a string text into a formatted string for using with raw URLs or from a formatted string back into “normal” text.

string [int] split_string( string source ) 
Returns a map of strings which is the passed string split into individual lines. Originally implemented for use when parsing session logs, but may see more uses in the future.
http://kolmafia.us/showthread.php?t=573 
string [int] split_string( string source, string regex ) 
string [int,int] group_string( string source, string regex ) 
see this post located on the script repository for more information: http://kolmafia.us/showthread.php?t=318 

string [int] session_logs( string player, int day_count )
Gives access to the session logs saved by kolmafia. More details will be added when this function's own page is written. For now, more extensive details can be found here: http://kolmafia.us/showthread.php?t=573

buffer append( buffer source, string text ) 
Returns the source buffer with the string added on at the end. 
buffer append_tail( matcher regex, buffer source ) 
This function appends the text returned by a matcher to the end of the buffer text.

String Handling Routines

2009-09-29T04:56:58Z

Spiny Twizzler: /* Part 8 - String Handling Routines */

== Part 8 - String Handling Routines ==
Under Construction
void print( string helloworld ) 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window.
string [[visit_url alpha|visit_url( string url )]] 
Accesses the specified URL, manages any applicable redirects (including if the page offered a choice adventure), and returns the HTML of the final response page.
string location_to_url( location place ) 

Returns the URL that would need to be accessed to visit the specified location.
boolean contains_text( string source, string query ) 
Reveals if the query string is a substring of the source string.
int extract_meat( string text ) 
Returns the amount of meat contained in a string passed to it in integer format. For use in k-mail parsing. *Not for use on pending trades.*
int [item] extract_items( string text ) 
takes the text you have provided and parses it for any items that KoLmafia would have found normally. This means you have access to the built-in pluralization handler as well as the ability to NOT have to lookup description IDs or whatever other loops you had to use to access that information. For use in k-mail parsing. *Not for use on pending trades.*
int length( string text ) 
Returns the length of the given string.

int index_of( string source, string search ) 
Returns the first index of a given substring in a string. 
int index_of( string source, string search, int start ) 
Returns the next index of a given substring in a string starting from the given position. 
int last_index_of( string source, string search ) 
Returns the last index of a given substring in a string.
string substring( string source, int startfrom ) 
Returns the substring of the given string starting from the given character position in the string, and ending at the last character. 
string substring( string source, int start, int end ) 

Returns the substring of the given string starting from the character position indicated by start in the string, and ending at the character position indicated by end.
string replace_string( string source, string search, string replace ) 
searches the source string for the search string and replaces all instances with the replace string
string url_encode( string text ) 
string url_decode( string text ) 
Converts a string text into a formatted string for using with raw URLs or from a formatted string back into “normal” text.

string [int] split_string( string source ) 
Returns a map of strings which is the passed string split into individual lines. Originally implemented for use when parsing session logs, but may see more uses in the future.
http://kolmafia.us/index.php/topic,794.msg3868.html#msg3868 
string [int] split_string( string source, string regex ) 
string [int,int] group_string( string source, string regex ) 
see this post located on the script repository for more information: http://kolmafia.us/showthread.php?t=318 

string [int] session_logs( string player, int day_count )
Gives access to the session logs saved by kolmafia. More details will be added when this function's own page is written. For now, more extensive details can be found here: http://kolmafia.us/showthread.php?t=573

buffer append( buffer source, string text ) 
Returns the source buffer with the string added on at the end. 
buffer append_tail( matcher regex, buffer source ) 
This function appends the text returned by a matcher to the end of the buffer text.

String Handling Routines

2009-09-29T04:54:43Z

Spiny Twizzler: /* Part 8 - String Handling Routines */

== Part 8 - String Handling Routines ==
Under Construction
void print( string helloworld ) 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window.
string [[visit_url alpha|visit_url( string url )]] 
Accesses the specified URL, manages any applicable redirects (including if the page offered a choice adventure), and returns the HTML of the final response page.
string location_to_url( location place ) 

Returns the URL that would need to be accessed to visit the specified location.
boolean contains_text( string source, string query ) 
Reveals if the query string is a substring of the source string.
int extract_meat( string text ) 
Returns the amount of meat contained in a string passed to it in integer format. For use in k-mail parsing. *Not for use on pending trades.*
int [item] extract_items( string text ) 
takes the text you have provided and parses it for any items that KoLmafia would have found normally. This means you have access to the built-in pluralization handler as well as the ability to NOT have to lookup description IDs or whatever other loops you had to use to access that information. For use in k-mail parsing. *Not for use on pending trades.*
int length( string text ) 
Returns the length of the given string.

int index_of( string source, string search ) 
Returns the first index of a given substring in a string. 
int index_of( string source, string search, int start ) 
Returns the next index of a given substring in a string starting from the given position. 
int last_index_of( string source, string search ) 
Returns the last index of a given substring in a string.
string substring( string source, int startfrom ) 
Returns the substring of the given string starting from the given character position in the string, and ending at the last character. 
string substring( string source, int start, int end ) 

Returns the substring of the given string starting from the character position indicated by start in the string, and ending at the character position indicated by end.
string replace_string( string source, string search, string replace ) 
searches the source string for the search string and replaces all instances with the replace string
string url_encode( string text ) 
string url_decode( string text ) 
Converts a string text into a formatted string for using with raw URLs or from a formatted string back into “normal” text.

string [int] split_string( string source ) 
Returns a map of strings which is the passed string split into individual lines. Originally implemented for use when parsing session logs, but may see more uses in the future.
http://kolmafia.us/index.php/topic,794.msg3868.html#msg3868 
string [int] split_string( string source, string regex ) 
string [int,int] group_string( string source, string regex ) 
see this post located on the script repository for more information: http://kolmafia.us/index.php/topic,451.msg2235.html#msg2235 

string [int] session_logs( string player, int day_count )
Gives access to the session logs saved by kolmafia. More details will be added when this function's own page is written. For now, more extensive details can be found here: http://kolmafia.us/showthread.php?t=573

buffer append( buffer source, string text ) 
Returns the source buffer with the string added on at the end. 
buffer append_tail( matcher regex, buffer source ) 
This function appends the text returned by a matcher to the end of the buffer text.