Kolmafia - User contributions [en]

KoLmafia Guide: Custom Combat Script

2010-07-16T16:09:57Z

SinginSally:

Autoattacking is fine and all, but in many cases you want something a bit more sophisticated. Let's say we are a Disco Bandit, fighting the Giants in the Cloud Castle with plenty of MP regen. We want to use our Disco Bandit combo skill which makes the fight easier and gives us a 1 turn +30% meat buff. This would be a huge pain to do manually for every fight.

1) In the Mafia Frame, Click the 'Custom Combat' Bottom Tab when in the Adventure TopTab. You will see a script called "Default", and it has several lines: A [Default] folder-looking icon, followed by a 1: Special Action, and 2: Attack With Weapon.
: [[File:Lesson5 default.png]]

This is what the script does: 
When encountering a [default] monster, it will do any special action indicated under the Special box, as described in the last lesson. This includes Pickpocketing, or whatever. 
On Round 2, it will Attack with Weapon. 
On round 3 and beyond, it repeats the last action commanded, which in this case is Attack with Weapon.
This continues until you have lost or won the fight.

2) We are gonna make our own script now! Click the NEW button at the bottom-right. Give it a name. This script is now selected instead of the "Default" custom script.

Note that we have the exact same 'default code' we saw in step 1. Note that [default] does NOT refer to the name of the script. It is simply a header referring to the series of actions it performs against a default monster. In advanced scripts you can put in a [monster name] with special actions taken against just that monster. This would be great for casting an elemental spell against a physical-resistant foe for example. For now, don't worry about it.

3) Click EDIT and modify our script. Go ahead and enter the following. For my example above, the script I described earlier would look like:
:[default]
:1: steal
:2: skill disco dance of doom
:3: skill disco dance II: electric boogaloo
:4: attack

When you hit OK, it will interpret what you typed. For example, the keyword 'steal' turns into 'try to steal an item'.
This script will pickpocket if applicable, do my 2 disco skills, then attack with weapon until end of combat.
: [[File:Lesson5 DiscoAttack.png]]

A more flexible script would be to Use Special Action as the round 1 action. This would allow me to choose whether to pickpocket or not, based on what is in my Special box. For you, make the following script depending on your class:
:line 1 - [default] (leave this line alone)
:line 2 - 1: special action (leave this line alone too)
:line 3 - add 2: skill <insert skill name here>
:line 4 - 3: attack. (leave this line alone)

So really, all you did is add line 3 and renumber line 4 from 2: attack to 3: attack.

The only trick is to find the exact name of the desired skill. Pick one of your low-level skills like Clobber, Toss, a spell, Sing, or whatever your level 1 power is. Use your Relay Browser and click your top-left character profile to get the exact name. Type or Cut&Paste it in. Then hit OK. The 'attack' command will turn into 'attack with weapon'. If you typed the skill in properly it should be in the script. Otherwise, Mafia will complain about an invalid skill. Note that the last entry is what the script will keep repeating until the combat is over.

For Reference, the HELP button will give you a list of the script commands. 'steal' is for pickpocketing, 'skill X' will perform the skill, X, you specify. 'item X' uses an item. There are several others to explore later.

4) Make sure the main KoLmafia Frame's 'Action:' pulldown shows 'custom combat script' as the active one, as opposed to 'attack with weapon'.
: [[File:Lesson5 ccs.png]]
Next, make sure that your named script is selected, as opposed to that Default one.
: [[File:Lesson5 cccName.png]]

5) Time to test it! Go fight something in the Relay Browser and click the Script button at top-left. Watch and see what it does. Did it work? Actually this might be a bit tricky to determine since Scripted attacks tend to skip browser refreshes. Instead, click the 'Graphical CLI' tab and see EXACTLY what your character did.

'''Bonus)''' Modify your script and add a 20: abort. This will instruct the script to abort as the 20th action (not necessarily the 20th round). It will pop up a mini-browser and you will finish the fight manually. This is a good catch-all safety feature in case you are fighting a physical immune with no elemental damage, or using a low-power 'disguise outfit' or trying to wield a melee weapon as a moxie-class, or whatever else went wrong.

'''BOTTOM LINE:''' Combat Scripts are very flexible and can help you take advantage of stuff you might normally be too lazy to do regularly such as Disco combos, Turtle Tamer Chains, Noodle Summons, and other repetitive things.

'''Continue''' to [[KoLmafia Guide: Auto-Adventuring|Lesson 6: Auto-Adventuring]]

[[Category:KoLmafia Guide]][[Category:New User Help]]

KoLmafia Guide: Custom Combat Script

2010-07-16T16:07:43Z

SinginSally:

Autoattacking is fine and all, but in many cases you want something a bit more sophisticated. Let's say we are a Disco Bandit, fighting the Giants in the Cloud Castle with plenty of MP regen. We want to use our Disco Bandit combo skill which makes the fight easier and gives us a 1 turn +30% meat buff. This would be a huge pain to do manually for every fight.

1) In the Mafia Frame, Click the 'Custom Combat' Bottom Tab when in the Adventure TopTab. You will see a script called "Default", and it has several lines: A [Default] folder-looking icon, followed by a 1: Special Action, and 2: Attack With Weapon.
: [[File:Lesson5 default.png]]

This is what the script does: 
When encountering a [default] monster, it will do any special action indicated under the Special box, as described in the last lesson. This includes Pickpocketing, or whatever. 
On Round 2, it will Attack with Weapon. 
On round 3 and beyond, it repeats the last action commanded, which in this case is Attack with Weapon.
This continues until you have lost or won the fight.

2) We are gonna make our own script now! Click the NEW button at the bottom-right. Give it a name. This script is now selected instead of the "Default" custom script.

Note that we have the exact same 'default code' we saw in step 1. Note that [default] does NOT refer to the name of the script. It is simply a header referring to the series of actions it performs against a default monster. In advanced scripts you can put in a [monster name] with special actions taken against just that monster. This would be great for casting an elemental spell against a physical-resistant foe for example. For now, don't worry about it.

3) Click EDIT and modify our script. Go ahead and enter the following. For my example above, the script I described earlier would look like:
:[default]
:1: steal
:2: skill disco dance of doom
:3: skill disco dance II: electric boogaloo
:4: attack

When you hit OK, it will interpret what you typed. For example, the keyword 'steal' turns into 'try to steal an item'.
This script will pickpocket if applicable, do my 2 disco skills, then attack with weapon until end of combat.
: [[File:Lesson5 DiscoAttack.png]]

A more flexible script would be to Use Special Action as the round 1 action. This would allow me to choose whether to pickpocket or not, based on what is in my Special box. For you, make the following script depending on your class:
:line 1 - [default] (leave this line alone)
:line 2 - 1: special action (leave this line alone too)
:line 3 - add 2: skill <insert skill name here>
:line 4 - 3: attack. (leave this line alone)

So really, all you did is add line 3 and renumber line 4 from 2: attack to 3: attack.

The only trick is to find the exact name of the desired skill. Pick one of your low-level skills like Clobber, Toss, a spell, Sing, or whatever your level 1 power is. Use your Relay Browser and click your top-left character profile to get the exact name. Type or Cut&Paste it in. Then hit OK. The 'attack' command will turn into 'attack with weapon'. If you typed the skill in properly it should be in the script. Otherwise, Mafia will complain about an invalid skill. Note that the last entry is what the script will keep repeating until the combat is over.

For Reference, the HELP button will give you a list of the script commands. 'steal' is for pickpocketing, 'skill X' will perform the skill, X, you specify. 'item X' uses an item. There are several others to explore later.

4) Make sure the main KoLmafia Frame's 'Action:' pulldown shows 'custom combat script' as the active one, as opposed to 'attack with weapon'.
: [[File:Lesson5 ccs.png]]
Next, make sure that your named script is selected, as opposed to that Default one.
: [[File:Lesson5 cccName.png]]

5) Time to test it! Go fight something in the Relay Browser and click the Script button at top-left. Watch and see what it does. Did it work? Actually this might be a bit tricky to determine since Scripted attacks tend to skip browser refreshes. Instead, click the 'Graphical CLI' tab and see EXACTLY what your character did.

[b]Bonus)[/b] Modify your script and add a 20: abort. This will instruct the script to abort as the 20th action (not necessarily the 20th round). It will pop up a mini-browser and you will finish the fight manually. This is a good catch-all safety feature in case you are fighting a physical immune with no elemental damage, or using a low-power 'disguise outfit' or trying to wield a melee weapon as a moxie-class, or whatever else went wrong.

[b]BOTTOM LINE:[/b] Combat Scripts are very flexible and can help you take advantage of stuff you might normally be too lazy to do regularly such as Disco combos, Turtle Tamer Chains, Noodle Summons, and other repetitive things.

[b]Continue[/b] to [[KoLmafia Guide: Auto-Adventuring|Lesson 6: Auto-Adventuring]]

[[Category:KoLmafia Guide]][[Category:New User Help]]

KoLmafia Guide: Attack Script

2010-05-26T16:42:21Z

SinginSally:

Now we are going to fight a foe using a Mafia script instead of our standard method. It is very easy!

1) In the Mafia frame with the Adventure Top Tab active, on the far right there is a pulldown that is labeled 'Action:'. It defaults to 'Attack with Weapon'. Not surprisingly, when auto-combat is activated the script will keep attacking until the combat is over. By clicking this pulldown, you can choose several other options, based on what your character has available. For example, you can have it spam Thrust-Smack, or cast a spell, or whatever.
For now, either stick with weapon-attack, or casting a low MP offensive spell.

You can click in the bar below labeled 'Special:' to set up conditional beginning-of-fight actions. For example, as a Moxie-Class, an option is for Mafia to automatically pickpocket all non-bosses if you win initiative. If you are a moxie-class, pick this option. You could also tell Mafia to always cast Entangling Noodles. When selected, a corresponding symbol shows up in the Special Box. Note that the option is ignored if you don't meet the requirements (for example, asking for Noodles when you don't have the skill).

: [[File:Lesson4 actions.png]]

2) In your relay browser, go fight something easy but takes a few rounds to kill. If you use Combat Action Bars, click the 'Script' button.
: [[File:Lesson4 CAB.png]]
:If you don't use action bars, Mafia adds several buttons for easier combat and the 'Script' will be one of them.
: [[File:Lesson4 KolCbt.png]]

3) The script will execute, which will pickpocket if possible (if you are a Moxie class, noodle if Myst,etc.), and then spam the default action until the fight is over. Cool huh? No more clicking the Attack button 6 times every fight! If you run out of mana, it will default to a weapon attack. (more on this later).

You will notice the fight will go a lot faster too in that it will appear to 'skip rounds'. This is because KoLMafia can send commands and receive results back faster than your browser will refresh. Hence a 12 round fight may only take 3 or 4 refreshes. This speeds up fighting significantly. It is also easier on the server.

''' Important note:''' In the latest versions of kolMafia (> 14.0), all repetitive actions are now converted into Combat Macros. This has a few advantages and disadvantages. You will no longer skip rounds; the result of each and every round is now displayed for you. Entering a combat macro is a bit easier on the server since it only takes a single server action. However, you have to scroll to the very bottom to see the final round results (or click the link) which can be very irritating if the combat is several rounds long. Plus, you can no longer tell if combat is going poorly and quickly 'abort' when auto-adventuring. (Best example of this is against a physical immune where you can see the rounds dragging on as you do 1 point per round). At this time, I don't know if there is any option of using the conventional method.

'''BOTTOM LINE:''' You can save clicks and reduce lag by using the Script button to fight easy battles for you.

'''Continue''' to [[KoLmafia Guide: Custom Combat Script|Lesson 5: Custom Combat Script]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Useful Commands

2010-05-26T16:32:16Z

SinginSally:

Most people will prefer the GUI for KoL playing. However, Mafia does have a handful of useful functions that you can type in.

These are the ones that I have found to be useful. Your mileage will vary, but read through these and try em out. A FULL LIST can be found in my Links section at the top of the guide.

1) You will need to be at the 'Graphical CLI' top-level tab.
: [[File:Lesson15 CLItab.png]]

2) At the bottom of the screen is a textbox where you may enter commands.
: [[File:Lesson15 CLIinput.png]]
----

* help [optional command] - Gives you a list of commands. OR how to use the given command if you type it 'help burn' for example.

* Ashref [optional filter] - If you tackle scripting this is invaluable. By itself, lists all ash script commands and what they do. You can include text after ashref which will then filter the output. For example, 'ashref item' would show all commands with item in the name or description.

* clear - Clears the screen and log entries entirely.

* hatter - If you have access to the Rabbit Hole, you can equip hats of certain character lengths and get buffs. This command prints out a table of all hats you own and the according buffs you could get!

* flowers - an automatic PvP script that beats up people and tries to get flowers. Good when you are too lazy to PvP.

* inv [optional filter] - Shows your inventory. The cool thing is that you can add a filter. So for a list of all your wads, you would type 'inv wad' and it will come back with Twinkly Wad, Hot Wad, or whatever wads you have. I generally use the item manager and sort by alphabetical order or type instead. But this works too. For example, you ask yourself 'did I get that pirate insult book doodad?'. You don't have to know the exact name. Just type Insult and let it do the work.

* modref - This gives you a huge list of pretty much ALL conceivable character stats such as Sleaze Damage, HP Max, Regen Rate, all resistances, and so forth. Furthermore the exact text of the first column works as a 'category' which you can then feed to the next few commands.

* maximize [category] - Equips your character using your inventory to the best of its ability in order to maximize the given category! Categories are found through the 'modref' command above. So if you wanted to maximize your Sleaze Resistance, you would type 'maximize Sleaze Resistance' and watch it go! It will give you a Score for the level of the maximized level. This is extremely useful for Clan Dungeons!

* modtrace [category] - Prints out a list of all sources that modify the desired category, either positively or negatively. So if you are wondering WHY you have a Meat Drop rate of say..140%, it will break it down for you!

* modifies [category] - Shows you ALL sources that modify the given category IN THE ENTIRE GAME. Whereas the previous commands just work with what inventory you have, this command lists everything, straight from the wiki. Sometimes this command is kind of flaky.

* wiki [filter] - This command shows you the wiki entry for whatever you typed in and pops it up in a new Tab. This is a really handy shortcut.

* Various Listers - These commands give you a list of quest or ascension-specific stuff you have identified.
** bang - Shows identified Dungeon of Doom potions. (clear, murky, etc)
** dusty - Lists identifies Dusty Wine bottles. (pinot noir, merlot, etc)
** insults - Lists all known pirate insults.
** demons - Lists names of demons known for summoning.

* pvplog - shows results of PvP combat. It actually generates a spreadsheet of all battles from your messagebox. To see it, you must go to the KoLMafia Directory under the Attacks subdirectory. It is very helpful though and even figures out all your enemies stats for you! (Like how many White Canadians they have drank, etc.) This is great if there is one guy that really hacks you off. This parsed log will help you gather info on them.

* undercut - Any items in your Mall store with the default price of 999999999 will be repriced to match the lowest mall price. Mafia uses the 5th lowest price, so you won't necessarily undercut everyone. On the other hand, you won't fall victim to the 1/day limit super-low priced options!

* reprice - ALL items in your mall store are repriced to match the lowest known mall price. Uses the 5th lowest price as per above.

* alias [=> assigns] - Lets you create a shortcut command. As an example of setting one, typing "alias buffode=> csend 300 meat to buffBawt" would assign the alias such that typing 'buffode' would then execute 'csend 300 meat to buffBawt' from then on. In this case it would then send meat to some random buffbut which you would know would cast Ode to Booze on you. Typing alias without an assignment shows all the aliases you currently have. They will stay until specifically deleted. Note that I have historically had some problems with the spacing of the =>, so try no spaces, 1 space before and 1 space after.

* csend - as shown in Alias above. Sends a kmail to the target with attached meat or items.

:[[File:Lesson15 output1.png]]

Continue to [[KoLmafia Guide: Closing Thoughts|Lesson 15: Closing Thoughts]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Useful Commands

2010-05-17T17:09:16Z

SinginSally:

Most people will prefer the GUI for KoL playing. However, Mafia does have a handful of useful functions that you can type in.

These are the ones that I have found to be useful. Your mileage will vary, but read through these and try em out. A FULL LIST can be found in my Links section at the top of the guide.

1) You will need to be at the 'Graphical CLI' top-level tab.

2) At the bottom of the screen is a small textbox where you may enter commands.
----

* help [optional command] - Gives you a list of commands. OR how to use the given command if you type it 'help burn' for example.

* Ashref [optional filter] - If you tackle scripting this is invaluable. By itself, lists all ash script commands and what they do. You can include text after ashref which will then filter the output. For example, 'ashref item' would show all commands with item in the name or description.

* clear - Clears the screen and log entries entirely.

* inv [optional filter] - Shows your inventory. The cool thing is that you can add a filter. So for a list of all your wads, you would type 'inv wad' and it will come back with Twinkly Wad, Hot Wad, or whatever wads you have. I generally use the item manager and sort by alphabetical order or type instead. But this works too. For example, you ask yourself 'did I get that pirate insult book doodad?'. You don't have to know the exact name. Just type Insult and let it do the work.

* modref - This gives you a huge list of pretty much ALL conceivable character stats such as Sleaze Damage, HP Max, Regen Rate, all resistances, and so forth. Furthermore the exact text of the first column works as a 'category' which you can then feed to the next few commands.

* maximize [category] - Equips your character using your inventory to the best of its ability in order to maximize the given category! Categories are found through the 'modref' command above. So if you wanted to maximize your Sleaze Resistance, you would type 'maximize Sleaze Resistance' and watch it go! It will give you a Score for the level of the maximized level. This is extremely useful for Clan Dungeons!

* modtrace [category] - Prints out a list of all sources that modify the desired category, either positively or negatively. So if you are wondering WHY you have a Meat Drop rate of say..140%, it will break it down for you!

* modifies [category] - Shows you ALL sources that modify the given category IN THE ENTIRE GAME. Whereas the previous commands just work with what inventory you have, this command lists everything, straight from the wiki. Sometimes this command is kind of flaky.

* wiki [filter] - This command shows you the wiki entry for whatever you typed in and pops it up in a new Tab. This is a really handy shortcut.

* Various Listers - These commands give you a list of quest or ascension-specific stuff you have identified.
** bang - Shows identified Dungeon of Doom potions. (clear, murky, etc)
** dusty - Lists identifies Dusty Wine bottles. (pinot noir, merlot, etc)
** insults - Lists all known pirate insults.
** demons - Lists names of demons known for summoning.

* pvplog - shows results of PvP combat. It actually generates a spreadsheet of all battles from your messagebox. To see it, you must go to the KoLMafia Directory under the Attacks subdirectory. It is very helpful though and even figures out all your enemies stats for you! (Like how many White Canadians they have drank, etc.) This is great if there is one guy that really hacks you off. This parsed log will help you gather info on them.

* undercut - Any items in your Mall store with the default price of 999999999 will be repriced to match the lowest mall price. Mafia uses the 5th lowest price, so you won't necessarily undercut everyone. On the other hand, you won't fall victim to the 1/day limit super-low priced options!

* reprice - ALL items in your mall store are repriced to match the lowest known mall price. Uses the 5th lowest price as per above.

* alias [=> assigns] - Lets you create a shortcut command. As an example of setting one, typing "alias buffode=> csend 300 meat to buffBawt" would assign the alias such that typing 'buffode' would then execute 'csend 300 meat to buffBawt' from then on. In this case it would then send meat to some random buffbut which you would know would cast Ode to Booze on you. Typing alias without an assignment shows all the aliases you currently have. They will stay until specifically deleted. Note that I have historically had some problems with the spacing of the =>, so try no spaces, 1 space before and 1 space after.

* csend - as shown in Alias above. Sends a kmail to the target with attached meat or items.

Continue to [[KoLmafia Guide: Closing Thoughts|Lesson 15: Closing Thoughts]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Running ASH Scripts

2010-05-17T17:03:44Z

SinginSally:

KolMafia has the capability to execute scripts which can perform just about any KoL action. Mafia scripting uses an .ash extension and is simply a text file that contains a bunch of Mafia commands with some programming language constructs as needed. You can browse, download, and execute scripts that other people have written to help automate specific functions or expand Mafia capabilities.

This poses a bit of a security risk, obviously. Mafia is all open-source and examined by many people and is relatively trustworthy. Some random dude's script.... not so much. Feel free to skip this lesson if this makes you nervous. Note that scripts can be extremely helpful though, so it is worth learning about them.

In this lesson, we are going to find a simple script, download it, store it, then execute it.

# First, we need to find a script we want to execute. For this lesson, point your browser to the KolMafia forum. (link at the top of the guide). This mafia forum has a compendium of various scripts that you can look through in the future. For now, in [http://kolmafia.us/showthread.php?t=1736&highlight=tattoo this forum thread], scroll to the last entry and find the most updated Tattoo.ash attachment.
# Click and download the Tattoos.ash attachment. You might have to join the KolMafia forum to do the download. It is not a bad idea to do so anyways, so go ahead and do it.
Or, you can cut&paste from the bottom of this page into a Tattoos.ash text file.
# Go find the downloaded Tattoos.ash on your computer.
# Open the script using Notepad or similar text browser. Take a look. This is just so you can see what a script looks like, and also for your own peace of mind.
# Do a Find, and look for "buy", "sell", "notify", and "send" text. This is a quick security check. Notify is a one-time mailing to the developer of a script which just lets them know you use their script. Good for epeen value I guess. Send/csend can actually mail people Meat or Items so ensure that nothing funny is going on there. Buy/Sell deals with item manipulation. You want to make sure a script is not gonna go sell all your stuff or buy expensive things. Even the best meaning script can bankrupt you.
# Move the Tattoos.ash script to where your KoL executable lives. Remember in our first lesson we put KolMafia in a folder. Since then, Mafia created several sub-folders where it stores its settings and stuff. In particular, a sub-directory called 'Scripts' should be present. Move Tattoos.ash into the scripts subdirectory.
# At the top, click Scripts and 'Refresh Menu'. Go to Scripts again and you will see 'Tattoo.ash' in the list. You could click it to execute. Do not do this right now though.
# Back in Mafia, click the Graphical CLI tab.
# At the very bottom of the screen there is a text entry field. Type Tattoos.ash and hit enter. (or Tattoos will suffice)
# The Tattoos.ash will then be executed. I am assuming that you finished the Artist quest as it is one of the first ones you received. If so, the script will equip any outfit that you don't have a trophy for already then visit the Tattoo Artist. If you have not done the artist quest this ascension, I have no idea what the script does.
In any case, you will see exactly what the script does since you are already in the CLI tab.

Anyways, this script is pretty cool. Normally it takes a good deal of work to determine when you have acquired a 'new' outfit that you have not received a tattoo for. Assuming you happen to know you have a new outfit, you now have to equip it, visit the Tattoo shop, then put your original equipment back on. This script does this all for you! It searches every single outfit you possess, sees if you have the tattoo and if not, it gets it for you. It also tells you which outfits you are lacking for unreceived tattoos. Pretty cool huh?

<div style="margin-bottom: 1em; font-size: 12px; border: dashed 1px green; padding: 1em; margin:0px 20px;"><syntaxhighlight>
## Original script from: http://kolmafia.us/index.php/topic,527.msg2569.html#msg2569 [19 October 2006]
## Updated by Hippymon 13 November 2007
### Updated by Raven434 - 2009-02-13
### There are 49 outfit based tattoos now, up from Hippymon's last update of 38.
record tatdata{
string gear;
string Img;
};
tatdata[int] Tat;
void load_table(){
##data obtained from http://kol.coldfront.net/thekolwiki/index.php/Outfits_by_number
### New Tat #10 added in
### Modded - there is no #13 listed in the outfits_by_number page

Tat[1].gear = "Bugbear Costume";
Tat[2].gear = "Filthy Hippy Disguise";
Tat[3].gear = "Frat Boy Ensemble";
Tat[4].gear = "Knob Goblin Harem Girl Disguise";
Tat[5].gear = "Knob Goblin Elite Guard Uniform";
Tat[6].gear = "Hot and Cold Running Ninja Suit";
Tat[7].gear = "eXtreme-Cold Weather gear";
Tat[8].gear = "Mining Gear";
Tat[9].gear = "Swashbuckling Getup";
Tat[10].gear = "Terrifying Clown Suit";
Tat[11].gear = "Crimbo Duds";
Tat[12].gear = "Star Garb";
Tat[13].gear = "#13 is evil! No such tattoo! This is a placeholder in the table.";
Tat[14].gear = "Furry Suit";
Tat[15].gear = "8-Bit Finery";
Tat[16].gear = "Yendorian Finery";
Tat[17].gear = "OK Lumberjack Outfit";
Tat[18].gear = "Radio Free Regalia";
Tat[19].gear = "Bow Tux";
Tat[20].gear = "Clockwork Apparatus";
Tat[21].gear = "Gnauga Hides";
Tat[22].gear = "Time Trappings";
Tat[23].gear = "Cloaca-Cola Uniform";
Tat[24].gear = "Dyspepsi-Cola Uniform";
Tat[25].gear = "Arboreal Raiment";
Tat[26].gear = "Grass Guise";
Tat[27].gear = "Encephalic Ensemble";
Tat[28].gear = "Glad Bag Glad Rags";
Tat[29].gear = "Antique Arms And Armor";
Tat[30].gear = "Terrycloth Tackle";
Tat[31].gear = "Tropical Crimbo Duds";
Tat[32].gear = "War Hippy Fatigues";
Tat[33].gear = "Frat Warrior Fatigues";
Tat[34].gear = "Bounty-Hunting Rig";
Tat[35].gear = "Black Armaments";
Tat[36].gear = "Palmist Paraphernalia";
Tat[37].gear = "Tapered Threads";
Tat[38].gear = "Roy Orbison Disguise";
Tat[39].gear = "Cursed Zombie Pirate Costume";
Tat[40].gear = "Crimborg Assault Armor";
Tat[41].gear = "El Vibrato Relics";
Tat[42].gear = "Pyretic Panhandler Paraphernalia";
Tat[43].gear = "Hyperborean Hobo Habiliments";
Tat[44].gear = "Vile Vagrant Vestments";
Tat[45].gear = "Dire Drifter Duds";
Tat[46].gear = "Tawdry Tramp Togs";
Tat[47].gear = "Hodgman's Regal Frippery";
Tat[48].gear = "Arrrbor Day Apparrrrrel";
Tat[49].gear = "Mutant Couture";

##Tat 1-26 added by nightmist
##Tat 28-35 and a few file names changed/added by Hippymon
### Same changes as above for new #10, no #13, new 36-49.
Tat[ 1].Img = "bugbear.gif";
Tat[ 2].Img = "hippy.gif";
Tat[ 3].Img = "fratboy.gif";
Tat[ 4].Img = "haremgirl.gif";
Tat[ 5].Img = "eliteguard.gif";
Tat[ 6].Img = "ninja.gif";
Tat[ 7].Img = "coldgear.gif";
Tat[ 8].Img = "miner.gif";
Tat[ 9].Img = "pirate.gif";
Tat[ 10].Img = "Clowntat.gif";
Tat[ 11].Img = "pressietat.gif";
Tat[ 12].Img = "startat.gif";
Tat[ 14].Img = "losertat.gif";
Tat[ 15].Img = "swordtat.gif";
Tat[ 16].Img = "elbereth.gif";
Tat[ 17].Img = "canadiatat.gif";
Tat[ 18].Img = "radiotat.gif";
Tat[ 19].Img = "bowtat.gif";
Tat[ 20].Img = "clocktat.gif";
Tat[ 21].Img = "gnaugatat.gif";
Tat[ 22].Img = "hourtat.gif";
Tat[ 23].Img = "cola1tat.gif";
Tat[ 24].Img = "cola2tat.gif";
Tat[ 25].Img = "wreathtat.gif";
Tat[ 26].Img = "eggtat.gif";
Tat[ 27].Img = "jfishtat.gif";
Tat[ 28].Img = "recyctat.gif";
Tat[ 29].Img = "armortat.gif";
Tat[ 30].Img = "toweltat.gif";
Tat[ 31].Img = "tropictat.gif";
Tat[ 32].Img = "warhiptat.gif";
Tat[ 33].Img = "warfrattat.gif";
Tat[ 34].Img = "meattat.gif";
Tat[ 35].Img = "blacktat.gif";
Tat[ 36].Img = "palmtat.gif";
Tat[ 37].Img = "ducttat.gif";
Tat[ 38].Img = "Orbisontat.gif";
Tat[ 39].Img = "Zompirtat.gif";
Tat[ 40].Img = "Halotat.gif";
Tat[ 41].Img = "Elvtat.gif";
Tat[ 42].Img = "Hothobotat.gif";
Tat[ 43].Img = "Colhobotat.gif";
Tat[ 44].Img = "Stehobotat.gif";
Tat[ 45].Img = "Spohobotat.gif";
Tat[ 46].Img = "Slehobotat.gif";
Tat[ 47].Img = "Hodgmantat.gif";
Tat[ 48].Img = "Arbordaytat.gif";
Tat[ 49].Img = "Dnatat.gif";

}

void get_tats(int a){
if(have_outfit(Tat[a].gear)){
if(!contains_text(visit_url("account_tattoos.php"), Tat[a].Img)){
cli_execute("unequip weapon");
outfit(Tat[a].gear);
visit_url("town_wrong.php?place=artist");
}
}
else print(Tat[a].gear + " is incomplete.");
}

void get_tats_main(){
int a = 1;
while(a < 49){
get_tats(a);
a = a + 1;
}
}

void main(){
load_table();
get_tats_main();
}

print("*** Check your Display Case and / or your Colossal Closet for possible missing outfit pieces. ***");
print("__________________________________________________________________________");
</syntaxhighlight></div>

Bonus) Browse the KolMafia scripts forum briefly. You can see that there are some pretty cool scripts available, such as ones that automate several annoying aspects of quests for you. You might note that some scripts have prerequisites. One script in particular, ZLib, was created solely as a programming library for other script-writers and is widely used.

Bonus2) I just started doing the Slime Tube and it sure is a pain. I found a cool slime.ash program which would outfit you, fight the slime, then rinse off when the Covered In Slime effect would kill you. However, it would make me take up to 99% of my HPs in Slime, then waste tons of healing aids to get me back to max. I modified it to auto-rinse after taking 500 damage from a single Covered in Slime effect. This let me kill slime without needing any healing effects at all.

The point is that it is very do-able to download someone else's script then hack it to make it do what you want it to do... or to remove undesired behavior. (notifys, use of consumables, buying things from the mall, etc)

'''BOTTOM LINE:''' Learning how to safely execute other people's scripts can be extremely helpful. Just about anything you want to do, someone else has wanted to do it also, and probably has a script for it.

Continue to [[KoLmafia Guide: Useful Commands|Lesson 14: Useful Commands]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: PvP (Beating Up People)

2010-05-17T17:02:12Z

SinginSally:

[[File:Lesson12 flowermenu.png|right]]
* Click the Flower-looking icon in the main frame. [[File:Lesson12 flowericon.png]] OR, main menubar under Tools you can select Flower Hunter.
* If you haven't broken your hippy stone yet, it will ask you if you want to do so. You can only attack or be attacked in PvP if you break it.
*: [[File:Lesson12 hippystone.png]]
* It pops up a new window and defaults to the Attack tab. Click the Search tab instead.
{|
|valign=top|<ul><li>It automatically populates the Max Rank field intelligently. For example, with a 87 Rank, it will set a Max Rank of 48. What this means is that it will look for foes that are at the lower spectrum of what you can attack. Remember, a 87 can only attack as low as a 37. Just 37 though would only show a very limited number of foes. Plus if you won the fight, you'd have to re-search for 38s. Therefore the 37-48 is the default to give you a decent range of opponents to fight. If you want to attack higher ranking foes, you can change that maximum limit.</li>

<li>Click Search with the default options. You can see that it finds a bunch of foes below rank 48 for you to pick on, all the way down to rank 37.
|valign=top|[[File:Lesson12 attack2.png]]</li></ul>
|}
{|
|valign=top|<ul><li>Select the people you wish to attack. Just don't choose anyone less than 50 ranking lower than your own rank if you changed the lower limit default for some reason. Keep in mind that your rank goes up after every fight (we hope!), so don't queue up a bunch of rank 37s!

<li>Now click the Attack Tab. It will default to using your main stat for Fighting. It defaults to Stealing a Flower. You can pick Rank or Dignity.

<li>'''Important note''': KoLMafia was apparently written by a bunch of PvP pansies. But, an update was made so that you can now choose to steal items or meat. (subject to ascension rules) Dirty!
|valign=top|[[File:Lesson12 attack3.png]]</li></ul>
|}

* All you have to do now is select foes, then click Attack. It will pop up a window showing the results...which you will probably have to enlarge. Note that it will not allow you to attack members of your own clan. Thanks a '''lot''' to Bale for finding such an appropriate PvP screenshot for this guide. ;-)
*:[[File:Lesson12 attack4.png]]

There are TWO other ways to use the PvP interface for Mafia....

* If you want to just pick flowers, you can click the Search tab, click the Flowers button. WARNING: It will automatically search for low ranked foes and fight them with all your PvP attacks! It is a quick and easy way to PvP. If you lose, it will find new opponents using your now-lower rank.

* You can always use the normal PvP interface at your campground and fight like normal. You would only use Mafia to search for victims. The only downside is that you cannot cut&paste the names. Hence you must type them in yourself. However, now that Mafia supports the full PvP capability, there isn't so much reason to do this.

'''BOTTOM LINE:''' KolMafia is a huge improvement to the default PvP system, allowing much greater ability to find foes.

Continue to [[KoLmafia Guide: Running ASH Scripts|Lesson 13: Running ASH Scripts]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Running ASH Scripts

2010-05-11T16:07:12Z

SinginSally:

KolMafia has the capability to execute scripts which can perform just about any KoL action. Mafia scripting uses an .ash extension and is simply a text file that contains a bunch of Mafia commands with some programming language constructs as needed. You can browse, download, and execute scripts that other people have written to help automate specific functions or expand Mafia capabilities.

This poses a bit of a security risk, obviously. Mafia is all open-source and examined by many people and is relatively trustworthy. Some random dude's script.... not so much. Feel free to skip this lesson if this makes you nervous. Note that scripts can be extremely helpful though, so it is worth learning about them.

In this lesson, we are going to find a simple script, download it, store it, then execute it.

# First, we need to find a script we want to execute. For this lesson, point your browser to the KolMafia forum. (link at the top of the guide). This mafia forum has a compendium of various scripts that you can look through in the future. For now, in [http://kolmafia.us/showthread.php?t=1736&highlight=tattoo this forum thread], scroll to the last entry and find the most updated Tattoo.ash attachment.
# Click and download the Tattoos.ash attachment. You might have to join the KolMafia forum to do the download. It is not a bad idea to do so anyways, so go ahead and do it.
Or, you can cut&paste from the bottom of this page into a Tattoos.ash text file.
# Go find the downloaded Tattoos.ash on your computer.
# Open the script using Notepad or similar text browser. Take a look. This is just so you can see what a script looks like, and also for your own peace of mind.
# Do a Find, and look for "buy", "sell", "notify", and "send" text. This is a quick security check. Notify is a one-time mailing to the developer of a script which just lets them know you use their script. Good for epeen value I guess. Send/csend can actually mail people Meat or Items so ensure that nothing funny is going on there. Buy/Sell deals with item manipulation. You want to make sure a script is not gonna go sell all your stuff or buy expensive things. Even the best meaning script can bankrupt you.
# Move the Tattoos.ash script to where your KoL executable lives. Remember in our first lesson we put KolMafia in a folder. Since then, Mafia created several sub-folders where it stores its settings and stuff. In particular, a sub-directory called 'Scripts' should be present. Move Tattoos.ash into the scripts subdirectory.
# At the top, click Scripts and 'Refresh Menu'. Go to Scripts again and you will see 'Tattoo.ash' in the list. You could click it to execute. Do not do this right now though.
# Back in Mafia, click the Graphical CLI tab.
# At the very bottom of the screen there is a text entry field. Type Tattoos.ash and hit enter. (or Tattoos will suffice)
# The Tattoos.ash will then be executed. I am assuming that you finished the Artist quest as it is one of the first ones you received. If so, the script will equip any outfit that you don't have a trophy for already then visit the Tattoo Artist. If you have not done the artist quest this ascension, I have no idea what the script does.
In any case, you will see exactly what the script does since you are already in the CLI tab.

Anyways, this script is pretty cool. Normally it takes a good deal of work to determine when you have acquired a 'new' outfit that you have not received a tattoo for. Assuming you happen to know you have a new outfit, you now have to equip it, visit the Tattoo shop, then put your original equipment back on. This script does this all for you! It searches every single outfit you possess, sees if you have the tattoo and if not, it gets it for you. It also tells you which outfits you are lacking for unreceived tattoos. Pretty cool huh?

<div style="margin-bottom: 1em; font-size: 12px; border: dashed 1px green; padding: 1em; margin:0px 20px;"><syntaxhighlight>
## Original script from: http://kolmafia.us/index.php/topic,527.msg2569.html#msg2569 [19 October 2006]
## Updated by Hippymon 13 November 2007
### Updated by Raven434 - 2009-02-13
### There are 49 outfit based tattoos now, up from Hippymon's last update of 38.
record tatdata{
string gear;
string Img;
};
tatdata[int] Tat;
void load_table(){
##data obtained from http://kol.coldfront.net/thekolwiki/index.php/Outfits_by_number
### New Tat #10 added in
### Modded - there is no #13 listed in the outfits_by_number page

Tat[1].gear = "Bugbear Costume";
Tat[2].gear = "Filthy Hippy Disguise";
Tat[3].gear = "Frat Boy Ensemble";
Tat[4].gear = "Knob Goblin Harem Girl Disguise";
Tat[5].gear = "Knob Goblin Elite Guard Uniform";
Tat[6].gear = "Hot and Cold Running Ninja Suit";
Tat[7].gear = "eXtreme-Cold Weather gear";
Tat[8].gear = "Mining Gear";
Tat[9].gear = "Swashbuckling Getup";
Tat[10].gear = "Terrifying Clown Suit";
Tat[11].gear = "Crimbo Duds";
Tat[12].gear = "Star Garb";
Tat[13].gear = "#13 is evil! No such tattoo! This is a placeholder in the table.";
Tat[14].gear = "Furry Suit";
Tat[15].gear = "8-Bit Finery";
Tat[16].gear = "Yendorian Finery";
Tat[17].gear = "OK Lumberjack Outfit";
Tat[18].gear = "Radio Free Regalia";
Tat[19].gear = "Bow Tux";
Tat[20].gear = "Clockwork Apparatus";
Tat[21].gear = "Gnauga Hides";
Tat[22].gear = "Time Trappings";
Tat[23].gear = "Cloaca-Cola Uniform";
Tat[24].gear = "Dyspepsi-Cola Uniform";
Tat[25].gear = "Arboreal Raiment";
Tat[26].gear = "Grass Guise";
Tat[27].gear = "Encephalic Ensemble";
Tat[28].gear = "Glad Bag Glad Rags";
Tat[29].gear = "Antique Arms And Armor";
Tat[30].gear = "Terrycloth Tackle";
Tat[31].gear = "Tropical Crimbo Duds";
Tat[32].gear = "War Hippy Fatigues";
Tat[33].gear = "Frat Warrior Fatigues";
Tat[34].gear = "Bounty-Hunting Rig";
Tat[35].gear = "Black Armaments";
Tat[36].gear = "Palmist Paraphernalia";
Tat[37].gear = "Tapered Threads";
Tat[38].gear = "Roy Orbison Disguise";
Tat[39].gear = "Cursed Zombie Pirate Costume";
Tat[40].gear = "Crimborg Assault Armor";
Tat[41].gear = "El Vibrato Relics";
Tat[42].gear = "Pyretic Panhandler Paraphernalia";
Tat[43].gear = "Hyperborean Hobo Habiliments";
Tat[44].gear = "Vile Vagrant Vestments";
Tat[45].gear = "Dire Drifter Duds";
Tat[46].gear = "Tawdry Tramp Togs";
Tat[47].gear = "Hodgman's Regal Frippery";
Tat[48].gear = "Arrrbor Day Apparrrrrel";
Tat[49].gear = "Mutant Couture";

##Tat 1-26 added by nightmist
##Tat 28-35 and a few file names changed/added by Hippymon
### Same changes as above for new #10, no #13, new 36-49.
Tat[ 1].Img = "bugbear.gif";
Tat[ 2].Img = "hippy.gif";
Tat[ 3].Img = "fratboy.gif";
Tat[ 4].Img = "haremgirl.gif";
Tat[ 5].Img = "eliteguard.gif";
Tat[ 6].Img = "ninja.gif";
Tat[ 7].Img = "coldgear.gif";
Tat[ 8].Img = "miner.gif";
Tat[ 9].Img = "pirate.gif";
Tat[ 10].Img = "Clowntat.gif";
Tat[ 11].Img = "pressietat.gif";
Tat[ 12].Img = "startat.gif";
Tat[ 14].Img = "losertat.gif";
Tat[ 15].Img = "swordtat.gif";
Tat[ 16].Img = "elbereth.gif";
Tat[ 17].Img = "canadiatat.gif";
Tat[ 18].Img = "radiotat.gif";
Tat[ 19].Img = "bowtat.gif";
Tat[ 20].Img = "clocktat.gif";
Tat[ 21].Img = "gnaugatat.gif";
Tat[ 22].Img = "hourtat.gif";
Tat[ 23].Img = "cola1tat.gif";
Tat[ 24].Img = "cola2tat.gif";
Tat[ 25].Img = "wreathtat.gif";
Tat[ 26].Img = "eggtat.gif";
Tat[ 27].Img = "jfishtat.gif";
Tat[ 28].Img = "recyctat.gif";
Tat[ 29].Img = "armortat.gif";
Tat[ 30].Img = "toweltat.gif";
Tat[ 31].Img = "tropictat.gif";
Tat[ 32].Img = "warhiptat.gif";
Tat[ 33].Img = "warfrattat.gif";
Tat[ 34].Img = "meattat.gif";
Tat[ 35].Img = "blacktat.gif";
Tat[ 36].Img = "palmtat.gif";
Tat[ 37].Img = "ducttat.gif";
Tat[ 38].Img = "Orbisontat.gif";
Tat[ 39].Img = "Zompirtat.gif";
Tat[ 40].Img = "Halotat.gif";
Tat[ 41].Img = "Elvtat.gif";
Tat[ 42].Img = "Hothobotat.gif";
Tat[ 43].Img = "Colhobotat.gif";
Tat[ 44].Img = "Stehobotat.gif";
Tat[ 45].Img = "Spohobotat.gif";
Tat[ 46].Img = "Slehobotat.gif";
Tat[ 47].Img = "Hodgmantat.gif";
Tat[ 48].Img = "Arbordaytat.gif";
Tat[ 49].Img = "Dnatat.gif";

}

void get_tats(int a){
if(have_outfit(Tat[a].gear)){
if(!contains_text(visit_url("account_tattoos.php"), Tat[a].Img)){
cli_execute("unequip weapon");
outfit(Tat[a].gear);
visit_url("town_wrong.php?place=artist");
}
}
else print(Tat[a].gear + " is incomplete.");
}

void get_tats_main(){
int a = 1;
while(a < 49){
get_tats(a);
a = a + 1;
}
}

void main(){
load_table();
get_tats_main();
}

print("*** Check your Display Case and / or your Colossal Closet for possible missing outfit pieces. ***");
print("__________________________________________________________________________");
</syntaxhighlight></div>

Bonus) Browse the KolMafia scripts forum briefly. You can see that there are some pretty cool scripts available, such as ones that automate several annoying aspects of quests for you. You might note that some scripts have prerequisites. One script in particular, ZLib, was created solely as a programming library for other script-writers and is widely used.

Bonus2) I just started doing the Slime Tube and it sure is a pain. I found a cool slime.ash program which would outfit you, fight the slime, then rinse off when the Covered In Slime effect would kill you. However, it would make me take up to 99% of my HPs in Slime, then waste tons of healing aids to get me back to max. I modified it to auto-rinse after taking 500 damage from a single Covered in Slime effect. This let me kill slime without needing any healing effects at all.

The point is that it is very do-able to download someone else's script then hack it to make it do what you want it to do... or to remove undesired behavior. (notifys, use of consumables, buying things from the mall, etc)

BOTTOM LINE: There are a lot of really useful scripts people have already written which can help you out.

Continue to [[KoLmafia Guide: Useful Commands|Lesson 14: Useful Commands]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: PvP (Beating Up People)

2010-05-11T15:56:20Z

SinginSally:

[[File:Lesson12 flowermenu.png|right]]
* Click the Flower-looking icon in the main frame. [[File:Lesson12 flowericon.png]] OR, main menubar under Tools you can select Flower Hunter.
* If you haven't broken your hippy stone yet, it will ask you if you want to do so. You can only attack or be attacked in PvP if you break it.
*: [[File:Lesson12 hippystone.png]]
* It pops up a new window and defaults to the Attack tab. Click the Search tab instead.
{|
|valign=top|<ul><li>It automatically populates the Max Rank field intelligently. For example, with a 87 Rank, it will set a Max Rank of 48. What this means is that it will look for foes that are at the lower spectrum of what you can attack. Remember, a 87 can only attack as low as a 37. Just 37 though would only show a very limited number of foes. Plus if you won the fight, you'd have to re-search for 38s. Therefore the 37-48 is the default to give you a decent range of opponents to fight. If you want to attack higher ranking foes, you can change that maximum limit.</li>

<li>Click Search with the default options. You can see that it finds a bunch of foes below rank 48 for you to pick on, all the way down to rank 37.
|valign=top|[[File:Lesson12 attack2.png]]</li></ul>
|}
{|
|valign=top|<ul><li>Select the people you wish to attack. Just don't choose anyone less than 50 ranking lower than your own rank if you changed the lower limit default for some reason. Keep in mind that your rank goes up after every fight (we hope!), so don't queue up a bunch of rank 37s!

<li>Now click the Attack Tab. It will default to using your main stat for Fighting. It defaults to Stealing a Flower. You can pick Rank or Dignity.

<li>'''Important note''': KoLMafia was apparently written by a bunch of PvP pansies. But, an update was made so that you can now choose to steal items or meat. (subject to ascension rules) Dirty!
|valign=top|[[File:Lesson12 attack3.png]]</li></ul>
|}

* All you have to do now is select foes, then click Attack. It will pop up a window showing the results...which you will probably have to enlarge. Note that it will not allow you to attack members of your own clan. Thanks a '''lot''' to Bale for finding such an appropriate PvP screenshot for this guide. ;-)
*:[[File:Lesson12 attack4.png]]

There are TWO other ways to use the PvP interface for Mafia....

* If you want to just pick flowers, you can click the Search tab, click the Flowers button. WARNING: It will automatically search for low ranked foes and fight them with all your PvP attacks! It is a quick and easy way to PvP. If you lose, it will find new opponents using your now-lower rank.

* You can always use the normal PvP interface at your campground and fight like normal. You would only use Mafia to search for victims. The only downside is that you cannot cut&paste the names. Hence you must type them in yourself. However, now that Mafia supports the full PvP capability, there isn't so much reason to do this.

Continue to [[KoLmafia Guide: Running ASH Scripts|Lesson 13: Running ASH Scripts]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Eating & Drinking

2010-05-11T15:35:55Z

SinginSally:

This lesson covers managing and creating food,drink,spleen with Mafia. By default, eating and drinking sucks in KoL. For a new player you have no clue what most of the items do, and their description is unhelpful and lacking in any concrete info in adventures gained or fullness used. Digging through the wiki for every item is time-consuming and irritating.
Once you get into recipes for creating food and booze, it becomes very difficult to get anything done without tons of wiki studying. You will master several common recipes but will likely overlook a lot of food and drinks you '''could''' make because you don't have them in mind.

Mafia does a lot to address this and help you automate and keep track of your consumption. In this lesson, we will attempt to make and consume some drinks.

# We are going to make some drinks. I am assuming that you have at least '''some''' stuff in your inventory that you can use to make drinks, AND you are not almost-drunk already. Go ahead and use advanced cocktail to summon Ice Cubes, etc if you can do so. Note that breakfast will do this for you.
# Click the top icon that looks like a backpack, or from the main menubar under General, select Item Manager.
#: [[File:Lesson11 topicons.png]]
# This is a big interface. On the left hand side, amongst the long list of stuff, under Usable, click on Booze. I recommend that you click the checkbox labeled "per drunk" to sort it with the highest quality booze at the top.
#:[[File:Lesson11 manager.png]]
# The screen is split into a top half and a bottom half. The bottom half contains a scrollpanel which has listings of booze, sorted by the quality of the beverage. Note that each drink has complete info as to stats and adventures per inebriation all spelled out. It's really awesome!
# You will notice that each drink has a number in parenthesis for Possible and Current. The Current number is how many of that drink you really have in your inventory. Possible is how many you COULD have, by mixing, buying, etc. When the Potential number is the same as the Actual, this means you have all of that drink that you could with your current state of inventory.
# You can click the 'No Create' checkbox which will then only show drinks you have in your inventory, vs showing all drinks you could conceivably make. Consider though that Mafia '''does'' adjust the quality of created drinks based on the number of turns needed to create them. For example, you will notice that your adventures per drunk increase for all your mixed drinks when you have a bartender-in-a-box. Especially the 1 and 2 drunkenness drinks since spending a turn to make a 1 drunk drink is much worse than 1 turn to make a 4 drunk one. The Per-Drunk checkbox should be active as Adventures per Drunk point are a much more useful measurement than total adventures.
# Going through the scrollbar, find the highest drink where you have more Possible than Current. This means you can make this drink. Select it and click Enqueue. It will ask how many to enqueue. It defaults to the difference between how many you have and can have, up to how much you can actually consume. In other words, if you have 3 martinis and 2 olive/gin, then it will default to enqueueing 2.
# Now, that drink goes to the Top of your screen's panel. Notice that the tab now shows how much Drunkenness you have enqueued. You can click the Ingredients Used tab to show exactly what the drink consists of. This is particularly useful for both food and drink as you want to keep a tight rein on your Spices in many cases. You also would probably not want to waste a precious Lime making a margarita with training wheels when you could make a Key Lime pie instead!
#:[[File:Lesson11 queue.png]]
# Click the Create button. It will now mix that drink for you. Depending on the settings it may even automatically create a bartender-in-a-box to ensure that it doesn't cost any turns. See below for how to do that!
# That drink now disappears from the top box and now your Current number has gone up for that drink. It made that drink for you.
# '''In-a-box feature:''' In the item manager, under Creatable, there are checkboxes to ensure Mafia will '''only''' create food/drink using a in-a-box from your campsite and another to automatically create an in-a-box when you lack one or it breaks. This is nice in that it ensures that you will not use up precious turns. It is also very helpful when your in-a-Box breaks and Mafia doesn't have enough parts to reassemble it. In which case, you would normally use up turns when cooking/mixing. With this feature active you would all the sudden notice all your recipes disappear from mafia, which would alert you that something is amiss. However, it is very important that you turn this feature off when you ascend! The reason being that Mafia will simply not show any recipes until you make the appropriate in-a-box, which might be a while during hardcore. In the meantime you are left wondering why can't make any drinks! Note that if you do not have sufficient parts to create the in-a-box, you might want to change your preferences temporarily to allow Mafia to purchase from the mall. Mafia will then buy what it needs in order to assemble it in the ''cheapest manner possible'' if not in ronin/hardcore.
#:[[File:Lesson11 in-a-boxen.png]]
# You will probably wanna go ahead and drink. Use any booze-booster like the Ode to Booze buff or whatever first. Then, assuming you have a max drunkenness of 15 (the default), enqueue 14 drunkenness worth of your best booze. You can Consume directly if desired, but I prefer to queue it all up first and make it. It is usually a good idea to make all your booze and food first, then consume it. This ensures that if you must use turns to create something that it won't mess up your Ode to Booze or Milk of Magnesium. Nothing is worse than using those then running out of buff turns while making all the consumables!
# The top box will populate with your booze and auto-count the intoxication, warning you if you are about to overdrink. Click Consume when ready and it will drink.
# Exit the Inventory Manager, click the CGI Graphical tab and look at the log. See what all it really did for you behind the scenes. You might see that it bought a fruit from a hippy (by disguising if you had the suit), or a soda water from the Market. The log lets you see EXACTLY what it did, which is an important step when learning KoLMafia!
# Bring up the Inventory Manager again. Repeat this process for Food. Then, click Spleen and go ahead and consume all the various Moxie Weeds and other junk that accumulates in your inventory for the free substats (unless you want to autosell them for meat). If you've got wads or other adventure-granting spleen items this is where you consume them.

'''Warning:''' It should be noted that the Food and Booze Manager is VERY pesky about allowing you to make drinks that it knows you cannot consume. If you are totally drunk, you will find that the Item Manager will not let you make any drinks! In this case you can still make them by going to the Createable section where it has listings for food and booze. The drawback is that it won't show you detailed consumption information in that window. This might be necessary if you wanted to make a bunch of cocktails to sell for example.

'''Bottom Line:''' KolMafia really takes the guesswork/research out of eating and drinking, and is a huge help for cooking/mixing.

Continue to [[KoLmafia Guide: PvP (Beating Up People)|Lesson 12: PvP (Beating Up People)]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Setting Up Breakfast

2010-05-11T15:15:09Z

SinginSally:

'Breakfast' is the Mafia functionality of completing repetitive actions that you generally would want to always do. These involve no usage of any resources, nor is there any particular choice or strategy regarding it. For example, there is no reason at all to not pick the Clan Meat Tree or use the Klaw game, or to read your class book (the one that gives you a small number of substats every day), or to use a cheap toaster, or get your cut from the produce stand. Basically, Mafia will automatically do all actions of this type when breakfast is invoked.

On the other hand, some things you might wish to control. For example, you might always want to use the Clan Snack Machine, but which chips do you pick? You want to autocast your Tome, but if you have more than one, which one do you use? Since these type of actions have some user interaction involved, the Breakfast Preferences handles these. Let's check these preferences:

# Bring up the Preferences as before under main menubar, General, Preferences.
# Click the Breakfast tab.
# The first thing you see are options to execute scripts during login or logout. We will skip this, but note that it gives you the ability to perform specialized custom commands. For example, say you want to switch your gear to equipment that boosts your adventures per day, then drink a final cocktail. You could use the On Logout script to do so. In our scripting tutorial we will create such a logout script. It can literally be a single line, for example a DoLogout.ash file with 'cli_execute("maximize adv");' would always equip any items you own that give more adventures per day. I don't know about you, but Ive already lost hundreds of turns because I've forgotten to equip a Chrome sword or Dead Mans Watch during hardcore.
# You will see two separate sections for both Ronin-clear characters and in-ronin ones. Many of the settings will be exactly the same... EXCEPT to enable 'honor path restrictions' during the ronin period. Though you might choose to have less automation during in-ronin breakfast since it is a pickier part of the game.
# I would recommend you click all of the applicable available checkboxes. Automatically getting hermit clovers when available is nice. This command buys hermit permits if needed, then visits the Hermit, gets clovers, then uses them to make them Disassembled Clovers up to however many worthless trinkets you have available. Note that it will '''not''' spend your adventures fishing around in the sewer for Worthless trinkets though. Lets say you spent some turns in the sewer yesterday to burn-off a bad status effect. Or used a 31337 scroll or whatever. You might forget to check for clovers the following days when they are available. This takes care of it for you.
# You probably want to turn off 'Enable Auto-Recovery', especially in-ronin. This would for example let Mafia use MP restores to use your Tome or heal you in preparation for adventuring. I prefer to manage this myself. More on this in the HP/MP Recovery lesson.
#: [[File:Lesson10 breakfast.png]]

You are done! Go ahead and activate breakfast by one of several methods. You could click Breakfast from the Daily Deeds panel under Adventuring (I prefer this panel up instead of the Location Details and changed it by using the pulldown). Or you could logout and re-login making sure to checkbox Breakfast. There is bound to be a breakfast button on the GUI somewhere. You can type breakfast in the CLI too.
In any case, invoke it and then check the CLI tab and see exactly what Breakfast did for you. You will likely see something and say what I've said, "Oh yeah! I totally forgot about that!".

'''BOTTOM LINE:''' Breakfast is a great way to automatically do things that you want done but don't necessarily remember every time.

Continue to [[KoLmafia Guide: Eating & Drinking|Lesson 11: Eating & Drinking]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Goal-Oriented Adventuring

2010-05-11T14:59:22Z

SinginSally:

For this lesson, we are going to complete a Bounty Hunter contract with KolMafia.

[[File:Lesson8 Hunter.png|right]]
# Go to the Hunter like normal, pick a reasonable bounty that is fairly easy to do, in a zone you can access. Check your equipment, etc.
#* Alternatively, you can click the 'Travel' from the main menubar, and click 'Visit the Hunter'. Then choose your bounty. That might be a bit quicker (as shown in the screenshot to the right).
# Go to the Mafia Frame. Make sure your custom combat script is good to go, unless you just want auto-attack or auto-spell. Change the Adventure number to 60, just to have a constraint. (A bounty takes 40 typically). Make sure you have 60 adventures left. Eat/Drink/etc to do this.
# Look at the zone selection box. When you first select a bounty it automatically selects the appropriate zone for you.
# Click the Checkbox under your combat script that says '''Goals:'''. It un-greys a dropdown box. If the box is greyed out, this means NO goal oriented adventuring will occur. Mafia should automatically have the right bounty items selected for you.
# In the dropdown box for Goals, you ought to see something like '3 triffid bark' that corresponds to your bounty goal. Make sure this is selected, un-greyed, and looks right.
#: [[File:Lesson8 GoalAdventure.png]]
# Clear your session with the main menubar, Tools, 'Clear All Results'. I like to do this for each session of adventures. It will help us better see what is going on for training purposes.
# Tell it to '''Begin'''. Mafia will start adventuring and automatically update you on your goal progress. You will see the Goals box start dropping to '2 triffid bark' or whatever as you find your goal item. It will also '''automatically stop adventuring''' when its goal is done, which will likely be before the 60 turns you constrained it to. You will notice that it even turns in your bounty for you when its done! If it was unable to complete its Goal, it will inform you when it hits its constraint.
#: [[File:Lesson8 CLI.png]]
# Warning: Once the goals are completed, it will reset back to the '3 triffid bark' or whatever goal. Basically it looks like before you started adventuring. This is a feature Mafia does to allow multiple sets of goals. Like if you wanted to get 2 sets of your goal item. Obviously you cannot do multiple Bounty Hunts in a single day, so you will just uncheck the Goals checkbox and be done.

-----

Bonus) The Goals-Oriented feature is really great for bounty and also questing. It is pre-loaded with several intelligent goals for various zones. For example, in the pirate quest you are tasked with acquiring 3 different items to become a pirate. Normally you have to remember which items you have gotten that are related to the quest. By using Mafia, you can simply type in that zone, then uncheck Goals, use the goals pulldown menu and select the set of those particular 3 items. When you adventure, it will go until all three items are acquired.

This feature is possible because KolMafia has many built-in goals that correspond with automate-able adventure constraints. It knows that you are on the Pirate quest, at a certain part of it. Therefore, it knows that you need X,Y, and Z items to continue. Hence, it appears as a potential goal. Once you have these items or are done with the quest, this goal is not an option anymore.

You can also type in your '''own''' goals! If you want say 4 Limes from the Fruit Golems, you'd go to the Menegerie 1 zone, type in 5 Lime as your goal and then go! I generally don't use this because of the possibility of error. If you misspell the item or pick the wrong zone, you could waste a bunch of turns.

'''BOTTOM LINE:''' Goal-oriented adventuring is even more automated and intelligent than auto-adventuring and can be a big help!

'''Continue to '''[[KoLmafia Guide: Setting Preferences|Lesson 9: Setting Preferences]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Goal-Oriented Adventuring

2010-05-11T14:58:42Z

SinginSally:

For this lesson, we are going to complete a Bounty Hunter contract with KolMafia.

[[File:Lesson8 Hunter.png|right]]
# Go to the Hunter like normal, pick a reasonable bounty that is fairly easy to do, in a zone you can access. Check your equipment, etc.
#* Alternatively, you can click the 'Travel' from the main menubar, and click 'Visit the Hunter'. Then choose your bounty. That might be a bit quicker (as shown in the screenshot to the right).
# Go to the Mafia Frame. Make sure your custom combat script is good to go, unless you just want auto-attack or auto-spell. Change the Adventure number to 60, just to have a constraint. (A bounty takes 40 typically). Make sure you have 60 adventures left. Eat/Drink/etc to do this.
# Look at the zone selection box. When you first select a bounty it automatically selects the appropriate zone for you.
# Click the Checkbox under your combat script that says '''Goals:'''. It un-greys a dropdown box. If the box is greyed out, this means NO goal oriented adventuring will occur. Mafia should automatically have the right bounty items selected for you.
# In the dropdown box for Goals, you ought to see something like '3 triffid bark' that corresponds to your bounty goal. Make sure this is selected, un-greyed, and looks right.
#: [[File:Lesson8 GoalAdventure.png]]
# Clear your session with the main menubar, Tools, 'Clear All Results'. I like to do this for each session of adventures. It will help us better see what is going on for training purposes.
# Tell it to '''Begin'''. Mafia will start adventuring and automatically update you on your goal progress. You will see the Goals box start dropping to '2 triffid bark' or whatever as you find your goal item. It will also '''automatically stop adventuring''' when its goal is done, which will likely be before the 60 turns you constrained it to. You will notice that it even turns in your bounty for you when its done! If it was unable to complete its Goal, it will inform you when it hits its constraint.
#: [[File:Lesson8 CLI.png]]
# Warning: Once the goals are completed, it will reset back to the '3 triffid bark' or whatever goal. Basically it looks like before you started adventuring. This is a feature Mafia does to allow multiple sets of goals. Like if you wanted to get 2 sets of your goal item. Obviously you cannot do multiple Bounty Hunts in a single day, so you will just uncheck the Goals checkbox and be done.

Bonus) The Goals-Oriented feature is really great for bounty and also questing. It is pre-loaded with several intelligent goals for various zones. For example, in the pirate quest you are tasked with acquiring 3 different items to become a pirate. Normally you have to remember which items you have gotten that are related to the quest. By using Mafia, you can simply type in that zone, then uncheck Goals, use the goals pulldown menu and select the set of those particular 3 items. When you adventure, it will go until all three items are acquired.

This feature is possible because KolMafia has many built-in goals that correspond with automate-able adventure constraints. It knows that you are on the Pirate quest, at a certain part of it. Therefore, it knows that you need X,Y, and Z items to continue. Hence, it appears as a potential goal. Once you have these items or are done with the quest, this goal is not an option anymore.

You can also type in your '''own''' goals! If you want say 4 Limes from the Fruit Golems, you'd go to the Menegerie 1 zone, type in 5 Lime as your goal and then go! I generally don't use this because of the possibility of error. If you misspell the item or pick the wrong zone, you could waste a bunch of turns.

'''BOTTOM LINE:''' Goal-oriented adventuring is even more automated and intelligent than auto-adventuring and can be a big help!

'''Continue to '''[[KoLmafia Guide: Setting Preferences|Lesson 9: Setting Preferences]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Setting Preferences

2010-05-04T17:14:18Z

SinginSally:

This lesson is important to keep Mafia from doing stuff you don't want it to. In the latest 13.9 version, the developer has set much more conservative defaults so this is not as necessary. Still, lets go through the major options.

# Under the main menubar under General, click Preferences. This pops up a tabbed browser with tons and tons of preferences and options.
# You probably took one look at all of it, said 'Oh @&%$!' and closed it. It's all good... Re-open it now. :-)
# Make sure we are on the General tab of the options:
# Definitely keep the Save-Options thing going. Otherwise it won't remember when you change them!
# The first interesting option is "Auto-Remove malignant status effects". You might want Mafia to not use restoratives to remove bad conditions. Many bad-effects really aren't all that significant. Therefore, you would not want to waste resources removing minor impediments. On the other hand, a newer player might keep this since they don't know what restores work on which condition anyways. That said, don't forget that if you are able to remove a condition, then it's duration will be '''underlined''' on your relay browser. One click will have Mafia auto-remove it.
# I think the Equipment change for buff means that it will automatically equip items that improve the buff you are casting then swap back. Say, use of an epic or legendary accordion if you happen to have a basic one equipped or something. I don't think this comes up very much.
# Cast Buffs not Defined in Moods - If checked, I believe this gives Mafia carte-blanche to cast basically any buff you can cast when you have Mafia using excess MP under 'mana burning'. I'd leave this off.
# Cast summon skills during buff rebalance - If you have a Tome or Libram or Grimore, and also are letting Mafia use excess MP to recast buffs, this option allows it to also cast these summons. Tomes are no problem but Librams can quickly deplete your MP due to their scaling nature.
# I do recommend 'Protect against accidental ten-leaf clover usage'. This warns you when you are about to enter a zone which would use a ten-leaf clover. As a noob, I've wasted many clovers in this way before Mafia came along. It also turns all 10-leaf clovers into Disassembled ones whenever you acquire them... in case you were wondering where your clovers went. :-)
# Clan Sewers doodad lets you not go to the Sewers unless you have specific items needed to get anywhere. I'd uncheck it. By the time you know what this really does, you will have it handled.
# Memento items? I guess this keeps you from pulverizing or autoselling certain items. Not sure what items are classifed as such.
# I recommend allowing mafia to buy from NPC stores. This gives you a lot more flexibility when creating drinks and food since Mafia will know that they can buy fruits and other components from the NPC as necessary. This generally occurs when you are making food&booze where you already have a good amount of control.
# I would keep Buy from the Mall turned off. You MIGHT want to turn this on for short periods, such as when creating a bartender/chef in a box. That is a lot easier than assembling it yourself or trying to figure out which pieces you are missing. Note that Mafia will never buy anything worth more than 20,000 meat which provides a safety feature.
# Your clan probably has a bunch of rules regarding the Stash. Hence, uncheck Taking items from clan stash, as this can lead to nastygrams from your clan!
#: [[File:Lesson9 General.png]]
# Under the Browser tab, do NOT check the wiki option, as every item you click will pop up a full page wiki entry, constrained to a tiny 4 inch item display. Not cool. You can use the right-click menu of your account options to look-up stuff anyways. Or use the Mafia inventory manager to easily right-click to pop up a wiki page.
# You should check to enable user-scripted relay browser overrides. This sounds tricky and does absolutely nothing right now. However, 3 months from now you will try to use some cool script and it won't work. You won't know that it has to override some of the relay browser defaults and that it is utterly hozed because this obscure little box is not checked... not that it has happened to me or anything... ;-)
# These HP/MP restore links I think only appear in the mini-browser. This option won't really affect you.
# The maintain Health/Mana during manual adventure is significant. I'd turn these off. It means that Mafia will still try to recover HP/MP as defined in your HP/MP Recovery tab, even when playing manually! When I am in manual mode, I want TOTAL CONTROL.
#: [[File:Lesson9 browser.png]]
# Under 'Main Tabs', you can actually customize which Mafia functions appear. If you dragged Item Manager for example from the Complete List to the Startup in Tabs, then it would be accessible as a Tab instead of you having to specifically pull it up. Once you get the hang of Mafia better, you might want to add a commonly used tool to the Tabs.
#: [[File:Lesson9 tabs.png]]
# Ignore Breakfast for now. That will be the next lesson.

'''BOTTOM LINE:''' It is important to know some of the key options to constrain Mafia.

Continue to [[KoLmafia Guide: Setting Up Breakfast|Lesson 10: Setting Up Breakfast]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Setting Preferences

2010-05-04T16:58:58Z

SinginSally:

This lesson is important to keep Mafia from doing stuff you don't want it to. In the latest 13.9 version, the developer has set much more conservative defaults so this is not as necessary. Still, lets go through the major options.

# Under the main menubar under General, click Preferences. This pops up a tabbed browser with tons and tons of preferences and options.
# You probably took one look at all of it, said 'Oh @&%$!' and closed it. It's all good... Re-open it now. :-)
# Make sure we are on the General tab of the options:
# The first interesting option is "Auto-Remove malignant status effects". You might want Mafia to not use restoratives to remove bad conditions. Many bad-effects really aren't all that significant. Therefore, you would not want to waste resources removing minor impediments. On the other hand, a newer player might keep this since they don't know what restores work on which condition anyways. That said, don't forget that if you are able to remove a condition, then it's duration will be '''underlined''' on your relay browser. One click will have Mafia auto-remove it.
# I do recommend 'Protect against accidental ten-leaf clover usage'. This warns you when you are about to enter a zone which would use a ten-leaf clover. As a noob, I've wasted many clovers in this way before Mafia came along. It also turns all 10-leaf clovers into Disassembled ones whenever you acquire them... in case you were wondering where your clovers went. :-)
# I recommend allowing mafia to buy from NPC stores. This gives you a lot more flexibility when creating drinks and food since Mafia will know that they can buy fruits and other components from the NPC as necessary. This generally occurs when you are making food&booze where you already have a good amount of control.
# I would keep Buy from the Mall turned off. You MIGHT want to turn this on for short periods, such as when creating a bartender/chef in a box. That is a lot easier than assembling it yourself or trying to figure out which pieces you are missing. Note that Mafia will never buy anything worth more than 20,000 meat which provides a safety feature.
# Your clan probably has a bunch of rules regarding the Stash. Hence, uncheck Taking items from clan stash, as this can lead to nastygrams from your clan!
#: [[File:Lesson9 General.png]]
# Under the Browser tab, do NOT check the wiki option, as every item you click will pop up a full page wiki entry, constrained to a tiny 4 inch item display. Not cool. You can use the right-click menu of your account options to look-up stuff anyways. Or use the Mafia inventory manager to easily right-click to pop up a wiki page.
# You should check to enable user-scripted relay browser overrides. This sounds tricky and does absolutely nothing right now. However, 3 months from now you will try to use some cool script and it won't work. You won't know that it has to override some of the relay browser defaults and that it is utterly hozed because this obscure little box is not checked... not that it has happened to me or anything... ;-)
#: [[File:Lesson9 browser.png]]
# Under 'Main Tabs', you can actually customize which Mafia functions appear. If you dragged Item Manager for example from the Complete List to the Startup in Tabs, then it would be accessible as a Tab instead of you having to specifically pull it up. Once you get the hang of Mafia better, you might want to add a commonly used tool to the Tabs.
#: [[File:Lesson9 tabs.png]]
# Ignore Breakfast for now. That will be the next lesson.

'''BOTTOM LINE:''' It is important to know some of the key options to constrain Mafia.

Continue to [[KoLmafia Guide: Setting Up Breakfast|Lesson 10: Setting Up Breakfast]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Automatic HP/MP Recovery

2010-05-04T16:43:32Z

SinginSally:

These zones were easy and you should not have lost any significant HP/MP. This will not always be the case.

Mafia can (and WILL!) automatically recover HPs and MPs in-between encounters. In some cases it will even restore in combat! You probably don't want Mafia running off buying stuff to heal you or using precious semi-rare consumables. Therefore, we need to get Mafia under control. 

As an update, the Mafia creators have started with much more conservative defaults to prevent Mafia from doing 'unexpected stuff' which flusters newbies. This is a good thing as I uttered many an unrepeatable oath while trying to figure out what the heck Mafia was doing at times. Anyways, it is still worth going through this lesson.

# Click the 'HP/MP Usage' tab in Mafia Frame when the Adventure tab is active. It will give you a painfully detailed listing of whether it will automatically use HP/MP recovery in between adventures.
# I personally do not want Mafia to recover MP and health automatically. I recommend the following settings:
#* Stop Automation - N/A. This aborts auto-adventuring if Mafia cannot recover you.
#* Restore your Health - Set both dropdowns to 'Do not recover health'.
#* Mana Burning - set to 'Do not rebalance buffs' for now. This uses 'excess MP' to recast your buffs. Great if you have MP-restore items or familiars, so you don't have to keep manually recasting buffs.
#* Restore your Mana - Set to 'Do not auto-recover mana'.
#* It is not a bad idea to uncheck all the various recovery boxes that might be checked.
: [[File:Lesson7 HpMpUsage.png]]

Bonus) Ok, lets say you want to explore this functionality a bit more. Say you are a Seal Clubber with Tongue of the Otter which is a healing spell. Say you have a Cocabo or other MP-restoring familiar or item. You expect to take some light to moderate damage in a zone, but not enough to use full Restores. Let's look at how you would set this up to have Mafia heal you.

* Under 'Stop Automation', set to Stop if auto-recovery fails. This means that Mafia will stop auto-adventuring if it is unable to recover your HP/MP as specified.
* Under Restore Your Health, the first drop-down indicates how low your HP percentage drops before Mafia tries to heal you. Set to 80%.
* The second Health Dropdown indicates how much Mafia tries to heal you once triggered. Set to 90% as you don't want Mafia to waste healing if you are at 99% when it is trying to recover you to 100%.
* Let's keep Mana Burning left alone. We will be using our excess MP to heal, not rebuff.
* Leave Restore Your Mana controls disabled.

Now you need to go set 'Tongue of the Otter' under the various restores. Uncheck everything else. 

You are now set up. After every fight, if you are below 80%, it will cast Tongue until you are at 90% or higher. If you don't have the MP to cast Tongue under the set conditions, Mafia will abort auto-adventuring. Then you can manually heal, restore MP, change the Restore settings, or manually adventure.

'''BOTTOM LINE:''' You can decide whether to have KolMafia auto-recover health and mana for you. I prefer to retain manual control over it for the most part. However under certain conditions it is extremely helpful.

Continue to [[KoLmafia Guide: Goal-Oriented Adventuring|Lesson 8: Goal-Oriented Adventuring]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Automatic HP/MP Recovery

2010-05-04T16:39:59Z

SinginSally:

These zones were easy and you should not have lost any significant HP/MP. This will not always be the case.

Mafia can (and WILL!) automatically recover HPs and MPs in-between encounters. In some cases it will even restore in combat! You probably don't want Mafia running off buying stuff to heal you or using precious semi-rare consumables. Therefore, we need to get Mafia under control. 

As an update, the Mafia creators have started with much more conservative defaults to prevent Mafia from doing 'unexpected stuff' which flusters newbies. This is a good thing as I uttered many an unrepeatable oath while trying to figure out what the heck Mafia was doing at times. Anyways, it is still worth going through this lesson.

# Click the 'HP/MP Usage' tab in Mafia Frame when the Adventure tab is active. It will give you a painfully detailed listing of whether it will automatically use HP/MP recovery in between adventures.
# I personally do not want Mafia to recover MP and health automatically. I recommend the following settings:
#* Stop Automation - N/A. This aborts auto-adventuring if Mafia cannot recover you.
#* Restore your Health - Set both dropdowns to 'Do not recover health'.
#* Mana Burning - set to 'Do not rebalance buffs' for now. This uses 'excess MP' to recast your buffs. Great if you have MP-restore items or familiars, so you don't have to keep manually recasting buffs.
#* Restore your Mana - Set to 'Do not auto-recover mana'.
: [[File:Lesson7 HpMpUsage.png]]

Bonus) Ok, lets say you want to explore this functionality a bit more. Say you are a Seal Clubber with Tongue of the Otter which is a healing spell. Say you have a Cocabo or other MP-restoring familiar or item. You expect to take some light to moderate damage in a zone, but not enough to use full Restores. Let's look at how you would set this up to have Mafia heal you.

# First, set to 'Stop Automation'. This means that Mafia will stop auto-adventuring if it is unable to recover your HP/MP as specified.
# Under Restore Your Health, the first drop-down indicates how low your HP percentage drops before Mafia tries to heal you. Set to 80%.
# The second Health Dropdown indicates how much Mafia tries to heal you once triggered. Set to 90% as you don't want Mafia to waste healing if you are 99% trying to recover you to 100%.
# Let's keep Mana Burning left alone. We will be using our excess MP to heal, not rebuff.
# Leave MP restore off.

Now you need to go set 'Tongue of the Otter' under the various restores. Uncheck everything else. 

You are now set up. After every fight, if you are below 80%, it will cast Tongue until you are at 90% or higher. If you don't have the MP to cast Tongue under the set conditions, Mafia will abort auto-adventuring. Then you can manually heal, restore MP, change the Restore settings, or manually adventure.

'''BOTTOM LINE:''' You can decide whether to have KolMafia auto-recover health and mana for you. I prefer to retain manual control over it for the most part. However under certain conditions it is extremely helpful.

Continue to [[KoLmafia Guide: Goal-Oriented Adventuring|Lesson 8: Goal-Oriented Adventuring]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Auto-Adventuring

2010-05-04T16:19:26Z

SinginSally:

Now we are going to let Mafia adventure for us! We have learned how to prepare a custom combat script, on the off chance that you have Mr. A combat items or skills to use, or actually ARE a disco bandit and want to use your disco combos. Otherwise, just set Mafia to Attack with Weapon, or to use a spell. Alternatively you can use a simple CCS(custom combat script) that does nothing but attack or cast, but has an Abort line at action 20. This is a great safety precaution for more dangerous areas.

1) Lets pick a location. Pick one that is pretty easy for your level such as Sleazy Back Alley. Making sure the 'Adventure' TopTab is active, you need to find and select the location. This can be irritating because there is so much crap! There are many locations that are obsolete (Crimbo 2006 for example) that clog up the works. Fortunately the text-bar right above the locations box is a '''filter!''' Type in Sleazy for example and it will filter the results so you can find the Sleazy back alley.
Anyways, pick an easy location to adventure for testing purposes then make sure it is selected as indicated by highlight.

[[File:Lesson6 Sleazy.png|right]]
2) Next to the text-filter box on the right is a small entry textbox with a little up and down adjustment arrows. This is where you specify the maximum number of adventures to go on. It is a good idea to type in a limiting number. Otherwise, Mafia will use ALL your remaining adventures if not aborted. Another reason to limit adventures is in case something goes wrong. If you get poisoned and beat up, you certainly don't want Mafia to keep losing fight after fight! You have to pay attention and don't assume Mafia is going to intelligently take care of everything for you.

3) Clear the display by selecting Tools from the Main MenuBar, then 'Clear Results'. We want a fresh panel to see the results of our adventuring!

4) Make sure the 'Goals' dropdown is greyed out. If not, uncheck the little box to its right.

5) One more thing... click the 'Choice Advs' tab once your zone is selected. You will see a Zone and Item tab that relates mostly to that particular zone. This lets you auto-select what Mafia will do when it encounters a particular adventure. For the Sleazy Alley, you will see 5 different pulldowns. Each one corresponds to the five different possible non-combat choice adventures in that zone. It comes with intelligent defaults, but you can customize it as you wish. 
Note that "skip adventure" corresponds to Mafia picking the choice that backs out of the adventure without using up an adventure. Note also that you can always request to "Show in browser" which will pop up a mini-browser and let you choose when that encounter comes up. This is helpful for adventures that give you pieces of an outfit for example. You will want to make different choices each time you hit that particular one.
: [[File:Lesson6 choices.png]]

6) Now, click BEGIN! The big progress bar in the middle will start incrementing as you adventure. You can see your HPs/MPs going up and down and your experience increases, and your substat gains and loot acquired.

7) The progress bar will indicate when it is done. In general for Mafia, a blackened bar will be displayed when a task is done and Mafia is idle. Sometimes there is lag in KoL, so this gives you an idea when a task is actually done.
: [[File:Lesson6 complete.png]]

8) After starting the adventuring, click the Graphical CGI tab which logs our adventures. The log shows you exactly what happened (or is happening) for those 10 adventures. This is important to see that your combat script is doing what it is supposed to. (pickpocketing, etc) Technically we have already tested this, but it is worthwhile to check.

9) Once it is done, click back to the Adventure tab and you can see a summary of those 10 adventures. It shows all Meat, Loot, and Substats gained in that bottom-left tab.

10) IMPORTANT! REFRESH YOUR BROWSER! Mafia synchs with the browser, but the browser does NOT auto-refresh when you do stuff in the Mafia Frame! Keep this in mind. Hence, the Adventures Remaining and other info will not be current. Once you do an adventure or something that would refresh the info, the browser will catch up.

Note that refreshing the browser will KICK YOU OUT OF CHAT. No biggie, but you will lose chat history this way. A way to avoid this is to either use Mafia's built in chat interface, OR instead of refreshing the browser, the status-window on the left has a refresh link at the very bottom.

Bonus) Note that you can also click the 'Stop Now' or 'Stop After' buttons on the Adventure tab to stop adventuring. I recommend the Stop-After which will finish the current adventure. If you 'Stop Now', a mini-browser pops up for you to manually finish the current encounter if you happen to have stopped it mid-fight.

BOTTOM LINE: Mafia can REALLY speed up the 'grind' aspect with careful usage of auto-adventure. This is one of my favorite features.

Continue to [[KoLmafia Guide: Automatic HP/MP Recovery|Lesson 7: Automatic HP/MP Recovery]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Custom Combat Script

2010-05-04T15:30:39Z

SinginSally:

Autoattacking is fine and all, but in many cases you want something a bit more sophisticated. Let's say we are a Disco Bandit, fighting the Giants in the Cloud Castle with plenty of MP regen. We want to use our Disco Bandit combo skill which makes the fight easier and gives us a 1 turn +30% meat buff. This would be a huge pain to do manually for every fight.

1) In the Mafia Frame, Click the 'Custom Combat' Bottom Tab when in the Adventure TopTab. You will see a script called "Default", and it has several lines: A [Default] folder-looking icon, followed by a 1: Special Action, and 2: Attack With Weapon.
: [[File:Lesson5 default.png]]

This is what the script does: 
When encountering a [default] monster, it will do any special action indicated under the Special box, as described in the last lesson. This includes Pickpocketing, or whatever. 
On Round 2, it will Attack with Weapon. 
On round 3 and beyond, it repeats the last action commanded, which in this case is Attack with Weapon.
This continues until you have lost or won the fight.

2) We are gonna make our own script now! Click the NEW button at the bottom-right. Give it a name. This script is now selected instead of the "Default" custom script.

Note that we have the exact same 'default code' we saw in step 1. Note that [default] does NOT refer to the name of the script. It is simply a header referring to the series of actions it performs against a default monster. In advanced scripts you can put in a [monster name] with special actions taken against just that monster. This would be great for casting an elemental spell against a physical-resistant foe for example. For now, don't worry about it.

3) Click EDIT and modify our script. Go ahead and enter the following. For my example above, the script I described earlier would look like:
:[default]
:1: steal
:2: skill disco dance of doom
:3: skill disco dance II: electric boogaloo
:4: attack

When you hit OK, it will interpret what you typed. For example, the keyword 'steal' turns into 'try to steal an item'.
This script will pickpocket if applicable, do my 2 disco skills, then attack with weapon until end of combat.
: [[File:Lesson5 DiscoAttack.png]]

A more flexible script would be to Use Special Action as the round 1 action. This would allow me to choose whether to pickpocket or not, based on what is in my Special box. For you, make the following script depending on your class:
:line 1 - [default] (leave this line alone)
:line 2 - 1: special action (leave this line alone too)
:line 3 - add 2: skill <insert skill name here>
:line 4 - 3: attack. (leave this line alone)

So really, all you did is add line 3 and renumber line 4 from 2: attack to 3: attack.

The only trick is to find the exact name of the desired skill. Pick one of your low-level skills like Clobber, Toss, a spell, Sing, or whatever your level 1 power is. Use your Relay Browser and click your top-left character profile to get the exact name. Type or Cut&Paste it in. Then hit OK. The 'attack' command will turn into 'attack with weapon'. If you typed the skill in properly it should be in the script. Otherwise, Mafia will complain about an invalid skill. Note that the last entry is what the script will keep repeating until the combat is over.

For Reference, the HELP button will give you a list of the script commands. 'steal' is for pickpocketing, 'skill X' will perform the skill, X, you specify. 'item X' uses an item. There are several others to explore later.

4) Make sure the main KolMafia Frame's 'Action:' pulldown shows 'custom combat script' as the active one, as opposed to 'attack with weapon'.
: [[File:Lesson5 ccs.png]]
Next, make sure that your named script is selected, as opposed to that Default one.
: [[File:Lesson5 cccName.png]]

5) Time to test it! Go fight something in the Relay Browser and click the Script button at top-left. Watch and see what it does. Did it work? Actually this might be a bit tricky to determine since Scripted attacks tend to skip browser refreshes. Instead, click the 'Graphical CLI' tab and see EXACTLY what your character did.

Bonus) Modify your script and add a 20: abort. This will instruct the script to abort as the 20th action (not necessarily the 20th round). It will pop up a mini-browser and you will finish the fight manually. This is a good catch-all safety feature in case you are fighting a physical immune with no elemental damage, or using a low-power 'disguise outfit' or trying to wield a melee weapon as a moxie-class, or whatever else went wrong.

BOTTOM LINE: Combat Scripts are very flexible and can help you take advantage of stuff you might normally be too lazy to do regularly such as Disco combos, Turtle Tamer Chains, Noodle Summons, and other repetitive things.

Continue to [[KoLmafia Guide: Auto-Adventuring|Lesson 6: Auto-Adventuring]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Basics (Relay Browser)

2010-05-04T14:14:32Z

SinginSally:

We are going to play using KoLMafia in the easiest manner possible.
Here is a shot of the main frame where you will click one button and then minimize:

[[File:Interface-Main-Annotated.png]]

# On the Mafia Frame, click the '''RELAY BROWSER''' icon. It is second one over from the top left and looks like a little treasure map with an X marks the spot. [[File:Relay-icon.png]] Or, under the Main MenuBar click 'General', then click 'Relay Browser'.
## This opens your default browser to KoL and looks just like what you are used to when you login to KoL.
## It might use the wrong browser by default. For example, Internet Exploder instead of Firefox or Chrome that you might prefer. If this happens, do this:
##* Click General from the top menubar.
##* Click Preferences
##* Click the Browser Tab.
##* In the Browser textbar, click the [...] button to browse and find the executable for the desired browser. Alternatively, you can try typing in the name of the browser and KoLMafia will attempt to find it for you.
# Do you have any greasemonkey scripts? You can still use many of them in this relay browser. I don't really recommend using any invasive ones since we are trying to migrate away from them and focus on Mafia for the time being. Go ahead and disable all Greasemonkey scripts for now. Just keep in mind that you can still use them if you want functionality that Mafia cannot easily duplicate. For example, there is a Greasemonkey script that tries to calculate your total meat value that I still use. A Raid Manager is also a great one once you start doing Clan Dungeons which parses your clan dungeon logs. There is no equivalent in mafia at the time being.
# Completely ignore the Mafia Frame or minimize it. Play like normal for a while (at least 20 turns), using the Relay Browser. It is practically identical to standard play. Try to play in a zone with some non-combat choice encounters.

'''Seeing KolMafia in Action:'''

While using the Relay Browser, you will start noticing some cool stuff that it does automatically to help you out. Here is a short list of stuff to note/try:

# If you encountered a non-combat adventure with choices, you will see the first Mafia bonus. Mafia gives you a short description of exactly what happens when you select that particular choice. This is super cool and really lowers the Wikipedia usage or guesswork, especially if you are a new player!
#:[[File:Dumpster Diving.png]]
# When you fight a foe, it gives you a quick display about that monster's level, estimated hit points, item drops and percentages, meat drop rate, and so forth. This is really helpful information and is much easier than looking up stuff in the Wiki, or playing blind.
#:[[File:Monster stats.png]]
# There is a hidden counter that gives you a semi-rare encounter periodically. It is normally tracked by eating a fortune cookie or two, then logic-ing out what the magic number is. Then keeping track of how many turns are left until the encounter. If you have no idea what I am talking about, look up [http://kol.coldfront.net/thekolwiki/index.php/Semi-Rare_Adventures semi-rare at the KoL Wiki].
#* With Mafia, when you eat a Fortune Cookie, it notes the 3 numbers given. It knows which numbers are out of bounds, based on your Ascention Path (Oxycore, Standard, BadMoon, etc) and can sometimes determine the Semi-Rare countdown number based on one cookie. In any case, all valid numbers are added to your buff entries as 'Fortune Cookie(XXX)' counters.
#*:[[File:Fortune cookie counter.png]]
#* Eating a second cookie will get rid of ambiguity if there are multiple valid Fortune Cookie counters.
#* The counter counts down as you adventure. When it is gone and you try to adventure, it will stop you. It reminds you that the counter is up and what your last semi-rare was (so you don't try to do the same one again, which negates it).
#* After the semi-rare, two buffs appear which are a minimum and maximum cookie counter. This makes it a lot more likely that Mafia can figure out the right counter number with only one cookie.
#*:[[File:Semirare window.png]]
# Your Last Adventure link now has a history which shows your last '''five''' adventure locations. Any of them are clickable. This is very convenient, especially when you make short-term detours such as doing a semi-rare and then have to find your adventure location again.
# If you use Action Bars (an interface choice in your KoL Account Preferences), you might notice a "Script" button at the top-left when in a fight. We will learn how to use that [[KoLmafia_Guide:_Attack_Script|later]] in the tutorial to automatically perform a series of combat actions.
#: [[File:Lesson1 CAB.png]]
#If you use the standard text-based stuff in a fight, you will see additional hotkey-able clickable buttons along the top with certain actions. Normally to use a combat skill, you have to select your combat skill to use from a drop-down. Mafia makes appropriate buttons for you to save time. It will always have buttons for noodles and olfaction if you know those skills. There's a button to jiggle your chefstaff if you have one equipped. It also adds a script button which will be discussed [[KoLmafia_Guide:_Attack_Script|later]]. Other buttons are the last several skills you have used.
#: [[File:Lesson1 KolCbt.png]]
# You will notice that Mafia helps you out some with quests. For example, it auto-fills in answers to certain puzzles, remembers which Dungeon of Doom potions do what, and misc other stuff.
# If you click the underlined number under an effect, KolMafia will use an appropriate item or spell to remove it.
# You might even notice that Mafia does some stuff automatically whether you like it or not! For example, if you get beaten-up, Mafia might use an item to remove that condition automatically. This can be a source of irritation, but we will learn to handle it by setting our preferences appropriately in a later lesson.

'''BOTTOM LINE:''' You can play KoL just like normal and get a lot of handy bonus information very easily.

'''Continue''' to [[KoLmafia Guide: Java Interface|Lesson 2: Java Interface]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Preface

2010-05-04T14:08:42Z

SinginSally: /* How I Teach & Requirements */

== How I Teach & Requirements ==

I have only played KoL for 3 months. (well, more like 7 now!) I am hoping this means that I will not take stuff for-granted like year-long players. I can actually address more advanced stuff now that I know how clan dungeons work, the Sea, and so forth. ;-)

I assume that you have played KoL for at least a few weeks before reading this guide. This is simply so I can reference examples while teaching. This is not a strict requirement though... it just means that you might not catch some of my examples.

Finally, you need to be able to '''play''' while reading this guide! Learning while trying to break a speed ascension record or something is probably not the best way to go. 50 turns should be enough to get through most of the lessons.

My main goal is to start out playing KoL using KoLMafia's 'Relay Browser', which is basically identical to normal browser play. Then, each short lesson will progressively give you a new 'trick' that you can use. This lets you learn at your own pace.

Continue working through the guide by doing 'Lessons' until you have learned as much as you want. The lessons are roughly in the order of importance, or more honestly, the order in which I figured the stuff out. :-) There is tons of stuff that I probably won't cover, but by the time you are done with the lessons, you will have the hang of it.

== What About Greasemonkey? ==

Greasemonkey is another scripting tool that can be used for Kingdom of Loathing. Please skip this section if you don't know or care about Greasemonkey.

I tried Greasemonkey scripts. They are nice, but have four major disadvantages:

* CodeRot - Many scripts are outdated and their functionality continues to break due to new content, changes, etc.

* Out of Date - A script is typically written by the author who uses it, posts it, then it is forgotten. People quit KoL all the time for varying reasons. Hence, scripts are very likely to be outdated by the time you find them.

* Version Overload - On the other hand, there can be too many versions of a popular script, all written by different people who baselined off of someone else's version and so forth. Certain versions incorporate particular fixes and updates, but might be lacking updates and rewrites by someone else. It can be difficult to find the latest, most correct version of a particular script.

* Security Issues - Greasemonkey by itself doesn't do anything. All functionality comes from the actual scripts, which coupled with many versions/updates and the fact that scripts are scattered all over the internet makes executing them more of a security risk.

I decided to try KoLMafia which has these advantages:

* More Secure - It comes from ONE sourceforge open-source website and its base version includes plenty of functionality. This makes it much safer to use out of the box.

* Easier to Install - No digging around and searching forums for hours to find the right script. (At least not until you have mastered Mafia and go looking for Mafia-specific scripts...)

* Easier to Customize - Not much of an issue at first, but writing a new Greasemonkey script is relatively hard. Modifying KoLMafia behavior can be a lot easier for certain aspects.

* Consolidated Updates - All KoLMafia work occurs at its sourceforge website. Versions are numbered and under version-control. This means you can easily find the most up-to-date version and no intermediate fixes were skipped.

* Easier to Figure Out - While the documentation for KoLMafia is not amazing, you will have a lot more luck finding help documents (like this one!) for Mafia, as opposed to documentation for random Greasemonkey scripts.

== Links ==

You need to have this post handy, '''while playing''' I will guide you through each lesson, but you have to be reading it while using KoLMafia for it to really make any sense. Printing it or having it on a second monitor is helpful.

First, here's a list of various websites that I may refer to during the guide. You do not need to worry about them now!

*KolMafia's website: http://kolmafia.sourceforge.net/ 
*KolMafia forum: http://kolmafia.us/ 
*KolMafia Wiki: http://wiki.kolmafia.us/index.php?title=Main_Page 
*A Previously Existing Guide: http://forums.kingdomofloathing.com/vb/showthread.php?t=140340 
*List of CLI Commands http://kolmafia.sourceforge.net/scripting.html 
*List of all KolMafia global variables (more for scripting): http://wiki.kolmafia.us/index.php?title=List_of_KoLmafia_Properties 

== Getting Started ==

We are now officially starting your KolMafia lessons!

# Go to KolMafia's website (listed above). The download link is not really obvious; it's a small link at the top left somewhere. Click it to go here: https://sourceforge.net/project/showfiles.php?group_id=126572
# By default it picks the appropriate package for you. All you need is '''your''' system's file. As a windows user, I download the 3 Meg executable. Mac users download theirs. Linux, etc. If all else fails, use the java Jar file.
# Move the file somewhere handy. Note that KolMafia can be downloaded as an executable. However, it does '''not install''' per se. Instead, I like to say that it 'roots'. When executed, '''will create quite a few subfolders''' to store its settings. Therefore, I extremely highly recommend placing it in its own folder. Once moved, make a link to it on your desktop so you can easily execute it. . You just run the file to run KoLMafia. No further setup is needed.
# If the file doesn't run, you need the 1.6 or better Java Runtime Environment. This is not particularly hard and many will likely already have it. The KolMafia website given above, has a 'Getting Started' section that you can refer to in case of such issues.
# When you first run it, '''two''' windows pop up. Ignore the complicated looking frame, and look at the one with the login fields. Type in your login info (make sure you don't have KoL running elsewhere obviously), then click the '''LOGIN''' button. Ignore the RELAY button for now. Keep the other options unchecked, including breakfast. We will discuss this stuff later.
# The Login frame goes away and now you have the main box, which I will call the KolMafia Frame. I don't have a place to store an up to date picture, but the whole thing is kind-of intimidating. You are probably ready to quit, but ''stick in there!''' We will make this easy by doing things step-by-step. I'm a noob, remember? I got your back! ;-)
# Note that is possible that KolMafia '''may pop up an events logger window'''. This occurrs if you were attacked, received a message, or whatever other event type stuff might happen. Just close that small window if you encounter it.

'''Continue''' to [[KoLmafia Guide: Basics (Relay Browser)|Lesson 1: Basics (Relay Browser)]]

[[Category:KoLmafia Guide]]

KoLmafia Guide

2010-05-04T14:06:07Z

SinginSally: /* Introduction */

= Introduction =
{{GuideP|
A few KoLMafia guides exist already, but they are out-of-date, too brief or just too complex. They are typically for more advanced players that catch the lingo and references. My guide is by a noob, to be on the level of noobs. It is (hopefully) easy to understand, pretty verbose, and up to date (at time of update in May 2010).
}}
{{GuideP|
This guide is for those players that are interested in using a great third-party tool to enrich their Kingdom of Loathing experience significantly. Mafia is a java program that acts as a go-between for you to the KoL server. It has its own frame that contains a lot of functionality. In addition, you will use a normal browser window to play like normal. Mafia helps you in many ways:
}}
{{GuideP|
* Mafia allows you to use a 'Relay Browser' which is practically identical to the normal playing environment. The only noticeable difference is that Mafia adds bonus information and reminders that are very helpful when playing. This is by far my favorite feature because you do not have to try to learn a brand new interface to use Mafia.
}}
{{GuideP|
* Provides some alternative interfaces to do certain functions that you may or may not like better than the built-in interface. At the very least, you can easily say... look up a mall price on something in Mafia without having to redirect your browser to the mall and then back to your inventory or adventuring location. Or quickly check your entire inventory with filtering without leaving your browser.
}}
{{GuideP|
* Automation. KolMafia allows you to intelligently automate actions, from small scale to larger scale. As an example, you can easily set up a 'script' combat button that will then do exactly what you want it to do; Maybe a Disco Bandit always wants to Pickpocket if possible, followed up by a Disco Dance, then auto-attack the rest of the way. Or an owner of a certain familiar wants to extend each fight to maximize Meat/Mana/HP,etc gains. Instead of doing this manually for each fight, you click ONE button which does the entire sequence! As an update, KoL itself now provides Combat Macros. However, I think Mafia is easier to understand and easier to configure it to work right.
}}
{{GuideP|
* Reduction of lag. Mafia works as an interface directly to KoL. What this means is that when you automate actions, no browser refresh is needed. This is really helpful, as a 12 round auto-combat using the Script button will be done in about three browser refreshes.
}}
{{GuideP|
* Collating of information. KolMafia keeps track of all stat gains, meat found, items found, and an entire log of everything that has happened in the game. The info is logged automatically and effortlessly if you want it. It is just about essensial for those who want to compete in leaderboard challenges or post logs of their ascension on their clan website.
}}
{{GuideP|
* Ability to call player written scripts which do various stuff. For example, one of them will automatically equip all outfits you own to get any unearned Tattoos. These scripts require more trust, but I will show you how to examine scripts and see what they do for yourself.
}}
{{GuideP|
Remember... Automation is only '''one''' aspect of KolMafia! I generally avoid too much of something 'playing for me' myself, and it is entirely possible to use and love KolMafia with '''no automation whatsoever!''' 

Unless you are outright opposed to the concept of KolMafia or Greasemonkey, I'd strongly urge you to read this guide and give it a try. By the end of the first Lesson, you will know enough to decide for yourself. ---Warning:--- There are some '''light spoilers''' in this guide for illustration purposes!
}}

= Table of Contents =
{{GuideP|
* [[KoLmafia Guide: Preface|Preface]]
* [[KoLmafia Guide: Basics (Relay Browser)|Lesson 1: Basics (Relay Browser)]]
* [[KoLmafia Guide: Java Interface|Lesson 2: Java Interface]]
* [[KoLmafia Guide: Stats-Checking|Lesson 3: Stats-Checking]]
* [[KoLmafia Guide: Attack Script|Lesson 4: Attack Script]]
* [[KoLmafia Guide: Custom Combat Script|Lesson 5: Custom Combat Script]]
* [[KoLmafia Guide: Auto-Adventuring|Lesson 6: Auto-Adventuring]]
* [[KoLmafia Guide: Automatic HP/MP Recovery|Lesson 7: Automatic HP/MP Recovery]]
* [[KoLmafia Guide: Goal-Oriented Adventuring|Lesson 8: Goal-Oriented Adventuring]]
* [[KoLmafia Guide: Setting Preferences|Lesson 9: Setting Preferences]]
* [[KoLmafia Guide: Setting Up Breakfast|Lesson 10: Setting Up Breakfast]]
* [[KoLmafia Guide: Eating & Drinking|Lesson 11: Eating & Drinking]]
* [[KoLmafia Guide: PvP (Beating Up People)|Lesson 12: PvP (Beating Up People)]]
* [[KoLmafia Guide: Running ASH Scripts|Lesson 13: Running ASH Scripts]]
* [[KoLmafia Guide: Useful Commands|Lesson 14: Useful Commands]]
* [[KoLmafia Guide: Closing Thoughts|Lesson 15: Closing Thoughts]]
}}

= Scripting for Dummies =
{{GuideP|
As an addendum to the basic KolMafia end user guide above, I also created a guide that helps you learn how to create simple scripts. It is surprisingly easy to create these scripts and they can accomplish many repetitive tasks that you might do on a daily basis. For example, a farming setup script might pull out a familiar, equip a certain outfit, buff yourself up, ask a buffbot for buffs, drink some potions to increase itemfind, and increase the Monster Level dial to maximum, and finally setup a particular custom combat script. This makes it easy to do things without forgetting stuff! 
I would recommend that you at least browse through the scripting guide, see some of the neat stuff that you are capable of doing, then decide if it is worthwhile for you to dive into it yourself. I strongly suspect that at the very least, you can copy and paste some of my example scripts, change some of the buff/item/familiar names, and have your very own script!
}}
{{GuideP|
* [[KoLmafia Guide: An Introduction to Scripting|An Introduction to Scripting]]
* [[KoLmafia Guide: Your first Script|Post-Lesson 1: Your first Script, Automatically Buffing Up]]
* [[KoLmafia Guide: Automatic Mall Selling|Post-Lesson 2: Automatic Mall Selling]]
* [[KoLmafia Guide: Automatic Buffing II|Post-Lesson 3: Automatic Buffing II, Buffbots and Status Checking]]
* [[KoLmafia Guide: Logout script|Post-Lesson 4: Logout Scripting for Overdrinking, Adventure Equipment, Librams, etc.]]
* [[KoLmafia Guide: Creating an Auto-adventuring Script|Post-Lesson 5: Creating an Auto-adventuring Script]]
* [[KoLmafia Guide: Commonly Used ASH Commands|Post-Lesson 6: Commonly Used ASH Commands]]
* [[KoLmafia Guide: In Closing|In Closing]]
}}

KoLmafia Guide: Custom Combat Script

2010-04-28T16:45:54Z

SinginSally:

Autoattacking is fine and all, but in many cases you want something a bit more sophisticated. For my example, I am a level 15 Disco Bandit, fighting the Giants in the Cloud Castle with plenty of MP regen. I want to use my Disco Bandit combo skill which makes the fight easier and gives me a 1 turn +30% meat buff.

1) As an example, this is what I would do: (don't actually do anything for this step) In the Mafia Frame, I click the 'Custom Combat' Bottom Tab when in the Adventure TopTab. I see a script called "Default", and it has several lines: A [Default] folder, followed by a 1: Special Action, and 2: Attack With Weapon. This indicates the following:

When encountering a [default] monster, on round 1: it will Use any special action indicated under the Special box, as described in the last lesson. This includes Pickpocketing, or whatever.
On Round 2, it will Attack with Weapon.
On round 3 and beyond, it repeats the last action commanded, which in this case is Attack with Weapon.
: [[File:Lesson5 default.png]]

2) We are gonna make our own script now! Click the NEW button at the bottom-right. Give it a name. This script is now selected instead of the "Default" custom script.

Note that we have the exact same 'default code' we saw in step 1. Note that [default] does NOT refer to the name of the script. It is simply a header referring to the series of actions it performs against a default monster. In advanced scripts you can put in a [monster name] with special actions taken against just that monster. This would be great for casting an elemental spell against a physical-resistant foe for example. For now, don't worry about it.

3) Click EDIT and modify our script. For my example, My script I described earlier would look like:
:[default]
:1: steal
:2: skill disco dance of doom
:3: skill disco dance II: electric boogaloo
:4: attack

When you hit OK, it will interpret what you typed. For example, the keyword 'steal' turns into 'try to steal an item'.
This script will pickpocket if applicable, do my 2 disco skills, then attack with weapon until end of combat.
: [[File:Lesson5 DiscoAttack.png]]

A more flexible script would be to Use Special Action as the round 1 action. This would allow me to choose whether to pickpocket or not, based on what is in my Special box. For you, make the following script depending on your class:
:line 1 - [default] (leave this line alone)
:line 2 - 1: special action (leave this line alone too)
:line 3 - add 2: skill <insert skill name here>
:line 4 - 3: attack. (leave this line alone)

So really, all you did is add line 3 and renumber line 4 from 2: attack to 3: attack.

The only trick is to find the exact name of the desired skill. Pick one of your low-level skills like Thrust-Smack, or a spell, or whatever. Use your Relay Browser and click your top-left character profile to get the exact name. Type it in, Hit OK. The 'attack' command will turn into 'attack with weapon'. Note that the last entry is what the script will keep repeating until the combat is over.

For Reference, the HELP button will give you a list of the script commands. 'steal' is for pickpocketing, 'skill X' will perform the skill, X, you specify. 'item X' uses an item. There are several others to explore later.

4) Make sure the main KolMafia Frame's 'Action:' pulldown shows 'custom combat script' as the active one, as opposed to 'attack with weapon'.
: [[File:Lesson5 ccs.png]]
Next, make sure that your named script is selected, as opposed to Default.
: [[File:Lesson5 cccName.png]]

5) Time to test it! Go fight something in the Relay Browser and click the Script button at top-left. Watch and see what it does. Did it work? Actually this might be a bit tricky to determine since Scripted attacks tend to skip browser refreshes. Instead, click the 'Graphical CLI' tab and see EXACTLY what your character did.

Bonus) Modify your script and add a 20: abort. This will instruct the script to abort as the 20th action (not necessarily the 20th round). It will pop up a mini-browser and you will finish the fight manually. This is a good catch-all safety feature in case you are fighting a physical immune with no elemental damage, or using a low-power 'disguise outfit' or trying to wield a melee weapon as a moxie-class, or whatever else went wrong.

BOTTOM LINE: Combat Scripts are very flexible and can help you take advantage of stuff you might normally be too lazy to do regularly such as Disco combos, Turtle Tamer Chains, Noodle Summons, and other repetitive things.

Continue to [[KoLmafia Guide: Auto-Adventuring|Lesson 6: Auto-Adventuring]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Attack Script

2010-04-28T16:43:13Z

SinginSally:

Now we are going to fight a foe using a Mafia script instead of our standard method. It is very easy!

1) In the Mafia frame with the Adventure Top Tab active, on the far right there is a pulldown that is labeled 'Action:'. It defaults to 'Attack with Weapon'. Not surprisingly, when auto-combat is activated the script will keep attacking until the combat is over. By clicking this pulldown, you can choose several other options, based on what your character has available. For example, you can have it spam Thrust-Smack, or cast a spell, or whatever.
For now, either stick with weapon-attack, or casting a low MP offensive spell.

You can click in the bar below labeled 'Special:' to set up conditional beginning-of-fight actions. For example, as a Moxie-Class, an option is for Mafia to automatically pickpocket all non-bosses if you win initiative. If you are a moxie-class, pick this option. You could also tell Mafia to always cast Entangling Noodles. When selected, a corresponding symbol shows up in the Special Box. Note that the option is ignored if you don't meet the requirements (for example, asking for Noodles when you don't have the skill).

: [[File:Lesson4 actions.png]]

2) In your relay browser, go fight something easy but takes a few rounds to kill. If you use Combat Action Bars, click the 'Script' button.
: [[File:Lesson4 CAB.png]]
:If you don't use action bars, Mafia adds several buttons for easier combat and the 'Script' will be one of them.
: [[File:Lesson4 KolCbt.png]]

3) The script will execute, which will pickpocket if possible (if you are a Moxie class, noodle if Myst,etc.), and then spam the default action until the fight is over. Cool huh? No more clicking the Attack button 6 times every fight! If you run out of mana, it will default to a weapon attack. (more on this later).

You will notice the fight will go a lot faster too in that it will appear to 'skip rounds'. This is because KoLMafia can send commands and receive results back faster than your browser will refresh. Hence a 12 round fight may only take 3 or 4 refreshes. This speeds up fighting significantly. It is also easier on the server.

'''BOTTOM LINE:''' You can save clicks and reduce lag by using the Script button to fight easy battles for you.

'''Continue''' to [[KoLmafia Guide: Custom Combat Script|Lesson 5: Custom Combat Script]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Stats-Checking

2010-04-28T16:37:30Z

SinginSally:

The goal of this lesson is to understand the relationship between the relay browser and the Mafia Frame. The Mafia Frame stays in-sync with the relay browser automatically. This means anything done in the relay browser is captured in Mafia. There is no refresh necessary.

Now that you've adventured for a while, go to the Mafia Frame. Click the 'Adventure' Top Tab if it is not already up. Notice the following:

* The Adventure location dropdown is automatically set to where you adventured last, indicated by the highlighted area.
: [[File:Lesson3 adventure.png]]

{|
|valign=top|<ul><li>Two panels are in the bottom middle of the screen. The 'Location Details' at the right side shows you all possible encounters for the zone you were last in with drops, percentages and other info. This panel is based on information from the game itself and is roughly equivalent to a compacted wikipedia entry on a zone. It changes based on which zone you have selected in the Adventure dropdown. This is a quick and easy way to determine if this zone is a bit out of your league, or if it is really too easy for you to fully benefit. Advanced players use this info to boost Monster Level for more challenge and benefits since it calculates how often you will hit or evade based on your Muscle/Moxie.
|valign=top|[[File:Lesson3 locationdetails.png]]</li></ul>
|}

{|
|valign=top|<ul><li>[[File:Lesson3 sessionresults.png]]
|valign=middle|The 'Session Results' panel at the left is a running total of the results of your adventures used so far. This gives you a general idea of how much meat, substats, and items that you have received in your last X number of adventures. To reset this panel, click the 'Tools' Main MenuBar, then 'Clear Results'. (Please don't do this yet.)</li></ul>
|}

* Click the Graphical CLI Top Tab. This is misnamed somewhat, as what it really displays is the relevant information that Mafia has extracted from KoL while you have been playing using the standard graphical interface. It effectively acts as a Log of your activity. You can see all the adventures and fights that you have done this session. This is an important tab to remember, as I was very leery of Mafia at first. Sometimes, Mafia would do stuff and I had no idea what the heck it was doing! This log keeps track of '''every''' action that mafia performs. This should go a long way to ease your mind, since you can always refer to this panel. Note that you can type 'clear' into the text box at the bottom to clear the log. ('Clear Results' does not seem to do the trick)
:: [[File:Lesson3 CLI.png]]

* The Character Display has all your stats, including some extra ones at the bottom like your Monster Level Modifier, Combat Encounter Rate Modifier, Initiative Modifier, Experience Bonus, Meat Drop and Item Drop modifiers. The only thing lacking is a Semi-Rare counter, which is found on the Relay Browser instead. The semi-rare counter is also found under your current effects found in the casting section.

* Click the Character Display where all your stats are displayed and mafia will pop-up a little box. Feast your eyes on all the additional cool info that mafia calculates for you, such as Damage Absorption, your resistances, bonus damage, and lots of useful information.
:: [[File:Lesson3 stats.png]]

* In the Adventure Tab's bottom two panels, you can right click and do various operations. For example, hopefully you found a usable item in your previous adventures. Right-click the item. This pulls up a menu where you can consume (use) the item, autosell it, get a wiki description or other options. This is a really handy alternative to digging through your inventory, finding it, and finally dealing with a recently found item. Currently, you can '''not''' mall-sell an item from this menu. Autosell != mallsell.
:: [[File:Lesson3 useresults.png]]

'''BOTTOM LINE:''' The KolMafia frame keeps track of stuff you do in the relay browser (normal play).

'''Continue''' to [[KoLmafia Guide: Attack Script|Lesson 4: Attack Script]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Java Interface

2010-04-28T16:30:29Z

SinginSally:

This lesson is a quick one just to standardize my terminology. You dont have to remember all this. The only goal is so you have an idea where I am referring to if I say "Click the Main MenuBar" for example.

Bring up the KolMafia main frame if minimized. I will refer to the following conventions when discussing various parts of it. Wow, this is a lot easier when I have screenshots. :-)

* Main Menu Bar - This appears at the top of the screen and has "General Tools People Travel Quests Scripts Window Help" categories. When you click on a category, various sub-categories appear as dropdowns.

* Top Icons - These are the 18 icons at the top of the kolmafia screen. Clicking them generally takes you to various sub-frames for specific tasks.

* Character Display - At the left hand side shows all your character information.

* Top Tabs - These are "Adventure Graphical CLI Purchases Gear Changer Skill Caster". These tabs are clickable to show different GUI windows for various functionality.

* Status Bar - When the '''Adventure''' tab is active, this large horizontal bar in the middle of the frame hows the status of the current or last action taken.

* Bottom Tabs - In certain modes, other tabs are active and show different capabilities. When the Adventure tab is active, you will see bottom tabs showing "Overview Choice Advs HP/MP Usage Mood Setup Custom Combat".

[[File:Lesson 2.png]]

'''BOTTOM LINE:''' Now you know what my terminology means.

'''Continue''' to [[KoLmafia Guide: Stats-Checking|Lesson 3: Stats-Checking]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Basics (Relay Browser)

2010-04-28T16:27:51Z

SinginSally:

We are going to play using KoLMafia in the easiest manner possible.
Here is a shot of the main frame:

[[File:Interface-Main-Annotated.png]]

# On the Mafia Frame, click the '''RELAY BROWSER''' icon. It is second one over from the top left and looks like a little treasure map with an X marks the spot. [[File:Relay-icon.png]] Or, under the Main MenuBar click 'General', then click 'Relay Browser'.
## This opens your default browser to KoL and looks just like what you are used to when you login to KoL.
## It might use the wrong browser by default. For example, Internet Exploder instead of Firefox or Chrome that you might prefer. If this happens, do this:
##* Click General from the top menubar.
##* Click Preferences
##* Click the Browser Tab.
##* In the Browser textbar, click the [...] button to browse and find the executable for the desired browser. Alternatively, you can try typing in the name of the browser and KoLMafia will attempt to find it for you.
# Do you have any greasemonkey scripts? You can still use many of them in this relay browser. I don't really recommend using any invasive ones since we are trying to migrate away from them and focus on Mafia for the time being. Go ahead and disable all Greasemonkey scripts for now. Just keep in mind that you can still use them if you want functionality that Mafia cannot easily duplicate. For example, there is a Greasemonkey script that tries to calculate your total meat value that I still use. A Raid Manager is also a great one once you start doing Clan Dungeons which parses your clan dungeon logs. There is no equivalent in mafia at the time being.
# Completely ignore the Mafia Frame. Play like normal for a while (at least 20 turns), using the Relay Browser. It is practically identical to standard play. Try to play in a zone with some non-combat choice encounters.

'''Seeing KolMafia in Action:'''

While using the Relay Browser, you will start noticing some cool stuff that it does automatically to help you out. Here is a short list of stuff to note/try:

# If you encountered a non-combat adventure with choices, you will see the first Mafia bonus. Mafia gives you a short description of exactly what happens when you select that particular choice. This is super cool and really lowers the Wikipedia usage or guesswork, especially if you are a new player!
#:[[File:Dumpster Diving.png]]
# When you fight a foe, it gives you a quick display about that monster's level, estimated hit points, item drops and percentages, meat drop rate, and so forth. This is really helpful information and is much easier than looking up stuff in the Wiki, or playing blind.
#:[[File:Monster stats.png]]
# There is a hidden counter that gives you a semi-rare encounter periodically. It is normally tracked by eating a fortune cookie or two, then logic-ing out what the magic number is. Then keeping track of how many turns are left until the encounter. If you have no idea what I am talking about, look up [http://kol.coldfront.net/thekolwiki/index.php/Semi-Rare_Adventures semi-rare at the KoL Wiki].
#* With Mafia, when you eat a Fortune Cookie, it notes the 3 numbers given. It knows which numbers are out of bounds, based on your Ascention Path (Oxycore, Standard, BadMoon, etc) and can sometimes determine the Semi-Rare countdown number based on one cookie. In any case, all valid numbers are added to your buff entries as 'Fortune Cookie(XXX)' counters.
#*:[[File:Fortune cookie counter.png]]
#* Eating a second cookie will get rid of ambiguity if there are multiple valid Fortune Cookie counters.
#* The counter counts down as you adventure. When it is gone and you try to adventure, it will stop you. It reminds you that the counter is up and what your last semi-rare was (so you don't try to do the same one again, which negates it).
#* After the semi-rare, two buffs appear which are a minimum and maximum cookie counter. This makes it a lot more likely that Mafia can figure out the right counter number with only one cookie.
#*:[[File:Semirare window.png]]
# Your Last Adventure link now has a history which shows your last '''five''' adventure locations. Any of them are clickable. This is very convenient, especially when you make short-term detours such as doing a semi-rare and then have to find your adventure location again.
# If you use Action Bars (an interface choice in your KoL Account Preferences), you might notice a "Script" button at the top-left when in a fight. We will learn how to use this later in the tutorial to automatically perform a series of combat actions. If you use the standard text-based stuff in a fight, you will see additional hotkey-able clickable buttons along the top with certain actions. Normally to use a combat skill, you have to select your combat skill to use from a drop-down. Mafia knows what class you are, what skills you know and makes appropriate buttons for you to save time.
: [[File:Lesson4 CAB.png]]
: [[File:Lesson4 KolCbt.png]]
# You will notice that Mafia helps you out some with quests. For example, it auto-fills in answers to certain puzzles, remembers which Dungeon of Doom potions do what, and misc other stuff.
# You might even notice that Mafia does some stuff automatically whether you like it or not! For example, if you get beaten-up, Mafia might use an item to remove that condition automatically. This can be a source of irritation, but we will learn to handle it by setting our preferences appropriately in a later lesson.

'''BOTTOM LINE:''' You can play KoL just like normal and get a lot of handy bonus information very easily.

'''Continue''' to [[KoLmafia Guide: Java Interface|Lesson 2: Java Interface]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Basics (Relay Browser)

2010-04-28T16:24:25Z

SinginSally:

We are going to play using KoLMafia in the easiest manner possible.
Here is a shot of the main frame:

[[File:Interface-Main-Annotated.png]]

# On the Mafia Frame, click the '''RELAY BROWSER''' icon. It is second one over from the top left and looks like a little treasure map with an X marks the spot. [[File:Relay-icon.png]] Or, under the Main MenuBar click 'General', then click 'Relay Browser'.
## This opens your default browser to KoL and looks just like what you are used to when you login to KoL.
## It might use the wrong browser by default. For example, Internet Exploder instead of Firefox or Chrome that you might prefer. If this happens, do this:
##* Click General from the top menubar.
##* Click Preferences
##* Click the Browser Tab.
##* In the Browser textbar, click the [...] button to browse and find the executable for the desired browser. Alternatively, you can try typing in the name of the browser and KoLMafia will attempt to find it for you.
# Do you have any greasemonkey scripts? You can still use many of them in this relay browser. I don't really recommend using any invasive ones since we are trying to migrate away from them and focus on Mafia for the time being. Go ahead and disable all Greasemonkey scripts for now. Just keep in mind that you can still use them if you want functionality that Mafia cannot easily duplicate. For example, there is a Greasemonkey script that tries to calculate your total meat value that I still use. A Raid Manager is also a great one once you start doing Clan Dungeons which parses your clan dungeon logs. There is no equivalent in mafia at the time being.
# Completely ignore the Mafia Frame. Play like normal for a while (at least 20 turns), using the Relay Browser. It is practically identical to standard play. Try to play in a zone with some non-combat choice encounters.

'''Seeing KolMafia in Action:'''

While using the Relay Browser, you will start noticing some cool stuff that it does automatically to help you out. Here is a short list of stuff to note/try:

# If you encountered a non-combat adventure with choices, you will see the first Mafia bonus. Mafia gives you a short description of exactly what happens when you select that particular choice. This is super cool and really lowers the Wikipedia usage or guesswork, especially if you are a new player!
#:[[File:Dumpster Diving.png]]
# When you fight a foe, it gives you a quick display about that monster's level, estimated hit points, item drops and percentages, meat drop rate, and so forth. This is really helpful information and is much easier than looking up stuff in the Wiki, or playing blind.
#:[[File:Monster stats.png]]
# There is a hidden counter that gives you a semi-rare encounter periodically. It is normally tracked by eating a fortune cookie or two, then logic-ing out what the magic number is. Then keeping track of how many turns are left until the encounter. If you have no idea what I am talking about, look up [http://kol.coldfront.net/thekolwiki/index.php/Semi-Rare_Adventures semi-rare at the KoL Wiki].
#* With Mafia, when you eat a Fortune Cookie, it notes the 3 numbers given. It knows which numbers are out of bounds, based on your Ascention Path (Oxycore, Standard, BadMoon, etc) and can sometimes determine the Semi-Rare countdown number based on one cookie. In any case, all valid numbers are added to your buff entries as 'Fortune Cookie(XXX)' counters.
#*:[[File:Fortune cookie counter.png]]
#* Eating a second cookie will get rid of ambiguity if there are multiple valid Fortune Cookie counters.
#* The counter counts down as you adventure. When it is gone and you try to adventure, it will stop you. It reminds you that the counter is up and what your last semi-rare was (so you don't try to do the same one again, which negates it).
#* After the semi-rare, two buffs appear which are a minimum and maximum cookie counter. This makes it a lot more likely that Mafia can figure out the right counter number with only one cookie.
#*:[[File:Semirare window.png]]
# Your Last Adventure link now has a history which shows your last '''five''' adventure locations. Any of them are clickable. This is very convenient, especially when you make short-term detours such as doing a semi-rare and then have to find your adventure location again.
# If you use Action Bars (an interface choice in your KoL Account Preferences), you might notice a "Script" button at the top-left when in a fight. We will learn how to use this later in the tutorial to automatically perform a series of combat actions. If you use the standard text-based stuff in a fight, you will see additional hotkey-able clickable buttons along the top with certain actions. Normally to use a combat skill, you have to select your combat skill to use from a drop-down. Mafia knows what class you are, what skills you know and makes appropriate buttons for you to save time.
# You will notice that Mafia helps you out some with quests. For example, it auto-fills in answers to certain puzzles, remembers which Dungeon of Doom potions do what, and misc other stuff.
# You might even notice that Mafia does some stuff automatically whether you like it or not! For example, if you get beaten-up, Mafia might use an item to remove that condition automatically. This can be a source of irritation, but we will learn to handle it by setting our preferences appropriately in a later lesson.

'''BOTTOM LINE:''' You can play KoL just like normal and get a lot of handy bonus information very easily.

'''Continue''' to [[KoLmafia Guide: Java Interface|Lesson 2: Java Interface]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Basics (Relay Browser)

2010-04-28T16:23:30Z

SinginSally:

We are going to play using KoLMafia in the easiest manner possible.
Here is a shot of the main frame:

[[File:Interface-Main-Annotated.png]]

# On the Mafia Frame, click the '''RELAY BROWSER''' icon. It is second one over from the top left and looks like a little treasure map with an X marks the spot. [[File:Relay-icon.png]] Or, under the Main MenuBar click 'General', then click 'Relay Browser'.
## This opens your default browser to KoL and looks just like what you are used to when you login to KoL.
## It might use the wrong browser by default. For example, Internet Exploder instead of Firefox or Chrome that you might prefer. If this happens, do this:
##* Click General from the top menubar.
##* Click Preferences
##* Click the Browser Tab.
##* In the Browser textbar, click the [...] button to browse and find the executable for the desired browser. Alternatively, you can try typing in the name of the browser and KoLMafia will attempt to find it for you.
# Do you have any greasemonkey scripts? You can still use many of them in this relay browser. I don't really recommend using any invasive ones since we are trying to migrate away from them and focus on Mafia for the time being. Go ahead and disable all Greasemonkey scripts for now. Just keep in mind that you can still use them if you want functionality that Mafia cannot easily duplicate. For example, there is a Greasemonkey script that tries to calculate your total meat value that I still use. A Raid Manager is also a great one once you start doing Clan Dungeons which parses your clan dungeon logs. There is no equivalent in mafia at the time being.
# Completely ignore the Mafia Frame. Play like normal for a while (at least 20 turns), using the Relay Browser. It is practically identical to standard play. Try to play in a zone with some non-combat choice encounters.

'''Seeing KolMafia in Action:'''

While using the Relay Browser, you will start noticing some cool stuff that it does automatically to help you out. Here is a short list of stuff to note/try:

# If you encountered a non-combat adventure with choices, you will see the first Mafia bonus. Mafia gives you a short description of exactly what happens when you select that particular choice. This is super cool and really lowers the Wikipedia usage or guesswork, especially if you are a new player!
#:[[File:Dumpster Diving.png]]
# When you fight a foe, it gives you a quick display about that monster's level, estimated hit points, item drops and percentages, meat drop rate, and so forth. This is really helpful information and is much easier than looking up stuff in the Wiki, or playing blind.
#:[[File:Monster stats.png]]
# There is a hidden counter that gives you a semi-rare encounter periodically. It is normally tracked by eating a fortune cookie or two, then logic-ing out what the magic number is. Then keeping track of how many turns are left until the encounter. If you have no idea what I am talking about, look up [http://kol.coldfront.net/thekolwiki/index.php/Semi-Rare_Adventures semi-rare at the KoL Wiki].
#* With Mafia, when you eat a Fortune Cookie, it notes the 3 numbers given. It knows which numbers are out of bounds, based on your Ascention Path (Oxycore, Standard, BadMoon, etc) and can sometimes determine the Semi-Rare countdown number based on one cookie. In any case, all valid numbers are added to your buff entries as 'Fortune Cookie(XXX)' counters.
#*:[[File:Fortune cookie counter.png]]
#* Eating a second cookie will get rid of ambiguity if there are multiple valid Fortune Cookie counters.
#* The counter counts down as you adventure. When it is gone and you try to adventure, it will stop you. It reminds you that the counter is up and what your last semi-rare was (so you don't try to do the same one again, which negates it).
#* After the semi-rare, two buffs appear which are a minimum and maximum cookie counter. This makes it a lot more likely that Mafia can figure out the right counter number with only one cookie.
#*:[[File:Semirare window.png]]
# Your Last Adventure link now has a history which shows your last '''five''' adventure locations. Any of them are clickable. This is very convenient, especially when you make short-term detours such as doing a semi-rare and then have to find your adventure location again.
# If you use Action Bars (an interface choice in your KoL Account Preferences), you might notice a "Script" button at the top-left when in a fight. We will learn how to use this later in the tutorial to automatically perform a series of combat actions. If you use the standard text-based stuff in a fight, you will see additional hotkey-able clickable buttons along the top with certain actions. Normally to use a combat skill, you have to select your combat skill to use from a drop-down. Mafia knows what class you are, what skills you know and makes appropriate buttons for you to save time.
# You will notice that Mafia helps you out some with quests. For example, it auto-fills in answers to certain puzzles, remembers which Dungeon of Doom potions do what, and misc other stuff.
# You MIGHT even notice that Mafia does some stuff automatically whether you like it or not! For example, if you get beaten-up, Mafia might use an item to remove that condition automatically. This can be a source of irritation, but we will learn to handle it.

'''BOTTOM LINE:''' You can play KoL just like normal and get a lot of handy bonus information very easily.

'''Continue''' to [[KoLmafia Guide: Java Interface|Lesson 2: Java Interface]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Auto-Adventuring

2010-04-19T16:05:32Z

SinginSally:

Now we are going to let Mafia adventure for us! We have our customized combat script prepared and are ready to go! (You might want to modify it to remove the level 0 test-skill that we did in the lesson).

1) Lets pick a location. Pick one that is pretty easy such as Sleazy Back Alley. Making sure the 'Adventure' TopTab is active, you need to find and select the location. This can be irritating because there is so much crap! There are many locations that are obsolete (Crimbo 2006 for example) that clog up the works. Fortunately the text-bar right above the locations box is a FILTER! Type in Sleazy for example and it will filter the results so you can find the Sleazy back alley.
Anyways, pick an easy location to adventure for testing purposes then make sure it is selected as indicated by highlight.

[[File:Lesson6 Sleazy.png|right]]
2) Next to the text-filter box on the right is a small entry textbox with a little up and down adjustment arrows. This is where you specify the maximum number of adventures to go on. It is a good idea to type in a limiting number. Otherwise, Mafia will use ALL your remaining adventures if not aborted. Put in 10.

3) Clear the display by selecting Tools from the Main MenuBar, then 'Clear Results'. We want a fresh panel to see the results of our adventuring!

4) Make sure the 'Goals' dropdown is greyed out. If not, uncheck the little box to its right.

5) One more thing... click the 'Choice Advs' tab once your zone is selected. You will see a Zone and Item tab that relates mostly to that particular zone. This lets you auto-select what Mafia will do when it encounters a particular adventure. For the Sleazy Alley, you will see 5 different pulldowns. Each one corresponds to 5 non-combat adventures in that zone. It comes with intelligent defaults, but you can customize it as you wish.
Note that "skip adventure" corresponds to Mafia picking the choice that backs out of the adventure without using up an adventure. Note also that you can always request to "Show in browser" which will pop up a mini-browser and let you choose when that encounter comes up.
: [[File:Lesson6 choices.png]]

6) Now, click BEGIN! The big progress bar in the middle will start incrementing as you adventure. You can see your HPs/MPs going up and down and your experience increases, and your substat gains and loot acquired.

7) The progress bar will indicate when it is done. In general for Mafia, a blackened bar will be displayed when a task is done and Mafia is idle. Sometimes there is lag in KoL, so this gives you an idea when a task is actually done.
: [[File:Lesson6 complete.png]]

8) After starting it, click the Graphical CGI tab which logs our adventures. The log shows you exactly what happened (or is happening) for those 10 adventures. This is important to see that your combat script is doing what it is supposed to. (pickpocketing, etc) Technically we have already tested this, but it is worthwhile to check.

9) Once it is done, click back to the Adventure tab and you can see a summary of those 10 adventures. It shows all Meat, Loot, and Substats gained in that bottom-left tab.

10) IMPORTANT! REFRESH YOUR BROWSER! Mafia synchs with the browser, but the browser does NOT auto-refresh when you do stuff in the Mafia Frame! Keep this in mind. Hence, the Adventures Remaining and other info will not be current. Once you do an adventure or something that would refresh the info, the browser will catch up.

Note that refreshing the browser will KICK YOU OUT OF CHAT. No biggie, but you will lose chat history this way. A way to avoid this is to either use Mafia's built in chat interface, OR instead of refreshing the browser, the status-window on the left has a refresh link at the very bottom.

Bonus) Note that you can also click the 'Stop Now' or 'Stop After' buttons on the Adventure tab to stop adventuring. I recommend the Stop-After which will finish the current adventure. If you 'Stop Now', a mini-browser pops up for you to manually finish the current encounter if you happen to have stopped it mid-fight.

BOTTOM LINE: Mafia can REALLY speed up the 'grind' aspect with careful usage of auto-adventure. This is one of my favorite features.

Continue to [[KoLmafia Guide: Automatic HP/MP Recovery|Lesson 7: Automatic HP/MP Recovery]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Setting Up Breakfast

2010-03-29T20:12:09Z

SinginSally:

Breakfast is the Mafia functionality of accomplishing repetitive stuff that you generally would want to do that involves no usage of any resources, nor is there any particular choice or strategy regarding it. For example, there is no reason at all to not pick the Clan Meat Tree or use the Klaw game, or to read your class book (the one that gives you a small number of substats every day), or to use a cheap toaster. These are all done automatically when you invoke Breakfast.

On the other hand, some things you might wish to control. For example, if you wish to use a Tome, or which chips to pick from the Clan Vending Machine. Since these have some user interaction involved, the Breakfast Preferences handles these. Let's check these preferences:

# Bring up the Preferences as before under main menubar, General, Preferences.
# Click the Breakfast tab.
# The first thing you see are options to execute scripts during login or logout. We will skip this, but note that it gives you the ability to perform specialized custom commands. For example, say you want to switch your gear to equipment that boosts your adventures per day, then drink a final cocktail. You could use the On Logout script to do so. In our scripting tutorial we will create such a logout script.
# You will see two separate sections for both Ronin-clear characters and in-ronin ones. For the most part, I'd expect you to have both of them exactly the same... EXCEPT to enable 'honor path restrictions' during the ronin period.
# I would recommend you click all of the applicable available checkboxes. The clover-acquirer is nice. This command buys hermit permits if needed, then visits the Hermit, gets clovers, then uses them to make them Disassembled Clovers if you have worthless trinkets with which to use them. Note that it will '''not''' spend your adventures fishing around in the sewer for Worthless trinkets though.
# You probably want to turn off 'Enable Auto-Recovery'. This would for example let Mafia use MP restores to use your Tome or heal you in preparation for adventuring. I prefer to manage this myself.

You are done! Go ahead and activate breakfast by one of several methods. You could click Breakfast from the Daily Deeds panel under Adventuring (I prefer this panel up instead of the Location Details and changed it by using the pulldown). There is probably a Breakfast option somewhere in the pulldown menus. Or you could logout, click Breakfast to enable it automatically and re-login.
Now you can check the CLI tab and see exactly what Breakfast did for you.

'''BOTTOM LINE:''' Breakfast is a great way to automatically do things that you want done but don't necessarily remember every time.

Continue to [[KoLmafia Guide: Eating & Drinking|Lesson 11: Eating & Drinking]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Useful Commands

2010-03-29T19:58:37Z

SinginSally:

Most people will prefer the GUI for KoL playing. However, Mafia does have a handful of useful functions that you can type in.

These are the ones that I have found to be useful. Your mileage will vary, but read through these and try em out. A FULL LIST can be found in my Links section at the top of the guide.

1) You will need to be at the 'Graphical CLI' top-level tab.

2) At the bottom of the screen is a small textbox where you may enter commands.
----

* help [optional command] - Gives you a list of commands. OR how to use the given command if you type it 'help burn' for example.

* clear - Clears the screen and log entries entirely.

* inv [filter] - Shows your inventory. The cool thing is that you can add a filter. So for a list of all your wads, you would type 'inv wad' and it will come back with Twinkly Wad, Hot Wad, or whatever wads you have. I generally use the item manager and sort by alphabetical order or type instead. But this works too. For example, you ask yourself 'did I get that pirate insult book doodad?'. You don't have to know the exact name. Just type Insult and let it do the work.

* modref - This gives you a huge list of pretty much ALL conceivable character stats such as Sleaze Damage, HP Max, Regen Rate, all resistances, and so forth. Furthermore the exact text of the first column works as a 'category' which you can then feed to the next few commands.

* maximize [category] - Equips your character using your inventory to the best of its ability in order to maximize the given category! Categories are found through the 'modref' command above. So if you wanted to maximize your Sleaze Resistance, you would type 'maximize Sleaze Resistance' and watch it go! It will give you a Score for the level of the maximized level. This is extremely useful for Clan Dungeons!

* modtrace [category] - Prints out a list of all sources that modify the desired category, either positively or negatively. So if you are wondering WHY you have a Meat Drop rate of say..140%, it will break it down for you!

* modifies [category] - Shows you ALL sources that modify the given category IN THE ENTIRE GAME. Whereas the previous commands just work with what inventory you have, this command lists everything, straight from the wiki. Sometimes this command is kind of flaky.

* wiki [filter] - This command shows you the wiki entry for whatever you typed in and pops it up in a new Tab. This is a really handy shortcut.

* Various Listers - These commands give you a list of quest or ascension-specific stuff you have identified.
** bang - Shows identified Dungeon of Doom potions. (clear, murky, etc)
** dusty - Lists identifies Dusty Wine bottles. (pinot noir, merlot, etc)
** insults - Lists all known pirate insults.
** demons - Lists names of demons known for summoning.

* pvplog - shows results of PvP combat. It actually generates a spreadsheet of all battles from your messagebox. To see it, you must go to the KoLMafia Directory under the Attacks subdirectory. It is very helpful though and even figures out all your enemies stats for you! (Like how many White Canadians they have drank, etc.) This is great if there is one guy that really hacks you off. This parsed log will help you gather info on them.

* undercut - Any items in your Mall store with the default price of 999999999 will be repriced to match the lowest mall price. Mafia uses the 5th lowest price, so you won't necessarily undercut everyone. On the other hand, you won't fall victim to the 1/day limit super-low priced options!

* reprice - ALL items in your mall store are repriced to match the lowest known mall price. Uses the 5th lowest price as per above.

* alias - Lets you create a shortcut command. Great for buffbots. For example, "alias buffode => csend 300 meat to buffBawt" would mean that you'd simply type buffode and it would then send meat to some random buffbut which you would know would cast Ode to Booze on you.

* csend - as shown in Alias above. Sends a kmail to the target with attached meat or items.

Continue to [[KoLmafia Guide: Closing Thoughts|Lesson 15: Closing Thoughts]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Closing Thoughts

2010-03-29T19:55:33Z

SinginSally:

KolMafia has so much functionality, it is ridiculous. We have gone over the basics, but I want to leave some final thoughts on other neat things Mafia can do.

1) Redundant Functionality - Mafia is meant to REPLACE the normal KoL interface. In our lessons, we have used Mafia as a supplement to the normal interface. What this means is that Mafia has a lot of duplicate functionality. For example, the Store Interface and the Equipping Manager are just about identical to what KoL already uses. Therefore, I use them interchangeably. In some cases, there is little advantage to using Mafia's version (such as the store manager). On the other hand, some functionality such as the Item Manager is much better in Mafia than the standard interface.

2) The Quest main menubar has some interesting functionality. By selecting one of these, KoLMafia will automate a quest for you. For example, the 'Tavern' will automatically adventure at random tavern locations until it finds the faucet. It will then stop and leave it up to you whether to turn it off or not. Selecting 'guild' will do all your guild unlocking quests. Maze will automatically work through the sorceress hedge maze for you. 'Leaflet' completes the leaflet quest for you, which saves a ton of time typing. Note that many people have written scripts that can automate quests even more.

3) You can write your own .ash scripts. Several tutorials may be found at http://kolmafia.sourceforge.net/advanced.html. I have started learning scripting and in fact have a newbie guide right after this section! It is very handy, especially for more advanced players. For example, a player might want to drink a Tiny Bottle of Absinthe, do the required 3 adventures for the not-a-pipe reward, and in between do farming at the Castle for example. This would be tedious to do manually. Heck, even with Mafia it would be a pain. However, you could write a reasonably simple script that would do this for you.

I think the best way to go about script writing is to find a similar script someone has written, then go modify it to do what you specifically want it to do. In the above example, I'd find a script that adventures in certain locations and uses items. You can then steal the syntax and replace 'Absinthe' and the appropriate adventure locations, rearrange it, and have yourself a functional script.

4) The Item Manager has a lot of functionality. I like to click the General selection and see ALL my inventory on one screen.
* You can then use the textbox and/or checkboxes to filter as desired, use items, send to mall, get a wiki page, etc. This is really handy when you want to do a quick check if you have something or not. Its a LOT easier than searching for a specific item with the normal inventory interface (even with CTRL-F to help you find it!).
*Under Equipment/Pulverize, it can assist you in knowing how to pulverize equipment and even send to Wadbot to do it for you!
*Hardcore players will appreciate that Mafia knows all crafting recipes and can help you create equipment based on what you have available.
*The Item Manager is great for restores. You can click Usable/Restores and it filters down to items that are usable to restore HP or MP. There is even a handy 'Check Wiki' link to find out what they do!

'''This is the end of the conventional KolMafia Guide!'''

If you are interested, once you have this down you might want to tackle scripting. This is writing your own scripts to do various stuff. I recommend that you at least read through the rest of this guide and it will give you an idea of what you are capable of and how difficult it will be to do so. I tried to include several very usable and easily modified scripts to get you started.

Continue to [[KoLmafia Guide: An Introduction to Scripting|Post-Lesson: Scripting for Dummies]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Stats-Checking

2010-03-25T17:12:45Z

SinginSally:

The goal of this lesson is to understand the relationship between the relay browser and the Mafia Frame. The Mafia Frame stays in-sync with the relay browser automatically. This means anything done in the relay browser is captured in Mafia. There is no refresh necessary.

Now that you've adventured for a while, go to the Mafia Frame. Click the 'Adventure' Top Tab if it is not already up. Notice the following:

* The Adventure location dropdown is automatically set to where you adventured last, indicated by the highlighted area.

* Two panels are in the bottom middle of the screen. The 'Location Details' on the right side shows you all possible encounters for the zone you were last in with drops, percentages and other info. This panel is based on information from the game itself and is roughly equivalent to a compacted wikipedia entry on a zone. It changes based on which zone you have selected in the Adventure dropdown. This is a quick and easy way to determine if this zone is a bit out of your league, or if it is really too easy for you to fully benefit. Advanced players use this info to boost Monster Level for more challenge and benefits since it calculates how often you will hit or evade based on your Muscle/Moxie.

* The 'Session Results' panel on the bottom left is a running total of the results of your adventures used so far. This gives you a general idea of how much meat, substats, and items that you have received in your last X number of adventures. To reset this panel, click the 'Tools' Main MenuBar, then 'Clear Results'. (don't do this yet though)

* Click the Graphical CGI Top Tab. This is misnamed somewhat, as what it REALLY displays is important stats that Mafia has extracted from the graphical interface while you've been playing. It effectively acts as a Log of your activity. You can see all the adventures and fights that you have done this session. This is an important tab to remember, as I was very leery of Mafia at first. Mostly because it did a bunch of stuff and I had no idea what the heck it was doing! This log keeps track of EVERY action that mafia performs. Note that you can type 'clear' into the textbox at the bottom to clear the log. ('Clear Results' does not seem to do the trick)

* Notice the Mafia Frame has all your stats, including some extra ones like your Monster Level Modifier, Combat Encounter Percentage Modification, Initiative Modifier, Experience Booster Mod, Meat Find and Item Find modifiers. The only thing lacking is a Semi-Rare counter, which is found on the Relay Browser instead.

* Right-Click the area in mafia that has all your stats. Feast your eyes on all the cool additional info that mafia calculates for you, such as Damage Absorbtion, all your resistances, bonus damage, and all kinds of cool stuff.

* In the Adventure Top Tab's two panels, you can right click and do various operations. For example, hopefully you found a usable item in your last 20ish adventures. Right-click the item. This pulls up a menu where you can Consume(use) the item, sell it, get a wiki-description, and other options. This is really handy instead of having to dig through your inventory, find it, then deal with the item appropriately.

BOTTOM LINE: The KolMafia frame keeps track of stuff you do in the relay browser (normal play).

Continue to [[KoLmafia Guide: Attack Script|Lesson 4: Attack Script]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Eating & Drinking

2010-03-25T17:07:50Z

SinginSally:

This lesson covers managing and creating food,drink,spleen with Mafia. By default, eating and drinking sucks in KoL. You have no clue what most of the items do, and their description is unhelpful. Digging through the wiki is time-consuming and irritating.
Once you get into recipes for creating food and booze, it becomes very difficult to get anything done without tons of Wiki studying.

Mafia does a lot to address this and help you automate and keep track of your consumption. In this lesson, we will attempt to make and consume some drinks.

1) We are going to make some drinks. I am assuming that you have SOME stuff in your inventory that you can use to make drinks, AND you are not almost-drunk already. Go ahead and use advanced cocktail to summon Ice Cubes, etc if you can do so. Note that breakfast will do this for you.

2) Click the Lunchbag looking icon, or from the main menubar under General, select Item Manager.

3) This is a big interface. On the left hand side, click on Booze in the long list of stuff to do, under Usables.

4) The screen is split into a top half and a bottom half. The bottom half contains a scrollpanel which has listings of booze, sorted by the quality of the beverage. Note that each drink has complete info as to stats and adventures per inebriation all spelled out. Its really awesome!

5) You will notice that each drink has a number in parenthesis for Possible and Current. The Current number is how many of that drink you really have in your inventory. Possible is how many you COULD have, by mixing, etc. When the Potential number is the same as the Actual, this means you have all of that drink that you could with your current state of inventory.

6) You can click the No Create checkbox which will then only show drinks you have in your inventory, vs showing all drinks you could conceivably make. The Per-Drunk checkbox should be active as Adventures per Drunk point are a much more useful measurement than total adventures.

7) Going through the scrollbar, find the highest drink where you have more Possible than Current. This means you can make this drink. Select it and click Enqueue. It will ask how many to enqueue. It defaults to the difference between how many you have and can have, up to how much you can actually consume. In other words, if you have 3 martinis and 2 olive/gin, then it will default to enqueing 2.

8) Now, that drink goes to the Top of your screen's panel. Notice that the tab now shows how much Drunkeness you have enqueued. You can click the Ingredients Used tab to show exactly what the drink consists of.

9) Click the Create button. It will now mix that drink for you, using a bartender-in-a-box if it can. It will '''AUTO_CREATE''' the bartender(!), if you have sufficient inventory to do so. If you changed the mafia preferences to buy from the mall, Mafia will go buy what it needs in order to assemble it in the cheapest manner possible if not in ronin/Hardcore.

10) That drink now disappears from the top box and now your Current number has gone up for that drink. It made that drink for you.

11) You will probably wanna go ahead and drink. Use any booze-booster like the Ode to Booze buff or whatever first. Then, assuming you have a max drunkenness of 15 (the default), enqueue 14 drunkness worth of your best booze. You can Consume directly if desired, but I prefer to queue it all up first.

12) The top box will populate with your booze and auto-count the intoxication, warning you if you are about to overdrink. Click Consume when ready and it will drink.

13) Exit the Inventory Manager, click the CGI Graphical tab and look at the log. See what all it really did for you behind the scenes. You might see that it bought a fruit from a hippy (by disguising if you had the suit), or a soda water from the Market. The log lets you see EXACTLY what it did, which is an important step when learning KoLMafia!

14) Bring up the Inventory Manager again. Repeat this process for Food. Then, click Spleen and go ahead and consume all the various Moxie Weeds and other junk that accumulates in your inventory. Mine as well get the free substats!
Advanced players can create and consume Wads or whatever other kind of Spleen management you guys do.

'''Warning:''' It should be noted that the Item Manager is VERY pesky about allowing you to make drinks that you cannot consume. If you are totally drunk, you will find that the Item Manager will not let you make any drinks!

'''X-in-a-box feature:''' There is a neat feature whereby you can mark a checkbox and Mafia will '''only''' create food/drink using a in-a-box from your campsite. This is nice in that it ensures that you will not use up precious turns. It is also very helpful when your in-A-Box breaks and Mafia doesn't have enough parts to reassemble it. In which case, you would use up turns when cooking/mixing. '''However''', it is very important that you turn this feature off when you ascend! The reason being that Mafia will simply not show any recipes until you make the appropriate in-a-box, which might be a while during hardcore.
Not that this would ever happen to me or anything... :-)

Bottom Line: KolMafia really takes the guesswork/research out of eating and drinking, and is a huge help for cooking/mixing.

Continue to [[KoLmafia Guide: PvP (Beating Up People)|Lesson 12: PvP (Beating Up People)]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: An Introduction to Scripting

2010-03-23T16:39:36Z

SinginSally:

'''Why Script?'''

Scripting is great! It allows you to accomplish many repetitive tasks that you will certainly appreciate if you are farming or doing other repetitive actions for very long.

For this portion of the guide, I am going to walk through a series of scripts that I made. These are relatively simple scripts with limited logic and fairly well commented code. I will explain why and how I did various portions of the script. The idea is to get you to understand each script well enough so that you can use cut&paste to piece together your own scripts. In my opinion, this is the easiest way to write your own scripts; steal pieces from other people's scripts! It really is not all that difficult to steal code snippits from others and make simple scripts that can simplify your life significantly.

Another thing to note is that you create scripts in an incremental manner. In other words, you start off doing something really simple and get it to work. Then, you might increase the complexity and get that to work. As you encounter issues or think of improvements, you add to the script. The bottom line is that you don't want to be overwhelmed and expect to get it all working on the first pass. It is much easier to break down a complicated script idea into several pieces, or to get a very basic version going first.

'''Debugging'''

The print statement is your best friend when debugging. By adding temporary print statements you can tell when your code is hit. You can also print out any variables. Use quotes around normal text, including extra spaces for variables. Use the plus to add together a series of things you want to print out. For example: print("Hit code after buff. Number of items = " +numItems +" at price " +itemPrice);
This code would tell you that you hit a certain point and then prints out some variables for you. Notice that printing a variable does NOT add any spacing around it, which is why I add spaces before and after my text in quotes.

'''Defining your Editor'''

In the KolMafia frame, go to General, Preferences, General. At the bottom there is an External Script Editor field. Fill in whatever editor you want to use. (For windows, I'd go with c:\Windows\NOTEPAD.exe). Then you can easily edit a script by holding down shift and clicking it in the 'Scripts' pulldown menu. This is a really cool feature and keeps you from having to keep the KolMafia/Scripts directory explorer around.

Continue to [[KoLmafia Guide: Your first Script|Post-Lesson 1: Your first Script, Automatically Buffing Up]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: An Introduction to Scripting

2010-03-23T16:39:12Z

SinginSally:

'''Intro'''
Scripting is great! It allows you to accomplish many repetitive tasks that you will certainly appreciate if you are farming or doing other repetitive actions for very long.

For this portion of the guide, I am going to walk through a series of scripts that I made. These are relatively simple scripts with limited logic and fairly well commented code. I will explain why and how I did various portions of the script. The idea is to get you to understand each script well enough so that you can use cut&paste to piece together your own scripts. In my opinion, this is the easiest way to write your own scripts; steal pieces from other people's scripts! It really is not all that difficult to steal code snippits from others and make simple scripts that can simplify your life significantly.

Another thing to note is that you create scripts in an incremental manner. In other words, you start off doing something really simple and get it to work. Then, you might increase the complexity and get that to work. As you encounter issues or think of improvements, you add to the script. The bottom line is that you don't want to be overwhelmed and expect to get it all working on the first pass. It is much easier to break down a complicated script idea into several pieces, or to get a very basic version going first.

'''Debugging'''

The print statement is your best friend when debugging. By adding temporary print statements you can tell when your code is hit. You can also print out any variables. Use quotes around normal text, including extra spaces for variables. Use the plus to add together a series of things you want to print out. For example: print("Hit code after buff. Number of items = " +numItems +" at price " +itemPrice);
This code would tell you that you hit a certain point and then prints out some variables for you. Notice that printing a variable does NOT add any spacing around it, which is why I add spaces before and after my text in quotes.

'''Defining your Editor'''
In the KolMafia frame, go to General, Preferences, General. At the bottom there is an External Script Editor field. Fill in whatever editor you want to use. (For windows, I'd go with c:\Windows\NOTEPAD.exe). Then you can easily edit a script by holding down shift and clicking it in the 'Scripts' pulldown menu. This is a really cool feature and keeps you from having to keep the KolMafia/Scripts directory explorer around.

Continue to [[KoLmafia Guide: Your first Script|Post-Lesson 1: Your first Script, Automatically Buffing Up]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Java Interface

2010-03-11T19:37:47Z

SinginSally:

This lesson is a quick one just to standardize my terminology. You dont have to remember all this. The ONLY goal is so you have an idea where I am referring to if I say "Click the Main MenuBar" for example.

Bring up the KolMafia main frame if minimized. I will refer to the following conventions when discussing various parts of it.

* Main MenuBar - This appears at the top of the screen and has "General Tools People Travel Quests Scripts Window Help" categories. When you click on a category, various sub-categories appear as dropdowns.

* Top Icons - These are the 20 or so icons at the top of the kolmafia screen. Clicking them generally takes you to various sub-frames for specific tasks.

* Character Display - At the left hand side shows all your character information.

* Top Tabs - These are "Adventure Graphical CLI Purchaces Gear Changer Skill Caster". These tabs are clickable to show different functionality.

* StatusBar - When the ADVENTURE tab is active, this is the big horizontal bar in the middle of the frame that shows the status of the current or last action taken.

* Bottom Tabs - In certain modes, other tabs are active and show different capabilities. When the Adventure tab is active, you will see bottom tabs showing "Overview Choice Advs HP/MP Usage Mood Setup Custom Combat".

'''BOTTOM LINE:''' Now you know what my terminology means.

'''Continue''' to [[KoLmafia Guide: Stats-Checking|Lesson 3: Stats-Checking]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Basics (Relay Browser)

2010-03-11T19:36:53Z

SinginSally:

We are going to play using KoLMafia in the easiest manner possible.
Here is a shot of the main frame:
[ATTACH]2629[/ATTACH] (yep, this is still in progress)

# On the Mafia Frame, click the RELAY BROWSER icon. It is second one over from the top left and looks like a little treasure map with an X marks the spot. Or, under the Main MenuBar click 'General', then click 'Relay Browser'.
## This opens your default browser to KoL and looks just like what you are used to when you login to KoL.
## It might use the wrong browser by default. For example, Internet Exploder instead of Firefox or Chrome that you might prefer. If this happens, do this:
##* Click General from the top menubar.
##* Click Preferences
##* Click the Browser Tab.
##* In the Browser textbar, click the [...] button to browse and find the executable for the desired browser. OR, try typing in the name of the browser and KoLMafia will try to find it for you.
# Do you have any greasemonkey scripts? You can STILL USE a lot of them in this relay browser. I don't really recommend using any invasive ones since we are trying to migrate away from them and focus on Mafia. Go ahead and disable all Greasemonkey scripts for now. Just keep in mind that you can still use them if you want functionality that Mafia cannot easily duplicate. For example, there is a GM script that tries to calculate your total meat value that I still use. A Raid Manager is also a great one once you start doing Clan Dungeons.
# Completely ignore the Mafia Frame. Play like normal for a while (at least 20 turns), using the Relay Browser. It is practically identical to standard play. Try to play in a zone with some non-combat choice encounters.

'''Seeing KolMafia in Action:'''

While using the Relay Browser, you will start noticing some cool stuff that it does automatically to help you out. Here is a short list of stuff to note/try:

# If you encountered a non-combat adventure with choices, you have seen the first cool Mafia thing. It gives you a short description of what happens when you select that particular choice. For example, if you were in the Sleazy Back Alley and encounted the Hobo non-combat adventure, for the choice, 'Look Under the Hobo', Mafia modifies it and appends ' - get a Mad Train Wine' on the button for that choice. This is super cool and really lowers the Wikipedia usage or guesswork.
# When you fight a foe, it gives you a quick display about that monster's level, hit points, what it drops, meat drop rate, and so forth. This is really helpful information and is much easier than looking up stuff in the Wiki, or playing blind.
# There is a hidden counter that gives you a semi-rare encounter periodically. It is normally tracked by eating a fortune cookie or two, then logic-ing out what the magic number is. Then keeping track of how many turns are left until the encounter. If you have no idea what I am talking about, go to the KoL Wiki and look up 'semi-rare'.
#* With Mafia, when you eat a Fortune Cookie, it notes the 3 numbers given. It knows which numbers are out of bounds, based on your Ascention Path (Oxycore, Standard, BadMoon, etc) and can sometimes determine the Semi-Rare countdown number based on one cookie. In any case, all valid numbers are added to your buff entries as 'Fortune Cookie(XXX)' counters.
#* Eating a second cookie will get rid of ambiguity if there are multiple valid Fortune Cookie counters.
#* The counter counts down as you adventure. When it is gone and you try to adventure, it will stop you. It reminds you that the counter is up and what your last semi-rare was (so you don't try to do the same one again, which negates it).
#* After the semi-rare, two buffs appear which are a minimum and maximum cookie counter. This makes it a lot more likely that Mafia can figure out the right counter number with only one cookie.
# Your Last Adventure link now has a history which shows your last FIVE adventure locations. Any of them are clickable. This is very convenient, especially when you make short-term detours such as doing a semi-rare.
# If you use Action Bars (an interface choice in your KoL Account Preferences), you might notice a "Script" button at the top-left when in a fight. We will learn how to use this later in the tutorial to automatically perform a series of combat actions. If you use the standard text-based stuff in a fight, you will see additional hotkey-able clickable buttons along the top with certain actions. Normally to use a combat skill, you have to select your combat skill to use from a drop-down. Mafia knows what class you are, what skills you know and makes appropriate buttons for you to save time.
# You will notice that Mafia helps you out some with quests. For example, it auto-fills in answers to certain puzzles, remembers which Dungeon of Doom potions do what, and misc other stuff.
# You MIGHT even notice that Mafia does some stuff automatically whether you like it or not! For example, if you get beaten-up, Mafia might use an item to remove that condition automatically. This can be a source of irritation, but we will learn to handle it.

'''BOTTOM LINE:''' You can play KoL just like normal and get a lot of handy bonus information very easily.

'''Continue''' to [[KoLmafia Guide: Java Interface|Lesson 2: Java Interface]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Basics (Relay Browser)

2010-03-11T19:34:21Z

SinginSally:

=== Lesson One: Basic Operation using the Relay Browser ===
----

We are going to play using KoLMafia in the easiest manner possible.
Here is a shot of the main frame:
[ATTACH]2629[/ATTACH] (yep, this is still in progress)

# On the Mafia Frame, click the RELAY BROWSER icon. It is second one over from the top left and looks like a little treasure map with an X marks the spot. Or, under the Main MenuBar click 'General', then click 'Relay Browser'.
## This opens your default browser to KoL and looks just like what you are used to when you login to KoL.
## It might use the wrong browser by default. For example, Internet Exploder instead of Firefox or Chrome that you might prefer. If this happens, do this:
##* Click General from the top menubar.
##* Click Preferences
##* Click the Browser Tab.
##* In the Browser textbar, click the [...] button to browse and find the executable for the desired browser. OR, try typing in the name of the browser and KoLMafia will try to find it for you.
# Do you have any greasemonkey scripts? You can STILL USE a lot of them in this relay browser. I don't really recommend using any invasive ones since we are trying to migrate away from them and focus on Mafia. Go ahead and disable all Greasemonkey scripts for now. Just keep in mind that you can still use them if you want functionality that Mafia cannot easily duplicate. For example, there is a GM script that tries to calculate your total meat value that I still use. A Raid Manager is also a great one once you start doing Clan Dungeons.
# Completely ignore the Mafia Frame. Play like normal for a while (at least 20 turns), using the Relay Browser. It is practically identical to standard play. Try to play in a zone with some non-combat choice encounters.

NOTICING SOME OF THE COOL MAFIA STUFF:

While using the Relay Browser, you will start noticing some cool stuff that it does automatically to help you out. Here is a short list of stuff to note/try:

# If you encountered a non-combat adventure with choices, you have seen the first cool Mafia thing. It gives you a short description of what happens when you select that particular choice. For example, if you were in the Sleazy Back Alley and encounted the Hobo non-combat adventure, for the choice, 'Look Under the Hobo', Mafia modifies it and appends ' - get a Mad Train Wine' on the button for that choice. This is super cool and really lowers the Wikipedia usage or guesswork.
# When you fight a foe, it gives you a quick display about that monster's level, hit points, what it drops, meat drop rate, and so forth. This is really helpful information and is much easier than looking up stuff in the Wiki, or playing blind.
# There is a hidden counter that gives you a semi-rare encounter periodically. It is normally tracked by eating a fortune cookie or two, then logic-ing out what the magic number is. Then keeping track of how many turns are left until the encounter. If you have no idea what I am talking about, go to the KoL Wiki and look up 'semi-rare'.
#* With Mafia, when you eat a Fortune Cookie, it notes the 3 numbers given. It knows which numbers are out of bounds, based on your Ascention Path (Oxycore, Standard, BadMoon, etc) and can sometimes determine the Semi-Rare countdown number based on one cookie. In any case, all valid numbers are added to your buff entries as 'Fortune Cookie(XXX)' counters.
#* Eating a second cookie will get rid of ambiguity if there are multiple valid Fortune Cookie counters.
#* The counter counts down as you adventure. When it is gone and you try to adventure, it will stop you. It reminds you that the counter is up and what your last semi-rare was (so you don't try to do the same one again, which negates it).
#* After the semi-rare, two buffs appear which are a minimum and maximum cookie counter. This makes it a lot more likely that Mafia can figure out the right counter number with only one cookie.
# Your Last Adventure link now has a history which shows your last FIVE adventure locations. Any of them are clickable. This is very convenient, especially when you make short-term detours such as doing a semi-rare.
# If you use Action Bars (an interface choice in your KoL Account Preferences), you might notice a "Script" button at the top-left when in a fight. We will learn how to use this later in the tutorial to automatically perform a series of combat actions. If you use the standard text-based stuff in a fight, you will see additional hotkey-able clickable buttons along the top with certain actions. Normally to use a combat skill, you have to select your combat skill to use from a drop-down. Mafia knows what class you are, what skills you know and makes appropriate buttons for you to save time.
# You will notice that Mafia helps you out some with quests. For example, it auto-fills in answers to certain puzzles, remembers which Dungeon of Doom potions do what, and misc other stuff.
# You MIGHT even notice that Mafia does some stuff automatically whether you like it or not! For example, if you get beaten-up, Mafia might use an item to remove that condition automatically. This can be a source of irritation, but we will learn to handle it.

BOTTOM LINE: You can play KoL just like normal and get a lot of handy bonus information very easily.

Continue to [[KoLmafia Guide: Java Interface|Lesson 2: Java Interface]]

[[Category:KoLmafia Guide]]

KoLmafia Guide: Basics (Relay Browser)

2010-03-11T19:33:58Z

SinginSally:

==== Lesson One: Basic Operation using the Relay Browser ====
----

We are going to play using KoLMafia in the easiest manner possible.
Here is a shot of the main frame:
[ATTACH]2629[/ATTACH] (yep, this is still in progress)

# On the Mafia Frame, click the RELAY BROWSER icon. It is second one over from the top left and looks like a little treasure map with an X marks the spot. Or, under the Main MenuBar click 'General', then click 'Relay Browser'.
## This opens your default browser to KoL and looks just like what you are used to when you login to KoL.
## It might use the wrong browser by default. For example, Internet Exploder instead of Firefox or Chrome that you might prefer. If this happens, do this:
##* Click General from the top menubar.
##* Click Preferences
##* Click the Browser Tab.
##* In the Browser textbar, click the [...] button to browse and find the executable for the desired browser. OR, try typing in the name of the browser and KoLMafia will try to find it for you.
# Do you have any greasemonkey scripts? You can STILL USE a lot of them in this relay browser. I don't really recommend using any invasive ones since we are trying to migrate away from them and focus on Mafia. Go ahead and disable all Greasemonkey scripts for now. Just keep in mind that you can still use them if you want functionality that Mafia cannot easily duplicate. For example, there is a GM script that tries to calculate your total meat value that I still use. A Raid Manager is also a great one once you start doing Clan Dungeons.
# Completely ignore the Mafia Frame. Play like normal for a while (at least 20 turns), using the Relay Browser. It is practically identical to standard play. Try to play in a zone with some non-combat choice encounters.

NOTICING SOME OF THE COOL MAFIA STUFF:

While using the Relay Browser, you will start noticing some cool stuff that it does automatically to help you out. Here is a short list of stuff to note/try:

# If you encountered a non-combat adventure with choices, you have seen the first cool Mafia thing. It gives you a short description of what happens when you select that particular choice. For example, if you were in the Sleazy Back Alley and encounted the Hobo non-combat adventure, for the choice, 'Look Under the Hobo', Mafia modifies it and appends ' - get a Mad Train Wine' on the button for that choice. This is super cool and really lowers the Wikipedia usage or guesswork.
# When you fight a foe, it gives you a quick display about that monster's level, hit points, what it drops, meat drop rate, and so forth. This is really helpful information and is much easier than looking up stuff in the Wiki, or playing blind.
# There is a hidden counter that gives you a semi-rare encounter periodically. It is normally tracked by eating a fortune cookie or two, then logic-ing out what the magic number is. Then keeping track of how many turns are left until the encounter. If you have no idea what I am talking about, go to the KoL Wiki and look up 'semi-rare'.
#* With Mafia, when you eat a Fortune Cookie, it notes the 3 numbers given. It knows which numbers are out of bounds, based on your Ascention Path (Oxycore, Standard, BadMoon, etc) and can sometimes determine the Semi-Rare countdown number based on one cookie. In any case, all valid numbers are added to your buff entries as 'Fortune Cookie(XXX)' counters.
#* Eating a second cookie will get rid of ambiguity if there are multiple valid Fortune Cookie counters.
#* The counter counts down as you adventure. When it is gone and you try to adventure, it will stop you. It reminds you that the counter is up and what your last semi-rare was (so you don't try to do the same one again, which negates it).
#* After the semi-rare, two buffs appear which are a minimum and maximum cookie counter. This makes it a lot more likely that Mafia can figure out the right counter number with only one cookie.
# Your Last Adventure link now has a history which shows your last FIVE adventure locations. Any of them are clickable. This is very convenient, especially when you make short-term detours such as doing a semi-rare.
# If you use Action Bars (an interface choice in your KoL Account Preferences), you might notice a "Script" button at the top-left when in a fight. We will learn how to use this later in the tutorial to automatically perform a series of combat actions. If you use the standard text-based stuff in a fight, you will see additional hotkey-able clickable buttons along the top with certain actions. Normally to use a combat skill, you have to select your combat skill to use from a drop-down. Mafia knows what class you are, what skills you know and makes appropriate buttons for you to save time.
# You will notice that Mafia helps you out some with quests. For example, it auto-fills in answers to certain puzzles, remembers which Dungeon of Doom potions do what, and misc other stuff.
# You MIGHT even notice that Mafia does some stuff automatically whether you like it or not! For example, if you get beaten-up, Mafia might use an item to remove that condition automatically. This can be a source of irritation, but we will learn to handle it.

BOTTOM LINE: You can play KoL just like normal and get a lot of handy bonus information very easily.

Continue to [[KoLmafia Guide: Java Interface|Lesson 2: Java Interface]]

[[Category:KoLmafia Guide]]

Talk:KoLmafia Guide: Scripting for Dummies

2010-03-09T16:20:42Z

SinginSally: Created page with 'Woah. This needs to be broken up into 4 or 5 sections like the main guide. Could someone do that for me? :-) I have no idea exactly how you did it with the main portion of the…'

Woah. This needs to be broken up into 4 or 5 sections like the main guide. Could someone do that for me? :-) I have no idea exactly how you did it with the main portion of the guide.

KoLmafia Guide: Useful Commands

2010-03-09T16:19:24Z

SinginSally:

Most people will prefer the GUI for KoL playing. However, Mafia does have a handful of useful functions that you can type in.

These are the ones that I have found to be useful. Your mileage will vary, but read through these and try em out. A FULL LIST can be found in my Links section at the top of the guide.

1) You will need to be at the 'Graphical CLI' top-level tab.

2) At the bottom of the screen is a small textbox where you may enter commands.
----

* help [optional command] - Gives you a list of commands. OR how to use the given command if you type it 'help burn' for example.

* clear - Clears the screen and log entries entirely.

* inv [filter] - Shows you your inventory. The cool thing is that you can add a filter. So for a list of all your wads, you would type 'inv wad' and it will come back with Twinkly Wad, Hot Wad, or whatever wads you have. I generally use the item manager and sort by alphabetical order or type instead. But this works too. For example, you ask yourself 'did I get that pirate insult book doodad?'. You don't have to know the exact name. Just type Insult and let it do the work.

* modref - This gives you a huge list of pretty much ALL conceivable character stats such as Sleaze Damage, HP Max, Regen Rate, all resistances, and so forth. Furthermore the exact text of the first column works as a 'category' which you can then feed to the next few commands.

* maximize [category] - Equips your character using your inventory to the best of its ability in order to maximize the given category! Categories are found through the 'modref' command above. So if you wanted to maximize your Sleaze Resistance, you would type 'maximize Sleaze Resistance' and watch it go! It will give you a Score for the level of the maximized level. This is extremely useful for Clan Dungeons!

* modtrace [category] - Prints out a list of all sources that modify the desired category, either positively or negatively. So if you are wondering WHY you have a Meat Drop rate of say..140%, it will break it down for you!

* modifies [category] - Shows you ALL sources that modify the given category IN THE ENTIRE GAME. Whereas the previous commands just work with what inventory you have, this command lists everything, straight from the wiki. Sometimes this command is kind of flaky.

* wiki [filter] - This command shows you the wiki entry for whatever you typed in and pops it up in a new Tab. This is a really handy shortcut.

* Various Listers - These commands give you a list of quest or ascension-specific stuff you have identified.
** bang - Shows identified Dungeon of Doom potions. (clear, murky, etc)
** dusty - Lists identifies Dusty Wine bottles. (pinot noir, merlot, etc)
** insults - Lists all known pirate insults.
** demons - Lists names of demons known for summoning.

* pvplog - shows results of PvP combat. It actually generates a spreadsheet of all battles from your messagebox. To see it, you must go to the KoLMafia Directory under the Attacks subdirectory. It is very helpful though and even figures out all your enemies stats for you! (Like how many White Canadians they have drank, etc.) This is great if there is one guy that really hacks you off. This parsed log will help you gather info on them.

* undercut - Any items in your Mall store with the default price of 999999999 will be repriced to match the lowest mall price. Note that Mafia ONLY knows the 5th cheapest price of any item in the mall. Therefore it may not actually price the item exactly right.

* reprice - ALL items in your mall store are repriced to match the lowest known mall price. As mentioned above, mafia can only know the 5th cheapest price of an item. Remember, YOU can go to the mall and read off the lowest price. Mafia can't read and is only able to 'ask' KoL what the price is by whatever interface (API) that KoL allows.

* alias - Lets you create a shortcut command. Great for buffbots. For example, "alias buffode => csend 300 meat to buffBawt" would mean that you'd simply type buffode and it would then send meat to some random buffbut which you would know would cast Ode to Booze on you.

* csend - as shown in Alias above. Sends a kmail to the target with attached meat or items.

Continue to [[KoLmafia Guide: Closing Thoughts|Lesson 15: Closing Thoughts]]

[[Category:KoLmafia Guide]]

KoLmafia Guide

2010-03-09T16:03:01Z

SinginSally:

= Introduction =
{{GuideP|
Although a few KoLMafia guides exist already, they are either out-of-date, too brief, or too complex. They work, but are typically for more advanced players that catch the lingo and references. My guide is by a noob, to be on the level of noobs. It is (hopefully) easy to understand, pretty verbose, and up to date (at time of writing anyways in Jan 2010).
}}
{{GuideP|
This guide is for those players that are interested in using a great third-party tool to enrich their Kingdom of Loathing experience significantly. Mafia is a java program that acts as a go-between for you to the KoL server. It has its own frame that contains a lot of functionality. In addition, you will use a normal browser window to play like normal. Mafia helps you in many ways:
}}
{{GuideP|
* Mafia allows you to use a 'Relay Browser' which is practically identical to the normal playing environment. The only noticeable difference is that Mafia adds bonus information and reminders that are very helpful when playing. This is by far my favorite feature because you do not have to try to learn a brand new interface to use and learn Mafia.
}}
{{GuideP|
* Provides some alternative interfaces to do certain functions that you may or may not like better than the built-in interface. At the very least, you can easily say... look up a mall price on something in Mafia without having to redirect your browser to the mall and then back to your inventory or adventuring location.
}}
{{GuideP|
* Automation. KolMafia allows you to intelligently automate actions, from small scale to larger scale. As an example, you can easily set up a 'script' combat button that will then do exactly what you want it to do; Maybe a Disco Bandit always wants to Pickpocket if possible, followed up by a Disco Dance, then auto-attack the rest of the way. Or an owner of a certain familiar wants to extend each fight to maximize Meat/Mana/HP,etc gains. Instead of doing this manually for each fight, you click ONE button which does the entire sequence!
}}
{{GuideP|
* Reduction of lag. Mafia works as an interface directly to KoL. What this means is that when you automate actions, no browser refresh is needed. This is really helpful, as a 12 round auto-combat using the Script button can be done in about three browser refreshes.
}}
{{GuideP|
* Collating of information. KolMafia keeps track of all stat gains, meat found, items found, and an entire log of everything that has happened in the game. The info is logged automatically and effortlessly if you want it.
}}
{{GuideP|
* Ability to call player written scripts which do various stuff. For example, one of them will help you equip outfits to get new Tattoos. These require more trust, but I will show you how to examine scripts and see what they do.
}}
{{GuideP|
Remember... Automation is only ONE aspect of KolMafia! I generally avoid too much of something 'playing for me' myself, and it is entirely possible to use and love KolMafia with NO automation whatsoever! 

Unless you are outright opposed to the concept of KolMafia or Greasemonkey, I'd strongly urge you to read this guide and give it a try. By the end of the first Lesson, you will know enough to decide for yourself. ---Warning:--- There are some '''light spoilers''' in this guide for illustration purposes!
}}

= Table of Contents =
{{GuideP|
* [[KoLmafia Guide: How I Teach & Requirements|How I Teach & Requirements]]
* [[KoLmafia Guide: What About Greasemonkey|What About Greasemonkey? (another automation/scripting toolset)]]
* [[KoLmafia Guide: Getting Started & Links|Getting Started, Installing KolMafia, and Helpful Links]]
* [[KoLmafia Guide: Basics (Relay Browser)|Lesson 1: Basics (Relay Browser)]]
* [[KoLmafia Guide: Java Interface|Lesson 2: Java Interface]]
* [[KoLmafia Guide: Stats-Checking|Lesson 3: Stats-Checking]]
* [[KoLmafia Guide: Attack Script|Lesson 4: Attack Script]]
* [[KoLmafia Guide: Custom Combat Script|Lesson 5: Custom Combat Script]]
* [[KoLmafia Guide: Auto-Adventuring|Lesson 6: Auto-Adventuring]]
* [[KoLmafia Guide: Automatic HP/MP Recovery|Lesson 7: Automatic HP/MP Recovery]]
* [[KoLmafia Guide: Goal-Oriented Adventuring|Lesson 8: Goal-Oriented Adventuring]]
* [[KoLmafia Guide: Setting Preferences|Lesson 9: Setting Preferences]]
* [[KoLmafia Guide: Setting Up Breakfast|Lesson 10: Setting Up Breakfast]]
* [[KoLmafia Guide: Eating & Drinking|Lesson 11: Eating & Drinking]]
* [[KoLmafia Guide: PvP (Beating Up People)|Lesson 12: PvP (Beating Up People)]]
* [[KoLmafia Guide: Running ASH Scripts|Lesson 13: Running ASH Scripts]]
* [[KoLmafia Guide: Useful Commands|Lesson 14: Useful Commands]]
* [[KoLmafia Guide: Closing Thoughts|Lesson 15: Closing Thoughts]]
}}
= Scripting Guide =
{{GuideP|
As an addendum to the basic KolMafia end user guide above, I also created a guide that helps you learn how to create simple scripts. It is surprisingly easy to create these scripts and they can accomplish many repetitive tasks that you might do on a daily basis. For example, a farming setup script might pull out a familiar, equip a certain outfit, buff yourself up, ask a buffbot for buffs, drink some potions to increase itemfind, and increase the Monster Level dial to maximum, and finally setup a particular custom combat script. This makes it easy to do things without forgetting stuff! 
I would recommend that you at least browse through the scripting guide, see some of the neat stuff that you are capable of doing, then decide if it is worthwhile for you to dive into it yourself. I strongly suspect that at the very least, you can copy and paste some of my example scripts, change some of the buff/item/familiar names, and have your very own script!
}}
{{GuideP|
[[KoLmafia Guide: Scripting for Dummies|Post-Lesson 1: Scripting for Dummies]] 
}}

KoLmafia Guide

2010-03-09T16:00:59Z

SinginSally:

= Introduction =
{{GuideP|
Although a few KoLMafia guides exist already, they are either out-of-date, too brief, or too complex. They work, but are typically for more advanced players that catch the lingo and references. My guide is by a noob, to be on the level of noobs. It is (hopefully) easy to understand, pretty verbose, and up to date (at time of writing anyways in Jan 2010).
}}
{{GuideP|
This guide is for those players that are interested in using a great third-party tool to enrich their Kingdom of Loathing experience significantly. Mafia is a java program that acts as a go-between for you to the KoL server. It has its own frame that contains a lot of functionality. In addition, you will use a normal browser window to play like normal. Mafia helps you in many ways:
}}
{{GuideP|
* Mafia allows you to use a 'Relay Browser' which is practically identical to the normal playing environment. The only noticeable difference is that Mafia adds bonus information and reminders that are very helpful when playing. This is by far my favorite feature because you do not have to try to learn a brand new interface to use and learn Mafia.
}}
{{GuideP|
* Provides some alternative interfaces to do certain functions that you may or may not like better than the built-in interface. At the very least, you can easily say... look up a mall price on something in Mafia without having to redirect your browser to the mall and then back to your inventory or adventuring location.
}}
{{GuideP|
* Automation. KolMafia allows you to intelligently automate actions, from small scale to larger scale. As an example, you can easily set up a 'script' combat button that will then do exactly what you want it to do; Maybe a Disco Bandit always wants to Pickpocket if possible, followed up by a Disco Dance, then auto-attack the rest of the way. Or an owner of a certain familiar wants to extend each fight to maximize Meat/Mana/HP,etc gains. Instead of doing this manually for each fight, you click ONE button which does the entire sequence!
}}
{{GuideP|
* Reduction of lag. Mafia works as an interface directly to KoL. What this means is that when you automate actions, no browser refresh is needed. This is really helpful, as a 12 round auto-combat using the Script button can be done in about three browser refreshes.
}}
{{GuideP|
* Collating of information. KolMafia keeps track of all stat gains, meat found, items found, and an entire log of everything that has happened in the game. The info is logged automatically and effortlessly if you want it.
}}
{{GuideP|
* Ability to call player written scripts which do various stuff. For example, one of them will help you equip outfits to get new Tattoos. These require more trust, but I will show you how to examine scripts and see what they do.
}}
{{GuideP|
Remember... Automation is only ONE aspect of KolMafia! I generally avoid too much of something 'playing for me' myself, and it is entirely possible to use and love KolMafia with NO automation whatsoever! 

Unless you are outright opposed to the concept of KolMafia or Greasemonkey, I'd strongly urge you to read this guide and give it a try. By the end of the first Lesson, you will know enough to decide for yourself. ---Warning:--- There are some '''light spoilers''' in this guide for illustration purposes!
}}

= Table of Contents =
{{GuideP|
* [[KoLmafia Guide: How I Teach & Requirements|How I Teach & Requirements]]
* [[KoLmafia Guide: What About Greasemonkey|What About Greasemonkey?]]
* [[KoLmafia Guide: Getting Started & Links|Getting Started & Links]]
* [[KoLmafia Guide: Basics (Relay Browser)|Lesson 1: Basics (Relay Browser)]]
* [[KoLmafia Guide: Java Interface|Lesson 2: Java Interface]]
* [[KoLmafia Guide: Stats-Checking|Lesson 3: Stats-Checking]]
* [[KoLmafia Guide: Attack Script|Lesson 4: Attack Script]]
* [[KoLmafia Guide: Custom Combat Script|Lesson 5: Custom Combat Script]]
* [[KoLmafia Guide: Auto-Adventuring|Lesson 6: Auto-Adventuring]]
* [[KoLmafia Guide: Automatic HP/MP Recovery|Lesson 7: Automatic HP/MP Recovery]]
* [[KoLmafia Guide: Goal-Oriented Adventuring|Lesson 8: Goal-Oriented Adventuring]]
* [[KoLmafia Guide: Setting Preferences|Lesson 9: Setting Preferences]]
* [[KoLmafia Guide: Setting Up Breakfast|Lesson 10: Setting Up Breakfast]]
* [[KoLmafia Guide: Eating & Drinking|Lesson 11: Eating & Drinking]]
* [[KoLmafia Guide: PvP (Beating Up People)|Lesson 12: PvP (Beating Up People)]]
* [[KoLmafia Guide: Running ASH Scripts|Lesson 13: Running ASH Scripts]]
* [[KoLmafia Guide: Useful Commands|Lesson 14: Useful Commands]]
* [[KoLmafia Guide: Closing Thoughts|Lesson 15: Closing Thoughts]]
}}
= Scripting Guide =
{{GuideP|
As an addendum to the basic KolMafia end user guide above, I also created a guide that helps you learn how to create simple scripts. It is surprisingly easy to create these scripts and they can accomplish many repetitive tasks that you might do on a daily basis. For example, a farming setup script might pull out a familiar, equip a certain outfit, buff yourself up, ask a buffbot for buffs, drink some potions to increase itemfind, and increase the Monster Level dial to maximum, and finally setup a particular custom combat script. This makes it easy to do things without forgetting stuff! 
I would recommend that you at least browse through the scripting guide, see some of the neat stuff that you are capable of doing, then decide if it is worthwhile for you to dive into it yourself. I strongly suspect that at the very least, you can copy and paste some of my example scripts, change some of the buff/item/familiar names, and have your very own script!
}}
{{GuideP|
[[KoLmafia Guide: Scripting for Dummies|Post-Lesson 1: Scripting for Dummies]] 
}}