imported>StDoodle |
|
| Line 1: |
Line 1: |
| − | {{RFI}}
| + | Here are some websites related to the KoLMafia community. |
| | | | |
| − | I keep getting questions from clannies, especially, on how to use this tool. Unfortunately, I don't know much beyond the basics, myself. So, if someone who DOES know the ins-and-outs could jot some info down, it would be much appreciated. --[[User:StDoodle|StDoodle (#1059825)]] 22:36, 19 June 2010 (UTC)
| + | *[http://www.kingdomofloathing.com '''Kingdom of Loathing'''] |
| | + | : The game's main website. |
| | | | |
| − | The core functionality is to maximize various [[modifiers]] according to certain parameters. A number preceding the modifier determines its weight -- this number (not restricted to integers) can be negative (for discouraged modifiers), zero (to ignore certain modifiers' effect), or positive (duh).
| + | *[http://kolmafia.us/index.php '''KoLMafia Script Repository'''] |
| | + | : The main script repository and forum for KoLMafia. |
| | | | |
| − | There's something about the +, but I'm not completely sure what it is. I think it's used to force an outfit (e.g. "item drop, +outfit hodg" when boss-killing), but I'm pretty sure there's something else to it. --[[User:Heeheehee|Heeheehee]] 02:33, 20 June 2010 (UTC)
| + | *[http://kolmafia.sourceforge.net/ '''KoLMafia at Sourceforge'''] |
| − | :Also, if anyone's interested, this is used as tiebreaker: | + | : Project website for KoLMafia. |
| | + | *[http://kolmafia.sourceforge.net/advanced.html '''Advanced Scripting Manual (ASH) at Sourceforge'''] |
| | + | : A useful manual to reference when using this wiki. |
| | | | |
| − | :"1 familiar weight, 1 familiar experience, 1 initiative, 5 exp, 1 item, 1 meat, 0.1 DA 1000 max, 1 DR, 0.5 all res, -10 mana cost, 1.0 mus, 0.5 mys, 1.0 mox, 1.5 mainstat, 1 HP, 1 MP, 1 weapon damage, 1 ranged damage, 1 spell damage, 1 cold damage, 1 hot damage, 1 sleaze damage, 1 spooky damage, 1 stench damage, 1 cold spell damage, 1 hot spell damage, 1 sleaze spell damage, 1 spooky spell damage, 1 stench spell damage, 1 critical, -1 fumble, 1 HP regen max, 3 MP regen max, 1 critical hit percent, 0.1 food drop, 0.1 booze drop, 0.1 hat drop, 0.1 weapon drop, 0.1 offhand drop, 0.1 shirt drop, 0.1 pants drop, 0.1 accessory drop, 1 DB combat damage"; | + | *[http://kol.coldfront.net '''Chillin' and Loathin' at Coldfront'''] |
| − | ::Also, the help thingy when you click on "help" in the modifier maximizer should help lots. (Reproduced below:) | + | : KoL at Coldfront is the official unofficial KoL fan site. |
| | | | |
| − | <h3>General</h3>
| + | *[http://kol.coldfront.net/thekolwiki/index.php/Main_Page '''KoL Wiki (at Coldfront)'''] |
| − | The specification of what attributes to maximize is made by a comma-separated list of keywords, each possibly preceded by a numeric weight. Commas can be omitted if the next item starts with a +, -, or digit. Using just a +, or omitting the weight entirely, is equivalent to a weight of 1. Likewise, using just a - is equivalent to a weight of -1. Non-integer weights can be used, but may not be meaningful with all keywords.
| + | : Large spoiler site and wiki, a useful reference site. |
| − | <h3>Numeric Modifiers</h3>
| |
| − | The full name of any numeric modifier (as shown by the <b>modref</b> CLI command) is a valid keyword, requesting that its value be maximized. If multiple modifiers are given, their weights specify their relative importance. Negative weights mean that smaller values are more desirable for that modifier.
| |
| − | <p>
| |
| − | Shorter forms are allowed for many commonly used modifiers. They can be abbreviated down to just the bold letters:
| |
| − | <br><b>mus</b>, <b>mys</b>, <b>mox</b>, <b>main</b>stat, <b>HP</b>, <b>MP</b>, <b>ML</b>, <b>DA</b>, <b>DR</b>, <b>com</b>bat rate, <b>item</b> drop, <b>meat</b> drop, <b>exp</b>erience, <b>adv</b>entures
| |
| − | <br>Also, resistance (of any type) can be abbreviated as <b>res</b>, and damage can be abbreviated as <b>dmg</b>. <b>all res</b>istance is a shortcut for giving the same weight to all five basic elements. Likewise, <b>elemental dmg</b> is a shortcut for the five elemental damage types.
| |
| − | <p>
| |
| − | Note that many modifiers come in pairs: a base value, plus a percentage boost (such as Moxie and Moxie Percent), or a penalty value. In general, you only need to specify the base modifier, and any related modifiers will automatically be taken into account.
| |
| − | <h3>Limits</h3>
| |
| − | Any numeric modifier keyword can be followed by one or both of these special keywords:
| |
| − | <br><b>min</b> - The weight specifies the minimum acceptable value for the preceding modifier. If the value is lower, the results will be flagged as a failure.+
| |
| − | <br><b>max</b> - The weight specifies the largest useful value for the preceding modifier. Larger values will be ignored in the score calculation, allowing other specified modifiers to be boosted instead.
| |
| − | <br>Note that the limit keywords won't quite work as expected for a modifier that you're trying to minimize.
| |
| − | <br>If <b>min</b> or <b>max</b> is specified at the start of the expression, it applies to the total score (the sum of each modifier value times its weight). A global <b>max</b> may allow equipment maximization to finish faster, since no further combinations will be considered once the specified value is reached.+
| |
| − | <h3>Other Modifiers</h3>
| |
| − | Boolean modifiers can also be used as keywords. With positive weight, the modifier is required to be true; with negative weight, it is required to be false. There is one shortcut available: <b>sea</b> requires both Adventure Underwater and Underwater Familiar to be true.
| |
| − | <p>
| |
| − | The only bitmap modifiers that currently appear useful for maximization are Clownosity and Raveosity, so they are allowed as a special case. The weight specifies the required minimum value; only one value is actually meaningful for each keyword, so <b>4 clownosity</b> and <b>7 raveosity</b> are the only useful forms.
| |
| − | <p>
| |
| − | String modifiers are not currently meaningful for maximization.
| |
| − | <h3>Equipment</h3>
| |
| − | Slot names can be used as keywords:
| |
| − | <br><b>hat</b>, <b>weapon</b>, <b>offhand</b>, <b>shirt</b>, <b>pants</b>, <b>acc1</b>, <b>acc2</b>, <b>acc3</b>, <b>familiar</b> (stickers and fake hands are not currently planned.)
| |
| − | <br>With positive weights, only the specified slots will be considered for maximization. With negative weights, all but the specified slots will be considered.
| |
| − | <br><b>empty</b> - With positive weight, consider only slots that are currently empty; with negative weight, only those that aren't empty. Either way, <b>+<i>slot</i></b> and <b>-<i>slot</i></b> can be used to further refine the selected slots.
| |
| − | <br><b>hand</b>ed - With a weight of 1, only 1-handed weapons will be considered. With a larger weight, only weapons with at least that handedness will be considered.
| |
| − | <br><b>melee</b> - With positive weight, only melee weapons will be considered. With negative weight, only ranged weapons will be considered.
| |
| − | <br><b>type <i>text</i></b> - Only weapons with a type containing <i>text</i> are considered; for example, <b>type club</b> if you plan to do some Seal Clubbing.
| |
| − | <br><b>shield</b> - With positive weight, only shields will be considered for your off-hand. Implies <b>1 handed</b>.
| |
| − | <br><b>equip <i>item</i></b> - The specified item is required (positive weight) or forbidden (negative weight). Multiple uses of <b>+equip</b> require all of the items to be equipped.
| |
| − | <br><b>outfit <i>name</i></b> - The specified standard outfit is required or forbidden. If the name is omitted, the currently equipped outfit is used. Multiple uses of <b>+outfit</b> are satisfied by any one of the outfits (since you can't be wearing more than one at a time).
| |
| − | <br>If both <b>+equip</b> and <b>+outfit</b> are used together, either one will satisfy the condition - all of the items, or one of the outfits. This special case is needed to be able to specify the conditions for adventuring in the Pirate Cove.
| |
| − | <br><b>tie</b>breaker - With negative weight, disables the use of a tiebreaker function that tries to choose equipment with generally beneficial attributes, even if not explicitly requested. There are only a few cases where this would be desirable: maximizing <b>+combat</b> or <b>-combat</b> (since there's usually only one item that can help), <b>adv</b> and/or <b>PvP fights</b> at rollover, and <b>familiar weight</b> when facing the Naughty Sorceress familiars.
| |
| − | <h3>Familiars</h3>
| |
| − | By default, the Modifier Maximizer does not recommend familiars, since there are many possible factors in choosing one beyond those that can be expressed via modifiers. However, you can request that specific familiars be compared with your current one:
| |
| − | <br><b>switch <i>familiar</i></b> - With positive weight, the familiar is added to the list to be considered (unless the player lacks that familiar, or is already using it, in which case there is no effect). With negative weight, the familiar is added to the list only if the player lacks the previously specified familiar. For example, <b>switch hobo monkey, -switch leprechaun</b> will only consider the leprechaun if the player doesn't have the monkey.
| |
| − | <h3>Assumptions</h3>
| |
| − | All suggestions are based on the assumption that you will be adventuring in the currently selected location, with all your current effects, prior to the next rollover (since some things depend on the moon phases). For best results, make sure the proper location is selected before maximizing. This is especially true in The Sea and clan dungeons, which have many location-specific modifiers.
| |
| − | <p>
| |
| − | Among effects, stat equalizer potions have a major effect on the suggested boosts, since they change the relative importance of additive and percentage stat boosts. Likewise, elemental phials make certain resistance boosts pointless. If you plan to use an equalizer or phial while adventuring, please use them first so that the suggestions take them into account.
| |
| − | <h3>GUI Use</h3>
| |
| − | If the Max Price field is zero or blank, the limit will be the smaller of your available meat, or your autoBuyPriceLimit (default 20,000). The other options should be self-explanatory.
| |
| − | <p>
| |
| − | You can select multiple boosts, and the title of the list will indicate the net effect of applying them all - note that this isn't always just the sum of their individual effects.
| |
| − | <h3>CLI Use</h3>
| |
| − | The Modifier Maximizer can be invoked from the gCLI or a script via <b>maximize <i>expression</i></b>, and will behave as if you'd selected Equipment: on-hand only, Max Price: don't check, and turned off the Include option. The best equipment will automatically be equipped (unless you invoked the command as <b>maximize? <i>expression</i></b>), but you'll still need to visit the GUI to apply effect boosts - there are too many factors in choosing between the available boosts for that to be safely automated. An error will be generated if the equipment changes weren't sufficient to fulfill all <b>min</b> keywords in the expression.
| |
| − | <h3>Limitations & Bugs</h3>
| |
| − | This is still a work-in-progress, so don't expect everything to work perfectly at the moment. However, here are some details that are especially broken:
| |
| − | * Items that can be installed at your campground for a bonus (such as Hobopolis bedding) aren't considered.
| |
| − | * Your song limit isn't considered when recommending buffs, nor are any daily casting limits.
| |
| − | * Mutually exclusive effects aren't handled properly.
| |
| − | * Weapon Damage, Ranged Damage, and Spell Damage are calculated assuming 100 points of base damage - in other words, additive and percentage boosts are considered to have exactly equal worth. It's possible that Weapon and Ranged damage might use a better estimate of the base damage in the future, but for Spell Damage, the proper base depends on which spell you end up using.
| |
| − | * Effects which vary in power based on how many turns are left (love songs, Mallowed Out, etc.) are handled poorly. If you don't have the effect, they'll be suggested based on the results you'd get from having a single turn of it. If you have the effect already, extending it to raise the power won't even be considered. Similar problems occur with effects that are based on how full or drunk you currently are.
| |