Kolmafia - User contributions [en]

Faxbot

2019-08-21T10:36:44Z

Pineapple of Despair: Bot name is a string, not a dedicated object. Confirmed by looking at the source code.

{{
#vardefine:name|faxbot}}{{
#vardefine:return_type|boolean}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
return_type={{#var:return_type}}|
parameter1={{Param|monster|m}}||
}}|

function2={{Function|
name={{#var:name}}|
return_type={{#var:return_type}}|

parameter1={{Param|monster|m}}||
parameter2={{Param|string|n}}||
p1desc={{Pspan|m}} is the monster of which to request a fax.|
p2desc={{Pspan|n}} is the name of the supported bot from to request a fax. If not specified, mafia will traverse its list of faxbots and pick the first one that is online and has your monster.|
}}|

function_description=Requests the specified monster from one of mafia's known faxbots (as of r19492 this is just EasyFax or CheeseFax).|

code1={{CodeSample|
title=Code Samples|
description=This will acquire a copy of a scary pirate if you're able to get a fax.|
code=
<syntaxhighlight>
if ((get_property("_photocopyUsed")=="false")&&(item_amount($item[photocopied monster])==0)) {
faxbot($monster[scary pirate]);
}
</syntaxhighlight>
}}|
see_also={{SeeAlso|can_faxbot|is_online}}|
special=The chat must be open for this function to successfully work, just as for other mafia fax interfaces.
}}

[[Category:Miscellaneous Functions]]

Use skill

2011-11-26T22:11:14Z

Pineapple of Despair: Added missing single-cast ashref declarations, fixed a pXdef typo.

{{
#vardefine:name|use_skill}}{{
#vardefine:return_type|boolean}}=Normal Use={{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|skill|to_use}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|casts}}|
parameter2={{Param|skill|to_use}}|
}}|

function3={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|skill|to_use}}|
parameter2={{Param|string|target}}|
}}|

function4={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|casts}}|
parameter2={{Param|skill|to_use}}|
parameter3={{Param|string|target}}|
p1desc={{Pspan|casts}} is the (optional) number of casts|
p2desc={{Pspan|to_use}} is the skill to use|
p3desc={{Pspan|target}} is the recipient (optional, for use with buffs only)|
}}|

function_description=Attempts to cast the skill {{pspan|to_use}} a number of times specified by {{pspan|casts}}, or once if not specified. Defaults to casting on yourself, but you can specify a {{pspan|target}} for buffs.|

code1={{CodeSample|
title=Code Sample|
description=This example will attempt to cast the specified skill as many times as it can with the MP the character has left.|
code=
<syntaxhighlight>
effect chosen = $effect[ Empathy ];
use_skill( my_mp() / mp_cost( to_skill(chosen) ) , to_skill(chosen) );
</syntaxhighlight>}}|

cli_equiv=The CLI command "cast" functions similarly to the normal version of this function (with similar parameters).|

}}=In-combat Consulting={{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=buffer|
return_also={{#var:return_also}}|
parameter1={{Param|skill|to_use}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=buffer|
return_also={{#var:return_also}}|
parameter1={{Param|int|casts}}|
parameter2={{Param|skill|to_use}}|
p1desc={{Pspan|casts}} is the (optional) number of casts|
p2desc={{Pspan|to_use}} is the skill to use|
}}|

function_description=Will loop the specified number of {{pspan|casts}} (default to 1 if omitted) using the specified skill {{pspan|to_use}}, never reconsulting the script until the loop is complete. One exception: this will not work with Lasagna Bandages, since it tries to cast the out-of-combat version of the skill. Using {{f|visit_url}} is required for casting Lasagna Bandages in combat.|

}}

[[Category:Skills and Effects]]|[[Category:In-combat Consulting]]

Item Management

2011-01-20T13:48:51Z

Pineapple of Despair: Acquiring worthless items no longer requires adventuring

{{TOCright}}
==Informational==
{{Flink|int|my_meat|desc=Returns the amount of meat you have on hand.}}
{{Flink|int|my_closet_meat|desc=Returns the amount of meat you have in your Colossal Closet.}}
{{Flink|int|pulls_remaining|desc=Returns the number of pulls you can make from storage, or 0 if not applicable.}}
{{Flink|boolean|have_chef|desc=Returns true if you have a chef-boxen at your campground.}}
{{Flink|boolean|have_bartender|desc=Returns true if you have a bartender-boxen at your campground.}}
{{Flink|int [item]|get_campground|desc=Returns a map of your campground items.}}
{{Flink|item|get_dwelling|desc=Returns the item corresponding with your dwelling.}}
{{Flink|boolean|have_mushroom_plot|desc=Returns true if and only if you've purchased a mushroom plot this run.}}
{{Flink|int|stills_available|desc=Returns the number of Nash Crosby's Still uses left for the day (0 if not accessible).}}
{{Flink|string|item_type|item|desc=Returns the type of item specified.}}
{{Flink|int|item_amount|item}}
{{Flink|int|closet_amount|item}}
{{Flink|int|display_amount|item}}
{{Flink|int|equipped_amount|item}}
{{Flink|int|shop_amount|item}}
{{Flink|int|stash_amount|item|}}
{{Flink|int|storage_amount|item|desc=These 7 functions return the total number available of a given item in the respective section of your inventory.}}
{{Flink|int|available_amount|item|desc=Returns the total number available of a given item in all inventory sections accessible to your character based on current restrictions.}}
{{Flink|int|creatable_amount|item|desc=Returns the amount of the item that you are capable of creating given your current inventory and skills.}}
{{Flink|int [item]|get_ingredients|item|desc=Returns a map where each key is one of the required ingredients, with the integer value the number required. If you don't have the skills needed to make the item, it will return an empty map.}}
{{Flink|int [item]|get_inventory|desc=Returns a map where each key is an item in your inventory, with the integer value its quantity.}}
{{Flink|int [item]|get_related|item|string|desc=Returns associated items in a zap or fold group (see page for details).}}
[[File:Item category.png|frame|You can categorize items in KoL using [[is tradeable|is_tradeable()]], [[is giftable|is_giftable()]], and [[is displayable|is_displayable()]].]]
{{Flink|boolean|is_tradeable|item|desc=Returns whether the item can be placed in the mall.}}
{{Flink|boolean|is_giftable|item|desc=Returns whether the item can be traded in a gift package.}}
{{Flink|boolean|is_displayable|item|desc=Returns whether the item can be put in a display case (true for all but quest items).}}
{{Flink|boolean|have_shop|desc=Returns whether you have a mall store.}}
{{Flink|boolean|have_display|desc=Returns whether you have a display case.}}
{{Flink|boolean|is_npc_item|item|desc=Returns whether the item can be bought from an NPC store.}}
{{Flink|void|refresh_stash|desc=Takes a new look at the contents of your clan stash, as that section of inventory cannot be internally tracked due to access by others.}}
{{Flink|int|mall_price|item|desc=Returns the current (lowest) mall price of the given item.}}
{{Flink|int|historical_price|item|desc=Returns the most recently checked price for an item. This will never hit the server, unlike mall_price().}}
{{Flink|float|historical_age|item|desc=Returns the age of the most recently checked price for an item in days. This allows you to decide if you want to use historical_price() or mall_price().}}
{{Flink|int|autosell_price|item|desc=Returns the autosell price of the item (0 for items that cannot be autosold).}}
{{Flink|int|get_power|item|desc=Returns the power of the item (0 for items that don't have a power).}}
{{Flink|string|to_plural|item|desc=Returns the plural of an item as a string.}}
{{Flink|int|meat_drop|{{opt|monster}}|desc=Returns a certain monster's base meat drop.}}
{{Flink|int [item]|item_drops|{{opt|monster}}|desc=Returns an array of a certain monster's base item drops, keying item to drop rate. Has certain limitations detailed on individual page.}}
{{Flink|record [int]|item_drops_array|{{opt|monster}}|desc=Returns an array of records holding information regarding a certain monster's base item drops.}}

==Moving Items Around==
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|take_closet|int|{{opt|item}}}}
{{Flink|boolean|take_display|int|item}}
{{Flink|boolean|take_stash|int|item}}
{{Flink|boolean|take_storage|int|item|desc=Attempts to take or put the specified item in the appropriate section of your inventory, and returns its success. If the item parameter is omitted from put_closet() or take_closet(), meat is transferred instead of an item.}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item|desc=Puts items in your store (see page for details).}}

==Acquiring & Using Items==
{{Flink|boolean|retrieve_item|int|item|desc=Uses KoLmafia internal logic to gather items (see page for details).}}
{{Flink|boolean|hermit|int|item|desc=Trades worthless items (buying and using chewing gum if needed) to the hermit for specified items (see page for details).}}
{{Flink|boolean|use|int|item|desc=Attempts to use items as specified and reports success.}}
{{Flink|boolean|eatsilent|int|item}}
{{Flink|boolean|eat|int|item|desc=Attempts to eat items as specified and reports success.}}
{{Flink|boolean|overdrink|int|item}}
{{Flink|boolean|drink|int|item|desc=Attempts to drink items as specified and reports success.}}
{{Flink|boolean|create|int|item|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}
{{Flink|boolean|buy|int|item}}
{{Flink|int|buy|int|item|int|desc=Tries to purchase the specified items (see page for details).}}
{{Flink|boolean|autosell|int|item|desc=Attempts to autosell the given items and reports success.}}
{{Flink|int|craft|string|int|item|item|desc=Raw crafting that obeys KoLmafia settings (see page for details).}}
[[Category:Scripting]]

KoLmafia Guide: Useful Commands

2011-01-20T13:01:50Z

Pineapple of Despair: Mention -tie

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! Note that it's recommended to follow the category name with -tie, as in "maximize items -tie" - this prevents Mafia from randomly swapping bits of equipment which do not actually affect the relevant stat.

* 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]][[Category:New User Help]]

Talk:KoLmafia Guide: Eating & Drinking

2011-01-20T08:19:02Z

Pineapple of Despair: Created page with ''''The in-a-box crafting section''' needs a bit of an overhaul, given the current division into normal and fancy consumables. Not sure how explain this in a noob-friendly way, th…'

'''The in-a-box crafting section''' needs a bit of an overhaul, given the current division into normal and fancy consumables. Not sure how explain this in a noob-friendly way, though.

KoLmafia Guide: Eating & Drinking

2011-01-19T16:32:52Z

Pineapple of Despair: NPC-store drinks have got price instead of possible number

This lesson covers managing and creating food, drink, and spleen-damaging items with Mafia. Eating and drinking in KoL's native interface sucks. As a new player you have no clue what most of the items do, and their description is only somewhat helpful 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 etc.; in case of drinks you can buy from NPC stores the possible number is replaced with their cost in meat. 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]][[Category:New User Help]]

KoLmafia Guide: Setting Up Breakfast

2011-01-19T16:19:07Z

Pineapple of Despair: Updated the "hermit clover" point for the current sewer behaviour.

'Breakfast' is the Mafia functionality of completing repetitive actions that you generally would want to always do at your first logon of the day. 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 all clovers the Hermit has got available and you can afford, , then uses them to make them Disassembled Clovers. Note that it '''will''' spend your meat fishing around in the sewer for Worthless trinkets as well as buying permits (if necessary), so you might want to keep this off for the first day or two of your run, when meat is scarce. Otherwise, this takes care of e.g. you forgetting to check for clovers the following days when they are available.
# 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]][[Category:New User Help]]

KoLmafia Guide: Setting Preferences

2011-01-19T16:06:30Z

Pineapple of Despair: Explained how to mark items as mementos

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 its duration will be '''underlined''' on your relay browser. One click will have Mafia auto-remove it.
# "Allow equipment changing when casting buffs" means Mafia will automatically attempt to minimise MP cost of casting, by equipping both weapons extending the number of adventures per cast and items directly lowering the number of MP consumed per cast. Just leave it on.
# Cast Buffs not Defined in Moods - If checked, this allows Mafia to re-cast any of the currently-active buffs when it is set to use up excess MP under 'mana burning', rather than just those defined in your mood scripts. 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? This keeps you from pulverizing or autoselling items you have marked as mementos by right-clicking on them and choosing "Add to memento list".
# 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]][[Category:New User Help]]

KoLmafia Guide: Setting Preferences

2011-01-19T16:03:55Z

Pineapple of Despair: Explained "cast buffs not defined in moods"

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 its duration will be '''underlined''' on your relay browser. One click will have Mafia auto-remove it.
# "Allow equipment changing when casting buffs" means Mafia will automatically attempt to minimise MP cost of casting, by equipping both weapons extending the number of adventures per cast and items directly lowering the number of MP consumed per cast. Just leave it on.
# Cast Buffs not Defined in Moods - If checked, this allows Mafia to re-cast any of the currently-active buffs when it is set to use up excess MP under 'mana burning', rather than just those defined in your mood scripts. 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]][[Category:New User Help]]

KoLmafia Guide: Setting Preferences

2011-01-19T16:01:27Z

Pineapple of Despair: Explained "allow equipment changing when casting buffs"

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 its duration will be '''underlined''' on your relay browser. One click will have Mafia auto-remove it.
# "Allow equipment changing when casting buffs" means Mafia will automatically attempt to minimise MP cost of casting, by equipping both weapons extending the number of adventures per cast and items directly lowering the number of MP consumed per cast. Just leave it on.
# 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]][[Category:New User Help]]

KoLmafia Guide: Goal-Oriented Adventuring

2011-01-19T15:45:44Z

Pineapple of Despair:

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.
# Set up your combat options. In action, set your method of killing the monster even if it is just "attack". In the special box under that, click for a list of options. If you have Transcendent Olfaction it is very useful to chose auto-olfaction there to automatically cast olfaction upon any monster that drops your goal.
# 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 Menagerie 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]][[Category:New User Help]]

Talk:KoLmafia Guide: Automatic HP/MP Recovery

2011-01-19T15:42:20Z

Pineapple of Despair: Created page with ''''Stop Automation''' can also stop auto-adventuring when your character's health has dropped below a certain level. It would be worth mentioning this in the guide, as it beats h…'

'''Stop Automation''' can also stop auto-adventuring when your character's health has dropped below a certain level. It would be worth mentioning this in the guide, as it beats having to get rid of Beaten Up... Haven't added it myself because it's a bit of a personal preference to what value to choose, especially given that it tends to change as the character grows more powerful. --[[User:Pineapple of Despair|Pineapple of Despair]] 15:42, 19 January 2011 (UTC)

KoLmafia Guide: Custom Combat Script

2011-01-19T15:31:34Z

Pineapple of Despair:

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 or location, 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 or at a default location. In advanced scripts you can put in a [monster/location name] with special actions taken against just that monster or while fighting at just that location (Mafia automatically determines which of the two this is). 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]]