Kolmafia - User contributions [en]

Installation

2025-01-06T17:21:53Z

Ryo Sangnoir:

{{TOCright}}

== How to Download the latest version. ==
The latest source build can be downloaded from the following locations:

# [http://builds.kolmafia.us/ builds.kolmafia.us]
# the [https://github.com/kolmafia/kolmafia/releases GitHub releases page].

Both of these sources have tested versions that are posted shortly after developers change code.

The GitHub releases page contains both the KoLmafia-xxxxx.jar java binaries and installers for an experimental version that includes a bundled version of Java. If you use the installers, they manage the Java dependency listed below, but it can be more difficult to troubleshoot issues.

== Dependencies==

===Java 21 or higher===
KoLmafia depends on Java 21 or higher The recommended version is linked at the top of every page of kolmafia.us. If you are executing KoLmafia from a jarfile, you will need to install Java first.

If you do not have a recent version of Java, the recommended version (as of this writing) is [https://adoptium.net/index.html Java 21].

Oracle may have issues, for simplicity use [https://adoptium.net/temurin/releases/ Adoptium]. Any OpenJDK build should be okay too like [https://www.azul.com/downloads/#zulu Zulu Java].

====Testing your Java installation====
From a Command Prompt (or Terminal) window, enter <code>java -version</code>

If that returns something like this, you should be good to go.

<code>Michaels-MBP:~ mcroft$ java -version openjdk version "21.0.4" 2024-07-16 OpenJDK Runtime Environment (build 21.0.4+7-Ubuntu-1ubuntu224.04) OpenJDK 64-Bit Server VM (build 21.0.4+7-Ubuntu-1ubuntu224.04, mixed mode, sharing)</code>

== Troubleshooting Runtime Issues==
=== Java Errors===
Please be aware that some older versions of Java do not get completely replaced when installing a newer version. Usually this happens with Java 8 JRE and Java 11+ JDKs. If that makes no sense, just delete Java 8.

If you get a message like this:<code>Error: A JNI error has occurred, please check your installation and try again.</code> Please [https://kolmafia.us/threads/java-11-now-required-for-kolmafia-java-17-recommended.26579/ read this announcement].

===Scaling support on HiDPI Monitors===

If the KoLmafia application is unexpectedly small on a [https://techterms.com/definition/hidpi HiDPI]/Retina Display monitor, then support for HiDPI should enabled. This should only be required on Linux, since HiDPI support is enabled automatically on Windows and MacOS.

On Linux, using HiDPI with a Java Swing application (such as KoLmafia) requires that you execute the '.jar' file with an option set as follows: <code>java -Dsun.java2d.uiScale=<multiplier> -jar <jarfile></code>

Depending on the screen size, a multiplier of 1.6 or 2.0 may be appropriate. You may need to experiment to find the ideal scaling multiplier for your screens.

[[Category:Tech Support]]
[[Category:New User Help]]

Installation

2025-01-06T17:21:17Z

Ryo Sangnoir: Java 21

{{TOCright}}

== How to Download the latest version. ==
The latest source build can be downloaded from the following locations:

# [http://builds.kolmafia.us/ builds.kolmafia.us]
# the [https://github.com/kolmafia/kolmafia/releases GitHub releases page].

Both of these sources have tested versions that are posted shortly after developers change code.

The GitHub releases page contains both the KoLmafia-xxxxx.jar java binaries and installers for an experimental version that includes a bundled version of Java. If you use the installers, they manage the Java dependency listed below, but it can be more difficult to troubleshoot issues.

== Dependencies==

===Java 21 or higher===
KoLmafia depends on Java 21 or higher The recommended version is linked at the top of every page of kolmafia.us. If you are executing KoLmafia from a jarfile, you will need to install Java first.

If you do not have a recent version of Java, the recommended version (as of this writing) is [https://adoptium.net/index.html Java 21].

Oracle may have issues, for simplicity use [https://adoptium.net/temurin/releases/ Adoptium]. Any OpenJDK build should be okay too like [https://www.azul.com/downloads/#zulu Zulu Java].

====Testing your Java installation====
From a Command Prompt (or Terminal) window, enter <code>java -version</code>

If that returns something like this, you should be good to go.

<code>Michaels-MBP:~ mcroft$ java -version openjdk version "21.0.4" 2024-07-16 OpenJDK Runtime Environment (build 21.0.4+7-Ubuntu-1ubuntu224.04) OpenJDK 64-Bit Server VM (build 21.0.4+7-Ubuntu-1ubuntu224.04, mixed mode, sharing)

== Troubleshooting Runtime Issues==
=== Java Errors===
Please be aware that some older versions of Java do not get completely replaced when installing a newer version. Usually this happens with Java 8 JRE and Java 11+ JDKs. If that makes no sense, just delete Java 8.

If you get a message like this:<code>Error: A JNI error has occurred, please check your installation and try again.</code> Please [https://kolmafia.us/threads/java-11-now-required-for-kolmafia-java-17-recommended.26579/ read this announcement].

===Scaling support on HiDPI Monitors===

If the KoLmafia application is unexpectedly small on a [https://techterms.com/definition/hidpi HiDPI]/Retina Display monitor, then support for HiDPI should enabled. This should only be required on Linux, since HiDPI support is enabled automatically on Windows and MacOS.

On Linux, using HiDPI with a Java Swing application (such as KoLmafia) requires that you execute the '.jar' file with an option set as follows: <code>java -Dsun.java2d.uiScale=<multiplier> -jar <jarfile></code>

Depending on the screen size, a multiplier of 1.6 or 2.0 may be appropriate. You may need to experiment to find the ideal scaling multiplier for your screens.

[[Category:Tech Support]]
[[Category:New User Help]]

Equipped amount

2023-03-24T08:56:05Z

Ryo Sangnoir: add boolean

{{
#vardefine:name|equipped_amount}}{{
#vardefine:return_type|int}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|it}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|it}}|
parameter2={{Param|boolean|includeAllFamiliars}}|
p1desc={{Pspan|it}} is the item that will be checked for among your worn gear.|
p2desc={{Pspan|includeAllFamiliars}} is whether you want to check the familiars in your terrarium in addition to your current familiar.|
}}|

function_description=Returns the amount of a given item currently equipped on your character.|

code1={{CodeSample|
title=Code Sample|
description=Checks if you're safe to chat.|
code=
<syntaxhighlight>
if (equipped_amount($item[sword behind inappropriate prepositions]) == 1 && have_effect($effect[Wanged]) == 0)
// Sword doesn't fire if you have this particular effect.
abort("You aren't safe to chat!");
</syntaxhighlight>
}}|

see_also={{SeeAlso|closet_amount|display_amount|item_amount|shop_amount|stash_amount|storage_amount}}|
}}
[[Category:Item Management]][[Category:Equipment]]

Modifiers

2023-03-10T18:34:30Z

Ryo Sangnoir: add more modifiers, but we're missing a load

{{TOCright}}
Here is a comprehensive list of modifiers calculated by KoLmafia. Note that these are also available as ASH functions -- the first form, which takes one parameter, provides information about your character's current state; the second form, which takes two parameters, information about the object in question.

To view this list of modifiers as it pertains to your character [and a specified ''object''], use the CLI command "modref [''object'']". To see what affects a certain modifier (or modifiers), use "modtrace ''filter''". For a list of all items that modify ''modifier'', use "modifies ''modifier''".

More specific information regarding these modifiers is available in modifiers.txt, one of KoLmafia's internally-stored datafiles.

A list of the functions used to access these modifiers can be found at [[Modifier Functions]].

==Numeric Modifiers==
Note that although some of these functions have an ASH derivative that may be easier to use, the two-parameter form is still relevant and rather useful when obtaining information about a particular object, rather than your current state.

When not logged in, these all return 0 for the 1-parameter form of {{f|numeric_modifier}}.
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Modifier Name
! Related ASH function / Notes
|-
| Familiar Weight
| {{f|weight_adjustment}}
|-
| Monster Level
| {{f|monster_level_adjustment}}
|-
| Combat Rate
| {{f|combat_rate_modifier}}
|-
| Initiative
| {{f|initiative_modifier}}
|-
| Experience
| {{f|experience_bonus}}
|-
| Item Drop
| {{f|item_drop_modifier}}
|-
| Meat Drop
| {{f|meat_drop_modifier}}
|-
| Damage Absorption
| {{f|raw_damage_absorption}}
|-
| Damage Reduction
| {{f|damage_reduction}}
|-
| Cold Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[cold] )]], but returns the level of resistance.
|-
| Hot Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[hot] )]], but returns the level of resistance.
|-
| Sleaze Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[sleaze] )]], but returns the level of resistance.
|-
| Spooky Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[spooky] )]], but returns the level of resistance.
|-
| Stench Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[stench] )]], but returns the level of resistance.
|-
| Mana Cost
| Similar to {{f|mana_cost_modifier}} -- only counts up to the -3 cap.
|-
| Moxie
| Sum of all absolute moxie modifiers.
|-
| Moxie Percent
| Sum of all percentage-based moxie modifiers.
|-
| Muscle
| Sum of all absolute muscle modifiers.
|-
| Muscle Percent
| Sum of all percentage-based muscle modifiers.
|-
| Mysticality
| Sum of all absolute mysticality modifiers.
|-
| Mysticality Percent
| Sum of all percentage-based mysticality modifiers.
|-
| Maximum HP
| Sum of all absolute HP modifiers.
|-
| Maximum HP Percent
| Sum of all percentage-based HP modifiers.
|-
| Maximum MP
| Sum of all absolute MP modifiers.
|-
| Maximum MP Percent
| Sum of all percentage-based MP modifiers.
|-
| Weapon Damage
| Sum of all absolute weapon damage modifiers.
|-
| Ranged Damage
| Sum of all absolute ranged damage modifiers.
|-
| Spell Damage
| Sum of all absolute spell damage modifiers.
|-
| Spell Damage Percent
| Sum of all percentage-based spell damage modifiers.
|-
| Cold Damage
| Total cold damage.
|-
| Hot Damage
| Total hot damage.
|-
| Sleaze Damage
| Total sleaze damage.
|-
| Spooky Damage
| Total spooky damage.
|-
| Stench Damage
| Total stench damage.
|-
| Cold Spell Damage
| Total cold spell damage.
|-
| Hot Spell Damage
| Total hot spell damage.
|-
| Sleaze Spell Damage
| Total sleaze spell damage.
|-
| Spooky Spell Damage
| Total spooky spell damage.
|-
| Stench Spell Damage
| Total stench spell damage.
|-
| Underwater Combat Rate
| Combat rate modifier, but underwater only.
|-
| Fumble
| Fumble multiplier.
|-
| HP Regen Min
| Lower bound of all HP-regenerating effects/equipment.
|-
| HP Regen Max
| Upper bound of all HP-regenerating effects/equipment.
|-
| MP Regen Min
| Lower bound of all MP-regenerating effects/equipment.
|-
| MP Regen Max
| Upper bound of all MP-regenerating effects/equipment.
|-
| Adventures
| Bonus Rollover adventures
|-
| Familiar Weight Percent
| Percentage modifier of Familiar Weight (from Bad Moon effects; always <= 0)
|-
| Weapon Damage Percent
| Sum of all percentage-based weapon damage modifiers.
|-
| Ranged Damage Percent
| Sum of all percentage-based ranged damage modifiers.
|-
| Stackable Mana Cost
| Similar to {{f|mana_cost_modifier}} -- all other MP cost modifiers.
|-
| Hobo Power
| Hobo Power from equipment and effects (effect, technically).
|-
| Base Resting HP
| Average HP gained from resting.
|-
| Resting HP Percent
| Percentage modifier to HP gained from resting (e.g. from Pagoda).
|-
| Bonus Resting HP
| Absolute modifier to HP gained from resting (e.g. from Gauze hammock).
|-
| Base Resting MP
| MP gained from resting.
|-
| Resting MP Percent
| Percentage modifier to HP gained from resting (e.g. Pagoda).
|-
| Bonus Resting MP
| Absolute modifier to HP gained from resting (e.g. from Beanbag chair).
|-
| Critical Hit Percent
| Percentage modifiers to critical hits (e.g. Depleted Grimacite Kneecapping stick).
|-
| PvP Fights
| Bonus PvP fights upon Rollover.
|-
| Volleyball
| Only for use with multiple parameters (e.g. Llama returns .5, metallic foil radar dish returns -1).
|-
| Sombrero
| Only for use with multiple parameters (e.g. Baby Sandworm returns 1, metallic foil radar dish returns 1).
|-
| Leprechaun
| Only for use with multiple parameters (e.g. Hobo monkey returns 1.25).
|-
| Fairy
| Only for use with multiple parameters (e.g. Hound dog returns 1.25).
|-
| Meat Drop Penalty
| Penalty to Meat Drops; result of having an Underwater location selected as your current location.
|-
| Hidden Familiar Weight
| Bonus familiar weight that does not show up on the character pane (e.g. from Temporary Teardrop Tattoo).
|-
| Item Drop Penalty
| Penalty to Item Drops; result of having an Underwater location selected as your current location.
|-
| Initiative Penalty
| Penalty to Initiative Drops; result of having an Underwater location selected as your current location.
|-
| Food Drop
| Exclusive bonus to food drops (e.g. Brother Flying Burrito's Blessing).
|-
| Booze Drop
| Exclusive bonus to booze drops (e.g. Brother Smother's Blessing).
|-
| Hat Drop
| Exclusive bonus to hat drops (e.g. velcro broadsword).
|-
| Weapon Drop
| Exclusive bonus to weapon drops (e.g. pilgrim shield).
|-
| Offhand Drop
| Exclusive bonus to offhand drops (None at the moment; placeholder).
|-
| Shirt Drop
| Exclusive bonus to shirt drops (None at the moment; placeholder).
|-
| Pants Drop
| Exclusive bonus to pants drops (e.g. baneful bandolier).
|-
| Accessory Drop
| Exclusive bonus to accessory drops (e.g. velcro paddle ball).
|-
| Volleyball Effectiveness
| Exclusive to the Baby Mutant Rattlesnake; evaluates an expression that factors in the current moon phase.
|-
| Sombrero Effectiveness
| Currently only returns 0; placeholder.
|-
| Leprechaun Effectiveness
| Exclusive to the Mutant Cactus Bud; evaluates an expression that factors in the current moon phase.
|-
| Fairy Effectiveness
| Exclusive to the Mutant Fire Ant; evaluates an expression that factors in the current moon phase.
|-
| Familiar Weight Cap
| Relevant only to the Mad Hatrack; returns maximum base weight based on equipment.
|-
| Slime Resistance
| Similar to [[elemental_resistance|elemental_resistance( $element[slime] )]], but returns the level of resistance.
|-
| Slime Hates It
| Number of Slime Hates It active, as taken from equipment and effects.
|-
| Spell Critical Percent
| Increased absolute spell critical rate.
|-
| Muscle Experience
| +X Mus substats/fight
|-
| Mysticality Experience
| +X Mys substats/fight
|-
| Moxie Experience
| +X Mox substats/fight
|-
| Effect Duration
| For use with the two-parameter form, using item as the other parameter. Returns duration of effect for potions.
|-
| Candy Drop
| Exclusive bonus to candy drops (e.g. peanut brittle shield).
|-
| DB Combat Damage
| Bonus damage from using DB combat skills (e.g. Chester's moustache)
|-
| Sombrero Bonus
| Provides X pounds of Sombrero (e.g. tiny sombrero)
|-
| Familiar Experience
| Bonus experience for familiars (e.g. Brother Corsican's Blessing)
|-
| Sporadic Meat Drop
| Bonus to Meat Drop that has a <100% chance of occurring (e.g. mayflower bouquet)
|-
| Sporadic Item Drop
| Bonus to Item Drop that has a <100% chance of occurring (e.g. mayflower bouquet)
|-
| Meat Bonus
| Absolute bonus to Meat Drop (e.g. ant sickle)
|-
| Pickpocket Chance
| Bonus to pickpocket chance (e.g. Elvish Sunglasses)
|-
| Combat Mana Cost
| Reduction to skill cost, in-combat only (e.g. camouflage T-shirt)
|-
|Muscle Experience Percent
| +X% to all Muscle Gains
|-
|Mysticality Experience Percent
| +X% to all Mysticality Gains
|-
|Moxie Experience Percent
| +X% to all Moxie Gains
|-
| Minstrel Level
| Level of Boris' Minstrel, Clancy
|-
| Muscle Limit
| Limit to Base Muscle
|-
| Mysticality Limit
| Limit to Base Mysticality
|-
| Moxie Limit
| Limit to Base Moxie
|-
| Song Duration
| Length of accordion song cast by accordion
|-
| Smithsness
| Bonus to Smithsness (used by The Smith's equipment)
|-
| Supercold Resistance
| Resistance to supercold damage (inflicted by warbears)
|-
| Reduce Enemy Defense
| Reduce enemy defense stat by a given percentage
|-
| Pool Skill
| How good you are at playing pool in The Haunted Billiards Room
|-
| Familiar Damage
| How much damage your familiar deals (e.g. autumn leaf pendant)
|-
| Gear Drop
| Exclusive bonus to gear drop (e.g. Combat Lover's Locket after reminiscing a Demon)
|-
| Damage Aura
| Sources of damage each turn (e.g. smirking shrunken head)
|-
| Sporadic Damage Aura
| Average sources of damage each turn, but not every turn (e.g. Biologically Shocked)
|-
| Thorns
| Source of damage when the enemy hits you (e.g. Spiky Shell)
|-
| Sporadic Thorns
| Average sources of damage when the enemy hits you, but not every turn (e.g. cannonball charrrm bracelet)
|}

==Derived Modifiers==
These are modifiers that are calculated based on other modifier values, rather than being a property of individual items. They can be used just like the numeric modifier names above, but are fairly useless with the one-parameter form of the function since you can easily retrieve the actual values (which may differ slightly from these predicted values, due to different rounding behavior or other errors in KoLmafia's modifier calculations). The intended usage is in the form numeric_modifier("_spec", ''name''), to determine the results of a potential equipment or effect change that has been tested by the CLI '''whatif''' command.
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Modifier Name
! Related ASH function / Notes
|-
| Buffed Muscle
| Predicted value of [[my_buffedstat|my_buffedstat($stat[muscle])]]
|-
| Buffed Mysticality
| Predicted value of [[my_buffedstat|my_buffedstat($stat[mysticality])]]
|-
| Buffed Moxie
| Predicted value of [[my_buffedstat|my_buffedstat($stat[moxie])]]
|-
| Buffed HP Maximum
| Predicted value of {{f|my_maxhp}}
|-
| Buffed MP Maximum
| Predicted value of {{f|my_maxmp}}
|}

==Bitmap Modifiers==
Note: This does not have a corresponding ASH function. Instead, these modifiers can all be called using the {{f|numeric_modifier}} function.

When not logged in, these all return 0x0 (0).
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Modifier Name
! Notes
|-
| Clownosity
| If this is >= 4, you can "Push the nose" in the Fun House. Might be "Clowniness" now.
|-
| Raveosity
| If this is >= 7, you can "Get into the club".
|-
| Brimstone
| These have many "bonuses" when you equip more of them at once.
|-
| Synergetic
| For items that have hidden bonuses when used together, such as the Secrets from the Future and the snake/wolf sword & shield.
|}

==Boolean Modifiers==
When not logged in, these all return false for the 1-parameter form of {{f|boolean_modifier}}.
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Modifier Name
! Notes
|-
| Softcore Only
| For use with the parameter "item"; returns true if the item in question has the Softcore Only flag (e.g. Travoltan Trousers).
|-
| Single Equip
| For use with the parameter "item"; returns true if the item in question has the Single Equip flag (e.g. plexiglass pendant).
|-
| Never Fumble
| Returns true if the player has an effect that prevents fumbling.
|-
| Weakens Monster
| For use with the parameter "item"; returns true if the item in question delevels on hit (e.g. 7-foot dwarven mattock).
|-
| Free Pull
| For use with the parameter "item"; returns true if the item in question can be pulled from Hagnk's for free (e.g. roll of toilet paper).
|-
| Variable
| For use with the parameter "item"; returns true if the item in question has a variable effect (e.g. depleted grimacite grappling hook).
|-
| Nonstackable Watch
| For use with the parameter "item"; returns true if the item in question counts as one of the nonstackable watches (e.g. dead guy's watch).
|-
| Lasts Until Rollover
| For use with the parameter "item"; returns true if the item in question disappears at rollover
|-
| Cold Immunity
| Returns true if Coldform is active.
|-
| Hot Immunity
| Returns true if Hotform is active.
|-
| Sleaze Immunity
| Returns true if Sleazeform is active.
|-
| Spooky Immunity
| Returns true if Spookyform is active.
|-
| Stench Immunity
| Returns true if Stenchform is active.
|-
| Cold Vulnerability
| Returns true if the player is vulnerable to Cold (e.g. from Sleazeform).
|-
| Hot Vulnerability
| Returns true if the player is vulnerable to Hot (e.g. from Spookyform).
|-
| Sleaze Vulnerability
| Returns true if the player is vulnerable to Sleaze (e.g. from Stenchform).
|-
| Spooky Vulnerability
| Returns true if the player is vulnerable to Spooky (e.g. from Coldform).
|-
| Stench Vulnerability
| Returns true if the player is vulnerable to Stench (e.g. from Hotform).
|-
| Moxie Controls MP
| Returns true if the player has a moxie magnet equipped.
|-
| Moxie May Control MP
| Returns true if the player has Travoltan Trousers equipped.
|-
| Four Songs
| Returns true if the player is able to "Keep 4 songs in [his] head instead of 3" (e.g. Brimstone Beret).
|-
| Additional Song
| Returns true if the player has the bonus from the El Hebilla del Cinturón de Lopez (Accordion Thief Epic Accessory).
|-
| Adventure Underwater
| Returns true if the player has some way to breathe underwater (e.g. makeshift SCUBA gear).
|-
| Underwater Familiar
| Returns true if the player's familiar has some way to breathe underwater (e.g. das boot).
|-
| Generic
| Returns true if the item in question can be equipped to all familiars.
|}

==String Modifiers==
Note: These use the two-parameter form, for the most part.
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Modifier Name
! Notes
|-
| Class
| Returns the class you must be to benefit from any of the enchantments on this item.
|-
| Effect
| Returns the effect that KoL associates with a potion (which may not be the potion's only effect).
|-
| Equalize
| Returns the base stat of an equalizer potion.
|-
| Equips On
| Holds a <nowiki>|</nowiki>-separated list of familiars that the item equips on. Not needed for the basic familiar-specific item listed in familiars.txt.
|-
| Familiar Tuning
| For use with Bandersnatch fold-able equipment; returns the stat associated with the item.
|-
| Intrinsic Effect
| Returns the intrinsic effect granted by a piece of equipment (e.g. Chapped Legs from leather chaps).
|-
| Modifiers
| Returns the raw text of this item's modifier data, useful for a quick view of all its enchantments.
|-
| Outfit
| Returns the name of the outfit (non-custom, folks!) that this item is part of.
|-
| Sign:xxx
| Returns sign specific modifiers. e.g. {{Pspan|string_modifier( "Sign:Vole", "Modifiers" )}} returns all modifiers related to being born under the Vole.
|-
| Stat Tuning
| For use with Crimbo '06 items, like tropical paperweight; returns the stat associated with the item.
|-
| Wiki Name
| Returns an empty string unless it is different, in which case the special HTML entities have been replaced. (e.g. frigid hankyu)
|}

[[Category:Scripting]]

Modifier Maximizer

2023-03-10T18:14:07Z

Ryo Sangnoir: /* Equipment */

{{TOCright}}

=Usage=
==General==
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.

Numeric weights determine how much an individual keyword will be counted toward the score that Mafia assigns to each combination. For instance, "2 item drop" will force item drop to contribute four times as much as, say, ".5 meat drop" in the expression "maximize 2 item drop, .5 meat drop". The weights are simply multiplied with the corresponding modifier, so in the preceding expression, a natty blue ascot would contribute 20*.5 = 10 to your score, while a lucky rabbit's foot would contribute 2*7 + .5*7 = 17.5 to your score.

==Numeric Modifiers==
The full name of any numeric modifier (as shown by the '''modref''' 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.

Shorter forms are allowed for many commonly used modifiers. They can be abbreviated down to just the bold letters:
 '''mus''', '''mys''', '''mox''', '''main'''stat, '''HP''', '''MP''', '''ML''', '''DA''', '''DR''', '''com'''bat rate, '''item''' drop, '''meat''' drop, '''exp'''erience, '''(spell) crit'''ical, '''adv'''entures, '''fites''' for "pvp fights"
 Also, resistance (of any type) can be abbreviated as '''res''', and damage can be abbreviated as '''dmg'''. '''all res'''istance is a shortcut for giving the same weight to all five basic elements. Likewise, '''elemental dmg''' is a shortcut for the five elemental damage types. '''passive damage''' will look for both '''damage aura''' (every round) and '''thorns''' (when hit).

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.

'''ocrs''' will maximize gear that increases the number of monster modifiers.

Finally, '''prismatic''' (dmg or res) is a derived modifier that attempts to provide a balance of all elemental types. By contrast the '''elemental''' modifier will attempt to maximize all elements, even if it means that some of the elements will get no boost at all.

==Limits==
Any numeric modifier keyword can be followed by one or both of these special keywords:
 '''min''' – The weight specifies the minimum acceptable value for the preceding modifier. If the value is lower, the results will be flagged as a failure.
 '''max''' – 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.
 Note that the limit keywords won't quite work as expected for a modifier that you're trying to minimize.
 If '''min''' or '''max''' 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 '''max''' may allow equipment maximization to finish faster, since no further combinations will be considered once the specified value is reached.+
 The preference '''maximizerCombinationLimit''' (set with '''set maximizerCombinationLimit = 100000''' in CLi) constrains the number of combinations Maximizer will consider. Depending where it is set, this may mean you don't get the best combination, but you may well get a good enough one faster. Depending which equipment you can use, you may find a higher value than 100000 is needed.

==Other Modifiers==
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: '''sea''' requires both Adventure Underwater and Underwater Familiar to be true.

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 '''4 clownosity''' and '''7 raveosity''' are the only useful forms.

String modifiers are not currently meaningful for maximization.

The 'Bees Hate You' challenge path adds a '''beeosity''' keyword, which specifies the maximum number of 'B's allowed in the names of your equipment items (each of which causes 10% of your maximum HP in damage at the start of every combat). The default is 2 at the moment. The value you specify will automatically be increased if you use a +'''equip''' or +'''outfit''' keyword (described below) that requires more 'B's to satisfy.

Some extra provided keywords are useful in PvP minigames. '''number''' increases score by the number of numbers in a piece of equipment's name. '''letter''' increases score by the number of letters in the name, and '''letter X''' can be used to count the number of Xs.
==Equipment==
Slot names can be used as keywords:
 '''hat''', '''weapon''', '''offhand''', '''shirt''', '''pants''', '''acc1''', '''acc2''', '''acc3''', '''familiar''' (stickers and fake hands are not currently planned.)
 With positive weights, only the specified slots will be considered for maximization. With negative weights, all but the specified slots will be considered.
 '''empty''' – With positive weight, consider only slots that are currently empty; with negative weight, only those that aren't empty. Either way, '''+''slot''''' and '''-''slot''''' can be used to further refine the selected slots.
 '''hand'''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.
 '''melee''' – With positive weight, only melee weapons will be considered. With negative weight, only ranged weapons will be considered.
 '''effective''' – With positive weight, if muscle higher than moxie, only melee weapons are considered, if moxie higher or equal to muscle, ranged weapons (and knives with Tricky Knifework known) are considered.
 '''type ''text''''' – Only weapons with a type containing ''text'' are considered; for example, '''type club''' if you plan to do some Seal Clubbing.
 '''shield''' – With positive weight, only shields will be considered for your off-hand. Implies '''1 handed'''.
 '''club''' – With positive weight, only clubs will be considered for your main-hand.
 '''sword''' – With positive weight, only swords will be considered for your main-hand.
 '''shield''' – With positive weight, only shields will be considered for your off-hand. Implies 1 handed.
 '''utensil''' – With positive weight, only utensils will be considered for your main-hand.
 '''knife''' – With positive weight, only knives will be considered for your main-hand.
 '''accordion''' – With positive weight, only accordions will be considered for your main-hand.
 '''current''' – By default Maximizer considers your current equipment in Hardcore and Ronin. With -current keyword it does not, with +current keyword in aftercore it forces it to be considered. Not considering current equipment will reduce the number of combinations considered, but will sometimes mean changes of equipment are suggested even though they don't improve what you are wearing.
 '''equip ''item''''' – The specified item is required (positive weight) or forbidden (negative weight). Multiple uses of '''+equip''' require all of the items to be equipped.
 '''bonus ''item''''' – The specified item is given a bonus to its score equivalent to weight.
 '''outfit ''name''''' – The specified standard outfit is required or forbidden. If the name is omitted, the currently equipped outfit is used. Multiple uses of '''+outfit''' are satisfied by any one of the outfits (since you can't be wearing more than one at a time).
 '''pirate''' – With positive weight, wear either Swashbuckling outfit or Pirate Fledges.
 '''plumber''' – If a plumber, require a plumber-specific weapon to be equipped (required to adventure).
 '''cold plumber''' – If a plumber, require a plumber-specific weapon that can deal cold damage to be equipped. Useful for getting Blech House.
 If both '''+equip''' and '''+outfit''' 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.
 '''tie'''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 '''+combat''' or '''-combat''' (since there's usually only one item that can help), '''adv''' and/or '''PvP fights''' at rollover, and '''familiar weight''' when facing the Naughty Sorceress familiars.

==Familiars==
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:
 '''switch ''familiar''''' – 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, '''switch hobo monkey, -switch leprechaun''' will only consider the leprechaun if the player doesn't have the monkey.
==Assumptions==
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.

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.
==GUI Use==
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.

Prices are based on the mall price database, so if the price has been looked up in the last 7 days that value is used, otherwise the current mall price is queried. If preference '''maximizerCurrentMallPrices''' is set to true the current mall price is always queried, this will be much slower and cause many more server hits.

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.
==CLI Use==
The Modifier Maximizer can be invoked from the gCLI or a script via '''maximize ''expression''''', 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 '''maximize? ''expression'''''), 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 '''min''' keywords in the expression.
==Limitations & Bugs==
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.

=Useful Expressions=
'''MP regen''': .5 mp regen max, .5 mp regen min

'''Pirates''': mainstat, +outfit swashbuckling

'''War''': mainstat, +outfit frat warrior

'''Shieldbutting''': muscle, +shield

=More Information=

Here is the expression used as '''tie'''breaker:

:"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";

See [http://kolmafia.us/showthread.php?4274 this thread] for details.
<h2>See Also</h2><div style="border: dashed 1px green; margin: 0.2em; padding: 1em; width=75%; background-color: #fff8dc;"><center>[[Modifiers]]</center></div>
[[Category:Automation]]

Modifier Maximizer

2023-03-10T18:13:36Z

Ryo Sangnoir: make more like maximizer help

{{TOCright}}

=Usage=
==General==
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.

Numeric weights determine how much an individual keyword will be counted toward the score that Mafia assigns to each combination. For instance, "2 item drop" will force item drop to contribute four times as much as, say, ".5 meat drop" in the expression "maximize 2 item drop, .5 meat drop". The weights are simply multiplied with the corresponding modifier, so in the preceding expression, a natty blue ascot would contribute 20*.5 = 10 to your score, while a lucky rabbit's foot would contribute 2*7 + .5*7 = 17.5 to your score.

==Numeric Modifiers==
The full name of any numeric modifier (as shown by the '''modref''' 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.

Shorter forms are allowed for many commonly used modifiers. They can be abbreviated down to just the bold letters:
 '''mus''', '''mys''', '''mox''', '''main'''stat, '''HP''', '''MP''', '''ML''', '''DA''', '''DR''', '''com'''bat rate, '''item''' drop, '''meat''' drop, '''exp'''erience, '''(spell) crit'''ical, '''adv'''entures, '''fites''' for "pvp fights"
 Also, resistance (of any type) can be abbreviated as '''res''', and damage can be abbreviated as '''dmg'''. '''all res'''istance is a shortcut for giving the same weight to all five basic elements. Likewise, '''elemental dmg''' is a shortcut for the five elemental damage types. '''passive damage''' will look for both '''damage aura''' (every round) and '''thorns''' (when hit).

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.

'''ocrs''' will maximize gear that increases the number of monster modifiers.

Finally, '''prismatic''' (dmg or res) is a derived modifier that attempts to provide a balance of all elemental types. By contrast the '''elemental''' modifier will attempt to maximize all elements, even if it means that some of the elements will get no boost at all.

==Limits==
Any numeric modifier keyword can be followed by one or both of these special keywords:
 '''min''' – The weight specifies the minimum acceptable value for the preceding modifier. If the value is lower, the results will be flagged as a failure.
 '''max''' – 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.
 Note that the limit keywords won't quite work as expected for a modifier that you're trying to minimize.
 If '''min''' or '''max''' 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 '''max''' may allow equipment maximization to finish faster, since no further combinations will be considered once the specified value is reached.+
 The preference '''maximizerCombinationLimit''' (set with '''set maximizerCombinationLimit = 100000''' in CLi) constrains the number of combinations Maximizer will consider. Depending where it is set, this may mean you don't get the best combination, but you may well get a good enough one faster. Depending which equipment you can use, you may find a higher value than 100000 is needed.

==Other Modifiers==
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: '''sea''' requires both Adventure Underwater and Underwater Familiar to be true.

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 '''4 clownosity''' and '''7 raveosity''' are the only useful forms.

String modifiers are not currently meaningful for maximization.

The 'Bees Hate You' challenge path adds a '''beeosity''' keyword, which specifies the maximum number of 'B's allowed in the names of your equipment items (each of which causes 10% of your maximum HP in damage at the start of every combat). The default is 2 at the moment. The value you specify will automatically be increased if you use a +'''equip''' or +'''outfit''' keyword (described below) that requires more 'B's to satisfy.

Some extra provided keywords are useful in PvP minigames. '''number''' increases score by the number of numbers in a piece of equipment's name. '''letter''' increases score by the number of letters in the name, and '''letter X''' can be used to count the number of Xs.
==Equipment==
Slot names can be used as keywords:
 '''hat''', '''weapon''', '''offhand''', '''shirt''', '''pants''', '''acc1''', '''acc2''', '''acc3''', '''familiar''' (stickers and fake hands are not currently planned.)
 With positive weights, only the specified slots will be considered for maximization. With negative weights, all but the specified slots will be considered.
 '''empty''' – With positive weight, consider only slots that are currently empty; with negative weight, only those that aren't empty. Either way, '''+''slot''''' and '''-''slot''''' can be used to further refine the selected slots.
 '''hand'''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.
 '''melee''' – With positive weight, only melee weapons will be considered. With negative weight, only ranged weapons will be considered.
 '''effective''' – With positive weight, if muscle higher than moxie, only melee weapons are considered, if moxie higher or equal to muscle, ranged weapons (and knives with Tricky Knifework known) are considered.
 '''type ''text''''' – Only weapons with a type containing ''text'' are considered; for example, '''type club''' if you plan to do some Seal Clubbing.
 '''shield''' – With positive weight, only shields will be considered for your off-hand. Implies '''1 handed'''.
 '''club''' – With positive weight, only clubs will be considered for your main-hand.
 '''sword''' – With positive weight, only swords will be considered for your main-hand.
 '''shield''' – With positive weight, only shields will be considered for your off-hand. Implies 1 handed.
 '''utensil''' – With positive weight, only utensils will be considered for your main-hand.
 '''knife''' – With positive weight, only knives will be considered for your main-hand.
 '''accordion''' – With positive weight, only accordions will be considered for your main-hand.
 '''current'''''' – By default Maximizer considers your current equipment in Hardcore and Ronin. With -current keyword it does not, with +current keyword in aftercore it forces it to be considered. Not considering current equipment will reduce the number of combinations considered, but will sometimes mean changes of equipment are suggested even though they don't improve what you are wearing.
 '''equip ''item''''' – The specified item is required (positive weight) or forbidden (negative weight). Multiple uses of '''+equip''' require all of the items to be equipped.
 '''bonus ''item''''' – The specified item is given a bonus to its score equivalent to weight.
 '''outfit ''name''''' – The specified standard outfit is required or forbidden. If the name is omitted, the currently equipped outfit is used. Multiple uses of '''+outfit''' are satisfied by any one of the outfits (since you can't be wearing more than one at a time).
 '''pirate''' – With positive weight, wear either Swashbuckling outfit or Pirate Fledges.
 '''plumber''' – If a plumber, require a plumber-specific weapon to be equipped (required to adventure).
 '''cold plumber''' – If a plumber, require a plumber-specific weapon that can deal cold damage to be equipped. Useful for getting Blech House.
 If both '''+equip''' and '''+outfit''' 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.
 '''tie'''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 '''+combat''' or '''-combat''' (since there's usually only one item that can help), '''adv''' and/or '''PvP fights''' at rollover, and '''familiar weight''' when facing the Naughty Sorceress familiars.

==Familiars==
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:
 '''switch ''familiar''''' – 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, '''switch hobo monkey, -switch leprechaun''' will only consider the leprechaun if the player doesn't have the monkey.
==Assumptions==
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.

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.
==GUI Use==
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.

Prices are based on the mall price database, so if the price has been looked up in the last 7 days that value is used, otherwise the current mall price is queried. If preference '''maximizerCurrentMallPrices''' is set to true the current mall price is always queried, this will be much slower and cause many more server hits.

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.
==CLI Use==
The Modifier Maximizer can be invoked from the gCLI or a script via '''maximize ''expression''''', 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 '''maximize? ''expression'''''), 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 '''min''' keywords in the expression.
==Limitations & Bugs==
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.

=Useful Expressions=
'''MP regen''': .5 mp regen max, .5 mp regen min

'''Pirates''': mainstat, +outfit swashbuckling

'''War''': mainstat, +outfit frat warrior

'''Shieldbutting''': muscle, +shield

=More Information=

Here is the expression used as '''tie'''breaker:

:"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";

See [http://kolmafia.us/showthread.php?4274 this thread] for details.
<h2>See Also</h2><div style="border: dashed 1px green; margin: 0.2em; padding: 1em; width=75%; background-color: #fff8dc;"><center>[[Modifiers]]</center></div>
[[Category:Automation]]

JavaScript Support

2022-12-13T08:48:06Z

Ryo Sangnoir: /* Library Functions */ neat trick for javascript scripts

As of revision 20509, KoLmafia supports scripting in JavaScript! You can run JS code from the CLI using <code>js <nowiki><code></nowiki></code>, and you can call scripts through any of the normal methods. Consult and "lifecycle" scripts (e.g. <code>betweenBattleScript</code>) are supported, too! '''This support is still experimental - you have been warned.'''

== Basics ==

=== Library Functions ===
All functions in the ASH runtime library are available inside the built-in <code>kolmafia</code> module. To use these functions, you must use the <code>require()</code> function to import them:

<syntaxhighlight lang="js">
const { print, myName() } = require("kolmafia");
print("Hello, " + myName());

// Alternative
const kolmafia = require("kolmafia");
kolmafia.print("Hello, " + kolmafia.myName());

// Alternative to have all functions in the global namespace
Object.assign(globalThis, require("kolmafia"));
print("Hello, " + myName());
</syntaxhighlight>

The <code>require()</code> function is usually called once at the top of the script.

Names of ASH functions are converted to [[wikipedia:CamelCase|camelCase]]. For example, {{f|print_html}} in ASH becomes <code>printHtml()</code> in JavaScript:

{| class="wikitable"
! style="width: 50%" | ASH
! style="width: 50%" | JavaScript
|- style="vertical-align: top"
|
<syntaxhighlight lang="d">
print_html("Some text");
</syntaxhighlight>
|
<syntaxhighlight lang="js">
const { printHtml } = require("kolmafia");
print("Some text");
</syntaxhighlight>
|}

When directly executing inline JavaScript code with the <code>js</code> or <code>jsq</code> commands, all library functions are already imported for you, so you don't have to import them:

> js print("My name is " + myName())
My name is <playername>

=== Importing and Exporting ===
KoLmafia uses the [[wikipedia:CommonJS|CommonJS]] module system, similar to [[wikipedia:Node.js|Node.js]]. You can export functions and values from one JavaScript file and import them from another JavaScript file:

{| class="wikitable"
! style="width: 50%" | <code>source.js</code>
! style="width: 50%" | <code>runner.js</code>
|- style="vertical-align: top"
|
<syntaxhighlight lang="js">
const { print } = require("kolmafia");
module.exports.hello = function hello() {
print("Hello, world!");
};
</syntaxhighlight>
|
<syntaxhighlight lang="js">
const { hello } = require("./source.js");
hello();
</syntaxhighlight>
|}

Check out [https://flaviocopes.com/commonjs/ this guide] for more examples.

You can export a function named <code>main()</code> to run it only when the script is invoked directly. When your script is imported by another script, the <code>main()</code> function will be ignored.

You can also import ASH scripts from JavaScript code. For details, see [[JavaScript Support#ASH_and_JavaScript_Interoperability|ASH and JavaScript Interoperability]].

=== Data Type Classes ===
All [[Data Types#Special Datatypes|enumerated data types]] in ASH are available as classes in JavaScript. For example, {{type|monster}} is available as the <code>Monster</code> class, and {{type|item}} is available as the <code>Item</code> class.

Each enumerated class has the following static methods:

* <code><ClassName>.get()</code> takes a number or string and returns an object of the class.
** For example, <code>Monster.get("fiendish can of asparagus")</code> is equivalent to <code>$monster[ fiendish can of asparagus ]</code> in ASH. <code>Item.get(1)</code> is equivalent to <code>$item[ 1 ]</code>.
** This also accepts string representations of integers. For example, <code>Item.get(5)</code> and <code>Item.get("5")</code> return the same result.
* <code><ClassName>.get()</code> can also take an array of numbers and strings, and return an array of objects.
** For example, <code>Item.get(["seal-clubbing club", "pail", 5])</code> is similar to <code>$items[ seal-clubbing club, pail, 5 ]</code> in ASH. However, the JavaScript version returns an array of objects, instead of a boolean map.
** Passing an empty array returns an empty array (i.e. <code>Item.get([])</code> is ''not'' the same as <code>$items[]</code>).
* <code><ClassName>.all()</code> takes no argument and returns all possible values of the class.
** For example, <code>Monster.all()</code> returns an array of all known monsters. This is similar to <code>$monsters[]</code> in ASH.

Enumerated objects support the <code>toString()</code> method, which acts like the {{f|to_string}} ASH function.

To retrieve the numeric ID of enumerated objects, use the {{f|to_int|toInt}} library function:

<syntaxhighlight lang="js">
let item = Item.get("filthy lucre");
let itemId = toInt(item);
</syntaxhighlight>

=== Other ===
* ASH maps are converted to plain JS objects, and ASH arrays are converted to JS arrays.
* You can look at the type reference for the JS version of the ASH runtime library with <code>jsref</code>, which works just like <code>ashref</code>.

== ASH and JavaScript Interoperability ==

JavaScript scripts can <code>require()</code> ASH scripts and use their functions. When an ASH script is <code>require()</code>-ed by JavaScript code, KoLmafia will execute top-level code, but only export functions in the top-level scope. ASH variables are not exported.

For example, you can use [[Zlib]] if it is installed:

<syntaxhighlight lang="js" line>
const { getvar } = require("zlib.ash");
let myvar = getvar("SOME_VAR_NAME");
</syntaxhighlight>

ASH scripts cannot <code>import</code> JavaScript scripts.

== JavaScript Version and Features ==
KoLmafia uses the [[wikipedia:Rhino (JavaScript engine)|Rhino]] engine to execute JavaScript code. Rhino supports an older version of JavaScript called "ES5", plus some features from newer versions. This means that many JavaScript features that work in web browsers might not work in KoLmafia.

Here is an incomplete list of post-ES5 features supported by Rhino ([https://kolmafia.us/threads/javascript-bugs.25638/post-160384 source]):

=== Supported ===
* Syntax
** <code>let</code> and (partially) <code>const</code>
*** Does not support block-level scoping or temporal dead zones, meaning that you cannot use <code>const</code> for loop variables. <code>for (const a in obj) { ... }</code> is a syntax error.
** Array/object destructuring (but spread/rest syntax (<code>...</code>) is ''not'' supported)
** <code>for...of</code> loop
** Arrow functions: <code>() => {}</code>
** Octal and binary literals
* Features
** Symbol
** Set, Map, WeakSet, WeakMap
** ES2015 methods in Array, Math, Number, Object, String
** <code>Array.prototype.includes()</code>
** <code>String.prototype.padStart()/padEnd()/trimStart()/trimEnd()</code>
** TypedArray: Can be constructed, but most TypedArray-specific methods are unavailable.

=== Unsupported ===
* Syntax
** Spread/rest syntax (<code>...</code>)
** Object destructuring in assignments (variable declarations are OK)
** Template string literals: Backtick string literals (<code>``</code>) are not a syntax error, but are treated as plain string literals.
** Classes
** ECMAScript modules (<code>import</code>/<code>export</code>)
** Default function parameters
** Computed property names
** Shorthand property names (in object literals)
** Exponentiation operator (<code>**</code>)
** Async/Await
** Trailing commas in function definitions (oddly, trailing commas are supported in function ''calls'')
* Features
** Promise
** Proxy
** Reflect

=== Other ===
Most JavaScript globals available in browsers and/or server-side environments like Node.js are ''not'' available. This includes <code>alert()</code>, <code>console.log()</code>, and <code>setTimeout()</code>.

== Code Checking ==

You can set up [https://eslint.org/ ESLint] to check your code for errors.

The following ESLint configuration (<code>.eslintrc.json</code>) checks if your JavaScript code uses features unsupported by KoLmafia, and prevents ESLint from complaining about KoLmafia builtins.

<syntaxhighlight lang="json">
{
"env": {
"commonjs": true,
"es6": true
},
"globals": {
"Promise": "off",
"Proxy": "off",
"Reflect": "off",
"Bounty": "readonly",
"Class": "readonly",
"Coinmaster": "readonly",
"Effect": "readonly",
"Element": "readonly",
"Familiar": "readonly",
"Item": "readonly",
"Location": "readonly",
"Monster": "readonly",
"Phylum": "readonly",
"Servant": "readonly",
"Skill": "readonly",
"Slot": "readonly",
"Stat": "readonly",
"Thrall": "readonly"
},
"parserOptions": {
"ecmaVersion": 6
},
"rules": {
"no-restricted-syntax": [
"error",
{
"selector": "AssignmentExpression > ObjectPattern",
"message": "Rhino does not support object destructuring in assignments (variable declarations are OK)"
},
{
"selector": "AssignmentPattern",
"message": "Rhino does not support default values for function parameters and array/object destructuring"
},
{
"selector": "ClassDeclaration, ClassExpression",
"message": "Rhino does not support ES2015 classes"
},
{
"selector": ":matches(ForInStatement, ForOfStatement, ForStatement) > VariableDeclaration[kind=const]",
"message": "Rhino does not support const declarations in the head of for-loops"
},
{
"selector": "ObjectExpression > Property[shorthand=true]",
"message": "Rhino does not support shorthand object properties"
},
{
"selector": "Property[computed=true]",
"message": "Rhino does not support computed object properties"
},
{
"selector": "RestElement, SpreadElement",
"message": "Rhino does not support spread/rest syntax"
},
{
"selector": "TemplateLiteral",
"message": "Rhino does not support template string literals"
}
]
}
}
</syntaxhighlight>

Note that this is unnecessary if you use a transpiler to convert modern JavaScript code to Rhino-compatible syntax.

== Transpiling ==

Various tools as Babel, Webpack, and TypeScript can convert modern JavaScript code (or another programming language) to legacy syntax supported by Rhino. These tools are called "transpilers". These tools allow you to enjoy the convenience and safety of modern language features, while still generating code that runs on KoLmafia.

=== [https://babeljs.io/ Babel] ===

Babel 7.15.0 supports Rhino as a compilation target.

The following config file (<code>babel.config.json</code>) will convert modern JavaScript syntax to Rhino-compatible ES5+:

<syntaxhighlight lang="json">
{
"presets": [
[
"@babel/preset-env",
{
"modules": false,
"targets": {
"rhino": "1.7.13"
}
}
]
]
}
</syntaxhighlight>

* Babel: As of r20558, you will still need to apply several patches to Babel in order to get babel-preset-env to work. See [https://github.com/phulin/bean-casual/tree/ts] for an example of a working Babel/Webpack/Typescript configuration; you'll need the configuration files and also the patches, which can be applied with patch-package.

=== [https://www.typescriptlang.org/ TypeScript] ===

TypeScript is a statically typed programming language that can be transpiled to JavaScript.

If you use TypeScript without Babel, you can set the <code>[https://www.typescriptlang.org/tsconfig#target target]</code> to <kbd>"ES5"</kbd>.

TypeScript does not provide [[wikipedia:Polyfill (programming)|polyfills]] for modern JavaScript APIs missing in Rhino. To use them, you must supply your own.

To avoid accidentally using any missing APIs, we recommend using the following configuration for your <code>tsconfig.json</code>:

<syntaxhighlight lang="js">
{
"compilerOptions": {
// JavaScript APIs supported by Rhino 1.7.13
// See https://mozilla.github.io/rhino/compat/engines.html for more info
"lib": [
"ES5",
"ES2015.Collection",
"ES2015.Core",
"ES2015.Generator",
"ES2015.Iterable",
"ES2015.Symbol",
"ES2015.Symbol.WellKnown",
"ES2016.Array.Include",
"ES2017.String",
"ES2019.String"
],
// Rhino uses require() instead of import/export
// Note: If you use Webpack or Rollup, change this to "ES2015"
"module": "CommonJS",
// Rhino supports ES5+
// Note: If you use Babel with TypeScript, change this to "ESNext"
"target": "ES5"
}
}
</syntaxhighlight>

If you use a bundler such as [https://webpack.js.org/ Webpack] or [https://rollupjs.org/ Rollup], you should change the <code>module</code> to <kbd>"ES2015"</kbd>, and let the bundlers convert your code to CommonJS.

== History ==
* [https://kolmafia.us/threads/20520-this-is-a-big-patch-to-set-up-consult-scripts-lifecycle-scripts-choiceadventurescript.25660/ r20520]: Lifecycle scripts now support JavaScript.
* [https://kolmafia.us/threads/20620-remove-valueof-as-per-philmasterplus.25845/ r20620]: Enumerated objects no longer provide a custom <code>valueOf()</code> method. Use {{f|to_int|toInt}} instead.
* [https://kolmafia.us/threads/20780-javascript-runtime-no-longer-interrupts-when-library-functions-return-false.26174/ r20780]: When calling ASH runtime library functions from JavaScript, functions that return a {{type|boolean}} will return <code>false</code> on failure instead of throwing a string as an exception.

Batfactors

2021-10-20T20:09:27Z

Ryo Sangnoir: link to batfactors.txt data file

{{TOCright}}{{DISPLAYTITLE:batfactors (batfactors.txt)}}
== What is batfactors? ==
[https://zachbardon.com/mafiatools/autoupdate.php?f=batfactors&act=getmap batfactors.txt] is a data file used by [[BatBrain]], containing information about all the various factors pertinent to battle. These are saved in a data-entry-friendly format rather than just saving a map of advevents, which would be bulkier and harder to edit. The vast majority of BatBrain's knowledge about items, skills, equipment, monsters, etc. is found in this file. As it is publicly editable on the Map Manager, a guide to understanding the format could be handy for someone looking to either add new content or fix old or previously unspaded content.

== The Format ==

Like all mafia data files, batfactors is a map file, in the following format:

<syntaxhighlight>
record combat_rec {
string ufname; // user-friendly name, not really used by BatBrain
string dmg; // damage to monster
string pdmg; // damage to player
string special; // comma-delimited list of other action results
};
combat_rec [string, int] factors;
</syntaxhighlight>

Note that the map has two indices. The first string represents the category. The second index is the integer identifying the relevant item/skill/familiar. For example the "bander" category, which contains information about your Bandersnatch's enhancements to combat skills, is indexed by skill number.

{| class="wikitable"
!Category
!Indexed by
!What?
|-
|bander
|skill number
|Your Bandersnatch's enhancements to the specified skill.
|-
|cadenza
|accordion item number
|The results of Cadenza using the specified accordion.
|-
|canhandle
|beans item number
|The results of Canhandle when wielding the specified can of beans.
|-
|chef
|staff item number
|Jiggle results for the specified chefstaff.
|-
|crown
|familiar number
|Results for the Crown of Thrones when the specified familiar is enthroned.
|-
|effect
|effect number
|Per-round results when you have the specified effect active (e.g. passive damage).
|-
|fam
|familiar number
|Results for the specified familiar.
|-
|gear
|equipment item number
|Per-round results when you have the specified item equipped.
|-
|hatrack
|hat item number
|Familiar results for your Mad Hatrack when it has the specified hat equipped.
|-
|headbutt
|hat item number
|Bonus damage from the specified turtle helmet.
|-
|item
|item number
|Results for throwing the specified combat item.
|-
|monster
|monster ID
|Special monster attributes such as resistances, damage caps, and immunities. This category is a bit special (see below).
|-
|scare
|pants item number
|Familiar results for your Fancypants Scarecrow when it has the specified pants equipped.
|-
|servant
|servant ID
|Results for your servant as Ed the Undying.
|-
|skill
|skill number
|Results for casting the specified combat skill.
|-
|thrall
|thrall ID
|Per-round results from having the specified pasta thrall active.
|}

After these important identifiers comes the actual information. The first field, ufname (user-friendly name), exists solely to make the data file human-readable and isn't even used by BatBrain when reading the file. The remaining three fields contain all the information and need to be formatted in a certain way to be understood, but I believe you'll find that format both intuitive and easy to edit.

== Spreads in Batfactors ==

The dmg and pdmg fields contain damage information, which is converted to a spread (float[element] map) in BatBrain. The format is versatile and can include formulas and any of BatBrain's fvars. Since this value is handled by ASH's [[modifier_eval]](), any of those key letters or text functions will also work. Basically damage is expressed as

amount elements

where amount is the damage formula and elements is a comma (but not space!)-delimited list of elements, using "none" for physical damage or "perfect" for always-correctly-tuned damage. You may also use "prismatic" as shorthand for specifying all five elements. If the action does only physical damage, elements (and the preceding space) may be omitted. If multiple elements are present, the damage in amount will be equally distributed among those elements.

{| class="wikitable"
|+Examples
|-
|10
|deals 10 physical damage
|-
| -10
|heals 10 hit points
|-
|10*L
|deals 10 times your level in physical damage
|-
|myhp/2
|deals half of your current hitpoints in physical damage
|-
|10 spooky
|deals 10 spooky damage
|-
|10 spooky,hot
|deals 5 spooky damage and 5 hot damage
|-
|10 prismatic
|deals 2 each of hot, cold, spooky, sleaze, and stench damage
|}

For cases where the damage is not equally distributed among elements, the above pattern may be repeated, separated by a pipe:

{| class="wikitable"
|+Examples
|-
|<nowiki>3 hot|7 spooky</nowiki>
|deals 3 hot damage and 7 spooky damage
|-
|<nowiki>50 hot,cold|4 hot</nowiki>
|deals 29 hot damage and 25 cold damage
|}

== Special ==

Of course, events may have many results besides just damage, and that is all contained in the special field. The special field, quite simply, is a comma (and space)-delimited list of keywords and values, like so:

keyword1 value1, keyword2 value2, keyword3 value3

As few as 0 keywords and values may be present. For numeric values such as MP or meat, formulas may be used since (as with the spreads above) these values will be handled by [[modifier_eval]](). Here are all the keywords BatBrain presently understands:

{| class="wikitable"
!Keyword
!Meaning of Value
|-
|aoe
|For skills with an area of effect, specifies the maximum number of monsters the skill affects.
|-
|att
|Monster attack modifier.
|-
|def
|Monster defense modifier.
|-
|stun
|Number of rounds the monster is stunned by this action, on average. Defaults to 1 if no value is specified.
|-
|mp
|Amount of MP gained/lost.
|-
|meat
|Amount of meat gained/lost.
|-
|item
|A semicolon+space-delimited list of item names. This action results in one of the items from this list. Estimated profit averages the value of these items.
|-
|itemcost
|An item required and expended by this action. This event uses up one of the specified item, and will be ignored if you lack it.
|-
|monster
|A monster name, or multiple pipe-delimited names. This event only happens for monsters specified here.
|-
|notmonster
|A monster name, or multiple pipe-delimited names. This event happens for any monster except those specified here.
|-
|phylum
|A phylum name. This event only applies to monsters of the specified phylum.
|-
|stats
|Substats earned, formatted as <nowiki>Mus|Mys|Mox</nowiki>.
|-
|custom
|If specified at all, this action is a custom action and should not be used in regular automation. The optional value represents the type of custom action (runaway, yellow, attract, banish, copy, etc).
|-
|mutex
|A mutually exclusive group this action belongs to. Any action in the group makes all other actions in the same-named group unavailable (e.g. Sauceror curses, sixguns, etc).
|-
|rate
|For familiars only (which includes hatrack and scare categories). The action rate of the familiar, expressed as a percent (1.0 = 100%).
|-
|!!
|Note. Usually used to explain something BatBrain is currently unable of knowing or tracking, i.e. unspaded data, ongoing damage, or some other strange mechanic.
|}

Some keywords have no values. BatBrain merely checks for the presence of the keyword to determine the relevant information.

{| class="wikitable"
!Keyword
!Presence Indicates
|-
|once
|The action can only be used once per combat.
|-
|endscombat
|The action automatically ends combat.
|-
|underwater
|The action is only valid underwater.
|-
|retal
|The results happen when the monster successfully hits you.
|-
|onhit
|The results happen when you hit the monster with a melee attack.
|-
|oncrit
|The results happen when you get a critical hit.
|}

== The "monster" Category ==

The monster category is handled differently to the other categories. The monster attributes are not loaded into an advevent, so it is not handled by to_event() as all the other categories are. Here are the key differences:

First of all, the integer index is the monster's ID, which is accessible in the $monster.id proxy field. Since some monsters' IDs are unknown, and therefore are listed as 0, batfactors uses an arbitrary negative index for those monsters, checking to_monster(ufname) to find a match against the monster name.

Secondly, the dmg field does not contain damage information, but rather monster resistances/vulnerabilities, still expressed as a spread. For each element, 0 is normal, 1.0 is immunity, and -1.0 is vulnerability. Normal elemental resistances/vulnerabilities are already calculated by BatBrain, and physical resistance, though it can be specified, is accessible in the physical_resistance proxy field, so you only need to include resistance information if the monster has exceptional resistances. These resistances will overwrite the existing resistances on a per-element basis.

The pdmg field is also re-purposed -- for monsters, it specifies the monster's "penetration", also expressed as a spread. For each element, the monster treats your resistance as being lower by the amount of levels specified. Since $element[none] is usually used for physical damage, it is used here to specify DA penetration.

Finally, the special field contains an entirely new set of keywords, which are only for use in the monster category:

{| class="wikitable"
!Keyword
!Value/Indicates
|-
|variable
|The monster is variable and should not be loaded from cache.
|-
|nopotato
|Potato-type familiars do not work vs. this monster.
|-
|nofamiliar
|Your familiar will not act vs. this monster.
|-
|onlyhurtby X
|The monster can only be damaged by X. Currently supported: aoe, pottery, healing, club (and all other weapon types)
|-
|aura X
|The monster has an aura dealing X player damage (specified as a spread) every round.
|-
|retal X
|Use this to specify retaliation damage (damage dealt to you when you succeed with a melee attack) as a spread.
|-
|maxround X
|Use this to specify combats of unusual durations (e.g. "maxround 50" for basement monsters).
|-
|group X
|Use this to specify group monsters, where X is the amount of monsters in the group (integer).
|-
|dmgformula X
|Use this to specify a monster's unique damage formula as a spread (for example, Your Shadow uses "95+maxhp/6")
|-
|damagecap X
|Use this to specify the monster's soft damage cap boundary (integer).
|-
|capexp X
|This is only meaningful with a soft damage cap, and specifies the exponent used to reduce damage above the boundary.
|-
|dodge (X)
|The monster has an X percent chance to dodge melee attacks.
|-
|autohit (X)
|The monster has an X percent chance to automatically hit you (e.g. gremlins).
|-
|automiss (X)
|The monster has an X percent chance to automatically miss you (e.g. crates).
|-
|nostagger (X)
|The monster has an X percent chance to ignore staggers.
|-
|nostun (X)
|The monster has an X percent chance to shrug a multi-round stunner each round.
|-
|noitems (X)
|The monster has an X percent chance of blocking items (e.g. Bonerdagon).
|-
|noskills (X)
|The monster has an X percent chance of blocking skills (e.g. Naughty Sorceress).
|-
|delevelres (X)
|The monster resists X percent of delevel effects.
|-
|spellres (X)
|The monster resists X percent of damage from combat spells.
|-
|dmgformula X
|Specify a monster's unique formula for dealing damage. For example, the entry for Your Shadow includes "dmgformula 95+maxhp/6".
|-
|drpenetration X
|The monster ignores your first X DR. The Doctor is IN!
|}

Any keyword that expresses a "percent" should be specified as a float between 0 and 1. For any keyword listed with (X) in parentheses, the value is optional and defaults to 1.0.

My garden type

2020-04-11T23:09:10Z

Ryo Sangnoir:

{{
#vardefine:name|my_garden_type}}{{
#vardefine:return_type|string}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
}}|

function_description=Returns the garden type of the logged-in character: none, pumpkin, peppermint, skeleton, beer, winter, thanksgarden, grass or mushroom.|

code1={{CodeSample|
title=Code Sample|
description=To fight a piranha plant, if you can:|
code=
<syntaxhighlight>
if (my_garden_type() == "mushroom" && !get_property("_mushroomGardenVisited").to_boolean()) {
cli_execute("garden fertilize");
}
</syntaxhighlight>}}|

see_also={{SeeAlso|get_campground}}|
}}

[[Category:Item Management]]

My garden type

2020-04-11T17:49:13Z

Ryo Sangnoir: Created page with "{{ #vardefine:name|my_garden_type}}{{ #vardefine:return_type|string}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregat..."

{{
#vardefine:name|my_garden_type}}{{
#vardefine:return_type|string}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
}}|

function_description=Returns the garden type of the logged-in character: pumpkin, peppermint, skeleton, beer, winter, thanksgarden, grass or mushroom.|

code1={{CodeSample|
title=Code Sample|
description=To fight a piranha plant, if you can:|
code=
<syntaxhighlight>
if (my_garden_type() == "mushroom" && !get_property("_mushroomGardenVisited").to_boolean()) {
cli_execute("garden fertilize");
}
</syntaxhighlight>}}|

see_also={{SeeAlso|get_campground}}|
}}

[[Category:Item Management]]