https://wiki.kolmafia.us/api.php?action=feedcontributions&feedformat=atom&user=HippoKingKolmafia - User contributions [en]2026-04-30T13:35:23ZUser contributionsMediaWiki 1.44.0https://wiki.kolmafia.us/index.php?title=Numeric_modifier&diff=9251Numeric modifier2025-03-16T00:45:17Z<p>HippoKing: mention string options, modifier type</p>
<hr />
<div>{{<br />
#vardefine:name|numeric_modifier}}{{<br />
#vardefine:return_type|float}}{{<br />
<br />
FunctionPage|<br />
name={{#var:name}}|<br />
<br />
function1={{Function|<br />
name={{#var:name}}|<br />
aggregate={{#var:aggregate}}|<br />
return_type={{#var:return_type}}|<br />
return_also={{#var:return_also}}|<br />
parameter1={{Param|string|modifier_name}}|<br />
}}|<br />
<br />
function2={{Function|<br />
name={{#var:name}}|<br />
aggregate={{#var:aggregate}}|<br />
return_type={{#var:return_type}}|<br />
return_also={{#var:return_also}}|<br />
parameter1={{Param|string|check_me}}|<br />
parameter2={{Param|string|modifier_name}}|<br />
}}|<br />
<br />
function3={{Function|<br />
name={{#var:name}}|<br />
aggregate={{#var:aggregate}}|<br />
return_type={{#var:return_type}}|<br />
return_also={{#var:return_also}}|<br />
parameter1={{Param|item|check_me}}|<br />
parameter2={{Param|string|modifier_name}}|<br />
}}|<br />
<br />
function4={{Function|<br />
name={{#var:name}}|<br />
aggregate={{#var:aggregate}}|<br />
return_type={{#var:return_type}}|<br />
return_also={{#var:return_also}}|<br />
parameter1={{Param|effect|check_me}}|<br />
parameter2={{Param|string|modifier_name}}|<br />
}}|<br />
<br />
function5={{Function|<br />
name={{#var:name}}|<br />
aggregate={{#var:aggregate}}|<br />
return_type={{#var:return_type}}|<br />
return_also={{#var:return_also}}|<br />
parameter1={{Param|skill|check_me}}|<br />
parameter2={{Param|string|modifier_name}}|<br />
p1desc={{Pspan|check_me}} is the string, item, effect or skill to check|<br />
p2desc={{Pspan|modifier_name}} is the <b>[[modifiers|modifier]]</b> to check. This also can (and should) be a <syntaxhighlight enclose="none">$modifier[]</syntaxhighlight> [[Data Types#Modifier|special type]], which will give you errors for a bad modifier rather than just returning zero.|<br />
}}|<br />
<br />
function_description=Returns your current modifier total for {{pspan|modifier_name}}, or the amount of modification from {{pspan|check_me}} if specified. If a string is specified for {{pspan|check_me}}, other options are available such as <syntaxhighlight enclose="none">"Outfit:name"</syntaxhighlight> or the <syntaxhighlight enclose="none">"Generate:_spec"</syntaxhighlight> from [[maximize]].</p><br />
===Special Syntax for Familiars===<br />
{{Function|<br />
name={{#var:name}}|<br />
aggregate={{#var:aggregate}}|<br />
return_type={{#var:return_type}}|<br />
return_also={{#var:return_also}}|<br />
parameter1={{Param|familiar|buddy}}|<br />
parameter2={{Param|string|check_me}}|<br />
parameter3={{Param|int|weight}}|<br />
parameter4={{Param|item|equipment}}|<br />
p1desc={{Pspan|buddy}} is the familiar to check|<br />
p2desc={{Pspan|check_me}} is the modifier to check|<br />
p3desc={{Pspan|weight}} is the familiar's weight (buffed, not including equipment)|<br />
p4desc={{Pspan|equipment}} is the familiar's equipment|<br />
}}<br />
<p>Returns the familiar's effect on this modifier (for instance, a baby gravy fairy would return some positive float for "Item Drop").|<br />
<br />
code1={{CodeSample|<br />
title=Code Sample|<br />
description=Prints your current Initiative:|<br />
code=<br />
<syntaxhighlight><br />
float init = numeric_modifier( "initiative" );<br />
print(init);<br />
</syntaxhighlight>}}<br />
{{CodeSample|<br />
description=Prints the sleaze damage bonus of the Frat Warrior Fatigues outfit (using the modifier type):|<br />
code=<br />
<syntaxhighlight><br />
float sleaze_damage = numeric_modifier("Outfit:Frat Warrior Fatigues", $modifier[sleaze damage] );<br />
print(sleaze_damage);<br />
</syntaxhighlight>}}<br />
{{CodeSample|<br />
description=Function that checks if a single effect from a given list will buff your muscle over an amount goal. The name of the first effect to satisfy the goal is printed, or you are warned if none is found.|<br />
code=<br />
<syntaxhighlight><br />
boolean buffMuscleTo( int goal ) {<br />
int current_muscle = my_buffedstat( $stat[Muscle] ) ;<br />
int base_muscle = my_basestat( $stat[Muscle] ) ;<br />
int muscle_increase ;<br />
if ( current_muscle >= goal ) return true ;<br />
<br />
foreach it in $effects[Tomato Power, Phorcefullness, Gr8tness, Incredibly Hulking] {<br />
if ( have_effect(it) > 0 ) continue ;<br />
muscle_increase = floor( base_muscle * numeric_modifier( it, "Muscle Percent" ) / 100 );<br />
if ( current_muscle + muscle_increase >= goal ) {<br />
print(it + " will bring your muscle over " + goal);<br />
return true;<br />
}<br />
}<br />
print("No effect found");<br />
return false;<br />
}<br />
</syntaxhighlight>}}|<br />
<br />
code2={{CodeSample|<br />
title=Potion/effect-giving items|<br />
description=To get a modifier from a consumable which gives an effect, it is first necessary to convert the item into its given effect with [[effect_modifier]]. <br> This snippet calculates what your meat drop bonus would be after eating a {{kolwiki|sweet roll alabama}}:|<br />
code=<syntaxhighlight><br />
float meat_boost = numeric_modifier( "meat drop" );<br />
effect effect_from_item = effect_modifier( $item[Sweet roll Alabama] , "effect" );<br />
<br />
meat_boost += numeric_modifier( effect_from_item , "meat drop" );<br />
</syntaxhighlight>}}|<br />
<br />
cli_equiv=The CLI command "modtrace" gives access to the same information when the correct parameters are specified.|<br />
<br />
<br />
more_info= For a full list of modifiers, see [[modifiers]].<br><br />
For more information about numeric_modifier(), see the following thread: [http://kolmafia.us/showthread.php?802 List].|<br />
}}<br />
<br />
{{SeeAlso|boolean_modifier|effect_modifier|string_modifier}}<br />
<br />
[[Category:Modifier Functions]]</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=Data_Types&diff=9250Data Types2025-03-16T00:39:41Z<p>HippoKing: /* Special Datatypes */ add modifier type</p>
<hr />
<div>{{TOCright}}<br />
==Primitive Datatypes==<br />
<br />
===void===<br />
Can be thought of better as the absence of a datatype. No value can be assigned to '''void''' nor can a value be returned from a function of datatype '''void'''.<br />
<br />
===boolean===<br />
A boolean value is either '''true''' or '''false'''. By default, a boolean variable is set to false.<br />
<br />
===int===<br />
<br />
A whole number (short for "integer"), either positive or negative (or 0). The int used by KoLmafia is a 64-bit signed int, meaning it has a maximum value of 9,223,372,036,854,775,807 and a minimum value of -9,223,372,036,854,775,808. The default value of a integer variable is 0.<br />
<br />
Be careful when doing math with integers! As with some other strongly-typed languages, numbers are converted to integers at every step of the operation when only integer types are used. For example:<br />
{{<br />
CodeSample|<br />
code=<br />
<syntaxhighlight><br />
int a = 1;<br />
int b = 2;<br />
print( a / b * 2 );<br />
</syntaxhighlight>}}<br />
Will give the output "0," not "1" as you may expect. Changing either variable to a float type will "correct" this.<br />
<br />
===float===<br />
<br />
The float data type is a double-precision 64-bit IEEE 754 floating point. Its range of values is beyond the scope of this discussion, but is specified in [hhttps://docs.oracle.com/javase/specs/jls/se17/html/jls-4.html#jls-4.2.3 section 4.2.3 of the Java Language Specification], and a tool to help understand / quickly see how/where imprecisions happen can be found [https://www.h-schmidt.net/FloatConverter/IEEE754.html here].<br />
<br />
When assigning to a variable of type float, one should be careful to always enter numbers in decimal form, as unwanted behavior can result from supplying a value that KoLmafia may interpret as an int type without the decimal point.<br />
<br />
Note that float is not infinitely precise; it intrinsically rounds off after a certain point. This loss of accuracy is for the sake of storage, but beware of the possibility of small errors compounding from multiple float types.<br />
{{<br />
CodeSample|<br />
description=For instance, try the following code as an example of how rather long post-decimal portions are handled:|<br />
code=<br />
<syntaxhighlight><br />
float f;<br />
f = 4.9999999;<br />
print( f );<br />
</syntaxhighlight>}}<br />
The default value of a <code>float</code> variable is 0.0.<br />
<br />
===string===<br />
<br />
A group of characters including, but not limited to: lowercase letters, uppercase characters, numbers, and various control characters. When assigning a value to a string, enclose the desired value in either single quotes (<code>'</code>), double quotes (<code>"</code>) or backticks (<code>`</code>) (note you must use the same quote type on both ends of the string assignment). If you need to include the same character inside of the string itself, you will need to escape it first with a backslash.<br />
<br />
{{<br />
CodeSample<br />
|description=For example:<br />
|code=<syntaxhighlight>string s = "This is my \"friend\" Pete.";</syntaxhighlight><br />
|moreinfo=Will result in the following being stored to s:<pre>This is my "friend" Pete</pre><br />
}}<br />
<br />
The default value of a string is an empty string, or literally <code>""</code><br />
<br />
When using backticks, you can concatenate expressions into your string using curly braces.<br />
<br />
{{<br />
CodeSample<br />
|description=For example:<br />
|code=<syntaxhighlight>string s = `Hello {my_name()}, you have {$item[lime].item_amount()} lime(s)!`;</syntaxhighlight><br />
}}<br />
<br />
===buffer===<br />
<br />
Similar to a string, but more efficient in certain operations, including concatenation and passing as function arguments. For the most part, you can interchange references to strings and buffers. However, you should test all such actions first, as a few functions require a specific datatype to be supplied as a parameter. (Most notably, those listed under [[String Handling Routines#Regular Expressions|Regular Expressions]].)<br />
<br />
==Special Datatypes==<br />
<br />
Several datatypes are included in KoLmafia to represent common categories within the KoL universe.<br />
<br />
Note that while variables of these types are declared in the same way as for Primitive Datatypes; assigning and referencing them is done differently.<br />
{{CodeSample|<br />
description=For example, to declare an item datatype and assign it a value, you would use the following line of code:|<br />
code=<br />
<syntaxhighlight><br />
item it = $item[ broken skull ];<br />
</syntaxhighlight>}}<br />
The default values of any variable of one of the following types is <code>$''type''[ none ]</code>. For example, the default value of a <code>item</code> variable is <code>$item[ none ]</code>.<br />
<br />
===bounty===<br />
<br />
([[Bounty#Related Functions|Related Functions]]) ([[Bounty#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
These are the non-items that the bounty hunter asks you to retrieve from monsters around the kingdom. There are quite a lot of them (42 in total) so I won't list them all here. You can find more about bounties at the {{kolwiki|The Bounty Hunter Hunter's Shack}}.<br />
<br />
===class===<br />
<br />
([[Class#Related Functions|Related Functions]]) ([[Class#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
Besides $class[ none ], there are six possible values for this datatype:<br />
<br />
* Seal Clubber<br />
* Turtle Tamer<br />
* Pastamancer<br />
* Sauceror<br />
* Disco Bandit<br />
* Accordion Thief<br />
<br />
===coinmaster===<br />
<br />
([[Coinmaster#Related Functions|Related Functions]]) ([[Coinmaster#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
All shops that deal with currency other than meat. Known values include:<br />
<br />
* {{kolwiki|The Bounty Hunter Hunter's Shack|Bounty Hunter Hunter}}<br />
* {{kolwiki|Mr. Store}}<br />
* {{kolwiki|Hermit}}<br />
* {{kolwiki|The Shore, Inc. Gift Shop}}<br />
* {{kolwiki|The Trapper's Cabin|The Trapper}}<br />
* {{kolwiki|A Vending Machine|Vending Machine}}<br />
* {{kolwiki|The Swagger Shop}}<br />
* {{kolwiki|The Hippy Camp (Wartime)|Dimemaster}}<br />
* {{kolwiki|The Orcish Frat House|Quartersmaster}}<br />
* {{kolwiki|BURT|Bugbear Token}}<br />
* {{kolwiki|Freshwater Fishbonery}}<br />
* {{kolwiki|Big Brother}}<br />
* {{kolwiki|The Terrified Eagle Inn}}<br />
* {{kolwiki|Ticket Redemption Counter|Arcade Ticket Counter}}<br />
* {{kolwiki|Cashier|Game Shoppe}}<br />
* {{kolwiki|Cashier|Game Shoppe Snacks}}<br />
* {{kolwiki|The Isotope Smithery|Isotope Smithery}}<br />
* {{kolwiki|Dollhawker's Emporium}}<br />
* {{kolwiki|The Lunar Lunch-o-Mat|Lunar Lunch-o-Mat}}<br />
* {{kolwiki|Paul's Boutique}}<br />
* {{kolwiki|The Frozen Brogurt Stand}}<br />
* {{kolwiki|Buff Jimmy's Souvenir Shop}}<br />
* {{kolwiki|Taco Dan's Taco Stand}}<br />
* {{kolwiki|You're the Fudge Wizard Now, Dog|Fudge Wand}}<br />
* {{kolwiki|The Neandermall}}<br />
* {{kolwiki|Legitimate Shoe Repair, Inc.}}<br />
* {{kolwiki|warbear black box|Warbear Black Box}}<br />
* {{kolwiki|The Dinsey Company Store}}<br />
* {{kolwiki|Internet Meme Shop}}<br />
<br />
===effect===<br />
<br />
([[Effect#Related Functions|Related Functions]]) ([[Effect#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
Any effect you can be under in KoL, whether from items, skills, or what-have-you, is valid for this datatype.<br />
<br />
The full range, besides $effect[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Effects}} page for more information.<br />
<br />
===element===<br />
<br />
([[Element#Related Functions|Related Functions]]) ([[Element#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
Besides $element[ none ], there are seven possible values for this datatype. (Note that "Bad Spelling" is not considered a true element.)<br />
Also note that these names are case-sensitive (referencing $element[ Spooky ] will generate an error).<br />
<br />
* cold<br />
* hot<br />
* sleaze<br />
* spooky<br />
* stench<br />
* slime<br />
* supercold<br />
<br />
===familiar===<br />
<br />
([[Familiar#Related Functions|Related Functions]]) ([[Familiar#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
Any familiar available in KoL is valid for this datatype.<br />
<br />
The full range, besides $familiar[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Familiars}} page for more information.<br />
<br />
===item===<br />
<br />
([[Item#Related Functions|Related Functions]]) ([[Item#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
Any item in all of KoL is valid for this datatype. Note that unlike most special datatypes, item references can make use of the item ID number.<br />
{{CodeSample|<br />
description=For example, you could assign the item plexiglass pants as follows:|<br />
code=<br />
<syntaxhighlight><br />
item it = $item[ 1234 ];<br />
</syntaxhighlight>}}<br />
The full range, besides $item[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Items}} page for more information.<br />
<br />
===location===<br />
<br />
([[Location#Related Functions|Related Functions]]) ([[Location#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
Any location one can adventure at in KoL is valid for this datatype.<br />
<br />
The full range, besides $location[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Locations}} page for more information.<br />
<br />
===modifier===<br />
<br />
([[Modifier#Related Functions|Related Functions]]) ([[Modifier#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
Modifiers control properties of your character and your skills, items etc. For example you want to know your item drop bonus, that's <syntaxhighlight enclose="none">$modifier[item drop]</syntaxhighlight>.<br />
<br />
The full range, besides <syntaxhighlight enclose="none">$modifier[ none ]</syntaxhighlight>, is too much to list and keep up with here: please see the [[modifiers]] page for more information.<br />
<br />
===monster===<br />
<br />
([[Monster#Related Functions|Related Functions]]) ([[Monster#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
Any monster you can encounter in KoL is valid for this datatype.<br />
<br />
The full range, besides $monster[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Monster Compendium}} page for more information.<br />
<br />
===path===<br />
<br />
([[Path#Related Functions|Related Functions]]) ([[Path#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
Any ascension path you can choose in Valhalla is valid for this datatype. This includes all {{kolwiki|special challenge paths}}, as well as Standard and the dietary restriction paths (Boozetafarian, Teetotaler, Oxygenarian). The "Unrestricted" path and aftercore are represented as $path[ none ].<br />
<br />
The full range, besides $path[ none ], is too much to list and keep up with here. See {{kolwiki|Ascension#Paths}} for more information.<br />
<br />
===phylum===<br />
<br />
([[Phylum#Related Functions|Related Functions]]) ([[Phylum#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
Each monster has a {{kolwiki|Phylum}}. Besides $phylum[none], the possible values for this datatype are:<br />
<br />
* beast<br />
* bug<br />
* constellation<br />
* construct<br />
* demon<br />
* dude<br />
* elemental<br />
* elf<br />
* fish<br />
* goblin<br />
* hippy<br />
* hobo<br />
* humanoid<br />
* horror<br />
* mer-kin<br />
* orc<br />
* penguin<br />
* pirate<br />
* plant<br />
* slime<br />
* undead<br />
* weird<br />
<br />
===servant===<br />
<br />
([[Servant#Related Functions|Related Functions]]) ([[Servant#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
Servants are unique to the {{kolwiki|Actually Ed the Undying}} path and located {{kolwiki|The Servants' Quarters}}, replacing familiars.<br />
<br />
* Assassin<br />
* Belly-Dancer<br />
* Bodyguard<br />
* Cat<br />
* Maid<br />
* Priest<br />
* Scribe<br />
<br />
===skill===<br />
<br />
([[Skill#Related Functions|Related Functions]]) ([[Skill#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
Any skill you can have in KoL, whether permable or not, granted by items, ''etc''., is valid for this datatype.<br />
<br />
The full range, besides $skill[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Skills}} page for more information.<br />
<br />
===slot===<br />
<br />
([[Slot#Related Functions|Related Functions]]) (slot has no proxy record fields)<br />
<br />
Besides $slot[ none ], there are 16 possible values for this datatype.<br />
<br />
* hat<br />
* back<br />
* weapon<br />
* off-hand<br />
* shirt<br />
* pants<br />
* acc1<br />
* acc2<br />
* acc3<br />
* familiar<br />
* sticker1<br />
* sticker2<br />
* sticker3<br />
* fakehand<br />
* bootspur<br />
* bootskin<br />
<br />
===stat===<br />
<br />
([[Stat#Related Functions|Related Functions]]) (stat has no proxy record fields)<br />
<br />
Besides $stat[ none ], there are six possible values for this datatype (the last three are for referencing sub-stats).<br />
<br />
* muscle<br />
* mysticality<br />
* moxie<br />
* submuscle<br />
* submysticality<br />
* submoxie<br />
<br />
===thrall===<br />
<br />
([[Thrall#Related Functions|Related Functions]]) ([[Thrall#Proxy Record Fields|Proxy Record Fields]])<br />
<br />
Pastamancers have the ability to summon {{kolwiki|Pasta Thralls}}. <br />
<br />
* Angel Hair Wisp<br />
* Elbow Macaroni<br />
* Lasagmbie<br />
* Penne Dreadful<br />
* Spaghetti Elemental<br />
* Spice Ghost<br />
* Vampieroghi<br />
* Vermincelli<br />
<br />
==aggregate==<br />
<br />
An aggregate is a complex datatype composed of two or more primitive or special datatypes. For more information, see [[Data Structures]].<br />
<br />
==record==<br />
<br />
Records are user-defined datatypes that hold as many sub-datatypes as desired. For more information, see the page for [[Data Structures]].<br />
<br />
==Plural Typed Constants==<br />
<br />
(see http://kolmafia.us/showthread.php?p=15592, from which this section is reproduced)<br />
<br />
Plural typed constants allow you to easily do something with a list of specified objects, without having to replicate code or laboriously build up an array of the objects so that you can iterate over it. Here's a quick example:<br />
{{CodeSample|code=<syntaxhighlight><br />
foreach weapon in $items[star sword, star staff, star crossbow] {<br />
if (available_amount(weapon) > 0) {<br />
equip(weapon);<br />
break;<br />
}<br />
}</syntaxhighlight>}}<br />
The syntax is basically the same as the existing typed constant feature, but with an "s" or "es" after the type name. (The "es" case is there so that you can properly pluralize "class".) The text between the square brackets is interpreted as a comma-separated list of elements, each of which is converted to the specified type as if it were an individual constant. More details:<br />
* The list can span multiple lines.<br />
* Whitespace before or after elements is ignored.<br />
* Completely empty elements are ignored (so that you can leave a comma at the end of the list).<br />
* You can include a comma or closing square bracket in an element by writing it as "\," or "\]".<br />
* All the other escape sequences allowed in strings are possible, such as "\n" (newline), "\t" (tab), and "\uXXXX" (Unicode character value). To put an actual backslash in an element, you have to write it as "\\".<br />
<br />
The value generated by a plural constant is of type boolean[type], with the keys being the specified elements, and the boolean value always being true - although you won't normally do anything with the boolean, you'd use a foreach loop to iterate over the keys. You can assign a plural constant to a variable declared as that type, but note that the value differs from a normal map in three important respects:<br />
* Since the expression that generates it is syntactically a constant, the value has to be immutable. If you were allowed to change it in any way, those changes would appear in every future use of the same constant.<br />
* There can be multiple instances of the same key - $ints[1,1,2,3,5,8] is perfectly valid, and will result in the value 1 appearing twice in a foreach loop.<br />
* The keys will appear in the order you wrote them, rather than being sorted alphanumerically as maps usually do.<br />
<br />
In addition to being used in a foreach loop, plural constants also efficiently support membership testing via the 'contains' operator. Here's another example:<br />
{{CodeSample|code=<syntaxhighlight><br />
for hour from 1 to 12 {<br />
print("It's " + hour + " o'clock.");<br />
if ($ints[10, 2, 4] contains hour) {<br />
print("Time to drink a Dr Pepper!");<br />
}<br />
}</syntaxhighlight>}}<br />
(Yes, that example could just as easily have been done with a switch statement.)<br />
<br />
Iterating over an empty list is rather pointless, so plural constants with no elements are given a different meaning: they represent every value of the specified type, where this is practical. (The 'none' value, if defined for a given type, is omitted.) The biggest benefit here is $items[], which lets you loop over every defined item, more efficiently than you could otherwise write in a script (since the list is generated once per session and then cached), and without having to hard-code a maximum item ID number in your script. Example:<br />
{{CodeSample|code=<syntaxhighlight><br />
foreach it in $items[] {<br />
if (autosell_price(it) == 42) print(it);<br />
}</syntaxhighlight>}}<br />
Enumeration of all possible values works with the following types:<br />
* $booleans[] - false and true.<br />
* $items[]<br />
* $locations[]<br />
* $classes[]<br />
* $stats[] - Muscle, Mysticality, Moxie: the substat values are omitted.<br />
* $skills[]<br />
* $effects[]<br />
* $familiars[]<br />
* $slots[] - includes sticker slots and fake hands, which you might not want to consider as normal slots.<br />
* $monsters[]<br />
* $elements[] - includes slime now, and possibly other not-quite-elements like cute in the future.<br />
<br />
The remaining types that can be used in plural constants require an explicit list of elements, since there are too many possible values:<br />
* $ints[] - you don't have enough RAM to store a list with 18 sextillion elements.<br />
* $floats[] - ditto.<br />
* $strings[] - nobody has that much RAM.<br />
<br />
==Custom==<br />
<br />
===matcher===<br />
<br />
A matcher isn't really a datatype so much as it's a class, but it is included here for reference, as it is used much as datatypes are in ASH. It can only be declared through the function {{f|create_matcher}}, using two strings. One is the string to find matches in, the other a regular expression to test against. For more information on using a matcher, see [[Regular Expressions]].<br />
<br />
==Notes==<br />
<br />
Buffers, aggregates, records and matchers are [https://developer.mozilla.org/en-US/docs/Glossary/Mutable mutable]. All other datatypes are immutable.<br />
<br />
[[Category:Scripting]]</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=Mafia_directories&diff=9131Mafia directories2021-12-24T02:55:52Z<p>HippoKing: I don't know why I keep editing this wiki. I'm not even sure I'm helping.</p>
<hr />
<div>* '''Windows''' users probably saved the mafia .jar (or .exe) in a folder/directory. This is the '''only''' directory that is used. Mafia, when first started, will have produced a load of sub-directories that it uses to store stuff. These will have names such as "buffs", "ccs", "clan", "data", "images", "relay", "scripts", "sessions" and "settings" (maybe not all of those, maybe some others) with stuff inside. <br />
<br />
* '''Mac''' users have theirs saved under "~/Library/Application Support/KoLmafia/"<br />
<br />
* '''Linux''' Your Mafia files will be saved in a hidden folder in your home directory. Go to <pre> ~/.kolmafia </pre> The tilde is your home directory, the period at the start makes that folder hidden. If you're using a CLI, you shouldn't have a problem. If you like GUIs, either turn on showing hidden stuff or just start one inside, like:<pre> cd ~/.kolmafia && nautilus </pre><br />
<br />
[[Category:Tech Support]]</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=Compiling_from_Source&diff=9122Compiling from Source2021-11-13T11:11:25Z<p>HippoKing: /* KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds. */ it's no longer "exactly nothing" accurate below the line</p>
<hr />
<div>=== GREAT BIG NEWS ===<br />
<br />
==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==<br />
The Windows section of this page is currently out of date. The Linux and macOS ones have been updated.<br />
<br />
The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.<br />
<br />
<br />
<br />
To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the SVN and be comfortable writing Java Code. Instructions for the first two are included below:<br />
<br />
==Windows==<br />
# Download Tools<br />
## Download and install Java Development Kit 1.8 or newer, available from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptopenjdk.net AdoptOpenJDK]<br />
## Download and install Subversion, from [https://subversion.apache.org/packages.html apache.org]<br />
## Download and install Tortoise SVN (or of course, another SVN program)from [https://tortoisesvn.net/downloads.html tortoisesvn]<br />
## Download and install ANT, from [https://ant.apache.org/bindownload.cgi apache.org]<br />
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]<br />
## Windows 10<br />
### Go to settings<br />
### type 'enviro' in the search<br />
### click on the 'edit environment variables' suggestion<br />
### add or edit ANT_HOME, JAVA_HOME, and PATH variables<br>''PATH should include ANT_HOME/bin and JAVA_HOME''</br>If ANT or JAVA installers have already set these variables, they can be updated or left alone.<br />
# Get Source and Build<br />
## Connect to the SVN server and download the source code for the Mafia Project. Using Tortoise SVN, you have to right-click on your desktop, select "SVN Checkout", and put the URL of the repository as "svn://svn.code.sf.net/p/kolmafia/code/". Leave all other settings as they are, and click OK.<br />
## Copy %ANT_HOME%/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up ANT correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.<br />
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.<br />
===Troubleshooting===<br />
====Double-Clicking ''ant.bat''====<br />
Due to how bat files work when you double-click them, ''ant.bat'' will auto-close before you can read its output.<br />
# ant assumes that builds are done from a command shell. You'll need to run from the command shell to execute any ant target other than the default, such as ''ant.bat update exec'' or ''ant.bat daily</br>ant -projecthelp'' will list all main targets<br />
# An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you.<br>When you run it again, you'll be able to read its output and it will exit after you ''Press any key to continue...''<br />
# Alternatively, you can create a wrapper batch file that calls the existing ''ant.bat'' file and adds a pause after executing it. This method allows you to set different ant targets and also prevents updates to ant from overwriting your modifications.<br />
<blockquote>Example of a very simple MyWrapper.bat file<pre><br />
# This is a wrapper batch file<br />
# First it runs ant<br />
call ant.bat daily<br />
# Then it pauses<br />
pause</pre></blockquote><br />
<br />
====''tools.jar'' not found====<br />
If you get an error message about "tools.jar" not being found, this means you're trying to build with the JRE (which doesn't contain this file) rather than the JDK (which contains it).<br><br />
To fix this, right click on ''my computer'' -> ''properties'' -> ''advanced system settings'' -> ''Environment Variables...'' then make sure your PATH contains a reference to the location of your JDK directory.<br />
<br />
==Linux==<br />
<br />
Do once:<br />
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]<br />
# Get an appropriate JDK. The safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].<br />
# Clone the repo:<br />
## If you have a github account:<syntaxhighlight lang="bash"><br />
git clone git@github.com:kolmafia/kolmafia.git<br />
</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre><br />
<br />
Do every session:<br />
Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre><br />
<br />
Actually compile:<pre>cd /where/you/cloned/kolmafia</pre><br />
<pre>./gradlew clean shadowJar</pre><br />
<br />
Get new updates with <pre>git pull</pre><br />
<br />
You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre><br />
<br />
Do other installation steps as you wish.<br />
<br />
==MacOSX (updated for Git/Gradle)==<br />
# Verify required packages<br />
## <code>''java --version''</code><br />
##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]<br />
## <code>''git --version''</code><br />
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]<br />
# Configure development environment<br>Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your terminal of choice.<br />
## In the terminal set JAVA_HOME to the java home directory. <br>''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home.<br>If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code><br />
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)<br />
# Clone the source code for the KoLmafia Project.<br>''<code>git clone git@github.com:kolmafia/kolmafia.git</code>''<br />
# Compile KoLmafia with the Gradle wrapper ''<code>cd kolmafia && ./gradlew runShadow</code>''<br />
<br />
=== Optional ===<br />
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]<br />
''[[Category:Tech Support]]''</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=Compiling_from_Source&diff=9121Compiling from Source2021-11-13T10:42:37Z<p>HippoKing: /* Linux */ github can't do anonymous clones except by http</p>
<hr />
<div>=== GREAT BIG NEWS ===<br />
<br />
==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==<br />
Exactly nothing below here is accurate, and we'll need to do a thorough cleanup of this page and the IDE setup page.<br />
<br />
The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.<br />
<br />
<br />
<br />
To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the SVN and be comfortable writing Java Code. Instructions for the first two are included below:<br />
<br />
==Windows==<br />
# Download Tools<br />
## Download and install Java Development Kit 1.8 or newer, available from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptopenjdk.net AdoptOpenJDK]<br />
## Download and install Subversion, from [https://subversion.apache.org/packages.html apache.org]<br />
## Download and install Tortoise SVN (or of course, another SVN program)from [https://tortoisesvn.net/downloads.html tortoisesvn]<br />
## Download and install ANT, from [https://ant.apache.org/bindownload.cgi apache.org]<br />
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]<br />
## Windows 10<br />
### Go to settings<br />
### type 'enviro' in the search<br />
### click on the 'edit environment variables' suggestion<br />
### add or edit ANT_HOME, JAVA_HOME, and PATH variables<br>''PATH should include ANT_HOME/bin and JAVA_HOME''</br>If ANT or JAVA installers have already set these variables, they can be updated or left alone.<br />
# Get Source and Build<br />
## Connect to the SVN server and download the source code for the Mafia Project. Using Tortoise SVN, you have to right-click on your desktop, select "SVN Checkout", and put the URL of the repository as "svn://svn.code.sf.net/p/kolmafia/code/". Leave all other settings as they are, and click OK.<br />
## Copy %ANT_HOME%/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up ANT correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.<br />
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.<br />
===Troubleshooting===<br />
====Double-Clicking ''ant.bat''====<br />
Due to how bat files work when you double-click them, ''ant.bat'' will auto-close before you can read its output.<br />
# ant assumes that builds are done from a command shell. You'll need to run from the command shell to execute any ant target other than the default, such as ''ant.bat update exec'' or ''ant.bat daily</br>ant -projecthelp'' will list all main targets<br />
# An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you.<br>When you run it again, you'll be able to read its output and it will exit after you ''Press any key to continue...''<br />
# Alternatively, you can create a wrapper batch file that calls the existing ''ant.bat'' file and adds a pause after executing it. This method allows you to set different ant targets and also prevents updates to ant from overwriting your modifications.<br />
<blockquote>Example of a very simple MyWrapper.bat file<pre><br />
# This is a wrapper batch file<br />
# First it runs ant<br />
call ant.bat daily<br />
# Then it pauses<br />
pause</pre></blockquote><br />
<br />
====''tools.jar'' not found====<br />
If you get an error message about "tools.jar" not being found, this means you're trying to build with the JRE (which doesn't contain this file) rather than the JDK (which contains it).<br><br />
To fix this, right click on ''my computer'' -> ''properties'' -> ''advanced system settings'' -> ''Environment Variables...'' then make sure your PATH contains a reference to the location of your JDK directory.<br />
<br />
==Linux==<br />
<br />
Do once:<br />
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]<br />
# Get an appropriate JDK. The safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].<br />
# Clone the repo:<br />
## If you have a github account:<syntaxhighlight lang="bash"><br />
git clone git@github.com:kolmafia/kolmafia.git<br />
</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre><br />
<br />
Do every session:<br />
Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre><br />
<br />
Actually compile:<pre>cd /where/you/cloned/kolmafia</pre><br />
<pre>./gradlew clean shadowJar</pre><br />
<br />
Get new updates with <pre>git pull</pre><br />
<br />
You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre><br />
<br />
Do other installation steps as you wish.<br />
<br />
==MacOSX (updated for Git/Gradle)==<br />
# Verify required packages<br />
## <code>''java --version''</code><br />
##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]<br />
## <code>''git --version''</code><br />
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]<br />
# Configure development environment<br>Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your terminal of choice.<br />
## In the terminal set JAVA_HOME to the java home directory. <br>''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home.<br>If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code><br />
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)<br />
# Clone the source code for the KoLmafia Project.<br>''<code>git clone git@github.com:kolmafia/kolmafia.git</code>''<br />
# Compile KoLmafia with the Gradle wrapper ''<code>cd kolmafia && ./gradlew runShadow</code>''<br />
<br />
=== Optional ===<br />
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]<br />
''[[Category:Tech Support]]''</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=Compiling_from_Source&diff=9120Compiling from Source2021-11-13T10:34:21Z<p>HippoKing: /* Linux */ god I suck at wiki syntax</p>
<hr />
<div>=== GREAT BIG NEWS ===<br />
<br />
==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==<br />
Exactly nothing below here is accurate, and we'll need to do a thorough cleanup of this page and the IDE setup page.<br />
<br />
The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.<br />
<br />
<br />
<br />
To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the SVN and be comfortable writing Java Code. Instructions for the first two are included below:<br />
<br />
==Windows==<br />
# Download Tools<br />
## Download and install Java Development Kit 1.8 or newer, available from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptopenjdk.net AdoptOpenJDK]<br />
## Download and install Subversion, from [https://subversion.apache.org/packages.html apache.org]<br />
## Download and install Tortoise SVN (or of course, another SVN program)from [https://tortoisesvn.net/downloads.html tortoisesvn]<br />
## Download and install ANT, from [https://ant.apache.org/bindownload.cgi apache.org]<br />
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]<br />
## Windows 10<br />
### Go to settings<br />
### type 'enviro' in the search<br />
### click on the 'edit environment variables' suggestion<br />
### add or edit ANT_HOME, JAVA_HOME, and PATH variables<br>''PATH should include ANT_HOME/bin and JAVA_HOME''</br>If ANT or JAVA installers have already set these variables, they can be updated or left alone.<br />
# Get Source and Build<br />
## Connect to the SVN server and download the source code for the Mafia Project. Using Tortoise SVN, you have to right-click on your desktop, select "SVN Checkout", and put the URL of the repository as "svn://svn.code.sf.net/p/kolmafia/code/". Leave all other settings as they are, and click OK.<br />
## Copy %ANT_HOME%/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up ANT correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.<br />
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.<br />
===Troubleshooting===<br />
====Double-Clicking ''ant.bat''====<br />
Due to how bat files work when you double-click them, ''ant.bat'' will auto-close before you can read its output.<br />
# ant assumes that builds are done from a command shell. You'll need to run from the command shell to execute any ant target other than the default, such as ''ant.bat update exec'' or ''ant.bat daily</br>ant -projecthelp'' will list all main targets<br />
# An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you.<br>When you run it again, you'll be able to read its output and it will exit after you ''Press any key to continue...''<br />
# Alternatively, you can create a wrapper batch file that calls the existing ''ant.bat'' file and adds a pause after executing it. This method allows you to set different ant targets and also prevents updates to ant from overwriting your modifications.<br />
<blockquote>Example of a very simple MyWrapper.bat file<pre><br />
# This is a wrapper batch file<br />
# First it runs ant<br />
call ant.bat daily<br />
# Then it pauses<br />
pause</pre></blockquote><br />
<br />
====''tools.jar'' not found====<br />
If you get an error message about "tools.jar" not being found, this means you're trying to build with the JRE (which doesn't contain this file) rather than the JDK (which contains it).<br><br />
To fix this, right click on ''my computer'' -> ''properties'' -> ''advanced system settings'' -> ''Environment Variables...'' then make sure your PATH contains a reference to the location of your JDK directory.<br />
<br />
==Linux==<br />
<br />
Do once:<br />
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]<br />
# Get an appropriate JDK. The safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].<br />
# Clone the repo: <pre>git clone https://github.com/kolmafia/kolmafia.git</pre><br />
<br />
Do every session:<br />
Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre><br />
<br />
Actually compile:<pre>cd /where/you/cloned/kolmafia</pre><br />
<pre>./gradlew clean shadowJar</pre><br />
<br />
Get new updates with <pre>git pull</pre><br />
<br />
You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre><br />
<br />
Do other installation steps as you wish.<br />
<br />
==MacOSX (updated for Git/Gradle)==<br />
# Verify required packages<br />
## <code>''java --version''</code><br />
##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]<br />
## <code>''git --version''</code><br />
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]<br />
# Configure development environment<br>Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your terminal of choice.<br />
## In the terminal set JAVA_HOME to the java home directory. <br>''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home.<br>If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code><br />
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)<br />
# Clone the source code for the KoLmafia Project.<br>''<code>git clone git@github.com:kolmafia/kolmafia.git</code>''<br />
# Compile KoLmafia with the Gradle wrapper ''<code>cd kolmafia && ./gradlew runShadow</code>''<br />
<br />
=== Optional ===<br />
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]<br />
''[[Category:Tech Support]]''</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=Compiling_from_Source&diff=9119Compiling from Source2021-11-13T10:31:40Z<p>HippoKing: /* Linux */ remove outdated instructions, suggest Adoptium for JDK</p>
<hr />
<div>=== GREAT BIG NEWS ===<br />
<br />
==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==<br />
Exactly nothing below here is accurate, and we'll need to do a thorough cleanup of this page and the IDE setup page.<br />
<br />
The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.<br />
<br />
<br />
<br />
To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the SVN and be comfortable writing Java Code. Instructions for the first two are included below:<br />
<br />
==Windows==<br />
# Download Tools<br />
## Download and install Java Development Kit 1.8 or newer, available from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptopenjdk.net AdoptOpenJDK]<br />
## Download and install Subversion, from [https://subversion.apache.org/packages.html apache.org]<br />
## Download and install Tortoise SVN (or of course, another SVN program)from [https://tortoisesvn.net/downloads.html tortoisesvn]<br />
## Download and install ANT, from [https://ant.apache.org/bindownload.cgi apache.org]<br />
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]<br />
## Windows 10<br />
### Go to settings<br />
### type 'enviro' in the search<br />
### click on the 'edit environment variables' suggestion<br />
### add or edit ANT_HOME, JAVA_HOME, and PATH variables<br>''PATH should include ANT_HOME/bin and JAVA_HOME''</br>If ANT or JAVA installers have already set these variables, they can be updated or left alone.<br />
# Get Source and Build<br />
## Connect to the SVN server and download the source code for the Mafia Project. Using Tortoise SVN, you have to right-click on your desktop, select "SVN Checkout", and put the URL of the repository as "svn://svn.code.sf.net/p/kolmafia/code/". Leave all other settings as they are, and click OK.<br />
## Copy %ANT_HOME%/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up ANT correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.<br />
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.<br />
===Troubleshooting===<br />
====Double-Clicking ''ant.bat''====<br />
Due to how bat files work when you double-click them, ''ant.bat'' will auto-close before you can read its output.<br />
# ant assumes that builds are done from a command shell. You'll need to run from the command shell to execute any ant target other than the default, such as ''ant.bat update exec'' or ''ant.bat daily</br>ant -projecthelp'' will list all main targets<br />
# An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you.<br>When you run it again, you'll be able to read its output and it will exit after you ''Press any key to continue...''<br />
# Alternatively, you can create a wrapper batch file that calls the existing ''ant.bat'' file and adds a pause after executing it. This method allows you to set different ant targets and also prevents updates to ant from overwriting your modifications.<br />
<blockquote>Example of a very simple MyWrapper.bat file<pre><br />
# This is a wrapper batch file<br />
# First it runs ant<br />
call ant.bat daily<br />
# Then it pauses<br />
pause</pre></blockquote><br />
<br />
====''tools.jar'' not found====<br />
If you get an error message about "tools.jar" not being found, this means you're trying to build with the JRE (which doesn't contain this file) rather than the JDK (which contains it).<br><br />
To fix this, right click on ''my computer'' -> ''properties'' -> ''advanced system settings'' -> ''Environment Variables...'' then make sure your PATH contains a reference to the location of your JDK directory.<br />
<br />
==Linux==<br />
<br />
Do once:<br />
# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]<br />
# Get an appropriate JDK. The safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].<br />
# Clone the repo: <pre>git clone https://github.com/kolmafia/kolmafia.git</pre><br />
<br />
Do every session:<br />
# Set up your environment to use that JDK you just downloaded<br />
<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre><br />
<br />
Actually compile:<br />
#<pre>cd /where/you/cloned/kolmafia<br />
./gradlew clean shadowJar</pre><br />
<br />
Get new updates with <pre>git pull</pre><br />
<br />
You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre><br />
<br />
Do other installation steps as you wish.<br />
<br />
==MacOSX (updated for Git/Gradle)==<br />
# Verify required packages<br />
## <code>''java --version''</code><br />
##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]<br />
## <code>''git --version''</code><br />
##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]<br />
# Configure development environment<br>Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your terminal of choice.<br />
## In the terminal set JAVA_HOME to the java home directory. <br>''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home.<br>If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code><br />
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)<br />
# Clone the source code for the KoLmafia Project.<br>''<code>git clone git@github.com:kolmafia/kolmafia.git</code>''<br />
# Compile KoLmafia with the Gradle wrapper ''<code>cd kolmafia && ./gradlew runShadow</code>''<br />
<br />
=== Optional ===<br />
If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]<br />
''[[Category:Tech Support]]''</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=Compiling_from_Source&diff=8991Compiling from Source2021-04-17T23:34:12Z<p>HippoKing: /* Linux */ no need to specific a version, use java latest</p>
<hr />
<div>To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the SVN and be comfortable writing Java Code. Instructions for the first two are included below:<br />
<br />
==Windows==<br />
# Download Tools<br />
## Download and install Java Development Kit 1.8 or newer, available from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptopenjdk.net AdoptOpenJDK]<br />
## Download and install Subversion, from [https://subversion.apache.org/packages.html apache.org]<br />
## Download and install Tortoise SVN (or of course, another SVN program)from [https://tortoisesvn.net/downloads.html tortoisesvn]<br />
## Download and install ANT, from [https://ant.apache.org/bindownload.cgi apache.org]<br />
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]<br />
## Windows 10<br />
### Go to settings<br />
### type 'enviro' in the search<br />
### click on the 'edit environment variables' suggestion<br />
### add or edit ANT_HOME, JAVA_HOME, and PATH variables<br>''PATH should include ANT_HOME/bin and JAVA_HOME''</br>If ANT or JAVA installers have already set these variables, they can be updated or left alone.<br />
# Get Source and Build<br />
## Connect to the SVN server and download the source code for the Mafia Project. Using Tortoise SVN, you have to right-click on your desktop, select "SVN Checkout", and put the URL of the repository as "svn://svn.code.sf.net/p/kolmafia/code/". Leave all other settings as they are, and click OK.<br />
## Copy %ANT_HOME%/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up ANT correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.<br />
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.<br />
===Troubleshooting===<br />
====Double-Clicking ''ant.bat''====<br />
Due to how bat files work when you double-click them, ''ant.bat'' will auto-close before you can read its output.<br />
# ant assumes that builds are done from a command shell. You'll need to run from the command shell to execute any ant target other than the default, such as ''ant.bat update exec'' or ''ant.bat daily</br>ant -projecthelp'' will list all main targets<br />
# An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you.<br>When you run it again, you'll be able to read its output and it will exit after you ''Press any key to continue...''<br />
# Alternatively, you can create a wrapper batch file that calls the existing ''ant.bat'' file and adds a pause after executing it. This method allows you to set different ant targets and also prevents updates to ant from overwriting your modifications.<br />
<blockquote>Example of a very simple MyWrapper.bat file<pre><br />
# This is a wrapper batch file<br />
# First it runs ant<br />
call ant.bat daily<br />
# Then it pauses<br />
pause</pre></blockquote><br />
<br />
====''tools.jar'' not found====<br />
If you get an error message about "tools.jar" not being found, this means you're trying to build with the JRE (which doesn't contain this file) rather than the JDK (which contains it).<br><br />
To fix this, right click on ''my computer'' -> ''properties'' -> ''advanced system settings'' -> ''Environment Variables...'' then make sure your PATH contains a reference to the location of your JDK directory.<br />
<br />
==Linux==<br />
<br />
# Install Sun Java Development Kit ( debian: apt-get install sun-java6-jdk )<br />
# Install Subversion ( debian: apt-get install svn )<br />
# Install Ant ( debian: apt-get install ant )<br />
# Connect to the SVN server and download the source code for the Mafia Project. ( svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia )<br />
# Verify tou are using sun-java with ( debian: update-alternatives --all )<br />
# I had to change $JAVA_HOME to compile ( export JAVA_HOME=/usr/lib/jvm/java-6-sun-1.6.0.12 )<br />
# Compile kolmafia with Ant ( debian: cd kolmafia && ant debian )<br />
# Install kolmafia ( debian: cd dist && dpkg -i kolmafia*.deb )<br />
<br />
===Fedora (or probably other RPM systems)===<br />
<br />
# Install Subversion: <pre>sudo yum install sqlite-devel subversion </pre><br />
# Install Java JDK: <pre>sudo yum install java-latest-openjdk-devel</pre><br />
# Install Ant: <pre>sudo yum install ant</pre><br />
# Checkout: <pre>svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia</pre><br />
# Build: <pre>cd kolmafia && ant</pre></pre><br />
<br />
You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre><br />
<br />
Do other installation steps as you wish.<br />
<br />
==MacOSX==<br />
# Install required packages</br>''MacOS X packages for Java, subversion, and ANT may also be installed via a package manager like [https://brew.sh Homebrew] or [https://www.macports.org MacPorts]. The instructions are written for a direct installation of the packages.''<br />
## Install Java Development Kit version 1.8 or newer from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptopenjdk.net OpenJDK] <br />
## Install Subversion 1.10 or newer from [https://subversion.apache.org/packages.html apache.org]<br />
## Install Ant 1.9 or newer from [https://ant.apache.org/bindownload.cgi apache.org]<br />
# Configure development environment</br>Most of these steps can be included in ''.profile'' or the equivalent for your terminal of choice.<br />
## In the terminal set JAVA_HOME to the java home directory. </br>''/usr/libexec/java_home -V'' will list all known values for java_home.</br>If you have multiple copies of java, choose the version you want to us''e.<br />
## In the terminal set ANT_HOME to the location of ANT. e.g. ''/opt/ant''<br />
## In the terminal make sure that Ant and subversion are in your ${PATH} variable. e.g.''PATH=${PATH}:/usr/local/opt/subversion/bin:/usr/local/ant/bin''<br />
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. cd ~/Projects, or some similar directory)<br />
# Connect to the SVN server and download the source code for the KoLmafia Project.</br>''svn checkout <nowiki>svn://svn.code.sf.net/p/kolmafia/code/</nowiki> kolmafia''<br />
# Compile KoLmafia with Ant (''cd kolmafia && ant daily'') <br />
# execute KoLmafia with the command ''java -jar dist/KoLmafia-*.jar<br />
<br />
[[Category:Tech Support]]</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=Compiling_from_Source&diff=8990Compiling from Source2021-04-17T22:53:37Z<p>HippoKing: /* Linux */ simple RPM build.</p>
<hr />
<div>To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the SVN and be comfortable writing Java Code. Instructions for the first two are included below:<br />
<br />
==Windows==<br />
# Download Tools<br />
## Download and install Java Development Kit 1.8 or newer, available from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptopenjdk.net AdoptOpenJDK]<br />
## Download and install Subversion, from [https://subversion.apache.org/packages.html apache.org]<br />
## Download and install Tortoise SVN (or of course, another SVN program)from [https://tortoisesvn.net/downloads.html tortoisesvn]<br />
## Download and install ANT, from [https://ant.apache.org/bindownload.cgi apache.org]<br />
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]<br />
## Windows 10<br />
### Go to settings<br />
### type 'enviro' in the search<br />
### click on the 'edit environment variables' suggestion<br />
### add or edit ANT_HOME, JAVA_HOME, and PATH variables<br>''PATH should include ANT_HOME/bin and JAVA_HOME''</br>If ANT or JAVA installers have already set these variables, they can be updated or left alone.<br />
# Get Source and Build<br />
## Connect to the SVN server and download the source code for the Mafia Project. Using Tortoise SVN, you have to right-click on your desktop, select "SVN Checkout", and put the URL of the repository as "svn://svn.code.sf.net/p/kolmafia/code/". Leave all other settings as they are, and click OK.<br />
## Copy %ANT_HOME%/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up ANT correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.<br />
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.<br />
===Troubleshooting===<br />
====Double-Clicking ''ant.bat''====<br />
Due to how bat files work when you double-click them, ''ant.bat'' will auto-close before you can read its output.<br />
# ant assumes that builds are done from a command shell. You'll need to run from the command shell to execute any ant target other than the default, such as ''ant.bat update exec'' or ''ant.bat daily</br>ant -projecthelp'' will list all main targets<br />
# An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you.<br>When you run it again, you'll be able to read its output and it will exit after you ''Press any key to continue...''<br />
# Alternatively, you can create a wrapper batch file that calls the existing ''ant.bat'' file and adds a pause after executing it. This method allows you to set different ant targets and also prevents updates to ant from overwriting your modifications.<br />
<blockquote>Example of a very simple MyWrapper.bat file<pre><br />
# This is a wrapper batch file<br />
# First it runs ant<br />
call ant.bat daily<br />
# Then it pauses<br />
pause</pre></blockquote><br />
<br />
====''tools.jar'' not found====<br />
If you get an error message about "tools.jar" not being found, this means you're trying to build with the JRE (which doesn't contain this file) rather than the JDK (which contains it).<br><br />
To fix this, right click on ''my computer'' -> ''properties'' -> ''advanced system settings'' -> ''Environment Variables...'' then make sure your PATH contains a reference to the location of your JDK directory.<br />
<br />
==Linux==<br />
<br />
# Install Sun Java Development Kit ( debian: apt-get install sun-java6-jdk )<br />
# Install Subversion ( debian: apt-get install svn )<br />
# Install Ant ( debian: apt-get install ant )<br />
# Connect to the SVN server and download the source code for the Mafia Project. ( svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia )<br />
# Verify tou are using sun-java with ( debian: update-alternatives --all )<br />
# I had to change $JAVA_HOME to compile ( export JAVA_HOME=/usr/lib/jvm/java-6-sun-1.6.0.12 )<br />
# Compile kolmafia with Ant ( debian: cd kolmafia && ant debian )<br />
# Install kolmafia ( debian: cd dist && dpkg -i kolmafia*.deb )<br />
<br />
===Fedora (or probably other RPM systems)===<br />
<br />
# Install Subversion: <pre>sudo yum install sqlite-devel subversion </pre><br />
# Install Java JDK: <pre>sudo yum install java-11-openjdk-devel</pre><br />
# Install Ant: <pre>sudo yum install ant</pre><br />
# Checkout: <pre>svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia</pre><br />
# Build: <pre>cd kolmafia && ant</pre></pre><br />
<br />
You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre><br />
<br />
Do other installation steps as you wish.<br />
<br />
==MacOSX==<br />
# Install required packages</br>''MacOS X packages for Java, subversion, and ANT may also be installed via a package manager like [https://brew.sh Homebrew] or [https://www.macports.org MacPorts]. The instructions are written for a direct installation of the packages.''<br />
## Install Java Development Kit version 1.8 or newer from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptopenjdk.net OpenJDK] <br />
## Install Subversion 1.10 or newer from [https://subversion.apache.org/packages.html apache.org]<br />
## Install Ant 1.9 or newer from [https://ant.apache.org/bindownload.cgi apache.org]<br />
# Configure development environment</br>Most of these steps can be included in ''.profile'' or the equivalent for your terminal of choice.<br />
## In the terminal set JAVA_HOME to the java home directory. </br>''/usr/libexec/java_home -V'' will list all known values for java_home.</br>If you have multiple copies of java, choose the version you want to us''e.<br />
## In the terminal set ANT_HOME to the location of ANT. e.g. ''/opt/ant''<br />
## In the terminal make sure that Ant and subversion are in your ${PATH} variable. e.g.''PATH=${PATH}:/usr/local/opt/subversion/bin:/usr/local/ant/bin''<br />
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. cd ~/Projects, or some similar directory)<br />
# Connect to the SVN server and download the source code for the KoLmafia Project.</br>''svn checkout <nowiki>svn://svn.code.sf.net/p/kolmafia/code/</nowiki> kolmafia''<br />
# Compile KoLmafia with Ant (''cd kolmafia && ant daily'') <br />
# execute KoLmafia with the command ''java -jar dist/KoLmafia-*.jar<br />
<br />
[[Category:Tech Support]]</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=CLI_Reference&diff=2918CLI Reference2009-08-30T16:53:54Z<p>HippoKing: finished reordering.</p>
<hr />
<div>The KoLmafia Graphical CLI is one of the most helpful features it has. This page is intended to provide information on the commands available.<br />
<br />
==Equipment, Inventory and Consumption Management==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command<br />
! Arguments<br />
! Description<br />
|-<br />
| *brewery*[?]<br />
| [ daily special &#124; item ] <br />
| show daily special [or consume it or other restaurant item].<br />
|-<br />
| *kitchen*[?]<br />
| item <br />
| consumes item at Hell's Kitchen, if available.<br />
|-<br />
| acquire<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| bake<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| chew[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| cleanup<br />
| <br />
| use, pulverize, or autosell your junk items.<br />
|-<br />
| closet<br />
| list filter &#124; put item... | take item... <br />
| list or manipulate your closet.<br />
|-<br />
| create<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| display<br />
| [filter] &#124; put item... | take item... <br />
| list or manipulate your display case.<br />
|-<br />
| eat[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| equip<br />
| [list filter] &#124; [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| find<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| fold[?]<br />
| item <br />
| produce item by using another form, repeated as needed.<br />
|-<br />
| ghost[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| hagnk<br />
| outfit name &#124; item [, item]... <br />
| pull items from Hagnk's storage.<br />
|-<br />
| hermit[?]<br />
| [item] <br />
| get clover status, or trade for item.<br />
|-<br />
| hobo[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| inv*<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| junk<br />
| <br />
| use, pulverize, or autosell your junk items.<br />
|-<br />
| make<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| maximize[?]<br />
| [+&#124;-&#124;weight] keyword, ...<br />
| run the Modifier Maximizer.<br />
|-<br />
| mix<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| modifies<br />
| filter <br />
| list all possible sources of modifiers matching filter.<br />
|-<br />
| modref<br />
| [object] <br />
| list all modifiers, show values for player [and object].<br />
|-<br />
| modtrace<br />
| filter <br />
| list everything that adds to modifiers matching filter.<br />
|-<br />
| outfit<br />
| [list filter] &#124; save name &#124; checkpoint &#124; name <br />
| list, save, restore, or change outfits.<br />
|-<br />
| overdrink[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| ply<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| pull<br />
| outfit name &#124; item [, item]... <br />
| pull items from Hagnk's storage.<br />
|-<br />
| pulverize<br />
| item [, item]... <br />
| pulverize specified items<br />
|-<br />
| quark[?]<br />
| [itemList...] <br />
| gain MP by pasting unstable quark with best item from itemList (or your junk list).<br />
|-<br />
| remove<br />
| slot &#124; name <br />
| remove equipment in slot, or that matches name<br />
|-<br />
| restaurant[?]<br />
| [ daily special &#124; item ] <br />
| show daily special [or consume it or other restaurant item].<br />
|-<br />
| retrieve<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| slimeling[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| smash<br />
| item [, item]... <br />
| pulverize specified items<br />
|-<br />
| smith<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| speculate<br />
| MCD num &#124; equip [slot] item &#124; unequip slot &#124; familiar type &#124; up eff &#124; uneffect eff &#124; quiet ; [another;...] <br />
| predict modifiers.<br />
|-<br />
| squeeze[?]<br />
| item <br />
| produce item by using another form, repeated as needed.<br />
|-<br />
| stash<br />
| [put] item... &#124; take item... <br />
| exchange items with clan stash<br />
|-<br />
| sticker*<br />
| sticker1 [, sticker2 [, sticker3]] <br />
| replace worn stickers.<br />
|-<br />
| storage<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| tinker<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| wear<br />
| [list filter] &#124; [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| whatif<br />
| MCD num &#124; equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...] <br />
| predict modifiers.<br />
|-<br />
| wield<br />
| [list filter] &#124; [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| zap<br />
| item [, item]... <br />
| transform items with your wand.<br />
|}<br />
<br />
<br />
==Quests==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command Name<br />
! Arguments<br />
! Description<br />
|-<br />
| !<br />
| <br />
| list the Dungeons of Doom potions you've identified.<br />
|-<br />
| bang<br />
| <br />
| list the Dungeons of Doom potions you've identified.<br />
|-<br />
| chamber<br />
| <br />
| automatically complete quest.<br />
|-<br />
| council<br />
| <br />
| visit the Council to advance quest progress.<br />
|-<br />
| dusty<br />
| <br />
| list the dusty bottles of wine you've identified.<br />
|-<br />
| entryway<br />
| [clover] <br />
| automatically complete quest [using a clover].<br />
|-<br />
| factory<br />
| report digits <br />
| Given a string of 7 dwarven digits, report on factory.<br />
|-<br />
| gourd<br />
| <br />
| automatically complete quest.<br />
|-<br />
| grandpa<br />
| query <br />
| Ask Grandpa about something.<br />
|-<br />
| guardians<br />
| <br />
| automatically complete quest.<br />
|-<br />
| guild<br />
| <br />
| automatically complete quest.<br />
|-<br />
| hedge*<br />
| <br />
| automatically complete quest.<br />
|-<br />
| insults<br />
| <br />
| list the pirate insult comebacks you know.<br />
|-<br />
| leaflet<br />
| [nomagic] &#124; location | command <br />
| complete leaflet quest [without using magic words].<br />
|-<br />
| maze<br />
| <br />
| automatically complete quest.<br />
|-<br />
| nemesis<br />
| <br />
| automatically complete quest.<br />
|-<br />
| tavern<br />
| <br />
| automatically complete quest.<br />
|-<br />
| telescope<br />
| [look] high &#124; low <br />
| get daily buff, or Lair hints from your telescope.<br />
|-<br />
| tower<br />
| <br />
| automatically complete quest.<br />
|}<br />
<br />
<br />
==Capitalism==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command Name<br />
! Arguments<br />
! Description<br />
|-<br />
| automall<br />
| <br />
| dump all profitable, non-memento items into the Mall.<br />
|-<br />
| autosell<br />
| item [, item]... <br />
| autosell items.<br />
|-<br />
| buy<br />
| item [@ limit] [, another]... <br />
| buy from NPC store or the Mall.<br />
|-<br />
| cheapest[?]<br />
| [+]item [,[-]item]... [; cmds] <br />
| compare prices, do cmds with "it" replaced with best.<br />
|-<br />
| expensive[?]<br />
| [+]item [,[-]item]... [; cmds]<br />
| compare prices, do cmds with "it" replaced with best.<br />
|-<br />
| mallbuy<br />
| item [@ limit] [, another]... <br />
| buy from NPC store or the Mall.<br />
|-<br />
| mallsell<br />
| item [[@] price [[limit] num]] [, another]... <br />
| sell in Mall.<br />
|-<br />
| reprice<br />
| <br />
| price all max-priced items at or below current Mall minimum price.<br />
|-<br />
| searchmall<br />
| item [ with limit number ] <br />
| search the Mall.<br />
|-<br />
| sell<br />
| item [, item]... <br />
| autosell items.<br />
|-<br />
| undercut<br />
| <br />
| price all max-priced items at or below current Mall minimum price.<br />
|-<br />
| untinker<br />
| [ item... ] <br />
| complete quest, or untinker items.<br />
|-<br />
| use[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|}<br />
<br />
<br />
==Mafia==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command Name<br />
! Arguments<br />
! Description<br />
|-<br />
| adv*[?]<br />
| last &#124; [count] location <br />
| spend your turns.<br />
|-<br />
| abort<br />
| [message] <br />
| stop current script or automated task.<br />
|-<br />
| alias<br />
| [ word => expansion ] <br />
| list or create CLI abbreviations.<br />
|-<br />
| ash<br />
| statement <br />
| test a line of ASH code without having to edit a script.<br />
|-<br />
| ashref<br />
| [filter] <br />
| summarize ASH built-in functions [matching filter].<br />
|-<br />
| backtrace<br />
| text &#124; off <br />
| dump stack when a gCLI message or page URL matches text (case-sensitive).<br />
|-<br />
| breakfast<br />
| <br />
| perform start-of-day activities.<br />
|-<br />
| budget<br />
| [number] <br />
| show [or set] the number of budgeted Hagnk's pulls.<br />
|-<br />
| buffbot<br />
| number <br />
| run buffbot for number iterations.<br />
|-<br />
| call<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| ccs<br />
| [script] <br />
| show [or select] Custom Combat Script in use.<br />
|-<br />
| cecho<br />
| color text <br />
| show text using color (specified by name or #RRGGBB).<br />
|-<br />
| chat<br />
| <br />
| switch to tab or open window<br />
|-<br />
| check<br />
| hp &#124; health &#124; mp &#124; mana &#124; both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| checkpoint<br />
| <br />
| remembers current equipment, use "outfit checkpoint" to restore.<br />
|-<br />
| clear<br />
| <br />
| clear CLI window.<br />
|-<br />
| cls<br />
| <br />
| clear CLI window.<br />
|-<br />
| condition*<br />
| clear &#124; check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| condref<br />
| <br />
| list conditions usable with if/while commands.<br />
|-<br />
| counters<br />
| [ clear &#124; add number [title img] ] <br />
| show, clear, or add to current turn counters.<br />
|-<br />
| debug<br />
| [on] &#124; off <br />
| start or stop logging of debugging data.<br />
|-<br />
| disable<br />
| all &#124; command [, command]... <br />
| allow/deny CLI commands.<br />
|-<br />
| events<br />
| [clear] <br />
| clear or show recent events.<br />
|-<br />
| exec*<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| exit<br />
| <br />
| logout and exit KoLmafia.<br />
|-<br />
| gc<br />
| <br />
| force Java garbage collection.<br />
|-<br />
| gear<br />
| <br />
| switch to tab or open window<br />
|-<br />
| get<br />
| preference [ = value ] <br />
| show/change preference settings<br />
|-<br />
| goal*<br />
| clear &#124; check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| help<br />
| [filter] <br />
| list CLI commands [that match filter].<br />
|-<br />
| item<br />
| <br />
| switch to tab or open window<br />
|-<br />
| later<br />
| commands <br />
| adds a button to do commands to the Daily Deeds list.<br />
|-<br />
| load<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| log<br />
| [status],[equipment],[effects],[etc.] <br />
| record data, "log snapshot" for all common data.<br />
|-<br />
| logecho<br />
| timestamp &#124; text <br />
| include timestamp or text in the session log only.<br />
|-<br />
| login<br />
| username <br />
| logout then log back in as username.<br />
|-<br />
| logout<br />
| <br />
| logout and return to login window.<br />
|-<br />
| logprint<br />
| timestamp &#124; text <br />
| include timestamp or text in the session log only.<br />
|-<br />
| mail<br />
| <br />
| switch to tab or open window<br />
|-<br />
| mood*<br />
| clear &#124; autofill | execute | repeat [numTimes] | moodName [numTimes] <br />
| mood management.<br />
|-<br />
| objective*<br />
| clear &#124; check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| opt*<br />
| <br />
| switch to tab or open window<br />
|-<br />
| print<br />
| timestamp &#124; text <br />
| include timestamp or text in the session log.<br />
|-<br />
| priphea<br />
| <br />
| launch KoLmafia GUI.<br />
|-<br />
| quit<br />
| <br />
| logout and exit KoLmafia.<br />
|-<br />
| radio<br />
| <br />
| switch to tab or open window<br />
|-<br />
| relay<br />
| <br />
| open the relay browser.<br />
|-<br />
| refresh<br />
| all &#124; status | equip | inv | storage | familiar | stickers <br />
| resynchronize with KoL.<br />
|-<br />
| repeat<br />
| [number] <br />
| repeat previous line [number times].<br />
|-<br />
| run<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| save<br />
| as mood <br />
| add your current effects to the mood.<br />
|-<br />
| session<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| set<br />
| preference [ = value ] <br />
| show/change preference settings<br />
|-<br />
| start<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| trigger*<br />
| clear &#124; autofill | [type,] effect [, action] <br />
| edit current mood<br />
|-<br />
| unalias<br />
| word <br />
| remove a CLI abbreviation.<br />
|-<br />
| update<br />
| data &#124; clear | prices URL or filename <br />
| download most recent data files, or revert to built-in data.<br />
|-<br />
| validate<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| verify<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| version<br />
| <br />
| display KoLmafia version.<br />
|}<br />
<br />
<br />
==Scripting==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command Name<br />
! Arguments<br />
! Description<br />
|-<br />
| <inline-ash-script><br />
| <br />
| embed an ASH script in a CLI script.<br />
|-<br />
| cecho<br />
| color text <br />
| show text using color (specified by name or #RRGGBB).<br />
|-<br />
| colorecho<br />
| color text <br />
| show text using color (specified by name or #RRGGBB).<br />
|-<br />
| echo<br />
| timestamp &#124; text <br />
| include timestamp or text in the session log.<br />
|-<br />
| else<br />
| ; commands <br />
| do commands if preceding if/while/try didn't execute.<br />
|-<br />
| elseif<br />
| condition; commands <br />
| do if condition is true but preceding condition was false.<br />
|-<br />
| if<br />
| condition; commands <br />
| do commands once if condition is true (see condref).<br />
|-<br />
| namespace<br />
| [filter] <br />
| list namespace scripts and the functions they define.<br />
|-<br />
| pause<br />
| [seconds] <br />
| pause script execution (default 1 second).<br />
|-<br />
| try<br />
| ; commands <br />
| do commands, and continue even if an error occurs.<br />
|-<br />
| using<br />
| filename <br />
| add ASH script to namespace.<br />
|-<br />
| wait<br />
| [seconds] <br />
| pause script execution (default 1 second).<br />
|-<br />
| while<br />
| condition; commands <br />
| do commands repeatedly while condition is true.<br />
|}<br />
<br />
<br />
==Other==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command Name<br />
! Arguments<br />
! Description<br />
|-<br />
| *.php*<br />
| <br />
| visit URL without showing results.<br />
|-<br />
| *mirror*<br />
| [filename] <br />
| stop [or start] logging to an additional file.<br />
|-<br />
| aa<br />
| skill <br />
| set default attack method.<br />
|-<br />
| attack<br />
| [ target [, target]... ] <br />
| PvP for dignity or flowers<br />
|-<br />
| autoattack<br />
| skill <br />
| set default attack method.<br />
|-<br />
| basement<br />
| <br />
| check Fernswarthy's Basement status.<br />
|-<br />
| burn<br />
| extra &#124; * &#124; num &#124; -num<br />
| use excess/all/specified/all but specified MP for buff extension and summons.<br />
|-<br />
| camp*<br />
| rest &#124; etc. [numTimes] <br />
| perform campground actions.<br />
|-<br />
| cast[?]<br />
| [ [count] skill [on player] ] <br />
| list spells, or use one.<br />
|-<br />
| clan<br />
| [ snapshot &#124; stashlog ] <br />
| clan management.<br />
|-<br />
| csend<br />
| item [, item]... to recipient [ &#124;| message ] <br />
| send kmail<br />
|-<br />
| demons<br />
| <br />
| list the demon names you know.<br />
|-<br />
| donate<br />
| boris &#124; mus | jarl | mys | pete | mox amount <br />
| donate in Hall of Legends.<br />
|-<br />
| drink[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| effects<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| enable<br />
| all &#124; command [, command]... <br />
| allow/deny CLI commands.<br />
|-<br />
| encounters<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| entity<br />
| <br />
| give details of your current pastamancer combat entity.<br />
|-<br />
| familiar[?]<br />
| [list filter] &#124; lock | unlock | species | none <br />
| list or change familiar types<br />
|-<br />
| field<br />
| [ plant square type &#124; pick square | harvest ] <br />
| view or use your mushroom plot<br />
|-<br />
| flowers<br />
| <br />
| commit random acts of PvP.<br />
|-<br />
| forum*<br />
| <br />
| visit the official KoL forums.<br />
|-<br />
| friars<br />
| [blessing] food &#124; familiar | booze <br />
| get daily blessing.<br />
|-<br />
| galaktik(hp&#124;mp)<br />
| [amount] <br />
| restore some or all hp or mp<br />
|-<br />
| hiddencity<br />
| square [temple&#124;altar item] <br />
| set Hidden City square [and perform an action there].<br />
|-<br />
| holiday<br />
| HolidayName <br />
| enable special processing for unpredicted holidays.<br />
|-<br />
| hottub<br />
| <br />
| soak in your clan's hot tub<br />
|-<br />
| http:*<br />
| <br />
| visit URL without showing results.<br />
|-<br />
| kmail<br />
| item [, item]... to recipient [ &#124;| message ] <br />
| send kmail<br />
|-<br />
| locations<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| lookup<br />
| item &#124; effect <br />
| go to appropriate KoL Wiki page.<br />
|-<br />
| mcd<br />
| number <br />
| set mind control device (or equivalent) to new value.<br />
|-<br />
| mind-control<br />
| number <br />
| set mind control device (or equivalent) to new value.<br />
|-<br />
| moleref<br />
| <br />
| Path of the Mole spoilers.<br />
|-<br />
| monsters<br />
| location <br />
| show combat details for the specified area.<br />
|-<br />
| moon*<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| mpitems<br />
| <br />
| counts MP restoratives in inventory.<br />
|-<br />
| nuns<br />
| [mp] <br />
| visit the Nunnery for restoration [but only if MP is restored].<br />
|-<br />
| olfact*<br />
| ( none &#124; monster name | [item] list | goals ) [abort] <br />
| tag next monster [that drops all items in list, or your goals].<br />
|-<br />
| putty<br />
| ( none &#124; monster name | [item] list | goals ) [abort] <br />
| tag next monster [that drops all items in list, or your goals].<br />
|-<br />
| pvp<br />
| [ target [, target]... ] <br />
| PvP for dignity or flowers<br />
|-<br />
| pvplog*<br />
| <br />
| summarize PvP results.<br />
|-<br />
| raffle<br />
| ticketsToBuy [ inventory &#124; storage ] <br />
| buy raffle tickets<br />
|-<br />
| recover*<br />
| hp &#124; health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| remedy[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| restore*<br />
| hp &#124; health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| safe<br />
| location <br />
| show summary data for the specified area.<br />
|-<br />
| send<br />
| item [, item]... to recipient [ &#124;| message ] <br />
| send kmail<br />
|-<br />
| shrug[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| skill[?]<br />
| [ [count] skill [on player] ] <br />
| list spells, or use one.<br />
|-<br />
| skills<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| sleep<br />
| number <br />
| rest on your clan sofa for number turns.<br />
|-<br />
| soak<br />
| <br />
| soak in your clan's hot tub<br />
|-<br />
| sofa<br />
| number <br />
| rest on your clan sofa for number turns.<br />
|-<br />
| spade<br />
| [prices URL] <br />
| submit automatically gathered data.<br />
|-<br />
| status<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| styx<br />
| muscle &#124; mysticality | moxie <br />
| get daily Styx Pixie buff.<br />
|-<br />
| summary<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| summon<br />
| demonName &#124; effect &#124; location &#124; number <br />
| use the Summoning Chamber.<br />
|-<br />
| text<br />
| URL <br />
| show text results from visiting URL.<br />
|-<br />
| train<br />
| base weight &#124; buffed weight | turns number <br />
| train familiar.<br />
|-<br />
| uneffect[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| unequip<br />
| slot &#124; name <br />
| remove equipment in slot, or that matches name<br />
|-<br />
| up?<br />
| effect [, effect]... <br />
| extend duration of effects.<br />
|-<br />
| wiki<br />
| searchText <br />
| perform search on KoL Wiki.<br />
|-<br />
| win<br />
| game <br />
| I'm as surprised as you! I didn't think it was possible.<br />
|}</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=CLI_Reference&diff=2917CLI Reference2009-08-30T16:16:00Z<p>HippoKing: reordered partly</p>
<hr />
<div>The KoLmafia Graphical CLI is one of the most helpful features it has. This page is intended to provide information on the commands available.<br />
<br />
<br />
==Inventory and Consumption Management==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command<br />
! Arguments<br />
! Description<br />
|-<br />
| *brewery*[?]<br />
| [ daily special &#124; item ] <br />
| show daily special [or consume it or other restaurant item].<br />
|-<br />
| *kitchen*[?]<br />
| item <br />
| consumes item at Hell's Kitchen, if available.<br />
|-<br />
| acquire<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| bake<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| chew[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| cleanup<br />
| <br />
| use, pulverize, or autosell your junk items.<br />
|-<br />
| closet<br />
| list filter &#124; put item... | take item... <br />
| list or manipulate your closet.<br />
|-<br />
| create<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| display<br />
| [filter] &#124; put item... | take item... <br />
| list or manipulate your display case.<br />
|-<br />
| eat[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| equip<br />
| [list filter] &#124; [slot] item <br />
| show equipment, or equip item [in slot].<br />
|}<br />
<br />
==Quests==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command Name<br />
! Arguments<br />
! Description<br />
|-<br />
| !<br />
| <br />
| list the Dungeons of Doom potions you've identified.<br />
|-<br />
| bang<br />
| <br />
| list the Dungeons of Doom potions you've identified.<br />
|-<br />
| chamber<br />
| <br />
| automatically complete quest.<br />
|-<br />
| council<br />
| <br />
| visit the Council to advance quest progress.<br />
|-<br />
| dusty<br />
| <br />
| list the dusty bottles of wine you've identified.<br />
|-<br />
| entryway<br />
| [clover] <br />
| automatically complete quest [using a clover].<br />
|-<br />
| factory<br />
| report digits <br />
| Given a string of 7 dwarven digits, report on factory.<br />
|}<br />
<br />
==Capitalism==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command Name<br />
! Arguments<br />
! Description<br />
|-<br />
| automall<br />
| <br />
| dump all profitable, non-memento items into the Mall.<br />
|-<br />
| autosell<br />
| item [, item]... <br />
| autosell items.<br />
|-<br />
| buy<br />
| item [@ limit] [, another]... <br />
| buy from NPC store or the Mall.<br />
|-<br />
| cheapest[?]<br />
| [+]item [,[-]item]... [; cmds] <br />
| compare prices, do cmds with "it" replaced with best.<br />
|-<br />
| expensive[?]<br />
| [+]item [,[-]item]... [; cmds]<br />
| compare prices, do cmds with "it" replaced with best.<br />
|}<br />
<br />
<br />
==Mafia==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command Name<br />
! Arguments<br />
! Description<br />
|-<br />
| adv*[?]<br />
| last &#124; [count] location <br />
| spend your turns.<br />
|-<br />
| abort<br />
| [message] <br />
| stop current script or automated task.<br />
|-<br />
| alias<br />
| [ word => expansion ] <br />
| list or create CLI abbreviations.<br />
|-<br />
| ash<br />
| statement <br />
| test a line of ASH code without having to edit a script.<br />
|-<br />
| ashref<br />
| [filter] <br />
| summarize ASH built-in functions [matching filter].<br />
|-<br />
| backtrace<br />
| text &#124; off <br />
| dump stack when a gCLI message or page URL matches text (case-sensitive).<br />
|-<br />
| breakfast<br />
| <br />
| perform start-of-day activities.<br />
|-<br />
| budget<br />
| [number] <br />
| show [or set] the number of budgeted Hagnk's pulls.<br />
|-<br />
| buffbot<br />
| number <br />
| run buffbot for number iterations.<br />
|-<br />
| call<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| ccs<br />
| [script] <br />
| show [or select] Custom Combat Script in use.<br />
|-<br />
| cecho<br />
| color text <br />
| show text using color (specified by name or #RRGGBB).<br />
|-<br />
| chat<br />
| <br />
| switch to tab or open window<br />
|-<br />
| check<br />
| hp &#124; health &#124; mp &#124; mana &#124; both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| checkpoint<br />
| <br />
| remembers current equipment, use "outfit checkpoint" to restore.<br />
|-<br />
| clear<br />
| <br />
| clear CLI window.<br />
|-<br />
| cls<br />
| <br />
| clear CLI window.<br />
|-<br />
| condition*<br />
| clear &#124; check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| condref<br />
| <br />
| list conditions usable with if/while commands.<br />
|-<br />
| counters<br />
| [ clear &#124; add number [title img] ] <br />
| show, clear, or add to current turn counters.<br />
|-<br />
| debug<br />
| [on] &#124; off <br />
| start or stop logging of debugging data.<br />
|-<br />
| disable<br />
| all &#124; command [, command]... <br />
| allow/deny CLI commands.<br />
|-<br />
| events<br />
| [clear] <br />
| clear or show recent events.<br />
|-<br />
| exec*<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| exit<br />
| <br />
| logout and exit KoLmafia.<br />
|}<br />
<br />
<br />
==Scripting==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command Name<br />
! Arguments<br />
! Description<br />
|-<br />
| <inline-ash-script><br />
| <br />
| embed an ASH script in a CLI script.<br />
|-<br />
| cecho<br />
| color text <br />
| show text using color (specified by name or #RRGGBB).<br />
|-<br />
| colorecho<br />
| color text <br />
| show text using color (specified by name or #RRGGBB).<br />
|-<br />
| echo<br />
| timestamp &#124; text <br />
| include timestamp or text in the session log.<br />
|-<br />
| else<br />
| ; commands <br />
| do commands if preceding if/while/try didn't execute.<br />
|-<br />
| elseif<br />
| condition; commands <br />
| do if condition is true but preceding condition was false.<br />
|}<br />
<br />
<br />
==Other==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command Name<br />
! Arguments<br />
! Description<br />
|-<br />
| *.php*<br />
| <br />
| visit URL without showing results.<br />
|-<br />
| *mirror*<br />
| [filename] <br />
| stop [or start] logging to an additional file.<br />
|-<br />
| aa<br />
| skill <br />
| set default attack method.<br />
|-<br />
| attack<br />
| [ target [, target]... ] <br />
| PvP for dignity or flowers<br />
|-<br />
| autoattack<br />
| skill <br />
| set default attack method.<br />
|-<br />
| basement<br />
| <br />
| check Fernswarthy's Basement status.<br />
|-<br />
| burn<br />
| extra &#124; * &#124; num &#124; -num<br />
| use excess/all/specified/all but specified MP for buff extension and summons.<br />
|-<br />
| camp*<br />
| rest &#124; etc. [numTimes] <br />
| perform campground actions.<br />
|-<br />
| cast[?]<br />
| [ [count] skill [on player] ] <br />
| list spells, or use one.<br />
|-<br />
| clan<br />
| [ snapshot &#124; stashlog ] <br />
| clan management.<br />
|-<br />
| csend<br />
| item [, item]... to recipient [ &#124;| message ] <br />
| send kmail<br />
|-<br />
| demons<br />
| <br />
| list the demon names you know.<br />
|-<br />
| donate<br />
| boris &#124; mus | jarl | mys | pete | mox amount <br />
| donate in Hall of Legends.<br />
|-<br />
| drink[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| effects<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| enable<br />
| all &#124; command [, command]... <br />
| allow/deny CLI commands.<br />
|-<br />
| encounters<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| entity<br />
| <br />
| give details of your current pastamancer combat entity.<br />
|-<br />
| familiar[?]<br />
| [list filter] &#124; lock | unlock | species | none <br />
| list or change familiar types<br />
|-<br />
| field<br />
| [ plant square type &#124; pick square | harvest ] <br />
| view or use your mushroom plot<br />
|-<br />
| find<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| flowers<br />
| <br />
| commit random acts of PvP.<br />
|-<br />
| fold[?]<br />
| item <br />
| produce item by using another form, repeated as needed.<br />
|-<br />
| forum*<br />
| <br />
| visit the official KoL forums.<br />
|-<br />
| friars<br />
| [blessing] food &#124; familiar | booze <br />
| get daily blessing.<br />
|-<br />
| galaktik(hp&#124;mp)<br />
| [amount] <br />
| restore some or all hp or mp<br />
|-<br />
| gc<br />
| <br />
| force Java garbage collection.<br />
|-<br />
| gear<br />
| <br />
| switch to tab or open window<br />
|-<br />
| get<br />
| preference [ = value ] <br />
| show/change preference settings<br />
|-<br />
| ghost[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| goal*<br />
| clear &#124; check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| gourd<br />
| <br />
| automatically complete quest.<br />
|-<br />
| grandpa<br />
| query <br />
| Ask Grandpa about something.<br />
|-<br />
| guardians<br />
| <br />
| automatically complete quest.<br />
|-<br />
| guild<br />
| <br />
| automatically complete quest.<br />
|-<br />
| hagnk<br />
| outfit name &#124; item [, item]... <br />
| pull items from Hagnk's storage.<br />
|-<br />
| hedge*<br />
| <br />
| automatically complete quest.<br />
|-<br />
| help<br />
| [filter] <br />
| list CLI commands [that match filter].<br />
|-<br />
| hermit[?]<br />
| [item] <br />
| get clover status, or trade for item.<br />
|-<br />
| hiddencity<br />
| square [temple&#124;altar item] <br />
| set Hidden City square [and perform an action there].<br />
|-<br />
| hobo[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| holiday<br />
| HolidayName <br />
| enable special processing for unpredicted holidays.<br />
|-<br />
| hottub<br />
| <br />
| soak in your clan's hot tub<br />
|-<br />
| http:*<br />
| <br />
| visit URL without showing results.<br />
|-<br />
| if<br />
| condition; commands <br />
| do commands once if condition is true (see condref).<br />
|-<br />
| insults<br />
| <br />
| list the pirate insult comebacks you know.<br />
|-<br />
| inv*<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| item<br />
| <br />
| switch to tab or open window<br />
|-<br />
| junk<br />
| <br />
| use, pulverize, or autosell your junk items.<br />
|-<br />
| kmail<br />
| item [, item]... to recipient [ &#124;| message ] <br />
| send kmail<br />
|-<br />
| later<br />
| commands <br />
| adds a button to do commands to the Daily Deeds list.<br />
|-<br />
| leaflet<br />
| [nomagic] &#124; location | command <br />
| complete leaflet quest [without using magic words].<br />
|-<br />
| load<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| locations<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| log<br />
| [status],[equipment],[effects],[etc.] <br />
| record data, "log snapshot" for all common data.<br />
|-<br />
| logecho<br />
| timestamp &#124; text <br />
| include timestamp or text in the session log only.<br />
|-<br />
| login<br />
| username <br />
| logout then log back in as username.<br />
|-<br />
| logout<br />
| <br />
| logout and return to login window.<br />
|-<br />
| logprint<br />
| timestamp &#124; text <br />
| include timestamp or text in the session log only.<br />
|-<br />
| lookup<br />
| item &#124; effect <br />
| go to appropriate KoL Wiki page.<br />
|-<br />
| mail<br />
| <br />
| switch to tab or open window<br />
|-<br />
| make<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| mallbuy<br />
| item [@ limit] [, another]... <br />
| buy from NPC store or the Mall.<br />
|-<br />
| mallsell<br />
| item [[@] price [[limit] num]] [, another]... <br />
| sell in Mall.<br />
|-<br />
| [+&#124;-|weight]<br />
| keyword, ... <br />
| run the Modifier Maximizer.<br />
|-<br />
| maze<br />
| <br />
| automatically complete quest.<br />
|-<br />
| mcd<br />
| number <br />
| set mind control device (or equivalent) to new value.<br />
|-<br />
| mind-control<br />
| number <br />
| set mind control device (or equivalent) to new value.<br />
|-<br />
| mix<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| modifies<br />
| filter <br />
| list all possible sources of modifiers matching filter.<br />
|-<br />
| modref<br />
| [object] <br />
| list all modifiers, show values for player [and object].<br />
|-<br />
| modtrace<br />
| filter <br />
| list everything that adds to modifiers matching filter.<br />
|-<br />
| moleref<br />
| <br />
| Path of the Mole spoilers.<br />
|-<br />
| monsters<br />
| location <br />
| show combat details for the specified area.<br />
|-<br />
| mood*<br />
| clear &#124; autofill | execute | repeat [numTimes] | moodName [numTimes] <br />
| mood management.<br />
|-<br />
| moon*<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| mpitems<br />
| <br />
| counts MP restoratives in inventory.<br />
|-<br />
| namespace<br />
| [filter] <br />
| list namespace scripts and the functions they define.<br />
|-<br />
| nemesis<br />
| <br />
| automatically complete quest.<br />
|-<br />
| nuns<br />
| [mp] <br />
| visit the Nunnery for restoration [but only if MP is restored].<br />
|-<br />
| objective*<br />
| clear &#124; check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| olfact*<br />
| ( none &#124; monster name | [item] list | goals ) [abort] <br />
| tag next monster [that drops all items in list, or your goals].<br />
|-<br />
| opt*<br />
| <br />
| switch to tab or open window<br />
|-<br />
| outfit<br />
| [list filter] &#124; save name | checkpoint | name <br />
| list, save, restore, or change outfits.<br />
|-<br />
| overdrink[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| pause<br />
| [seconds] <br />
| pause script execution (default 1 second).<br />
|-<br />
| ply<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| print<br />
| timestamp &#124; text <br />
| include timestamp or text in the session log.<br />
|-<br />
| priphea<br />
| <br />
| launch KoLmafia GUI.<br />
|-<br />
| pull<br />
| outfit name &#124; item [, item]... <br />
| pull items from Hagnk's storage.<br />
|-<br />
| pulverize<br />
| item [, item]... <br />
| pulverize specified items<br />
|-<br />
| putty<br />
| ( none &#124; monster name | [item] list | goals ) [abort] <br />
| tag next monster [that drops all items in list, or your goals].<br />
|-<br />
| pvp<br />
| [ target [, target]... ] <br />
| PvP for dignity or flowers<br />
|-<br />
| pvplog*<br />
| <br />
| summarize PvP results.<br />
|-<br />
| quark[?]<br />
| [itemList...] <br />
| gain MP by pasting unstable quark with best item from itemList (or your junk list).<br />
|-<br />
| quit<br />
| <br />
| logout and exit KoLmafia.<br />
|-<br />
| radio<br />
| <br />
| switch to tab or open window<br />
|-<br />
| raffle<br />
| ticketsToBuy [ inventory &#124; storage ] <br />
| buy raffle tickets<br />
|-<br />
| recover*<br />
| hp &#124; health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| refresh<br />
| all &#124; status | equip | inv | storage | familiar | stickers <br />
| resynchronize with KoL.<br />
|-<br />
| relay<br />
| <br />
| open the relay browser.<br />
|-<br />
| remedy[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| remove<br />
| slot &#124; name <br />
| remove equipment in slot, or that matches name<br />
|-<br />
| repeat<br />
| [number] <br />
| repeat previous line [number times].<br />
|-<br />
| reprice<br />
| <br />
| price all max-priced items at or below current Mall minimum price.<br />
|-<br />
| restaurant[?]<br />
| [ daily special &#124; item ] <br />
| show daily special [or consume it or other restaurant item].<br />
|-<br />
| restore*<br />
| hp &#124; health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| retrieve<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| run<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| safe<br />
| location <br />
| show summary data for the specified area.<br />
|-<br />
| save<br />
| as mood <br />
| add your current effects to the mood.<br />
|-<br />
| searchmall<br />
| item [ with limit number ] <br />
| search the Mall.<br />
|-<br />
| sell<br />
| item [, item]... <br />
| autosell items.<br />
|-<br />
| send<br />
| item [, item]... to recipient [ &#124;| message ] <br />
| send kmail<br />
|-<br />
| session<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| set<br />
| preference [ = value ] <br />
| show/change preference settings<br />
|-<br />
| shrug[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| skill[?]<br />
| [ [count] skill [on player] ] <br />
| list spells, or use one.<br />
|-<br />
| skills<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| sleep<br />
| number <br />
| rest on your clan sofa for number turns.<br />
|-<br />
| slimeling[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| smash<br />
| item [, item]... <br />
| pulverize specified items<br />
|-<br />
| smith<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| soak<br />
| <br />
| soak in your clan's hot tub<br />
|-<br />
| sofa<br />
| number <br />
| rest on your clan sofa for number turns.<br />
|-<br />
| spade<br />
| [prices URL] <br />
| submit automatically gathered data.<br />
|-<br />
| speculate<br />
| MCD num &#124; equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...] <br />
| predict modifiers.<br />
|-<br />
| squeeze[?]<br />
| item <br />
| produce item by using another form, repeated as needed.<br />
|-<br />
| start<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| stash<br />
| [put] item... &#124; take item... <br />
| exchange items with clan stash<br />
|-<br />
| status<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| sticker*<br />
| sticker1 [, sticker2 [, sticker3]] <br />
| replace worn stickers.<br />
|-<br />
| storage<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| styx<br />
| muscle &#124; mysticality | moxie <br />
| get daily Styx Pixie buff.<br />
|-<br />
| summary<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| summon<br />
| demonName &#124; effect | location | number <br />
| use the Summoning Chamber.<br />
|-<br />
| tavern<br />
| <br />
| automatically complete quest.<br />
|-<br />
| telescope<br />
| [look] high &#124; low <br />
| get daily buff, or Lair hints from your telescope.<br />
|-<br />
| text<br />
| URL <br />
| show text results from visiting URL.<br />
|-<br />
| tinker<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| tower<br />
| <br />
| automatically complete quest.<br />
|-<br />
| train<br />
| base weight &#124; buffed weight | turns number <br />
| train familiar.<br />
|-<br />
| trigger*<br />
| clear &#124; autofill | [type,] effect [, action] <br />
| edit current mood<br />
|-<br />
| try<br />
| ; commands <br />
| do commands, and continue even if an error occurs.<br />
|-<br />
| unalias<br />
| word <br />
| remove a CLI abbreviation.<br />
|-<br />
| undercut<br />
| <br />
| price all max-priced items at or below current Mall minimum price.<br />
|-<br />
| uneffect[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| unequip<br />
| slot &#124; name <br />
| remove equipment in slot, or that matches name<br />
|-<br />
| untinker<br />
| [ item... ] <br />
| complete quest, or untinker items.<br />
|-<br />
| up?<br />
| effect [, effect]... <br />
| extend duration of effects.<br />
|-<br />
| update<br />
| data &#124; clear | prices URL or filename <br />
| download most recent data files, or revert to built-in data.<br />
|-<br />
| use[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| using<br />
| filename <br />
| add ASH script to namespace.<br />
|-<br />
| validate<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| verify<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| version<br />
| <br />
| display KoLmafia version.<br />
|-<br />
| wait<br />
| [seconds] <br />
| pause script execution (default 1 second).<br />
|-<br />
| wear<br />
| [list filter] &#124; [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| whatif<br />
| MCD num &#124; equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...] <br />
| predict modifiers.<br />
|-<br />
| while<br />
| condition; commands <br />
| do commands repeatedly while condition is true.<br />
|-<br />
| wield<br />
| [list filter] &#124; [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| wiki<br />
| searchText <br />
| perform search on KoL Wiki.<br />
|-<br />
| win<br />
| game <br />
| I'm as surprised as you! I didn't think it was possible.<br />
|-<br />
| zap<br />
| item [, item]... <br />
| transform items with your wand.<br />
|}</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=CLI_Reference&diff=2916CLI Reference2009-08-30T15:31:35Z<p>HippoKing: wikies are horrible but I think I finally got the table syntax right</p>
<hr />
<div>The KoLmafia Graphical CLI is one of the most helpful features it has. This page is intended to provide information on the commands available.<br />
<br />
==Inventory Management==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command<br />
! Arguments<br />
! Description<br />
|-<br />
| acquire<br />
| item<br />
| Ensures you have argument item, making or buying when necessary.<br />
|}<br />
<br />
==Quests==<br />
<br />
==Market Management==<br />
<br />
==Mafia==<br />
<br />
==Other==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command Name<br />
! Arguments<br />
! Description<br />
|-<br />
| !<br />
| <br />
| list the Dungeons of Doom potions you've identified.<br />
|-<br />
| *.php*<br />
| <br />
| visit URL without showing results.<br />
|-<br />
| *brewery*[?]<br />
| [ daily special &#124; item ] <br />
| show daily special [or consume it or other restaurant item].<br />
|-<br />
| *kitchen*[?]<br />
| item <br />
| consumes item at Hell's Kitchen, if available.<br />
|-<br />
| *mirror*<br />
| [filename] <br />
| stop [or start] logging to an additional file.<br />
|-<br />
| <inline-ash-script><br />
| <br />
| embed an ASH script in a CLI script.<br />
|-<br />
| aa<br />
| skill <br />
| set default attack method.<br />
|-<br />
| abort<br />
| [message] <br />
| stop current script or automated task.<br />
|-<br />
| acquire<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| adv*[?]<br />
| last &#124; [count] location <br />
| spend your turns.<br />
|-<br />
| alias<br />
| [ word => expansion ] <br />
| list or create CLI abbreviations.<br />
|-<br />
| ash<br />
| statement <br />
| test a line of ASH code without having to edit a script.<br />
|-<br />
| ashref<br />
| [filter] <br />
| summarize ASH built-in functions [matching filter].<br />
|-<br />
| attack<br />
| [ target [, target]... ] <br />
| PvP for dignity or flowers<br />
|-<br />
| autoattack<br />
| skill <br />
| set default attack method.<br />
|-<br />
| automall<br />
| <br />
| dump all profitable, non-memento items into the Mall.<br />
|-<br />
| autosell<br />
| item [, item]... <br />
| autosell items.<br />
|-<br />
| backtrace<br />
| text &#124; off <br />
| dump stack when a gCLI message or page URL matches text (case-sensitive).<br />
|-<br />
| bake<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| bang<br />
| <br />
| list the Dungeons of Doom potions you've identified.<br />
|-<br />
| basement<br />
| <br />
| check Fernswarthy's Basement status.<br />
|-<br />
| breakfast<br />
| <br />
| perform start-of-day activities.<br />
|-<br />
| budget<br />
| [number] <br />
| show [or set] the number of budgeted Hagnk's pulls.<br />
|-<br />
| buffbot<br />
| number <br />
| run buffbot for number iterations.<br />
|-<br />
| -num<br />
| <br />
| use excess/all/specified/all but specified MP for buff extension and summons.<br />
|-<br />
| buy<br />
| item [@ limit] [, another]... <br />
| buy from NPC store or the Mall.<br />
|-<br />
| call<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| camp*<br />
| rest &#124; etc. [numTimes] <br />
| perform campground actions.<br />
|-<br />
| cast[?]<br />
| [ [count] skill [on player] ] <br />
| list spells, or use one.<br />
|-<br />
| ccs<br />
| [script] <br />
| show [or select] Custom Combat Script in use.<br />
|-<br />
| cecho<br />
| color text <br />
| show text using color (specified by name or #RRGGBB).<br />
|-<br />
| chamber<br />
| <br />
| automatically complete quest.<br />
|-<br />
| chat<br />
| <br />
| switch to tab or open window<br />
|-<br />
| [,[-]item]...<br />
| [; cmds] <br />
| compare prices, do cmds with "it" replaced with best.<br />
|-<br />
| check<br />
| hp &#124; health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| checkpoint<br />
| <br />
| remembers current equipment, use "outfit checkpoint" to restore.<br />
|-<br />
| chew[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| clan<br />
| [ snapshot &#124; stashlog ] <br />
| clan management.<br />
|-<br />
| cleanup<br />
| <br />
| use, pulverize, or autosell your junk items.<br />
|-<br />
| clear<br />
| <br />
| clear CLI window.<br />
|-<br />
| closet<br />
| list filter &#124; put item... | take item... <br />
| list or manipulate your closet.<br />
|-<br />
| cls<br />
| <br />
| clear CLI window.<br />
|-<br />
| colorecho<br />
| color text <br />
| show text using color (specified by name or #RRGGBB).<br />
|-<br />
| condition*<br />
| clear &#124; check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| condref<br />
| <br />
| list conditions usable with if/while commands.<br />
|-<br />
| council<br />
| <br />
| visit the Council to advance quest progress.<br />
|-<br />
| counters<br />
| [ clear &#124; add number [title img] ] <br />
| show, clear, or add to current turn counters.<br />
|-<br />
| create<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| csend<br />
| item [, item]... to recipient [ &#124;| message ] <br />
| send kmail<br />
|-<br />
| debug<br />
| [on] &#124; off <br />
| start or stop logging of debugging data.<br />
|-<br />
| demons<br />
| <br />
| list the demon names you know.<br />
|-<br />
| disable<br />
| all &#124; command [, command]... <br />
| allow/deny CLI commands.<br />
|-<br />
| display<br />
| [filter] &#124; put item... | take item... <br />
| list or manipulate your display case.<br />
|-<br />
| donate<br />
| boris &#124; mus | jarl | mys | pete | mox amount <br />
| donate in Hall of Legends.<br />
|-<br />
| drink[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| dusty<br />
| <br />
| list the dusty bottles of wine you've identified.<br />
|-<br />
| eat[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| echo<br />
| timestamp &#124; text <br />
| include timestamp or text in the session log.<br />
|-<br />
| effects<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| else<br />
| ; commands <br />
| do commands if preceding if/while/try didn't execute.<br />
|-<br />
| elseif<br />
| condition; commands <br />
| do if condition is true but preceding condition was false.<br />
|-<br />
| enable<br />
| all &#124; command [, command]... <br />
| allow/deny CLI commands.<br />
|-<br />
| encounters<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| entity<br />
| <br />
| give details of your current pastamancer combat entity.<br />
|-<br />
| entryway<br />
| [clover] <br />
| automatically complete quest [using a clover].<br />
|-<br />
| equip<br />
| [list filter] &#124; [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| events<br />
| [clear] <br />
| clear or show recent events.<br />
|-<br />
| exec*<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| exit<br />
| <br />
| logout and exit KoLmafia.<br />
|-<br />
| [,[-]item]...<br />
| [; cmds] <br />
| compare prices, do cmds with "it" replaced with best.<br />
|-<br />
| factory<br />
| report digits <br />
| Given a string of 7 dwarven digits, report on factory.<br />
|-<br />
| familiar[?]<br />
| [list filter] &#124; lock | unlock | species | none <br />
| list or change familiar types<br />
|-<br />
| field<br />
| [ plant square type &#124; pick square | harvest ] <br />
| view or use your mushroom plot<br />
|-<br />
| find<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| flowers<br />
| <br />
| commit random acts of PvP.<br />
|-<br />
| fold[?]<br />
| item <br />
| produce item by using another form, repeated as needed.<br />
|-<br />
| forum*<br />
| <br />
| visit the official KoL forums.<br />
|-<br />
| friars<br />
| [blessing] food &#124; familiar | booze <br />
| get daily blessing.<br />
|-<br />
| galaktik(hp&#124;mp)<br />
| [amount] <br />
| restore some or all hp or mp<br />
|-<br />
| gc<br />
| <br />
| force Java garbage collection.<br />
|-<br />
| gear<br />
| <br />
| switch to tab or open window<br />
|-<br />
| get<br />
| preference [ = value ] <br />
| show/change preference settings<br />
|-<br />
| ghost[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| goal*<br />
| clear &#124; check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| gourd<br />
| <br />
| automatically complete quest.<br />
|-<br />
| grandpa<br />
| query <br />
| Ask Grandpa about something.<br />
|-<br />
| guardians<br />
| <br />
| automatically complete quest.<br />
|-<br />
| guild<br />
| <br />
| automatically complete quest.<br />
|-<br />
| hagnk<br />
| outfit name &#124; item [, item]... <br />
| pull items from Hagnk's storage.<br />
|-<br />
| hedge*<br />
| <br />
| automatically complete quest.<br />
|-<br />
| help<br />
| [filter] <br />
| list CLI commands [that match filter].<br />
|-<br />
| hermit[?]<br />
| [item] <br />
| get clover status, or trade for item.<br />
|-<br />
| hiddencity<br />
| square [temple&#124;altar item] <br />
| set Hidden City square [and perform an action there].<br />
|-<br />
| hobo[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| holiday<br />
| HolidayName <br />
| enable special processing for unpredicted holidays.<br />
|-<br />
| hottub<br />
| <br />
| soak in your clan's hot tub<br />
|-<br />
| http:*<br />
| <br />
| visit URL without showing results.<br />
|-<br />
| if<br />
| condition; commands <br />
| do commands once if condition is true (see condref).<br />
|-<br />
| insults<br />
| <br />
| list the pirate insult comebacks you know.<br />
|-<br />
| inv*<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| item<br />
| <br />
| switch to tab or open window<br />
|-<br />
| junk<br />
| <br />
| use, pulverize, or autosell your junk items.<br />
|-<br />
| kmail<br />
| item [, item]... to recipient [ &#124;| message ] <br />
| send kmail<br />
|-<br />
| later<br />
| commands <br />
| adds a button to do commands to the Daily Deeds list.<br />
|-<br />
| leaflet<br />
| [nomagic] &#124; location | command <br />
| complete leaflet quest [without using magic words].<br />
|-<br />
| load<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| locations<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| log<br />
| [status],[equipment],[effects],[etc.] <br />
| record data, "log snapshot" for all common data.<br />
|-<br />
| logecho<br />
| timestamp &#124; text <br />
| include timestamp or text in the session log only.<br />
|-<br />
| login<br />
| username <br />
| logout then log back in as username.<br />
|-<br />
| logout<br />
| <br />
| logout and return to login window.<br />
|-<br />
| logprint<br />
| timestamp &#124; text <br />
| include timestamp or text in the session log only.<br />
|-<br />
| lookup<br />
| item &#124; effect <br />
| go to appropriate KoL Wiki page.<br />
|-<br />
| mail<br />
| <br />
| switch to tab or open window<br />
|-<br />
| make<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| mallbuy<br />
| item [@ limit] [, another]... <br />
| buy from NPC store or the Mall.<br />
|-<br />
| mallsell<br />
| item [[@] price [[limit] num]] [, another]... <br />
| sell in Mall.<br />
|-<br />
| [+&#124;-|weight]<br />
| keyword, ... <br />
| run the Modifier Maximizer.<br />
|-<br />
| maze<br />
| <br />
| automatically complete quest.<br />
|-<br />
| mcd<br />
| number <br />
| set mind control device (or equivalent) to new value.<br />
|-<br />
| mind-control<br />
| number <br />
| set mind control device (or equivalent) to new value.<br />
|-<br />
| mix<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| modifies<br />
| filter <br />
| list all possible sources of modifiers matching filter.<br />
|-<br />
| modref<br />
| [object] <br />
| list all modifiers, show values for player [and object].<br />
|-<br />
| modtrace<br />
| filter <br />
| list everything that adds to modifiers matching filter.<br />
|-<br />
| moleref<br />
| <br />
| Path of the Mole spoilers.<br />
|-<br />
| monsters<br />
| location <br />
| show combat details for the specified area.<br />
|-<br />
| mood*<br />
| clear &#124; autofill | execute | repeat [numTimes] | moodName [numTimes] <br />
| mood management.<br />
|-<br />
| moon*<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| mpitems<br />
| <br />
| counts MP restoratives in inventory.<br />
|-<br />
| namespace<br />
| [filter] <br />
| list namespace scripts and the functions they define.<br />
|-<br />
| nemesis<br />
| <br />
| automatically complete quest.<br />
|-<br />
| nuns<br />
| [mp] <br />
| visit the Nunnery for restoration [but only if MP is restored].<br />
|-<br />
| objective*<br />
| clear &#124; check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| olfact*<br />
| ( none &#124; monster name | [item] list | goals ) [abort] <br />
| tag next monster [that drops all items in list, or your goals].<br />
|-<br />
| opt*<br />
| <br />
| switch to tab or open window<br />
|-<br />
| outfit<br />
| [list filter] &#124; save name | checkpoint | name <br />
| list, save, restore, or change outfits.<br />
|-<br />
| overdrink[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| pause<br />
| [seconds] <br />
| pause script execution (default 1 second).<br />
|-<br />
| ply<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| print<br />
| timestamp &#124; text <br />
| include timestamp or text in the session log.<br />
|-<br />
| priphea<br />
| <br />
| launch KoLmafia GUI.<br />
|-<br />
| pull<br />
| outfit name &#124; item [, item]... <br />
| pull items from Hagnk's storage.<br />
|-<br />
| pulverize<br />
| item [, item]... <br />
| pulverize specified items<br />
|-<br />
| putty<br />
| ( none &#124; monster name | [item] list | goals ) [abort] <br />
| tag next monster [that drops all items in list, or your goals].<br />
|-<br />
| pvp<br />
| [ target [, target]... ] <br />
| PvP for dignity or flowers<br />
|-<br />
| pvplog*<br />
| <br />
| summarize PvP results.<br />
|-<br />
| quark[?]<br />
| [itemList...] <br />
| gain MP by pasting unstable quark with best item from itemList (or your junk list).<br />
|-<br />
| quit<br />
| <br />
| logout and exit KoLmafia.<br />
|-<br />
| radio<br />
| <br />
| switch to tab or open window<br />
|-<br />
| raffle<br />
| ticketsToBuy [ inventory &#124; storage ] <br />
| buy raffle tickets<br />
|-<br />
| recover*<br />
| hp &#124; health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| refresh<br />
| all &#124; status | equip | inv | storage | familiar | stickers <br />
| resynchronize with KoL.<br />
|-<br />
| relay<br />
| <br />
| open the relay browser.<br />
|-<br />
| remedy[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| remove<br />
| slot &#124; name <br />
| remove equipment in slot, or that matches name<br />
|-<br />
| repeat<br />
| [number] <br />
| repeat previous line [number times].<br />
|-<br />
| reprice<br />
| <br />
| price all max-priced items at or below current Mall minimum price.<br />
|-<br />
| restaurant[?]<br />
| [ daily special &#124; item ] <br />
| show daily special [or consume it or other restaurant item].<br />
|-<br />
| restore*<br />
| hp &#124; health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| retrieve<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| run<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| safe<br />
| location <br />
| show summary data for the specified area.<br />
|-<br />
| save<br />
| as mood <br />
| add your current effects to the mood.<br />
|-<br />
| searchmall<br />
| item [ with limit number ] <br />
| search the Mall.<br />
|-<br />
| sell<br />
| item [, item]... <br />
| autosell items.<br />
|-<br />
| send<br />
| item [, item]... to recipient [ &#124;| message ] <br />
| send kmail<br />
|-<br />
| session<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| set<br />
| preference [ = value ] <br />
| show/change preference settings<br />
|-<br />
| shrug[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| skill[?]<br />
| [ [count] skill [on player] ] <br />
| list spells, or use one.<br />
|-<br />
| skills<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| sleep<br />
| number <br />
| rest on your clan sofa for number turns.<br />
|-<br />
| slimeling[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| smash<br />
| item [, item]... <br />
| pulverize specified items<br />
|-<br />
| smith<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| soak<br />
| <br />
| soak in your clan's hot tub<br />
|-<br />
| sofa<br />
| number <br />
| rest on your clan sofa for number turns.<br />
|-<br />
| spade<br />
| [prices URL] <br />
| submit automatically gathered data.<br />
|-<br />
| speculate<br />
| MCD num &#124; equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...] <br />
| predict modifiers.<br />
|-<br />
| squeeze[?]<br />
| item <br />
| produce item by using another form, repeated as needed.<br />
|-<br />
| start<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| stash<br />
| [put] item... &#124; take item... <br />
| exchange items with clan stash<br />
|-<br />
| status<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| sticker*<br />
| sticker1 [, sticker2 [, sticker3]] <br />
| replace worn stickers.<br />
|-<br />
| storage<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| styx<br />
| muscle &#124; mysticality | moxie <br />
| get daily Styx Pixie buff.<br />
|-<br />
| summary<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| summon<br />
| demonName &#124; effect | location | number <br />
| use the Summoning Chamber.<br />
|-<br />
| tavern<br />
| <br />
| automatically complete quest.<br />
|-<br />
| telescope<br />
| [look] high &#124; low <br />
| get daily buff, or Lair hints from your telescope.<br />
|-<br />
| text<br />
| URL <br />
| show text results from visiting URL.<br />
|-<br />
| tinker<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| tower<br />
| <br />
| automatically complete quest.<br />
|-<br />
| train<br />
| base weight &#124; buffed weight | turns number <br />
| train familiar.<br />
|-<br />
| trigger*<br />
| clear &#124; autofill | [type,] effect [, action] <br />
| edit current mood<br />
|-<br />
| try<br />
| ; commands <br />
| do commands, and continue even if an error occurs.<br />
|-<br />
| unalias<br />
| word <br />
| remove a CLI abbreviation.<br />
|-<br />
| undercut<br />
| <br />
| price all max-priced items at or below current Mall minimum price.<br />
|-<br />
| uneffect[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| unequip<br />
| slot &#124; name <br />
| remove equipment in slot, or that matches name<br />
|-<br />
| untinker<br />
| [ item... ] <br />
| complete quest, or untinker items.<br />
|-<br />
| up?<br />
| effect [, effect]... <br />
| extend duration of effects.<br />
|-<br />
| update<br />
| data &#124; clear | prices URL or filename <br />
| download most recent data files, or revert to built-in data.<br />
|-<br />
| use[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| using<br />
| filename <br />
| add ASH script to namespace.<br />
|-<br />
| validate<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| verify<br />
| [numberx] filename &#124; function [parameters] <br />
| check/run script.<br />
|-<br />
| version<br />
| <br />
| display KoLmafia version.<br />
|-<br />
| wait<br />
| [seconds] <br />
| pause script execution (default 1 second).<br />
|-<br />
| wear<br />
| [list filter] &#124; [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| whatif<br />
| MCD num &#124; equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...] <br />
| predict modifiers.<br />
|-<br />
| while<br />
| condition; commands <br />
| do commands repeatedly while condition is true.<br />
|-<br />
| wield<br />
| [list filter] &#124; [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| wiki<br />
| searchText <br />
| perform search on KoL Wiki.<br />
|-<br />
| win<br />
| game <br />
| I'm as surprised as you! I didn't think it was possible.<br />
|-<br />
| zap<br />
| item [, item]... <br />
| transform items with your wand.<br />
|}</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=CLI_Reference&diff=2915CLI Reference2009-08-30T15:23:48Z<p>HippoKing: fixed another issue</p>
<hr />
<div>The KoLmafia Graphical CLI is one of the most helpful features it has. This page is intended to provide information on the commands available.<br />
<br />
==Inventory Management==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command<br />
! Arguments<br />
! Description<br />
|-<br />
| acquire<br />
| item<br />
| Ensures you have argument item, making or buying when necessary.<br />
|}<br />
<br />
==Quests==<br />
<br />
==Market Management==<br />
<br />
==Mafia==<br />
<br />
==Other==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command Name<br />
! Arguments<br />
! Description<br />
|-<br />
| !<br />
| <br />
| list the Dungeons of Doom potions you've identified.<br />
|-<br />
| *.php*<br />
| <br />
| visit URL without showing results.<br />
|-<br />
| *brewery*[?]<br />
| [ daily special | item ] <br />
| show daily special [or consume it or other restaurant item].<br />
|-<br />
| *kitchen*[?]<br />
| item <br />
| consumes item at Hell's Kitchen, if available.<br />
|-<br />
| *mirror*<br />
| [filename] <br />
| stop [or start] logging to an additional file.<br />
|-<br />
| <inline-ash-script><br />
| <br />
| embed an ASH script in a CLI script.<br />
|-<br />
| aa<br />
| skill <br />
| set default attack method.<br />
|-<br />
| abort<br />
| [message] <br />
| stop current script or automated task.<br />
|-<br />
| acquire<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| adv*[?]<br />
| last | [count] location <br />
| spend your turns.<br />
|-<br />
| alias<br />
| [ word => expansion ] <br />
| list or create CLI abbreviations.<br />
|-<br />
| ash<br />
| statement <br />
| test a line of ASH code without having to edit a script.<br />
|-<br />
| ashref<br />
| [filter] <br />
| summarize ASH built-in functions [matching filter].<br />
|-<br />
| attack<br />
| [ target [, target]... ] <br />
| PvP for dignity or flowers<br />
|-<br />
| autoattack<br />
| skill <br />
| set default attack method.<br />
|-<br />
| automall<br />
| <br />
| dump all profitable, non-memento items into the Mall.<br />
|-<br />
| autosell<br />
| item [, item]... <br />
| autosell items.<br />
|-<br />
| backtrace<br />
| text | off <br />
| dump stack when a gCLI message or page URL matches text (case-sensitive).<br />
|-<br />
| bake<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| bang<br />
| <br />
| list the Dungeons of Doom potions you've identified.<br />
|-<br />
| basement<br />
| <br />
| check Fernswarthy's Basement status.<br />
|-<br />
| breakfast<br />
| <br />
| perform start-of-day activities.<br />
|-<br />
| budget<br />
| [number] <br />
| show [or set] the number of budgeted Hagnk's pulls.<br />
|-<br />
| buffbot<br />
| number <br />
| run buffbot for number iterations.<br />
|-<br />
| -num<br />
| <br />
| use excess/all/specified/all but specified MP for buff extension and summons.<br />
|-<br />
| buy<br />
| item [@ limit] [, another]... <br />
| buy from NPC store or the Mall.<br />
|-<br />
| call<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| camp*<br />
| rest | etc. [numTimes] <br />
| perform campground actions.<br />
|-<br />
| cast[?]<br />
| [ [count] skill [on player] ] <br />
| list spells, or use one.<br />
|-<br />
| ccs<br />
| [script] <br />
| show [or select] Custom Combat Script in use.<br />
|-<br />
| cecho<br />
| color text <br />
| show text using color (specified by name or #RRGGBB).<br />
|-<br />
| chamber<br />
| <br />
| automatically complete quest.<br />
|-<br />
| chat<br />
| <br />
| switch to tab or open window<br />
|-<br />
| [,[-]item]...<br />
| [; cmds] <br />
| compare prices, do cmds with "it" replaced with best.<br />
|-<br />
| check<br />
| hp | health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| checkpoint<br />
| <br />
| remembers current equipment, use "outfit checkpoint" to restore.<br />
|-<br />
| chew[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| clan<br />
| [ snapshot | stashlog ] <br />
| clan management.<br />
|-<br />
| cleanup<br />
| <br />
| use, pulverize, or autosell your junk items.<br />
|-<br />
| clear<br />
| <br />
| clear CLI window.<br />
|-<br />
| closet<br />
| list filter | put item... | take item... <br />
| list or manipulate your closet.<br />
|-<br />
| cls<br />
| <br />
| clear CLI window.<br />
|-<br />
| colorecho<br />
| color text <br />
| show text using color (specified by name or #RRGGBB).<br />
|-<br />
| condition*<br />
| clear | check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| condref<br />
| <br />
| list conditions usable with if/while commands.<br />
|-<br />
| council<br />
| <br />
| visit the Council to advance quest progress.<br />
|-<br />
| counters<br />
| [ clear | add number [title img] ] <br />
| show, clear, or add to current turn counters.<br />
|-<br />
| create<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| csend<br />
| item [, item]... to recipient [ | message ] <br />
| send kmail<br />
|-<br />
| debug<br />
| [on] | off <br />
| start or stop logging of debugging data.<br />
|-<br />
| demons<br />
| <br />
| list the demon names you know.<br />
|-<br />
| disable<br />
| all | command [, command]... <br />
| allow/deny CLI commands.<br />
|-<br />
| display<br />
| [filter] | put item... | take item... <br />
| list or manipulate your display case.<br />
|-<br />
| donate<br />
| boris | mus | jarl | mys | pete | mox amount <br />
| donate in Hall of Legends.<br />
|-<br />
| drink[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| dusty<br />
| <br />
| list the dusty bottles of wine you've identified.<br />
|-<br />
| eat[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| echo<br />
| timestamp | text <br />
| include timestamp or text in the session log.<br />
|-<br />
| effects<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| else<br />
| ; commands <br />
| do commands if preceding if/while/try didn't execute.<br />
|-<br />
| elseif<br />
| condition; commands <br />
| do if condition is true but preceding condition was false.<br />
|-<br />
| enable<br />
| all | command [, command]... <br />
| allow/deny CLI commands.<br />
|-<br />
| encounters<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| entity<br />
| <br />
| give details of your current pastamancer combat entity.<br />
|-<br />
| entryway<br />
| [clover] <br />
| automatically complete quest [using a clover].<br />
|-<br />
| equip<br />
| [list filter] | [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| events<br />
| [clear] <br />
| clear or show recent events.<br />
|-<br />
| exec*<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| exit<br />
| <br />
| logout and exit KoLmafia.<br />
|-<br />
| [,[-]item]...<br />
| [; cmds] <br />
| compare prices, do cmds with "it" replaced with best.<br />
|-<br />
| factory<br />
| report digits <br />
| Given a string of 7 dwarven digits, report on factory.<br />
|-<br />
| familiar[?]<br />
| [list filter] | lock | unlock | species | none <br />
| list or change familiar types<br />
|-<br />
| field<br />
| [ plant square type | pick square | harvest ] <br />
| view or use your mushroom plot<br />
|-<br />
| find<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| flowers<br />
| <br />
| commit random acts of PvP.<br />
|-<br />
| fold[?]<br />
| item <br />
| produce item by using another form, repeated as needed.<br />
|-<br />
| forum*<br />
| <br />
| visit the official KoL forums.<br />
|-<br />
| friars<br />
| [blessing] food | familiar | booze <br />
| get daily blessing.<br />
|-<br />
| galaktik(hp|mp)<br />
| [amount] <br />
| restore some or all hp or mp<br />
|-<br />
| gc<br />
| <br />
| force Java garbage collection.<br />
|-<br />
| gear<br />
| <br />
| switch to tab or open window<br />
|-<br />
| get<br />
| preference [ = value ] <br />
| show/change preference settings<br />
|-<br />
| ghost[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| goal*<br />
| clear | check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| gourd<br />
| <br />
| automatically complete quest.<br />
|-<br />
| grandpa<br />
| query <br />
| Ask Grandpa about something.<br />
|-<br />
| guardians<br />
| <br />
| automatically complete quest.<br />
|-<br />
| guild<br />
| <br />
| automatically complete quest.<br />
|-<br />
| hagnk<br />
| outfit name | item [, item]... <br />
| pull items from Hagnk's storage.<br />
|-<br />
| hedge*<br />
| <br />
| automatically complete quest.<br />
|-<br />
| help<br />
| [filter] <br />
| list CLI commands [that match filter].<br />
|-<br />
| hermit[?]<br />
| [item] <br />
| get clover status, or trade for item.<br />
|-<br />
| hiddencity<br />
| square [temple|altar item] <br />
| set Hidden City square [and perform an action there].<br />
|-<br />
| hobo[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| holiday<br />
| HolidayName <br />
| enable special processing for unpredicted holidays.<br />
|-<br />
| hottub<br />
| <br />
| soak in your clan's hot tub<br />
|-<br />
| http:*<br />
| <br />
| visit URL without showing results.<br />
|-<br />
| if<br />
| condition; commands <br />
| do commands once if condition is true (see condref).<br />
|-<br />
| insults<br />
| <br />
| list the pirate insult comebacks you know.<br />
|-<br />
| inv*<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| item<br />
| <br />
| switch to tab or open window<br />
|-<br />
| junk<br />
| <br />
| use, pulverize, or autosell your junk items.<br />
|-<br />
| kmail<br />
| item [, item]... to recipient [ | message ] <br />
| send kmail<br />
|-<br />
| later<br />
| commands <br />
| adds a button to do commands to the Daily Deeds list.<br />
|-<br />
| leaflet<br />
| [nomagic] | location | command <br />
| complete leaflet quest [without using magic words].<br />
|-<br />
| load<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| locations<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| log<br />
| [status],[equipment],[effects],[etc.] <br />
| record data, "log snapshot" for all common data.<br />
|-<br />
| logecho<br />
| timestamp | text <br />
| include timestamp or text in the session log only.<br />
|-<br />
| login<br />
| username <br />
| logout then log back in as username.<br />
|-<br />
| logout<br />
| <br />
| logout and return to login window.<br />
|-<br />
| logprint<br />
| timestamp | text <br />
| include timestamp or text in the session log only.<br />
|-<br />
| lookup<br />
| item | effect <br />
| go to appropriate KoL Wiki page.<br />
|-<br />
| mail<br />
| <br />
| switch to tab or open window<br />
|-<br />
| make<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| mallbuy<br />
| item [@ limit] [, another]... <br />
| buy from NPC store or the Mall.<br />
|-<br />
| mallsell<br />
| item [[@] price [[limit] num]] [, another]... <br />
| sell in Mall.<br />
|-<br />
| [+|-|weight]<br />
| keyword, ... <br />
| run the Modifier Maximizer.<br />
|-<br />
| maze<br />
| <br />
| automatically complete quest.<br />
|-<br />
| mcd<br />
| number <br />
| set mind control device (or equivalent) to new value.<br />
|-<br />
| mind-control<br />
| number <br />
| set mind control device (or equivalent) to new value.<br />
|-<br />
| mix<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| modifies<br />
| filter <br />
| list all possible sources of modifiers matching filter.<br />
|-<br />
| modref<br />
| [object] <br />
| list all modifiers, show values for player [and object].<br />
|-<br />
| modtrace<br />
| filter <br />
| list everything that adds to modifiers matching filter.<br />
|-<br />
| moleref<br />
| <br />
| Path of the Mole spoilers.<br />
|-<br />
| monsters<br />
| location <br />
| show combat details for the specified area.<br />
|-<br />
| mood*<br />
| clear | autofill | execute | repeat [numTimes] | moodName [numTimes] <br />
| mood management.<br />
|-<br />
| moon*<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| mpitems<br />
| <br />
| counts MP restoratives in inventory.<br />
|-<br />
| namespace<br />
| [filter] <br />
| list namespace scripts and the functions they define.<br />
|-<br />
| nemesis<br />
| <br />
| automatically complete quest.<br />
|-<br />
| nuns<br />
| [mp] <br />
| visit the Nunnery for restoration [but only if MP is restored].<br />
|-<br />
| objective*<br />
| clear | check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| olfact*<br />
| ( none | monster name | [item] list | goals ) [abort] <br />
| tag next monster [that drops all items in list, or your goals].<br />
|-<br />
| opt*<br />
| <br />
| switch to tab or open window<br />
|-<br />
| outfit<br />
| [list filter] | save name | checkpoint | name <br />
| list, save, restore, or change outfits.<br />
|-<br />
| overdrink[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| pause<br />
| [seconds] <br />
| pause script execution (default 1 second).<br />
|-<br />
| ply<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| print<br />
| timestamp | text <br />
| include timestamp or text in the session log.<br />
|-<br />
| priphea<br />
| <br />
| launch KoLmafia GUI.<br />
|-<br />
| pull<br />
| outfit name | item [, item]... <br />
| pull items from Hagnk's storage.<br />
|-<br />
| pulverize<br />
| item [, item]... <br />
| pulverize specified items<br />
|-<br />
| putty<br />
| ( none | monster name | [item] list | goals ) [abort] <br />
| tag next monster [that drops all items in list, or your goals].<br />
|-<br />
| pvp<br />
| [ target [, target]... ] <br />
| PvP for dignity or flowers<br />
|-<br />
| pvplog*<br />
| <br />
| summarize PvP results.<br />
|-<br />
| quark[?]<br />
| [itemList...] <br />
| gain MP by pasting unstable quark with best item from itemList (or your junk list).<br />
|-<br />
| quit<br />
| <br />
| logout and exit KoLmafia.<br />
|-<br />
| radio<br />
| <br />
| switch to tab or open window<br />
|-<br />
| raffle<br />
| ticketsToBuy [ inventory | storage ] <br />
| buy raffle tickets<br />
|-<br />
| recover*<br />
| hp | health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| refresh<br />
| all | status | equip | inv | storage | familiar | stickers <br />
| resynchronize with KoL.<br />
|-<br />
| relay<br />
| <br />
| open the relay browser.<br />
|-<br />
| remedy[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| remove<br />
| slot | name <br />
| remove equipment in slot, or that matches name<br />
|-<br />
| repeat<br />
| [number] <br />
| repeat previous line [number times].<br />
|-<br />
| reprice<br />
| <br />
| price all max-priced items at or below current Mall minimum price.<br />
|-<br />
| restaurant[?]<br />
| [ daily special | item ] <br />
| show daily special [or consume it or other restaurant item].<br />
|-<br />
| restore*<br />
| hp | health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| retrieve<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| run<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| safe<br />
| location <br />
| show summary data for the specified area.<br />
|-<br />
| save<br />
| as mood <br />
| add your current effects to the mood.<br />
|-<br />
| searchmall<br />
| item [ with limit number ] <br />
| search the Mall.<br />
|-<br />
| sell<br />
| item [, item]... <br />
| autosell items.<br />
|-<br />
| send<br />
| item [, item]... to recipient [ | message ] <br />
| send kmail<br />
|-<br />
| session<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| set<br />
| preference [ = value ] <br />
| show/change preference settings<br />
|-<br />
| shrug[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| skill[?]<br />
| [ [count] skill [on player] ] <br />
| list spells, or use one.<br />
|-<br />
| skills<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| sleep<br />
| number <br />
| rest on your clan sofa for number turns.<br />
|-<br />
| slimeling[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| smash<br />
| item [, item]... <br />
| pulverize specified items<br />
|-<br />
| smith<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| soak<br />
| <br />
| soak in your clan's hot tub<br />
|-<br />
| sofa<br />
| number <br />
| rest on your clan sofa for number turns.<br />
|-<br />
| spade<br />
| [prices URL] <br />
| submit automatically gathered data.<br />
|-<br />
| speculate<br />
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...] <br />
| predict modifiers.<br />
|-<br />
| squeeze[?]<br />
| item <br />
| produce item by using another form, repeated as needed.<br />
|-<br />
| start<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| stash<br />
| [put] item... | take item... <br />
| exchange items with clan stash<br />
|-<br />
| status<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| sticker*<br />
| sticker1 [, sticker2 [, sticker3]] <br />
| replace worn stickers.<br />
|-<br />
| storage<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| styx<br />
| muscle | mysticality | moxie <br />
| get daily Styx Pixie buff.<br />
|-<br />
| summary<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| summon<br />
| demonName | effect | location | number <br />
| use the Summoning Chamber.<br />
|-<br />
| tavern<br />
| <br />
| automatically complete quest.<br />
|-<br />
| telescope<br />
| [look] high | low <br />
| get daily buff, or Lair hints from your telescope.<br />
|-<br />
| text<br />
| URL <br />
| show text results from visiting URL.<br />
|-<br />
| tinker<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| tower<br />
| <br />
| automatically complete quest.<br />
|-<br />
| train<br />
| base weight | buffed weight | turns number <br />
| train familiar.<br />
|-<br />
| trigger*<br />
| clear | autofill | [type,] effect [, action] <br />
| edit current mood<br />
|-<br />
| try<br />
| ; commands <br />
| do commands, and continue even if an error occurs.<br />
|-<br />
| unalias<br />
| word <br />
| remove a CLI abbreviation.<br />
|-<br />
| undercut<br />
| <br />
| price all max-priced items at or below current Mall minimum price.<br />
|-<br />
| uneffect[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| unequip<br />
| slot | name <br />
| remove equipment in slot, or that matches name<br />
|-<br />
| untinker<br />
| [ item... ] <br />
| complete quest, or untinker items.<br />
|-<br />
| up?<br />
| effect [, effect]... <br />
| extend duration of effects.<br />
|-<br />
| update<br />
| data | clear | prices URL or filename <br />
| download most recent data files, or revert to built-in data.<br />
|-<br />
| use[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| using<br />
| filename <br />
| add ASH script to namespace.<br />
|-<br />
| validate<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| verify<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| version<br />
| <br />
| display KoLmafia version.<br />
|-<br />
| wait<br />
| [seconds] <br />
| pause script execution (default 1 second).<br />
|-<br />
| wear<br />
| [list filter] | [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| whatif<br />
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...] <br />
| predict modifiers.<br />
|-<br />
| while<br />
| condition; commands <br />
| do commands repeatedly while condition is true.<br />
|-<br />
| wield<br />
| [list filter] | [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| wiki<br />
| searchText <br />
| perform search on KoL Wiki.<br />
|-<br />
| win<br />
| game <br />
| I'm as surprised as you! I didn't think it was possible.<br />
|-<br />
| zap<br />
| item [, item]... <br />
| transform items with your wand.<br />
|}</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=CLI_Reference&diff=2914CLI Reference2009-08-30T15:18:13Z<p>HippoKing: corrected galaktik parsing</p>
<hr />
<div>The KoLmafia Graphical CLI is one of the most helpful features it has. This page is intended to provide information on the commands available.<br />
<br />
==Inventory Management==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command<br />
! Arguments<br />
! Description<br />
|-<br />
| acquire<br />
| item<br />
| Ensures you have argument item, making or buying when necessary.<br />
|}<br />
<br />
==Quests==<br />
<br />
==Market Management==<br />
<br />
==Mafia==<br />
<br />
==Other==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command Name<br />
! Arguments<br />
! Description<br />
|-<br />
| !<br />
| <br />
| list the Dungeons of Doom potions you've identified.<br />
|-<br />
| *.php*<br />
| <br />
| visit URL without showing results.<br />
|-<br />
| *brewery*[?]<br />
| [ daily special | item ] <br />
| show daily special [or consume it or other restaurant item].<br />
|-<br />
| *kitchen*[?]<br />
| item <br />
| consumes item at Hell's Kitchen, if available.<br />
|-<br />
| *mirror*<br />
| [filename] <br />
| stop [or start] logging to an additional file.<br />
|-<br />
| <inline-ash-script><br />
| <br />
| embed an ASH script in a CLI script.<br />
|-<br />
| aa<br />
| skill <br />
| set default attack method.<br />
|-<br />
| abort<br />
| [message] <br />
| stop current script or automated task.<br />
|-<br />
| acquire<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| adv*[?]<br />
| last | [count] location <br />
| spend your turns.<br />
|-<br />
| alias<br />
| [ word => expansion ] <br />
| list or create CLI abbreviations.<br />
|-<br />
| ash<br />
| statement <br />
| test a line of ASH code without having to edit a script.<br />
|-<br />
| ashref<br />
| [filter] <br />
| summarize ASH built-in functions [matching filter].<br />
|-<br />
| attack<br />
| [ target [, target]... ] <br />
| PvP for dignity or flowers<br />
|-<br />
| autoattack<br />
| skill <br />
| set default attack method.<br />
|-<br />
| automall<br />
| <br />
| dump all profitable, non-memento items into the Mall.<br />
|-<br />
| autosell<br />
| item [, item]... <br />
| autosell items.<br />
|-<br />
| backtrace<br />
| text | off <br />
| dump stack when a gCLI message or page URL matches text (case-sensitive).<br />
|-<br />
| bake<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| bang<br />
| <br />
| list the Dungeons of Doom potions you've identified.<br />
|-<br />
| basement<br />
| <br />
| check Fernswarthy's Basement status.<br />
|-<br />
| breakfast<br />
| <br />
| perform start-of-day activities.<br />
|-<br />
| budget<br />
| [number] <br />
| show [or set] the number of budgeted Hagnk's pulls.<br />
|-<br />
| buffbot<br />
| number <br />
| run buffbot for number iterations.<br />
|-<br />
| -num<br />
| <br />
| use excess/all/specified/all but specified MP for buff extension and summons.<br />
|-<br />
| buy<br />
| item [@ limit] [, another]... <br />
| buy from NPC store or the Mall.<br />
|-<br />
| call<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| camp*<br />
| rest | etc. [numTimes] <br />
| perform campground actions.<br />
|-<br />
| cast[?]<br />
| [ [count] skill [on player] ] <br />
| list spells, or use one.<br />
|-<br />
| ccs<br />
| [script] <br />
| show [or select] Custom Combat Script in use.<br />
|-<br />
| cecho<br />
| color text <br />
| show text using color (specified by name or #RRGGBB).<br />
|-<br />
| chamber<br />
| <br />
| automatically complete quest.<br />
|-<br />
| chat<br />
| <br />
| switch to tab or open window<br />
|-<br />
| [,[-]item]...<br />
| [; cmds] <br />
| compare prices, do cmds with "it" replaced with best.<br />
|-<br />
| check<br />
| hp | health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| checkpoint<br />
| <br />
| remembers current equipment, use "outfit checkpoint" to restore.<br />
|-<br />
| chew[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| clan<br />
| [ snapshot | stashlog ] <br />
| clan management.<br />
|-<br />
| cleanup<br />
| <br />
| use, pulverize, or autosell your junk items.<br />
|-<br />
| clear<br />
| <br />
| clear CLI window.<br />
|-<br />
| closet<br />
| list filter | put item... | take item... <br />
| list or manipulate your closet.<br />
|-<br />
| cls<br />
| <br />
| clear CLI window.<br />
|-<br />
| colorecho<br />
| color text <br />
| show text using color (specified by name or #RRGGBB).<br />
|-<br />
| condition*<br />
| clear | check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| condref<br />
| <br />
| list conditions usable with if/while commands.<br />
|-<br />
| council<br />
| <br />
| visit the Council to advance quest progress.<br />
|-<br />
| counters<br />
| [ clear | add number [title img] ] <br />
| show, clear, or add to current turn counters.<br />
|-<br />
| create<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| csend<br />
| item [, item]... to recipient [ | message ] <br />
| send kmail<br />
|-<br />
| debug<br />
| [on] | off <br />
| start or stop logging of debugging data.<br />
|-<br />
| demons<br />
| <br />
| list the demon names you know.<br />
|-<br />
| disable<br />
| all | command [, command]... <br />
| allow/deny CLI commands.<br />
|-<br />
| display<br />
| [filter] | put item... | take item... <br />
| list or manipulate your display case.<br />
|-<br />
| donate<br />
| boris | mus | jarl | mys | pete | mox amount <br />
| donate in Hall of Legends.<br />
|-<br />
| drink[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| dusty<br />
| <br />
| list the dusty bottles of wine you've identified.<br />
|-<br />
| eat[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| echo<br />
| timestamp | text <br />
| include timestamp or text in the session log.<br />
|-<br />
| effects<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| else<br />
| ; commands <br />
| do commands if preceding if/while/try didn't execute.<br />
|-<br />
| elseif<br />
| condition; commands <br />
| do if condition is true but preceding condition was false.<br />
|-<br />
| enable<br />
| all | command [, command]... <br />
| allow/deny CLI commands.<br />
|-<br />
| encounters<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| entity<br />
| <br />
| give details of your current pastamancer combat entity.<br />
|-<br />
| entryway<br />
| [clover] <br />
| automatically complete quest [using a clover].<br />
|-<br />
| equip<br />
| [list filter] | [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| events<br />
| [clear] <br />
| clear or show recent events.<br />
|-<br />
| exec*<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| exit<br />
| <br />
| logout and exit KoLmafia.<br />
|-<br />
| [,[-]item]...<br />
| [; cmds] <br />
| compare prices, do cmds with "it" replaced with best.<br />
|-<br />
| factory<br />
| report digits <br />
| Given a string of 7 dwarven digits, report on factory.<br />
|-<br />
| familiar[?]<br />
| [list filter] | lock | unlock | species | none <br />
| list or change familiar types<br />
|-<br />
| field<br />
| [ plant square type | pick square | harvest ] <br />
| view or use your mushroom plot<br />
|-<br />
| find<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| flowers<br />
| <br />
| commit random acts of PvP.<br />
|-<br />
| fold[?]<br />
| item <br />
| produce item by using another form, repeated as needed.<br />
|-<br />
| forum*<br />
| <br />
| visit the official KoL forums.<br />
|-<br />
| friars<br />
| [blessing] food | familiar | booze <br />
| get daily blessing.<br />
|-<br />
| galaktik(hp|mp)<br />
| [amount] <br />
| restore some or all hp or mp<br />
|-<br />
| gc<br />
| <br />
| force Java garbage collection.<br />
|-<br />
| gear<br />
| <br />
| switch to tab or open window<br />
|-<br />
| get<br />
| preference [ = value ] <br />
| show/change preference settings<br />
|-<br />
| ghost[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| goal*<br />
| clear | check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| gourd<br />
| <br />
| automatically complete quest.<br />
|-<br />
| grandpa<br />
| query <br />
| Ask Grandpa about something.<br />
|-<br />
| guardians<br />
| <br />
| automatically complete quest.<br />
|-<br />
| guild<br />
| <br />
| automatically complete quest.<br />
|-<br />
| hagnk<br />
| outfit name | item [, item]... <br />
| pull items from Hagnk's storage.<br />
|-<br />
| hedge*<br />
| <br />
| automatically complete quest.<br />
|-<br />
| help<br />
| [filter] <br />
| list CLI commands [that match filter].<br />
|-<br />
| hermit[?]<br />
| [item] <br />
| get clover status, or trade for item.<br />
|-<br />
| hiddencity<br />
| square [temple|altar item] <br />
| set Hidden City square [and perform an action there].<br />
|-<br />
| hobo[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| holiday<br />
| HolidayName <br />
| enable special processing for unpredicted holidays.<br />
|-<br />
| hottub<br />
| <br />
| soak in your clan's hot tub<br />
|-<br />
| http:*<br />
| <br />
| visit URL without showing results.<br />
|-<br />
| if<br />
| condition; commands <br />
| do commands once if condition is true (see condref).<br />
|-<br />
| insults<br />
| <br />
| list the pirate insult comebacks you know.<br />
|-<br />
| inv*<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| item<br />
| <br />
| switch to tab or open window<br />
|-<br />
| junk<br />
| <br />
| use, pulverize, or autosell your junk items.<br />
|-<br />
| kmail<br />
| item [, item]... to recipient [ | message ] <br />
| send kmail<br />
|-<br />
| later<br />
| commands <br />
| adds a button to do commands to the Daily Deeds list.<br />
|-<br />
| leaflet<br />
| [nomagic] | location | command <br />
| complete leaflet quest [without using magic words].<br />
|-<br />
| load<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| locations<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| log<br />
| [status],[equipment],[effects],[etc.] <br />
| record data, "log snapshot" for all common data.<br />
|-<br />
| logecho<br />
| timestamp | text <br />
| include timestamp or text in the session log only.<br />
|-<br />
| login<br />
| username <br />
| logout then log back in as username.<br />
|-<br />
| logout<br />
| <br />
| logout and return to login window.<br />
|-<br />
| logprint<br />
| timestamp | text <br />
| include timestamp or text in the session log only.<br />
|-<br />
| lookup<br />
| item | effect <br />
| go to appropriate KoL Wiki page.<br />
|-<br />
| mail<br />
| <br />
| switch to tab or open window<br />
|-<br />
| make<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| mallbuy<br />
| item [@ limit] [, another]... <br />
| buy from NPC store or the Mall.<br />
|-<br />
| mallsell<br />
| item [[@] price [[limit] num]] [, another]... <br />
| sell in Mall.<br />
|-<br />
| [+|-|weight]<br />
| keyword, ... <br />
| run the Modifier Maximizer.<br />
|-<br />
| maze<br />
| <br />
| automatically complete quest.<br />
|-<br />
| mcd<br />
| number <br />
| set mind control device (or equivalent) to new value.<br />
|-<br />
| mind-control<br />
| number <br />
| set mind control device (or equivalent) to new value.<br />
|-<br />
| mix<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| modifies<br />
| filter <br />
| list all possible sources of modifiers matching filter.<br />
|-<br />
| modref<br />
| [object] <br />
| list all modifiers, show values for player [and object].<br />
|-<br />
| modtrace<br />
| filter <br />
| list everything that adds to modifiers matching filter.<br />
|-<br />
| moleref<br />
| <br />
| Path of the Mole spoilers.<br />
|-<br />
| monsters<br />
| location <br />
| show combat details for the specified area.<br />
|-<br />
| mood*<br />
| clear | autofill | execute | repeat [numTimes] | moodName [numTimes] <br />
| mood management.<br />
|-<br />
| moon*<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| mpitems<br />
| <br />
| counts MP restoratives in inventory.<br />
|-<br />
| namespace<br />
| [filter] <br />
| list namespace scripts and the functions they define.<br />
|-<br />
| nemesis<br />
| <br />
| automatically complete quest.<br />
|-<br />
| nuns<br />
| [mp] <br />
| visit the Nunnery for restoration [but only if MP is restored].<br />
|-<br />
| objective*<br />
| clear | check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| olfact*<br />
| ( none | monster name | [item] list | goals ) [abort] <br />
| tag next monster [that drops all items in list, or your goals].<br />
|-<br />
| opt*<br />
| <br />
| switch to tab or open window<br />
|-<br />
| outfit<br />
| [list filter] | save name | checkpoint | name <br />
| list, save, restore, or change outfits.<br />
|-<br />
| overdrink[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| pause<br />
| [seconds] <br />
| pause script execution (default 1 second).<br />
|-<br />
| ply<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| print<br />
| timestamp | text <br />
| include timestamp or text in the session log.<br />
|-<br />
| priphea<br />
| <br />
| launch KoLmafia GUI.<br />
|-<br />
| pull<br />
| outfit name | item [, item]... <br />
| pull items from Hagnk's storage.<br />
|-<br />
| pulverize<br />
| item [, item]... <br />
| pulverize specified items<br />
|-<br />
| putty<br />
| ( none | monster name | [item] list | goals ) [abort] <br />
| tag next monster [that drops all items in list, or your goals].<br />
|-<br />
| pvp<br />
| [ target [, target]... ] <br />
| PvP for dignity or flowers<br />
|-<br />
| pvplog*<br />
| <br />
| summarize PvP results.<br />
|-<br />
| quark[?]<br />
| [itemList...] <br />
| gain MP by pasting unstable quark with best item from itemList (or your junk list).<br />
|-<br />
| quit<br />
| <br />
| logout and exit KoLmafia.<br />
|-<br />
| radio<br />
| <br />
| switch to tab or open window<br />
|-<br />
| raffle<br />
| ticketsToBuy [ inventory | storage ] <br />
| buy raffle tickets<br />
|-<br />
| recover*<br />
| hp | health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| refresh<br />
| all | status | equip | inv | storage | familiar | stickers <br />
| resynchronize with KoL.<br />
|-<br />
| relay<br />
| <br />
| open the relay browser.<br />
|-<br />
| remedy[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| remove<br />
| slot | name <br />
| remove equipment in slot, or that matches name<br />
|-<br />
| repeat<br />
| [number] <br />
| repeat previous line [number times].<br />
|-<br />
| reprice<br />
| <br />
| price all max-priced items at or below current Mall minimum price.<br />
|-<br />
| restaurant[?]<br />
| [ daily special | item ] <br />
| show daily special [or consume it or other restaurant item].<br />
|-<br />
| restore*<br />
| hp | health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| retrieve<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| run<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| safe<br />
| location <br />
| show summary data for the specified area.<br />
|-<br />
| save<br />
| as mood <br />
| add your current effects to the mood.<br />
|-<br />
| searchmall<br />
| item [ with limit number ] <br />
| search the Mall.<br />
|-<br />
| sell<br />
| item [, item]... <br />
| autosell items.<br />
|-<br />
| send<br />
| item [, item]... to recipient [ | message ] <br />
| send kmail<br />
|-<br />
| session<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| set<br />
| preference [ = value ] <br />
| show/change preference settings<br />
|-<br />
| shrug[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| skill[?]<br />
| [ [count] skill [on player] ] <br />
| list spells, or use one.<br />
|-<br />
| skills<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| sleep<br />
| number <br />
| rest on your clan sofa for number turns.<br />
|-<br />
| slimeling[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| smash<br />
| item [, item]... <br />
| pulverize specified items<br />
|-<br />
| smith<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| soak<br />
| <br />
| soak in your clan's hot tub<br />
|-<br />
| sofa<br />
| number <br />
| rest on your clan sofa for number turns.<br />
|-<br />
| spade<br />
| [prices URL] <br />
| submit automatically gathered data.<br />
|-<br />
| speculate<br />
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...] <br />
| predict modifiers.<br />
|-<br />
| squeeze[?]<br />
| item <br />
| produce item by using another form, repeated as needed.<br />
|-<br />
| start<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| stash<br />
| [put] item... | take item... <br />
| exchange items with clan stash<br />
|-<br />
| status<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| sticker*<br />
| sticker1 [, sticker2 [, sticker3]] <br />
| replace worn stickers.<br />
|-<br />
| storage<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| styx<br />
| muscle | mysticality | moxie <br />
| get daily Styx Pixie buff.<br />
|-<br />
| summary<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| summon<br />
| demonName | effect | location | number <br />
| use the Summoning Chamber.<br />
|-<br />
| tavern<br />
| <br />
| automatically complete quest.<br />
|-<br />
| telescope<br />
| [look] high | low <br />
| get daily buff, or Lair hints from your telescope.<br />
|-<br />
| text<br />
| URL <br />
| show text results from visiting URL.<br />
|-<br />
| tinker<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| tower<br />
| <br />
| automatically complete quest.<br />
|-<br />
| train<br />
| base weight | buffed weight | turns number <br />
| train familiar.<br />
|-<br />
| trigger*<br />
| clear | autofill | [type,] effect [, action] <br />
| edit current mood<br />
|-<br />
| try<br />
| ; commands <br />
| do commands, and continue even if an error occurs.<br />
|-<br />
| unalias<br />
| word <br />
| remove a CLI abbreviation.<br />
|-<br />
| undercut<br />
| <br />
| price all max-priced items at or below current Mall minimum price.<br />
|-<br />
| uneffect[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| unequip<br />
| slot | name <br />
| remove equipment in slot, or that matches name<br />
|-<br />
| untinker<br />
| [ item... ] <br />
| complete quest, or untinker items.<br />
|-<br />
| up?<br />
| effect [, effect]... <br />
| extend duration of effects.<br />
|-<br />
| update<br />
| data | clear | prices URL or filename <br />
| download most recent data files, or revert to built-in data.<br />
|-<br />
| use[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| using<br />
| filename <br />
| add ASH script to namespace.<br />
|-<br />
| validate<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| verify<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| version<br />
| <br />
| display KoLmafia version.<br />
|-<br />
| wait<br />
| [seconds] <br />
| pause script execution (default 1 second).<br />
|-<br />
| wear<br />
| [list filter] | [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| whatif<br />
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...] <br />
| predict modifiers.<br />
|-<br />
| while<br />
| condition; commands <br />
| do commands repeatedly while condition is true.<br />
|-<br />
| wield<br />
| [list filter] | [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| wiki<br />
| searchText <br />
| perform search on KoL Wiki.<br />
|-<br />
| win<br />
| game <br />
| I'm as surprised as you! I didn't think it was possible.<br />
|-<br />
| zap<br />
| item [, item]... <br />
| transform items with your wand.<br />
|}</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=CLI_Reference&diff=2913CLI Reference2009-08-30T15:15:00Z<p>HippoKing: added commands from parsing help, as yet unsorted.</p>
<hr />
<div>The KoLmafia Graphical CLI is one of the most helpful features it has. This page is intended to provide information on the commands available.<br />
<br />
==Inventory Management==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command<br />
! Arguments<br />
! Description<br />
|-<br />
| acquire<br />
| item<br />
| Ensures you have argument item, making or buying when necessary.<br />
|}<br />
<br />
==Quests==<br />
<br />
==Market Management==<br />
<br />
==Mafia==<br />
<br />
==Other==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command Name<br />
! Arguments<br />
! Description<br />
|-<br />
| !<br />
| <br />
| list the Dungeons of Doom potions you've identified.<br />
|-<br />
| *.php*<br />
| <br />
| visit URL without showing results.<br />
|-<br />
| *brewery*[?]<br />
| [ daily special | item ] <br />
| show daily special [or consume it or other restaurant item].<br />
|-<br />
| *kitchen*[?]<br />
| item <br />
| consumes item at Hell's Kitchen, if available.<br />
|-<br />
| *mirror*<br />
| [filename] <br />
| stop [or start] logging to an additional file.<br />
|-<br />
| <inline-ash-script><br />
| <br />
| embed an ASH script in a CLI script.<br />
|-<br />
| aa<br />
| skill <br />
| set default attack method.<br />
|-<br />
| abort<br />
| [message] <br />
| stop current script or automated task.<br />
|-<br />
| adv*[?]<br />
| last | [count] location <br />
| spend your turns.<br />
|-<br />
| alias<br />
| [ word => expansion ] <br />
| list or create CLI abbreviations.<br />
|-<br />
| ash<br />
| statement <br />
| test a line of ASH code without having to edit a script.<br />
|-<br />
| ashref<br />
| [filter] <br />
| summarize ASH built-in functions [matching filter].<br />
|-<br />
| attack<br />
| [ target [, target]... ] <br />
| PvP for dignity or flowers<br />
|-<br />
| autoattack<br />
| skill <br />
| set default attack method.<br />
|-<br />
| automall<br />
| <br />
| dump all profitable, non-memento items into the Mall.<br />
|-<br />
| autosell<br />
| item [, item]... <br />
| autosell items.<br />
|-<br />
| backtrace<br />
| text | off <br />
| dump stack when a gCLI message or page URL matches text (case-sensitive).<br />
|-<br />
| bake<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| bang<br />
| <br />
| list the Dungeons of Doom potions you've identified.<br />
|-<br />
| basement<br />
| <br />
| check Fernswarthy's Basement status.<br />
|-<br />
| breakfast<br />
| <br />
| perform start-of-day activities.<br />
|-<br />
| budget<br />
| [number] <br />
| show [or set] the number of budgeted Hagnk's pulls.<br />
|-<br />
| buffbot<br />
| number <br />
| run buffbot for number iterations.<br />
|-<br />
| -num<br />
| <br />
| use excess/all/specified/all but specified MP for buff extension and summons.<br />
|-<br />
| buy<br />
| item [@ limit] [, another]... <br />
| buy from NPC store or the Mall.<br />
|-<br />
| call<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| camp*<br />
| rest | etc. [numTimes] <br />
| perform campground actions.<br />
|-<br />
| cast[?]<br />
| [ [count] skill [on player] ] <br />
| list spells, or use one.<br />
|-<br />
| ccs<br />
| [script] <br />
| show [or select] Custom Combat Script in use.<br />
|-<br />
| cecho<br />
| color text <br />
| show text using color (specified by name or #RRGGBB).<br />
|-<br />
| chamber<br />
| <br />
| automatically complete quest.<br />
|-<br />
| chat<br />
| <br />
| switch to tab or open window<br />
|-<br />
| [,[-]item]...<br />
| [; cmds] <br />
| compare prices, do cmds with "it" replaced with best.<br />
|-<br />
| check<br />
| hp | health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| checkpoint<br />
| <br />
| remembers current equipment, use "outfit checkpoint" to restore.<br />
|-<br />
| chew[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| clan<br />
| [ snapshot | stashlog ] <br />
| clan management.<br />
|-<br />
| cleanup<br />
| <br />
| use, pulverize, or autosell your junk items.<br />
|-<br />
| clear<br />
| <br />
| clear CLI window.<br />
|-<br />
| closet<br />
| list filter | put item... | take item... <br />
| list or manipulate your closet.<br />
|-<br />
| cls<br />
| <br />
| clear CLI window.<br />
|-<br />
| colorecho<br />
| color text <br />
| show text using color (specified by name or #RRGGBB).<br />
|-<br />
| condition*<br />
| clear | check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| condref<br />
| <br />
| list conditions usable with if/while commands.<br />
|-<br />
| council<br />
| <br />
| visit the Council to advance quest progress.<br />
|-<br />
| counters<br />
| [ clear | add number [title img] ] <br />
| show, clear, or add to current turn counters.<br />
|-<br />
| create<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| csend<br />
| item [, item]... to recipient [ | message ] <br />
| send kmail<br />
|-<br />
| debug<br />
| [on] | off <br />
| start or stop logging of debugging data.<br />
|-<br />
| demons<br />
| <br />
| list the demon names you know.<br />
|-<br />
| disable<br />
| all | command [, command]... <br />
| allow/deny CLI commands.<br />
|-<br />
| display<br />
| [filter] | put item... | take item... <br />
| list or manipulate your display case.<br />
|-<br />
| donate<br />
| boris | mus | jarl | mys | pete | mox amount <br />
| donate in Hall of Legends.<br />
|-<br />
| drink[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| dusty<br />
| <br />
| list the dusty bottles of wine you've identified.<br />
|-<br />
| eat[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| echo<br />
| timestamp | text <br />
| include timestamp or text in the session log.<br />
|-<br />
| effects<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| else<br />
| ; commands <br />
| do commands if preceding if/while/try didn't execute.<br />
|-<br />
| elseif<br />
| condition; commands <br />
| do if condition is true but preceding condition was false.<br />
|-<br />
| enable<br />
| all | command [, command]... <br />
| allow/deny CLI commands.<br />
|-<br />
| encounters<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| entity<br />
| <br />
| give details of your current pastamancer combat entity.<br />
|-<br />
| entryway<br />
| [clover] <br />
| automatically complete quest [using a clover].<br />
|-<br />
| equip<br />
| [list filter] | [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| events<br />
| [clear] <br />
| clear or show recent events.<br />
|-<br />
| exec*<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| exit<br />
| <br />
| logout and exit KoLmafia.<br />
|-<br />
| [,[-]item]...<br />
| [; cmds] <br />
| compare prices, do cmds with "it" replaced with best.<br />
|-<br />
| factory<br />
| report digits <br />
| Given a string of 7 dwarven digits, report on factory.<br />
|-<br />
| familiar[?]<br />
| [list filter] | lock | unlock | species | none <br />
| list or change familiar types<br />
|-<br />
| field<br />
| [ plant square type | pick square | harvest ] <br />
| view or use your mushroom plot<br />
|-<br />
| find<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| flowers<br />
| <br />
| commit random acts of PvP.<br />
|-<br />
| fold[?]<br />
| item <br />
| produce item by using another form, repeated as needed.<br />
|-<br />
| forum*<br />
| <br />
| visit the official KoL forums.<br />
|-<br />
| friars<br />
| [blessing] food | familiar | booze <br />
| get daily blessing.<br />
|-<br />
| galaktik(hp|mp)<br />
| [amount] <br />
| restore some or all hp or mp<br />
|-<br />
| gc<br />
| <br />
| force Java garbage collection.<br />
|-<br />
| gear<br />
| <br />
| switch to tab or open window<br />
|-<br />
| get<br />
| preference [ = value ] <br />
| show/change preference settings<br />
|-<br />
| ghost[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| goal*<br />
| clear | check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| gourd<br />
| <br />
| automatically complete quest.<br />
|-<br />
| grandpa<br />
| query <br />
| Ask Grandpa about something.<br />
|-<br />
| guardians<br />
| <br />
| automatically complete quest.<br />
|-<br />
| guild<br />
| <br />
| automatically complete quest.<br />
|-<br />
| hagnk<br />
| outfit name | item [, item]... <br />
| pull items from Hagnk's storage.<br />
|-<br />
| hedge*<br />
| <br />
| automatically complete quest.<br />
|-<br />
| help<br />
| [filter] <br />
| list CLI commands [that match filter].<br />
|-<br />
| hermit[?]<br />
| [item] <br />
| get clover status, or trade for item.<br />
|-<br />
| hiddencity<br />
| square [temple|altar item] <br />
| set Hidden City square [and perform an action there].<br />
|-<br />
| hobo[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| holiday<br />
| HolidayName <br />
| enable special processing for unpredicted holidays.<br />
|-<br />
| hottub<br />
| <br />
| soak in your clan's hot tub<br />
|-<br />
| http:*<br />
| <br />
| visit URL without showing results.<br />
|-<br />
| if<br />
| condition; commands <br />
| do commands once if condition is true (see condref).<br />
|-<br />
| insults<br />
| <br />
| list the pirate insult comebacks you know.<br />
|-<br />
| inv*<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| item<br />
| <br />
| switch to tab or open window<br />
|-<br />
| junk<br />
| <br />
| use, pulverize, or autosell your junk items.<br />
|-<br />
| kmail<br />
| item [, item]... to recipient [ | message ] <br />
| send kmail<br />
|-<br />
| later<br />
| commands <br />
| adds a button to do commands to the Daily Deeds list.<br />
|-<br />
| leaflet<br />
| [nomagic] | location | command <br />
| complete leaflet quest [without using magic words].<br />
|-<br />
| load<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| locations<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| log<br />
| [status],[equipment],[effects],[etc.] <br />
| record data, "log snapshot" for all common data.<br />
|-<br />
| logecho<br />
| timestamp | text <br />
| include timestamp or text in the session log only.<br />
|-<br />
| login<br />
| username <br />
| logout then log back in as username.<br />
|-<br />
| logout<br />
| <br />
| logout and return to login window.<br />
|-<br />
| logprint<br />
| timestamp | text <br />
| include timestamp or text in the session log only.<br />
|-<br />
| lookup<br />
| item | effect <br />
| go to appropriate KoL Wiki page.<br />
|-<br />
| mail<br />
| <br />
| switch to tab or open window<br />
|-<br />
| make<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| mallbuy<br />
| item [@ limit] [, another]... <br />
| buy from NPC store or the Mall.<br />
|-<br />
| mallsell<br />
| item [[@] price [[limit] num]] [, another]... <br />
| sell in Mall.<br />
|-<br />
| [+|-|weight]<br />
| keyword, ... <br />
| run the Modifier Maximizer.<br />
|-<br />
| maze<br />
| <br />
| automatically complete quest.<br />
|-<br />
| mcd<br />
| number <br />
| set mind control device (or equivalent) to new value.<br />
|-<br />
| mind-control<br />
| number <br />
| set mind control device (or equivalent) to new value.<br />
|-<br />
| mix<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| modifies<br />
| filter <br />
| list all possible sources of modifiers matching filter.<br />
|-<br />
| modref<br />
| [object] <br />
| list all modifiers, show values for player [and object].<br />
|-<br />
| modtrace<br />
| filter <br />
| list everything that adds to modifiers matching filter.<br />
|-<br />
| moleref<br />
| <br />
| Path of the Mole spoilers.<br />
|-<br />
| monsters<br />
| location <br />
| show combat details for the specified area.<br />
|-<br />
| mood*<br />
| clear | autofill | execute | repeat [numTimes] | moodName [numTimes] <br />
| mood management.<br />
|-<br />
| moon*<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| mpitems<br />
| <br />
| counts MP restoratives in inventory.<br />
|-<br />
| namespace<br />
| [filter] <br />
| list namespace scripts and the functions they define.<br />
|-<br />
| nemesis<br />
| <br />
| automatically complete quest.<br />
|-<br />
| nuns<br />
| [mp] <br />
| visit the Nunnery for restoration [but only if MP is restored].<br />
|-<br />
| objective*<br />
| clear | check | add condition | set condition <br />
| modify your adventuring goals.<br />
|-<br />
| olfact*<br />
| ( none | monster name | [item] list | goals ) [abort] <br />
| tag next monster [that drops all items in list, or your goals].<br />
|-<br />
| opt*<br />
| <br />
| switch to tab or open window<br />
|-<br />
| outfit<br />
| [list filter] | save name | checkpoint | name <br />
| list, save, restore, or change outfits.<br />
|-<br />
| overdrink[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| pause<br />
| [seconds] <br />
| pause script execution (default 1 second).<br />
|-<br />
| ply<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| print<br />
| timestamp | text <br />
| include timestamp or text in the session log.<br />
|-<br />
| priphea<br />
| <br />
| launch KoLmafia GUI.<br />
|-<br />
| pull<br />
| outfit name | item [, item]... <br />
| pull items from Hagnk's storage.<br />
|-<br />
| pulverize<br />
| item [, item]... <br />
| pulverize specified items<br />
|-<br />
| putty<br />
| ( none | monster name | [item] list | goals ) [abort] <br />
| tag next monster [that drops all items in list, or your goals].<br />
|-<br />
| pvp<br />
| [ target [, target]... ] <br />
| PvP for dignity or flowers<br />
|-<br />
| pvplog*<br />
| <br />
| summarize PvP results.<br />
|-<br />
| quark[?]<br />
| [itemList...] <br />
| gain MP by pasting unstable quark with best item from itemList (or your junk list).<br />
|-<br />
| quit<br />
| <br />
| logout and exit KoLmafia.<br />
|-<br />
| radio<br />
| <br />
| switch to tab or open window<br />
|-<br />
| raffle<br />
| ticketsToBuy [ inventory | storage ] <br />
| buy raffle tickets<br />
|-<br />
| recover*<br />
| hp | health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| refresh<br />
| all | status | equip | inv | storage | familiar | stickers <br />
| resynchronize with KoL.<br />
|-<br />
| relay<br />
| <br />
| open the relay browser.<br />
|-<br />
| remedy[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| remove<br />
| slot | name <br />
| remove equipment in slot, or that matches name<br />
|-<br />
| repeat<br />
| [number] <br />
| repeat previous line [number times].<br />
|-<br />
| reprice<br />
| <br />
| price all max-priced items at or below current Mall minimum price.<br />
|-<br />
| restaurant[?]<br />
| [ daily special | item ] <br />
| show daily special [or consume it or other restaurant item].<br />
|-<br />
| restore*<br />
| hp | health | mp | mana | both <br />
| attempt to regain some HP or MP.<br />
|-<br />
| retrieve<br />
| item <br />
| ensure that you have item, creating or buying it if needed.<br />
|-<br />
| run<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| safe<br />
| location <br />
| show summary data for the specified area.<br />
|-<br />
| save<br />
| as mood <br />
| add your current effects to the mood.<br />
|-<br />
| searchmall<br />
| item [ with limit number ] <br />
| search the Mall.<br />
|-<br />
| sell<br />
| item [, item]... <br />
| autosell items.<br />
|-<br />
| send<br />
| item [, item]... to recipient [ | message ] <br />
| send kmail<br />
|-<br />
| session<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| set<br />
| preference [ = value ] <br />
| show/change preference settings<br />
|-<br />
| shrug[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| skill[?]<br />
| [ [count] skill [on player] ] <br />
| list spells, or use one.<br />
|-<br />
| skills<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| sleep<br />
| number <br />
| rest on your clan sofa for number turns.<br />
|-<br />
| slimeling[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| smash<br />
| item [, item]... <br />
| pulverize specified items<br />
|-<br />
| smith<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| soak<br />
| <br />
| soak in your clan's hot tub<br />
|-<br />
| sofa<br />
| number <br />
| rest on your clan sofa for number turns.<br />
|-<br />
| spade<br />
| [prices URL] <br />
| submit automatically gathered data.<br />
|-<br />
| speculate<br />
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...] <br />
| predict modifiers.<br />
|-<br />
| squeeze[?]<br />
| item <br />
| produce item by using another form, repeated as needed.<br />
|-<br />
| start<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| stash<br />
| [put] item... | take item... <br />
| exchange items with clan stash<br />
|-<br />
| status<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| sticker*<br />
| sticker1 [, sticker2 [, sticker3]] <br />
| replace worn stickers.<br />
|-<br />
| storage<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| styx<br />
| muscle | mysticality | moxie <br />
| get daily Styx Pixie buff.<br />
|-<br />
| summary<br />
| [param] <br />
| list indicated type of data, possibly filtered by param.<br />
|-<br />
| summon<br />
| demonName | effect | location | number <br />
| use the Summoning Chamber.<br />
|-<br />
| tavern<br />
| <br />
| automatically complete quest.<br />
|-<br />
| telescope<br />
| [look] high | low <br />
| get daily buff, or Lair hints from your telescope.<br />
|-<br />
| text<br />
| URL <br />
| show text results from visiting URL.<br />
|-<br />
| tinker<br />
| [ item... ] <br />
| list creatables, or create specified items.<br />
|-<br />
| tower<br />
| <br />
| automatically complete quest.<br />
|-<br />
| train<br />
| base weight | buffed weight | turns number <br />
| train familiar.<br />
|-<br />
| trigger*<br />
| clear | autofill | [type,] effect [, action] <br />
| edit current mood<br />
|-<br />
| try<br />
| ; commands <br />
| do commands, and continue even if an error occurs.<br />
|-<br />
| unalias<br />
| word <br />
| remove a CLI abbreviation.<br />
|-<br />
| undercut<br />
| <br />
| price all max-priced items at or below current Mall minimum price.<br />
|-<br />
| uneffect[?]<br />
| effect [, effect]... <br />
| remove effects using appropriate means.<br />
|-<br />
| unequip<br />
| slot | name <br />
| remove equipment in slot, or that matches name<br />
|-<br />
| untinker<br />
| [ item... ] <br />
| complete quest, or untinker items.<br />
|-<br />
| up?<br />
| effect [, effect]... <br />
| extend duration of effects.<br />
|-<br />
| update<br />
| data | clear | prices URL or filename <br />
| download most recent data files, or revert to built-in data.<br />
|-<br />
| use[?]<br />
| [either] item [, item]... <br />
| use/consume items<br />
|-<br />
| using<br />
| filename <br />
| add ASH script to namespace.<br />
|-<br />
| validate<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| verify<br />
| [numberx] filename | function [parameters] <br />
| check/run script.<br />
|-<br />
| version<br />
| <br />
| display KoLmafia version.<br />
|-<br />
| wait<br />
| [seconds] <br />
| pause script execution (default 1 second).<br />
|-<br />
| wear<br />
| [list filter] | [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| whatif<br />
| MCD num | equip [slot] item | unequip slot | familiar type | up eff | uneffect eff | quiet ; [another;...] <br />
| predict modifiers.<br />
|-<br />
| while<br />
| condition; commands <br />
| do commands repeatedly while condition is true.<br />
|-<br />
| wield<br />
| [list filter] | [slot] item <br />
| show equipment, or equip item [in slot].<br />
|-<br />
| wiki<br />
| searchText <br />
| perform search on KoL Wiki.<br />
|-<br />
| win<br />
| game <br />
| I'm as surprised as you! I didn't think it was possible.<br />
|-<br />
| zap<br />
| item [, item]... <br />
| transform items with your wand.<br />
|}</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=CLI_Reference&diff=2912CLI Reference2009-08-30T14:34:01Z<p>HippoKing: Created page with types and example command. Will expand later today.</p>
<hr />
<div>The KoLmafia Graphical CLI is one of the most helpful features it has. This page is intended to provide information on the commands available.<br />
<br />
==Inventory Management==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Command<br />
! Arguments<br />
! Description<br />
|-<br />
| acquire<br />
| item<br />
| Ensures you have argument item, making or buying when necessary.<br />
|}<br />
<br />
==Quests==<br />
<br />
==Market Management==<br />
<br />
==Other==</div>HippoKinghttps://wiki.kolmafia.us/index.php?title=User_talk:HippoKing/script&diff=2876User talk:HippoKing/script2009-08-29T20:58:27Z<p>HippoKing: Created page with 'This is the perl script I used to generate the page, in case it needs updating. Note that this needs to share a folder with the defaults.txt file from kolmafia, and you have to …'</p>
<hr />
<div>This is the perl script I used to generate the page, in case it needs updating.<br />
<br />
Note that this needs to share a folder with the defaults.txt file from kolmafia, and you have to change the revision number manually. It was intended to be used, not to be published, so it works but it's not pretty in the slightest.<br />
<br />
Output overwrites wiki.txt.<br />
<br />
<pre>#!perl<br />
use strict;<br />
use warnings;<br />
<br />
my $revision = 7582;<br />
<br />
open INFILE, '< defaults.txt' or die $!;<br />
open OUTFILE, '> wiki.txt' or die $!;<br />
<br />
my @global;<br />
my @user;<br />
<br />
while(<INFILE>) {<br />
chomp;<br />
my @line = split /\t/;<br />
if (exists($line[0])) {<br />
if ($line[0] eq "global") {<br />
shift @line;<br />
push @global,\@line;<br />
}<br />
if ($line[0] eq "user") {<br />
shift @line;<br />
push @user,\@line;<br />
}<br />
}<br />
}<br />
<br />
print OUTFILE ("This is a list of all the Property variables included in KoLmafia. It was automatically generated from r",$revision);<br />
# global variables<br />
<br />
print OUTFILE (<br />
"\n==Global Variables==\n",<br />
'{| class="wikitable" border="1"',<br />
"\n|-\n! Variable Name\n! Default Value\n! Notes\n");<br />
<br />
foreach my $line (@global) {<br />
print OUTFILE ('|-',"\n");<br />
<br />
for (my $i = 0; $i<3;$i++) {<br />
if (defined(@$line[$i])) {<br />
print OUTFILE ('| ',@$line[$i],"\n");<br />
}<br />
else {<br />
print OUTFILE ('| ',"\n");<br />
}<br />
}<br />
<br />
}<br />
<br />
print OUTFILE ('|}',"\n");<br />
<br />
# user Variables<br />
<br />
print OUTFILE (<br />
"\n==Per-Account Variables==\n",<br />
'{| class="wikitable" border="1"',<br />
"\n|-\n! Variable Name\n! Default Value\n! Notes\n");<br />
<br />
foreach my $line (@user) {<br />
print OUTFILE ('|-',"\n");<br />
<br />
for (my $i = 0; $i<3;$i++) {<br />
if (defined(@$line[$i])) {<br />
print OUTFILE ('| ',@$line[$i],"\n");<br />
}<br />
else {<br />
print OUTFILE ('| ',"\n");<br />
}<br />
}<br />
<br />
}<br />
<br />
print OUTFILE ('|}',"\n");<br />
</pre></div>HippoKinghttps://wiki.kolmafia.us/index.php?title=KoLmafia_Properties&diff=1230KoLmafia Properties2009-08-29T14:52:38Z<p>HippoKing: /* Part 11 - KoLmafia Properties */</p>
<hr />
<div>== Part 11 - KoLmafia Properties ==<br />
<br />
<p>In addition to affecting gameplay directly through ASH functions and CLI commands, scripters also have the ability to control certain core behaviors of KoLmafia through direct modification of the preferences file. In addition, scripters can also create variables that will survive across sessions. </p><br />
<p>To see all of the pre-defined variables that exist, look in the &#8220;settings&#8221; subfolder wherever you keep the KoLmafia executable and open up any of the prefs_<character name>.txt and GLOBAL_prefs.txt files named for your characters. This guide will not attempt to describe all of the variables that are there: many are uninteresting from the player&#8217;s point of view and others are too unwieldy to be properly set at the moment. Of those that are interesting and accessable, the functionality can be divided into three main sections:</p><br />
<br />
<h3>Choice Adventures</h3><br />
There is a large and ever-growing number of settings for choice adventures, all with the name '''choiceAdventureX''' (X is the number of the adventure). These settings control all of the non-combat adventures that give you a choice of outcomes. In the GUI, you can view and set these options in the Choices tab of the Preferences window, but you can also read and write the values from ASH using [[get_property()]] and [[set_property()]].<br />
<br />
Each choiceAdventure is set to a number, which corresponds to which choice you want to make from the available options in KoL (or in the GUI, in the case that mafia provides more options than KoL). According to Holatuwol ([http://kolmafia.us/index.php/topic,1155.0.html here]), the settings map to "X=pick the Xth Option" and "X+1=pick an item you don't have" (i.e., complete the outfit).<br />
<br />
For a complete (and very useful) list of choice adventures, consult [http://kol.coldfront.net/thekolwiki/index.php/Choice_Adventures_by_Number this page of the KoL Wiki].<br />
<br />
Optionally, you can figure out the correct numeric value by logging in to KoLmafia, using the Preferences Window to set the value to what you want, exiting KoLmafia, and then checking your character&#8217;s settings file (''yourname''_prefs.txt) to see the value that was set for the appropriate key.<br />
<br />
<h3>Other KoLmafia-based preferences</h3><br />
<p>This is going to be a limited survey of the more interesting of the settings that you can control.</p><br />
<p><b>battleAction</b> - This specifies the strategy that you will use in battle. The sorts of values that you might select here are &#8220;attack&#8221; for normal attacking, &#8220;custom&#8221; to use the Custom Combat Scripts, &#8220;item dictionary&#8221; when you&#8217;re adventuring in the Valley beyond Orc Chasm, or &#8220;skill thrust smack&#8221; to use TS during the entire battle.</p><br />
<br />
<p><b>hpAutoRecovery</b> - This is a float value that specifies the percentage of your HP at which the autohealer kicks in. I haven&#8217;t tried it, but I think you&#8217;d be generally unhappy if you set it to something other than a multiple of 0.1.</p><br />
<p><b>hpAutoRecoveryTarget</b> - A companion to the above, this is the target that the autohealer will aspire to achieve.</p><br />
<p>As before, feel free to peruse the .kcs file to see all of the values. The names aren&#8217;t very subtle, so you should be able to guess what they&#8217;re all for.</p><br />
<br />
<p>For a complete list, see [[List of KoLmafia Properties]].</p><br />
<br />
<h3>User-defined variables</h3><br />
<p>In addition to setting the variables that KoLmafia predefines, you can also create any others to cover any information you wish. As you do so, keep in mind that while you can clear a variable&#8217;s value to the null string, there is currently no way to delete a key (aside from editing the .txt file in the text processor of your choice and deleting the line that contains the key).<br />
<br />
</p></div>HippoKing