imported>StDoodle |
imported>Bale |
| Line 1: |
Line 1: |
| | {{TOCright}} | | {{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.
| + | ==Introduction== |
| | + | Many people wish to synchronize Mafia across multiple computers. They find it helpful to use the same counters, scripts, builds, etc regardless of where they are in the world. It can certainly be nice to know that your settings, such as the location of your last semi-rare are remembered by mafia regardless of you being at work or home. |
| | | | |
| − | 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.
| + | A popular and effective solution is to share mafia settings by running it on Dropbox or a flash drive. Since Dropbox has nearly every advantage possessed by the other, without needing to actually remember to take it with you, we'll discuss Dropbox. These same lessons can be used to run mafia from your flash drive, with just a little ingenuity. |
| | | | |
| − | ==Turn-Burning Scripts==
| + | Dropbox is a program found at [http://www.dropbox.com/ http://www.dropbox.com/] which will share a designated folder online. It uploads the contents of that folder to its website for free. 2 Gig of free storage is provided, so don't worry about the size of your mafia installation. Any other computer that also installs Dropbox (and logs on with your password) will synchronize all files in the dropbox folder. No other folders or files on your computer will be shared, so it is not a security risk. |
| | | | |
| − | '''autoBasement''' - ([http://kolmafia.us/showthread.php?3113 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
| + | ==Installation== |
| − | * Automates delving into Fernswarthy's Basement.
| + | First, download [http://www.dropbox.com/ Dropbox] and install it to your hard drive. It will prompt you for a location to designate as your Dropbox folder. The default location works fine. Any other location works fine also. |
| | | | |
| − | '''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]
| + | Next, download mafia to your Dropbox folder. You might want to put it in Dropbox/kolmafia. This works just like downloading mafia to any other location that you want to run it from. |
| − | * 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] | + | ==Sharing Settings== |
| − | * Automates semi-rare acquisition, use of dance cards and a few other counter related activities.
| + | If you're using Windows, then you're done! When you run mafia it will create a bunch of subdirectories just like it always does. Dropbox will share those subdirectories and their contents with your other computers online. Easy-peasy! |
| | | | |
| − | '''Dwarven Factory''' - ([http://kolmafia.us/showthread.php?2884 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja] | + | Unfortunately if you're using Linux or a Mac, then it isn't quite that easy. Those systems do not keep settings stored in the same location as the program. You'll need to set up symbolic links to trick them into saving their data in the Dropbox folder. |
| − | * 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]
| + | ===Creating Symlinks=== |
| − | * Automation for the L11 MacGuffin Quest.
| + | Linux users are expected to be familiar with the command line interface, so it should be easier for them. For Mac users some more detailed instructions will be provided. Replace /path/to/dropbox/folder/ with the actual path to your Dropbox folder. |
| | | | |
| − | '''One-Click Wossname''' - ([http://kolmafia.us/showthread.php?960 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
| + | *Linux |
| − | * A complete script for completing the L12 Island War quest.
| + | : Open the command-line interface and type in: |
| − | * It allows you to chose the medal you are rewarded with, including a Wossname.
| + | : ln -s ~/.kolmafia /path/to/dropbox/folder/KoLmafia |
| | | | |
| − | '''Rinn's Quest Scripts''' - ([http://kolmafia.us/showthread.php?2584 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
| + | *Mac |
| − | * Automation for most of the game's quests.
| + | : Open the command-line interface and type in: |
| | + | : ln -s /Library/Application\ Support/KoLmafia /path/to/dropbox/folder/KoLmafia |
| | | | |
| − | '''Slime Tube Adventuring Script''' - ([http://kolmafia.us/showthread.php?2596 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=alhifar Alhifar]
| + | : In case those instructions for the Mac made no sense, instructions will be provided step-by-step. |
| − | * Complete automation for the Slime Tube.
| + | # Open Terminal.app. This is in /Applications/Utilities, or you can just use Spotlight to find it. |
| − | * You set up the outfits for maximum ML and minimum ML. The script then switches between them.
| + | # Open Finder, and navigate to the folder containing your Dropbox folder. |
| − | * It even allows you to chose to kill or tatter slimes. | + | # In Terminal, type "cd ", then drag the Dropbox folder onto the Terminal window, then press Enter. |
| − | * The variety of options allows every type of Slime Tube play, even a slimeling run, to be automated.
| + | #* Leave the quotes out for all of these commands and make sure to include the trailing space. Copy-pasting the commands is advised. |
| | + | # In Terminal, type "ln -s /Library/Application\ Support/KoLmafia KoLmafia", then press enter. |
| | + | # You now have a symbolic link, and Dropbox will back up your mafia settings files. |
| | | | |
| − | ==Relay Override Scripts==
| + | [[Category:Tech Support]] |
| − | | |
| − | '''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. Deprecated by zarqon's WOSSMAN.
| |
| − | | |
| − | '''WOSSMAN''' - ([http://kolmafia.us/showthread.php?2072-ZLib-Zarqon-s-useful-function-library&p=38185&viewfull=1#post38185 download here] '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
| |
| − | * Zarqon's Wikified Online Script Settings Manager. Provides a more convenient method for editing ZLib variables. Since this script was released by the author of ZLib, this is essentially the official ZLib variable editor.
| |
| − | | |
| − | ==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?4812 download here]) '''Author:''' [http://kolmafia.us/member.php?720-StDoodle StDoodle]
| |
| − | * Tracks many 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 {{kolwiki|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|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|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.
| |
| − | | |
| − | [[Category:New User Help]][[Category:Scripting]]
| |