Kolmafia - User contributions [en]

Update Management

2026-03-27T10:29:04Z

Gausie: Fixed heading

New versions of KoLmafia are posted to the [https://github.com/kolmafia/kolmafia/releases GitHub releases page]. To manage updates, many members of the community have produced "automatic update" scripts.

=== Gausie's One-Liner ===
In a Unix shell (Linux, Mac and WSL) as long as you have curl and jq installed this should download and run the latest version.
curl -fLsgo kolmafia.jar $(curl -fsg '<nowiki>https://api.github.com/repos/kolmafia/kolmafia/releases/latest'</nowiki> | jq -r '.assets[] | select(.browser_download_url | contains(".jar")).browser_download_url') && java -jar kolmafia.jar

=== update-kolmafia ===
C2Talon has created an application to download and run the latest KoLmafia with binaries for Windows and Unix-like operating systems

https://github.com/C2Talon/update-kolmafia

=== '''Powershell Auto-Update Script by BigVinnie (Windows)''' ===
A one-click updater+launcher using Windows Powershell.

https://kolmafia.us/threads/powershell-to-auto-update-kolmafia.29816/

Update Management

2025-05-21T08:45:52Z

Gausie: Add update-kolmafia

Update Management

2025-05-21T08:42:52Z

Gausie: Created the page

Quest Tracking Preferences

2022-06-30T19:15:12Z

Gausie: Added new quests to track Suburbs of Dis

{{TOCright}}
KoLMafia internally tracks progress for a number of quests. These are stored as preferences in <code>settings\[charactername]_prefs.txt</code>.

==Council Quests==
===questL02Larva===
questL02Larva tracks the player's progress in the {{kolwiki|Spooky_Forest_Quest|Spooky Forest quest}}.

*unstarted: quest not yet received
*started: quest received from the Council
*step1: mosquito larva acquired
*finished: mosquito larva returned to the Council

===questL03Rat===
questL03Rat tracks the player's progress in the {{kolwiki|Typical_Tavern_Quest|Typical Tavern quest}}.

*unstarted: quest not yet received
*started: quest received from the Council
*step1: spoke to Bart Ender in the Typical Tavern
*step2: turned off the Rat Faucet
*finished: told Bart about the Faucet

===questL04Bat===
questL04Bat tracks the player's progress in the {{kolwiki|Boss_Bat_Quest|Boss Bat quest}}.

*unstarted: quest not yet received
*started: quest received from the Council
*step1-step3: demolished 1-3 walls in the Bat Hole
*step4: Boss Bat defeated
*finished: returned to the Council to report success

===questL05Goblin===
questL05Goblin tracks the player's progress in the {{kolwiki|The_King_of_Cobb's_Knob_Quest|The King of Cobb's Knob quest}}.

*unstarted: quest not yet received
*started: quest received from the Council
*step1: Cobb's Knob map decrypted
*finished: Knob Goblin King defeated

===questL06Friar===

questL06Friar tracks the player's progress in the {{kolwiki|Deep_Fat_Friars'_Gate_Quest|Friars' quest}}.

*unstarted: quest not yet received
*started: quest received from the Council
*step1: details received from the Friars
*step2: box of birthday candles, dodecagram & eldritch butterknife acquired.
*finished: cleansed the taint

===questL07Cyrptic===
questL07Cyrptic tracks the player's progress in the {{kolwiki|Undefile_the_Cyrpt_Quest|Undefile the Cyrpt quest}}.

*unstarted: quest not yet received
*started: quest received from the Council
*finished: Bonerdagon defeated

====Evilness====
When evilness in each zone is 25 or less the zone boss will be the next encounter.
When total evilness is 0 and all 4 bosses are defeated, the Haert of the Cyrpt will be accessible.
* cyrptAlcoveEvilness tracks current evilness in the Alcove
* cyrptCrannyEvilness tracks current evilness in the Cranny
* cyrptNicheEvilness tracks current evilness in the Niche
* cyrptNookEvilness tracks current evilness in the Nook
* cyrptTotalEvilness tracks the sum of evilness in the Cyrpt

===questL08Trapper===

questL08Trapper tracks the player's progress in the {{kolwiki|Mt._McLargeHuge_Quest|Mt. McLargeHuge Quest}}.

* unstarted: quest not yet received from the Council
* started: quest received from the Council
* step1: cheese and ore requested by the Trapper
* step2: cheese and ore returned to the Trapper
* step3: discovered the stairs up to the Mist-Shrouded Peak (via either route)
* step4: fought at least one yeti
* step5: defeated the monster at the top of the Peak
* finished: returned the fur to the Trapper (quest complete)

===questL09Topping===
questL08Trapper tracks the player's progress in the {{kolwiki|Orc_Chasm_Quest|Orc Chasm Quest}}.

* unstarted: quest not yet received from the Council
* started: quest received from the Council
* step1: bridge built
* step2: like, totally got the deets from the Highland Lord
* step3: lit all three signal fires
* finished: quest complete

====booPeakProgress====
booPeakProgress tracks the hauntedness level of {{kolwiki|A-boo Peak}}. A value of 18, for instance, indicates that A-boo Peak is 18% haunted.

Possible values: 0 - 100

====chasmBridgeProgress====
chasmBridgeProgress tracks the player's progress in building a bridge across the {{kolwiki|Orc Chasm}}. A value of 10, for instance, indicates that the bridge is 10 planks long.

Possible values: 0 - 30

====oilPeakProgress====
oilPeakProgress tracks the remaining pressure at {{kolwiki|Oil Peak}}. It decreases as the player reduces the pressure in the zone.

Possible values: 0.00 - 310.66
* 310.66: Pressure not yet reduced
* 0.00: Subquest completed

====twinPeakProgress====
twinPeakProgress is a nibble bitmask with least significant bit set for the first choice and the most significant for the fourth. You can parse this with bitwise operators. Here's some code that demonstrates how to use it.

<syntaxhighlight>
void comma(buffer b, string s) {
if(length(b) > 0)
b.append(", ");
b.append(s);
}

boolean mysterious(int progress, int c) {
return (progress & (1 << c)) == 0;
}

string twinPeak() {
int p = get_property("twinPeakProgress").to_int();
buffer need;
if(mysterious(p, 0)) need.comma("4 Stench Resistance");
if(mysterious(p, 1)) need.comma("+50% Item Drop");
if(mysterious(p, 2)) need.comma("Jar of Oil");
// Only check for final if first three complete
if(length(need) == 0) {
if(mysterious(p, 3))
return "Need +40% Initiative";
return "Twin Peak Completed";
}
return "Need " + need;
}
</syntaxhighlight>

====booPeakLit====
booPeakLit is a boolean which tracks if you have lit the fire at A-boo Peak or not

====oilPeakLit====
oilPeakLit is a boolean which tracks if you have lit the fire at Oil Peak or not

(note, twinPeakLit would be obsolete as it would simply track twinPeakProgress == 15)

===questL10Garbage===

questL10Garbage tracks the player's progress in {{kolwiki|Giant_Trash_Quest|the Giant Trash Quest}}.

* unstarted: quest not yet received from the Council
* started: quest received from the Council
* step1: giant beanstalk grown
* step2: first visit to the Penultimate Fantasy Airship
* step3 - step6: four Immateria acquired
* step7: S.O.C.K. acquired ({{kolwiki|The_Castle_in_the_Clouds_in_the_Sky_(Basement)|Castle Basement}} open)
* step8: {{kolwiki|The_Castle_in_the_Clouds_in_the_Sky_(Basement)|Castle Ground Floor}} open
* step9: {{kolwiki|The_Castle_in_the_Clouds_in_the_Sky_(Basement)|Castle Top Floor}} open
* step10: chore wheel turned
* finished: returned to the Council

===questL11MacGuffin===
questL11MacGuffin tracks the player's progress in the {{kolwiki|Quest_for_the_Holy_MacGuffin|Holy MacGuffin quest}}.

*unstarted:
*started: quest received from the Council
*step1: Black Market located (blackForestProgress == 5)
*step2: retrieved your father's MacGuffin diary
*finished: returned the MacGuffin to the Council

====questL11Black====
questL11Black tracks the player's progress in the {{kolwiki|Quest_for_the_Holy_MacGuffin|Black Market portion of the Holy MacGuffin quest}}.

*unstarted: quest not yet received
*started: quest received from the Council
*step1: spent at least one turn in the Black Forest
*step2: Black Market found
*step3: forged identification documents purchased
*finished: MacGuffin diary acquired

=====blackForestProgress=====
blackForestProgress tracks the player's progress in [http://kolmafia.us/showthread.php?15995 discovering the Black Market].

*0: no progress in exploring the Forest
*1: blackberry bushes located
*2: black cottage located
*3: black mineshaft located
*4: black church located
*5: black market located

====questL11Manor====
questL11Manor tracks the player's progress in the {{kolwiki|Quest_for_the_Holy_MacGuffin#Spookyraven_quest_.28In_a_Manor_of_Spooking|Spookyraven Manor portion of the Holy Macguffin quest}}.

*unstarted: quest not yet received
*started: quest received, by reading your father's MacGuffin diary
*step1: Spookyraven Manor Cellar opened
*step2: recipe: mortar-dissolving solution read
*step3: Suspicious Masonry demolished
*finished: Lord Spookyraven defeated

=====spookyravenRecipeUsed=====
spookyravenRecipeUsed tracks whether and how the player has read recipe: mortar-dissolving solution

*none: recipe not yet read
*with_glasses: recipe read with Lord Spookyraven's spectacles
*no_glasses: recipe read without the spectacles

====questL11Desert====
Explore the Arid, Extra-Dry Desert to find the pyramid mentioned in your father's journal.

*unstarted:
*started: quest started by reading your father's MacGuffin diary
*finished: discovered the Small Pyramid

=====desertExploration=====
*0: haven't yet started exploring the Desert
*1-99: Desert exploration in progress
*100: Desert fully explored

====questL11Pyramid====
questL11Pyramid tracks the player's progress in the {{kolwiki|Quest_for_the_Holy_MacGuffin#A_Small_Pyramid|Pyramid portion of the Holy Macguffin quest}}.

* unstarted: Ancient Buried Pyramid not yet discovered
* started: Ancient Buried Pyramid discovered
* step1: Middle Chamber opened
* step2: The Lower Chambers opened
* step3: Control Room opened
* finished: MacGuffin retrieved (quest complete)

=====gnasirProgress=====
gnasirProgress is a nibble bitmask with one bit for each possible way you can advance {{kolwiki|Quest_for_the_Holy_MacGuffin|Gnasir's quest}}. You can parse this with bitwise operators. Here's some code that demonstrates how to use it.
<syntaxhighlight>
int gnasirProgress = get_property("gnasirProgress").to_int();
buffer gnasir;
if((gnasirProgress & 1) == 0)
print("Gnasir wants a stone rose");
if((gnasirProgress & 2) == 0)
print("Gnasir wants a can of black paint");
if((gnasirProgress & 4) == 0)
print("Gnasir wants a killing jar");
if((gnasirProgress & 8) == 0)
print("Gnasir wants a 15 worm-riding manual page");
if((gnasirProgress & 16) == 0)
print("You need to use a drum machine to ride the worm");
</syntaxhighlight>

====questL11Ron====
Ron Copperhead
*unstarted:
*started: quest received, by reading your father's MacGuffin diary
*step1: received the intro adventure at A Mob of Zeppelin Protestors
*step2: cleared all 80 protestors and opened access to The Red Zeppelin
*step3: received the intro adventure at The Red Zeppelin
*step4: Found Ron "The Weasel" Copperhead
*finished: defeated Ron "The Weasel" Copperhead and received the Copperhead Charm (rampant)

=====zeppelinProtestors=====
Tracks protesters removed

====questL11Shen====
Shen Copperhead

*unstarted: quest not yet received from the Council
*started: quest received, by reading your father's MacGuffin diary
*step1: spoke to Shen Copperhead in the Copperhead club and received first item request (and poisoning)
*step2: acquired first item
*step3: returned first item, received second item request (and poisoning)
*step4: acquired second item
*step5: returned second item, received third item request (and poisoning)
*step6: acquired third item
*step7: returned third item
*finished: received the Copperhead Charm

====questL11Palindome====
questL11Palindome tracks the player's progress in the {{kolwiki|Quest_for_the_Holy_MacGuffin#The_Palindome|Palindome portion of the Never Odd or Even quest}}.

* unstarted: quest not yet received from the Council
* started: have the Talisman o' Namsilat
* step1: arranged the photos in Dr. Awkward's office
* step2: read 2 Love Me, Vol. 2
* step3: met Mr. Alarm in his office (received the wet stunt nut stew quest)
* step4: cooked wet stunt nut stew
* step5: returned the stew to Mr. Alarm
* finished: defeated Dr. Awkward

====questL11Worship====
questL11Worship tracks progress through the {{kolwiki|Quest_for_the_Holy_MacGuffin#Hidden_Temple_quest_.28Gotta_Worship_Them_All.29|Hidden Temple portion of the Quest for the Holy MacGuffin}}.

*unstarted: quest not yet received
*started: quest received, by reading your father's MacGuffin diary
*step1: (Hidden Temple opened?)
*step2: correct button pressed in the Temple
*step3: Hidden City uncovered
*step4: four stone spheres acquired
*finished: ancient amulet acquired from the Protector Spectre

=====questL11Business=====
*unstarted:
*started: Hidden Office Building opened
*finished: crackling stone sphere acquired

======hiddenOfficeProgress======
hiddenOfficeProgress tracks progress through the {{kolwiki|Hidden Office Building}} during the Quest for the Holy MacGuffin.

Possible values: 0, 1, 6 - 8
* 0: Haven't opened the Hidden Office Building
* 1: Hidden Office Building is open for adventuring
* 6: Encountered the Protector Spirit
* 7: Found the stone sphere
* 8: Placed the stone sphere in the relevant overgrown shrine

=====questL11Curses=====
*unstarted:
*started: Hidden Apartment Building opened
*finished: moss-covered stone sphere acquired

======hiddenApartmentProgress======
hiddenApartmentProgress tracks progress through the {{kolwiki|Hidden Apartment Building}} during the Quest for the Holy MacGuffin.

Possible values: 0, 1, 6 - 8
* 0: Haven't opened the Hidden Apartment Building
* 1: Hidden Apartment Building is open for adventuring
* 6: Encountered the Protector Spirit
* 7: Found the stone sphere
* 8: Placed the stone sphere in the relevant overgrown shrine

=====questL11Doctor=====
*unstarted:
*started: Hidden Hospital opened
*finished: dripping stone sphere acquired

======hiddenHospitalProgress======
hiddenHospitalProgress tracks progress through the {{kolwiki|Hidden Hospital}} during the Quest for the Holy MacGuffin.

Possible values: 0 - 8
* 0: Haven't opened the Hidden Hospital
* 1: Hidden Hospital is open for adventuring, but haven't bowled.
* 6: Encountered the Protector Spirit
* 7: Found the stone sphere
* 8: Placed the stone sphere in the relevant overgrown shrine

=====questL11Spare=====
*unstarted:
*started: Hidden Bowling Alley opened
*finished: scorched stone sphere acquired

======hiddenBowlingAlleyProgress======
hiddenBowlingAlleyProgress tracks progress through the {{kolwiki|Hidden Bowling Alley}} during the Quest for the Holy MacGuffin.

* 0: Haven't opened the Hidden Bowling Alley
* 1: Hidden Bowling Alley is open for adventuring
* 2-5: Number of times bowled is 1 less than hiddenBowlingAlleyProgress
* 6: Encountered the Protector Spirit
* 7: Found the stone sphere
* 8: Placed the stone sphere in the relevant overgrown shrine

=====hiddenTavernUnlock=====
hiddenTavernUnlock tracks whether or not you have unlocked the {{kolwiki|Hidden Tavern}} during the Quest for the Holy MacGuffin.

* When the value is equal to your number of ascensions, the Tavern is unlocked
* When the value is any other number, the Tavern is locked

===questL12War===
questL12War tracks progress during the {{kolwiki|Mysterious Island Quest}}.

* unstarted: quest not yet received from the Council
* started: quest received
* step1: War started
* finished: War ended; boss defeated (quest complete)

====warProgress====
Possible values for the progress of the {{kolwiki|Mysterious Island Quest|Isle War}}:
*unstarted: We can still visit the small version of the Mysterious Island
*started: The war is in progress
*finished: The final boss or bosses were defeated

====fratboysDefeated====
counts how many frat warriors have been killed on the battlefield (starts at 0).

====hippiesDefeated====
counts how many war hippies have been killed on the battlefield (starts at 0).

====sideDefeated====
Which side of the {{kolwiki|Mysterious Island Quest|Isle War}} was defeated during the Level 12 quest.

Possible values:
*neither
*hippies
*fratboys
*both

====sidequestArenaCompleted====
Tracks the status of {{kolwiki|The Mysterious Island Arena}} sidequest

Possible values:
*none
*fratboy
*hippy

====sidequestFarmCompleted====
Tracks the status of {{kolwiki|McMillicancuddy's Farm}} sidequest

Possible values:
*none
*fratboy
*hippy

====sidequestJunkyardCompleted====
Tracks the status of {{kolwiki|The Junkyard}} sidequest

Possible values:
*none
*fratboy
*hippy

====sidequestLighthouseCompleted====
Tracks the status of {{kolwiki|The Lighthouse}} sidequest

Possible values:
*none
*fratboy
*hippy

====sidequestNunsCompleted====
Tracks the status of {{kolwiki|Our Lady of Perpetual Indecision}} sidequest

Possible values:
*none
*fratboy
*hippy

====sidequestOrchardCompleted====
Tracks the status of {{kolwiki|The Organic Orchard}} sidequest

Possible values:
*none
*fratboy
*hippy

===questL12HippyFrat===
questL12War tracks progress during the {{kolwiki|Mysterious Island Quest}} in the {{kolwiki|Kingdom of Exploathing}} path

* unstarted: quest not yet received from the Council
* started: quest received
* step1: War started
* finished: War ended; boss defeated (quest complete)

===questL13Final===
Progress for the {{kolwiki|Naughty Sorceress Quest}}.

*unstarted: quest not yet received from the Council
*started: quest received; Registration Desk open (???)
*step1: spent at least one turn fighting competitors
*step2: competitors defeated
*step3: sash acquired
*step4: met Frank
*step5: Hedge Maze cleared
*step6: Tower Door locks unlocked
*step7: wall of skin defeated
*step8: wall of meat defeated
*step9: wall of bones defeated
*step10: antique mirror handled
*step11: shadow class defeated
*step12: Naughty Sorceress defeated
*step13: Council informed
*finished: prism smashed; King Ralph freed; Astral Gash accessible

===questL13Warehouse===
the final quest if you ascend as {{kolwiki|Actually Ed the Undying}} where you adventure in {{kolwiki|The Secret Council Warehouse}}.
*unstarted
*started
*finished
Current progress in the warehouse is tracked in warehouseProgress.

==Guild Quests==
===questG01Meatcar===
* unstarted
* started
* finished

===questG02Whitecastle===
* unstarted
* started
* finished

===questG03Ego===
* unstarted
* started
* finished

===questG04Nemesis===
Tracks the player's progress in the {{kolwiki|Me and My Nemesis|Nemesis quest}}.

*unstarted: Quest not yet received
*started: Quest received from the guild NPC
*step1: Tomb of the Unknown [Your Class] Here encountered at The Unquiet Garves
*step2: Defeated the Unknown [Your Class]
*step3: Post combat choice encountered after defeating the Unknown [Your Class]
*step4: Epic Weapon acquired
*step5: The "Fun" House opened
*step6: Defeated The Clownlord Beelzebozo
*step7: Instructed to make your Legendary Epic Weapon by the guild NPC
*step8: Meatsmithed your Legendary Epic Weapon
*step9: Presented the Legendary Epic Weapon to the guild NPC
*step10: Talked to Guild and opened the Dark Cave
*step11: Encountered the Dark Cave entrance at least once, but haven't solved the skill puzzle yet
*step12: Passed the Dark Cave entrance
*step13: Encountered the Impassable Rubble, but haven't destroyed it yet
*step14: 6 fizzing spore pods acquired
*step15: Impassable rubble cleared and ready for final (?) showdown
*step16: Defeated Nemesis (1st battle, drops Legendary Regalia Hat)
*step17: Presented the Legendary Regalia Hat to the guild NPC
*step18: Lost to 1st assassin - menacing thug (wanderer)
*step19: Defeated 1st assassin - menacing thug (wanderer)
*step20: Lost to 2nd assassin - Mob Penguin hitman (wanderer)
*step21: Defeated 2nd assassin - Mob Penguin hitman (wanderer)
*step22: Lost to 3rd assassin - class specific (wanderer)
*step23: Defeated 3rd assassin - class specific (wanderer)
*step24: Lost to 4th assassin - class specific (wanderer)
*step25: Defeated 4th assassin - class specific (wanderer)
*step26: Discovered the Volcano Lair from the O Cap'm, My Cap'm noncombat (''Note: This is not used since the Nemesis Quest revamp in 2015.'')
*step27: Defeated Nemesis (2nd battle, drops Legendary Regalia Pants)
*step28: Started fight with Nemesis after Volcano maze (3rd battle)
*step29: Defeated 1st form of Nemesis (3rd battle)
*finished: Defeated 2nd form of Nemesis (3rd battle, drops Legendary Regalia Accessory) (''Note: This is set before you talk to the guild NPC and receive the 6,000 meat reward.'')

===questG06Delivery===
* unstarted
* started
* finished

===questG07Myst===
Tracks the guild entry quest for mysticality classes (i.e. {{kolwiki|The League of Chef-Magi}})
* unstarted
* started: Received the quest from the guild leader
* step1: Obtained the {{kolwiki|exorcised sandwich}}
* finished: Returned the quest item to the guild leader

===questG08Moxie===
Tracks the guild entry quest for moxie classes (i.e. {{kolwiki|The Department of Shadowy Arts and Crafts}})
* unstarted
* started: Received the quest from the guild leader
* step1: Encountered the {{kolwiki|Now's Your Pants! I Mean... Your Chance!}} adventure and stole your own pants
* finished: Returned to the guild leader

===questG09Muscle===
Tracks the guild entry quest for muscle classes (i.e. {{kolwiki|The Brotherhood of the Smackdown}})
* unstarted
* started: Received the quest from the guild leader
* step1: Obtained the {{kolwiki|11-inch knob sausage}}
* finished: Returned the quest item to the guild leader

==Miscellaneous Quests==
===questM01Untinker===
Returning the screwdriver to the Untinker.
* unstarted
* step1: collected the rusty screwdriver
* finished: screwdriver returned

===questM02Artist===
* unstarted
* started
* finished

===questM03Bugbear===
* unstarted
* started
* finished

===questM04Galaktic===
* unstarted
* started
* finished

===questM05Toot===
* unstarted
* started
* finished

===questM06Gourd===
* unstarted
* started
* finished

===questM07Hammer===
* unstarted
* started
* finished

===questM08Baker===
* unstarted
* started
* finished

===questM09Rocks===
* unstarted
* started
* finished

===questM10Azazel===
questM10Azazel tracks the player's progress in the {{kolwiki|Azazel,_Ma_Belle|Azazel, Ma Belle quest}}.
*unstarted: quest not yet received
*started: received the quest, from Azazel or the stranger in Moaning Panda Square
*finished: returned Azazel's talismans to him

===questM11Postal===
* unstarted
* started
* finished

===questM12Pirate===
questM12Pirate tracks the player's progress in the {{kolwiki|Cap'm Caronch Quest}}.
*unstarted:
*started: Cap'm Caronch's Map found
*step1: acquired Cap'm Caronch's nasty booty from the booty crab
*step2: received the Orcish Frat House blueprints
*step3: retrieved Cap'm Caronch's dentures from the Frat House
*step4: returned the dentures to the Cap'm and accepted the beer pong challenge
*step5: won a game of beer pong
*step6: acquired pirate fledges
*finished: unlocked Belowdecks

===questM13Escape===
* unstarted
* started
* finished

===questM14Bounty===
* unstarted
* started
* finished

===questM15Lol===
questM15Lol tracks the player's progress in {{kolwiki|A Quest, LOL}}. (No, but seriously.)
* unstarted
* started
* finished

===questM16Temple===
The Hidden Legend of the Temple ("Dakota" Fanning)
* unstarted: quest not yet received
* started: Spoke to "Dakota" Fanning and accepted the quest.
* finished: Collected all 3 required items and spoke to "Dakota" Fanning again to unlock the Hidden Temple, or successfully used a {{kolwiki|Spooky Temple Map Quest|Spooky Temple map}}.

===questM17Babies===
Lady Spookyraven's Babies
* unstarted
* started
* finished

===questM18Swamp===
Marty and His Swamp Problems
* unstarted
* started
* finished

===questM19Hippy===
Give a Hippy a Boat...
* unstarted: quest not yet received
* started: Spoke to That Hippy and accepted quest.
* step1: Acquired Worse Homes and Gardens.
* step2: Read Worse Homes and Gardens (why?)
* step3: Crafted the Junk Junk.
* finished: Spoke to the Hippy with the Junk Junk in inventory.

===questM20Necklace===
questM20Necklace tracks the player's progress in {{kolwiki|Spookyraven_Manor_Quest#Lady_Spookyraven.27s_Necklace_.28First_Floor.29|retrieving Lady Spookyraven's necklace}}.

* unstarted: quest not yet received
* started: quest received from the telegram
* step1: billiards room key found
* step2: Pool Cue acquired
* step3: library key found
* step4: necklace found
* finished: necklace returned to Lady Spookyraven (quest complete)

===questM21Dance===
questM21Dance tracks the player's progress in the Second Floor portion of the {{kolwiki|Lady_spookyraven's_dance|Spookyraven Manor quest}}.

*unstarted:
*started: quest received, from Lady Spookyraven's ghostly telegram
*step1: spoken to Lady Spookyraven on the Second Floor
*step2: acquired Lady Spookyraven's dancing things
*step3: returned Lady Spookyraven's dancing things to her
*finished: danced with Lady Spookyraven in the Ballroom

===questM22Shirt===
The Shirt Off His Lack of Back
* unstarted
* started
* finished

===questM23Meatsmith===
Helping Make Ends Meat
* unstarted
* started
* step1 - Got a {{kolwiki|check to the Meatsmith}}.
* finished - Returned {{kolwiki|check to the Meatsmith}} to the Meatsmith.

===questM24Doc===
What's Up, Doc?
* unstarted
* started
* step1 - Collected the Herbs and need to return them to Doc Galaktik
* finished

===questM25Armorer===
Lending a Hand (and a Foot)
* unstarted
* started - accepted the quest from the Armorer and Leggerer
* step1 -
* finished

===questM26Oracle===
The Oracle quest (The Source Path)
* unstarted
* started
* finished

==Sea Quests==
===questS01OldGuy===
=finished
===questS02Monkees===
Hey Hey, Find The Monkees

* Start Go see Little Brother in the Sea Monkee Castle.
* step1 Rescue Big Brother from the Wreck of the Edgar Fitzsimmons.
* step2 Go see Big Brother in the Sea Monkee Castle.
* step3 Check in with Little Brother in the Sea Monkee Castle.
* step4 Find Grandpa in
* step5 Have a chat with Grandpa in the Sea Monkee Castle.
* step6 Search for clues to Grandma's location in the Mer-Kin Outpost.
* step7 Figure out what to do with Grandma's note... Perhaps Grandpa will have some ideas?
* step8 Rescue Grandma from the Mer-Kin Outpost.
* step9 Check back in with Little Brother in the Sea Monkee Castle.
* step10 Go check on Big Brother in the Sea Monkee Castle.
* step11 Buy the black glass from Big Brother in the Sea Monkee Castle.
* step12 Use the black glass to explore the Caliginous Abyss.
* finished You have rescued the entire family of Sea Monkees. Well, except for Dad, but we shouldn't talk about that.

====merkinQuestPath====
merkinQuestPath indicates which path the player has chosen in the {{kolwiki|Mer-Kin Deepcity}}, during the {{kolwiki|Sea Monkees Quest}}.

Possible values:
* none: Player has not yet chosen a path
* gladiator: Player will fight Yog-Urt, Elder Goddess of Hatred
* scholar: Player will fight Shub-Jigguwatt, Elder God of Violence
* done: Player has completed the Sea Monkees Quest

====skateParkStatus====
skateParkStatus tracks the player's progress in the {{kolwiki|war for the Skate Park}}.

*war: the war is ongoing
*ice: the roller skates have been chased out
*roller: the ice skates have been chased out
*peace: both sides have been chased out

==Quests Granted by Items==
===questI01Scapegoat===
=unstarted
===questI02Beat===
=unstarted

==Quests Granted by Familiars==
===questF01Primordial===
=unstarted
===questF02Hyboria===
=unstarted
===questF03Future===
=unstarted
===questF04Elves===
=unstarted
===questF05Clancy===
=unstarted

=== questClumsinessGrove ===

* started - Unlocked the first boss NC
* step1 - Added a boss to the combat selection vector (clumsinessGroveBoss)
* step2 - Defeated first boss
* step3 - Added second boss to the combat selection vector (clumsinessGroveBoss)
* finished - Defeated second boss

=== questGlacierOfJerks ===

* started - Unlocked the first boss NC
* step1 - Added a boss to the combat selection vector (glacierOfJerksBoss)
* step2 - Defeated first boss
* step3 - Added second boss to the combat selection vector (glacierOfJerksBoss)
* finished - Defeated second boss

=== questMaelstromOfLovers ===

* started - Unlocked the first boss NC
* step1 - Added a boss to the combat selection vector (maelstromOfLoversBoss)
* step2 - Defeated first boss
* step3 - Added second boss to the combat selection vector (maelstromOfLoversBoss)
* finished - Defeated second boss

==Bug Bear Invasion Properties==

===mothershipProgress===
mothershipProgress tracks progress of level completion in the {{kolwiki|Bugbear Mothership}}. It goes from 0 to 3 as that level is cleared.

Possible values: 0-3

===statusEngineering===
===statusGalley===
===statusMedbay===
===statusMorgue===
===statusNavigation===
===statusScienceLab===
===statusSonar===
===statusSpecialOps===
===statusWasteProcessing===
All of these work the same way.
*0-x (integers): insufficient bodata collected)
*open: all biodata collected and zone accessible
* unlocked: biodata collected but zone not yet accessible
* cleared: zone has been cleared

==Quests from the Elemental Planes==
===Spring Break Beach===
The Elemental Plane of Sleaze
=====questESlMushStash=====
Jimmy's Quest to collect receipts from the Fun-Guy Mansion.
=====questESlAudit=====
Taco Dan's Quest to collect receipts from the Fun-Guy Mansion.
=====questESlBacteria=====
Broden's Quest to collect bacteria from the Fun-Guy Mansion.
=====questESlCheeseburger=====
Jimmy's Quest to collect ingredients from the Sloppy Seconds Diner.
=====questESlSprinkles=====
Taco Dan's Quest to collect ingredients from the Sloppy Seconds Diner.
=====questESlCocktail=====
Broden's Quest to collect sprinkles from the Sloppy Seconds Diner.
=====questESlSalt=====
Jimmy's Quest to collect salt from the Sunken Yacht.
=====questESlFish=====
Taco Dan's Quest to collect fish meat from the Sunken Yacht.
=====questESlDebt=====
Broden's Quest to collect broupons from the Sunken Yacht.

===Conspiracy Island===
The Elemental Plane of Spooky
=====questESpOutOfOrder=====
Deep Dark Jungle - Out of Order
=====questESpJunglePun=====
Deep Dark Jungle - Pungle in the Jungle
=====questESpSmokes=====
Deep Dark Jungle - Everyone's Running Out of Smokes
=====questESpClipper=====
Mansion of Dr. Weirdeaux - The Big Clipper
=====questESpSerum=====
Mansion of Dr. Weirdeaux - Serum Sortie
=====questESpEVE=====
Secret Government Laboratory - Choking on the Rind
=====questESpFakeMedium=====
Secret Government Laboratory - Fake Medium at Large
=====questESpGore=====
Secret Government Laboratory - Gore Tipper

==Retired Properties==
These properties correspond to quests that have been removed from the game.

===questG05Dark===
Formerly tracked {{kolwiki|A Dark and Dank and Sinister Quest}} before it was retired in 2015.
* unstarted
* started
* finished

{{PropertyNav}}

Now to int

2020-10-19T12:07:08Z

Gausie: Created page with "{{ #vardefine:name|now_to_int}}{{ #vardefine:return_type|int}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregate}}| re..."

{{
#vardefine:name|now_to_int}}{{
#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}}|
}}|

function_description=Returns the current time (based on your local computer's system settings) as a UNIX timestamp (in milliseconds)|

}}
{{SeeAlso|gameday_to_string|gameday_to_int|now_to_string|time_to_string|timestamp_to_date|date_to_timestamp}}

[[Category:Miscellaneous Functions]]

Timestamp to date

2020-10-19T12:05:53Z

Gausie: Created page with "{{ #vardefine:name|timestamp_to_date}}{{ #vardefine:return_type|string}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggre..."

{{
#vardefine:name|timestamp_to_date}}{{
#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}}|
parameter2={{Param|int|timestamp}}|
parameter1={{Param|string|outFormat}}|
p2desc={{pspan|dtg}} is the timestamp to convert.|
p1desc={{pspan|inFormat}} is how the output string is formatted.|
}}|

function_description=Converts a UNIX timestamp (in milliseconds) to a date. Full information on [http://docs.oracle.com/javase/1.5.0/docs/api/java/text/SimpleDateFormat.html SimpleDateFormat] here.|

}}
{{SeeAlso|gameday_to_string|gameday_to_int|now_to_string|now_to_int|time_to_string|date_to_timestamp}}

[[Category:Miscellaneous Functions]]

Date to timestamp

2020-10-19T12:04:34Z

Gausie: Created page with "{{ #vardefine:name|date_to_timestamp}}{{ #vardefine:return_type|int}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregat..."

{{
#vardefine:name|date_to_timestamp}}{{
#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|string|inFormat}}|
parameter2={{Param|string|dtg}}|
p1desc={{pspan|inFormat}} is how the input string is formatted.|
p2desc={{pspan|dtg}} is the date string to convert.|
}}|

function_description=Converts a date to a UNIX timestamp (in milliseconds). Full information on [http://docs.oracle.com/javase/1.5.0/docs/api/java/text/SimpleDateFormat.html SimpleDateFormat] here.|

}}
{{SeeAlso|gameday_to_string|gameday_to_int|now_to_string|now_to_int|time_to_string|timestamp_to_date}}

[[Category:Miscellaneous Functions]]

Voting booth initiatives

2020-09-23T16:26:27Z

Gausie:

{{
#vardefine:name|voting_booth_initiatives}}{{
#vardefine:return_type|boolean [string]}}{{
#vardefine:aggregate|yes}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|class|class}}|
p1desc={{pspan|class}} is the class for the seed|
parameter2={{Param|int|path}}|
p2desc={{pspan|path}} is the path id for the seed|
parameter3={{Param|int|daycount}}|
p3desc={{pspan|daycount}} is the daycount for the seed|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|class}}|
p1desc={{pspan|class}} is the class id for the seed|
parameter2={{Param|int|path}}|
parameter3={{Param|int|daycount}}|
}}|

function_description=Returns a list of voting initiatives that are available for a given class on a given day of an ascension in a given path|

code1={{CodeSample|
title=Code Sample|
description=The following will tell you the initiatives available to you today without you ever having to visit the booth.|
code=
<syntaxhighlight>
string [string] initiatives = voting_booth_initiative( my_class(), my_path_id(), my_daycount() );
dump( initiatives );
</syntaxhighlight>}}|
}}

Voting booth initiatives

2020-09-23T16:13:46Z

Gausie:

{{
#vardefine:name|voting_booth_initiatives}}{{
#vardefine:return_type|string [string]}}{{
#vardefine:aggregate|yes}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|class|class}}|
p1desc={{pspan|class}} is the class for the seed|
parameter2={{Param|int|path}}|
p2desc={{pspan|class}} is the path id for the seed|
parameter3={{Param|int|daycount}}|
p3desc={{pspan|daycount}} is the daycount for the seed|
}}|

function_description=Returns a map of voting initiatives that are available for a given class on a given day of an ascension in a given path|

code1={{CodeSample|
title=Code Sample|
description=The following will tell you the initiatives available to you today without you ever having to visit the booth.|
code=
<syntaxhighlight>
string [string] initiatives = voting_booth_initiative( my_class(), my_path_id(), my_daycount() );
dump( initiatives );
</syntaxhighlight>}}|
}}

Voting booth initiatives

2020-09-23T16:13:33Z

Gausie: Created page with "{{ #vardefine:name|voting_booth_initiatives}}{{ #vardefine:return_type|string [string]}}{{ #vardefine:aggregate|yes}}{{ FunctionPage| name={{#var:name}}| function1={{Functio..."

{{
#vardefine:name|voting_booth_initiatives}}{{
#vardefine:return_type|string [string]}}{{
#vardefine:aggregate|yes}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|class|class}}|
p1desc={{pspan|class}} is the class for the seed|
parameter2={{Param|int|path}}|
p2desc={{pspan|class}} is the path id for the seed|
parameter3={{Param|int|daycount}}|
p3desc={{pspan|daycount}} is the daycount for the seed|
}}|

function_description=Returns a map of voting initiatives that are available for a given class on a given day of an ascension in a given path

code1={{CodeSample|
title=Code Sample|
description=The following will tell you the initiatives available to you today without you ever having to visit the booth.|
code=
<syntaxhighlight>
string [string] initiatives = voting_booth_initiative( my_class(), my_path_id(), my_daycount() );
dump( initiatives );
</syntaxhighlight>}}|
}}

Shop limit

2020-08-24T11:03:48Z

Gausie:

{{
#vardefine:name|shop_limit}}{{
#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}}|
p1desc={{Pspan|it}} is the item to check|
}}|

function_description=Returns the limit set on a given item that are currently for sale in your mall store.|
see_also={{SeeAlso|shop_amount|get_shop}}|
}}

[[Category:Item Management]]

Get shop

2020-08-24T11:03:36Z

Gausie:

{{#vardefine:name|get_shop}}{{
#vardefine:aggregate|yes}}{{
#vardefine:return_type|int [item]}}{{

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 a map where each key is an item in your Mall store, with the integer value how many you are currently selling.|
code1={{CodeSample|
title=Code Samples|
description=The following example creates a function called "in_shop" which tells you how many of a given item is currently in your shop.|
code=
<syntaxhighlight>
int[item] shop_items;
shop_items = get_shop();

void in_shop(string check) {
item thing = to_item(check);
if (thing == $item[none]) {
print(check+" is not a valid item.", "red");
return;
}
if (shop_items contains thing)
print("Your shop currently has "+shop_items[thing]+" "+thing+".", "blue");
else print("Your shop currently has 0 of "+thing, "blue");
}

//Check how many Mae Wests
in_shop("mae west");
//Check all items with greater than 4 fullness
foreach it in $items[]
if (it.fullness > 4)
in_shop(to_string(it));

</syntaxhighlight>|

}}|
see_also={{SeeAlso|shop_amount|shop_limit}}|
}}

[[Category:Item Management]]

Shop limit

2020-08-24T11:02:55Z

Gausie: Created page

{{
#vardefine:name|shop_limit}}{{
#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}}|
p1desc={{Pspan|it}} is the item to check|
}}|

function_description=Returns the limit set on a given item that are currently for sale in your mall store.|
see_also={{SeeAlso|closet_amount|display_amount|equipped_amount|item_amount|stash_amount|storage_amount}}|
}}

[[Category:Item Management]]

Put shop

2020-08-24T11:01:55Z

Gausie:

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

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|price}}|
parameter2={{Param|int|limit}}|
parameter3={{Param|item|it}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|price}}|
parameter2={{Param|int|limit}}|
parameter3={{Param|int|qty}}|
parameter4={{Param|item|it}}|
p1desc={{pspan|price}} is the price to set; using 0 will result in the max-price of 999,999,999 if item is not currently in your store|
p2desc={{pspan|limit}} is the limit per player per day, or no limit if set to 0|
p3desc={{pspan|qty}} an optional parameter for the quantity of items to put in your shop (defaults to all if not provided)|
p4desc={{pspan|it}} is the item to put in your mall store.|
}}|

function_description=Places items in your mall store with settings as described above. Returns true if placement is successful and false if placement fails.
Note that attempting to put an item in your store at less than minimum mall price will automatically reset the price to mall minimum.
Note that attempting to put a negative amount of an item in your store will not do anything, but will still return true.
Note that you cannot specify a quantity of 0 to change prices, but the function will still return true.|

code1={{CodeSample|
title=Code Sample|
description=The following example will put all of your broken skulls in your mall store for 500 meat at a limit of 5.|
code=
<syntaxhighlight>
put_shop(500 , 5 , $item[broken skull]);
</syntaxhighlight>}}|

see_also={{SeeAlso|have_shop|shop_amount|shop_limit|take_shop}}|
cli_equiv=The CLI command "mallsell" works similarly.|
}}

[[Category:Item Management]]

Log n

2020-08-20T10:08:52Z

Gausie: Created page with "{{ #vardefine:name|log_n}}{{ #vardefine:return_type|float}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregate}}| retur..."

{{
#vardefine:name|log_n}}{{
#vardefine:return_type|float}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|float|number}}|
p1desc={{Pspan|number}} is the number to natural log|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|float|number}}|
parameter2={{Param|float|base}}|
p1desc={{Pspan|number}} is the number to log|
p2desc={{Pspan|base}} is logarithmic base to use|
}}|

function_description=Returns the logarithm of {{pspan|number}}.|

}}

[[Category:Math and Numbers]]

Math and Numbers

2020-08-20T10:03:59Z

Gausie: Add log_n

{{Flink|int|ceil|float|desc=Returns the next highest value of the specified number as an integer.}}
{{Flink|int|floor|float|desc=Returns the next lowest value of the specified number as an integer.}}
{{Flink|boolean|is_integer|string|desc=Reports whether a string is an integer.}}
{{Flink|int|min|int|int}}
{{Flink|float|min|float|float|desc=Returns the lower of two numbers.}}
{{Flink|int|max|int|int}}
{{Flink|float|max|float|float|desc=Returns the higher of two numbers.}}
{{flink|float|expression_eval|string}}
{{flink|float|monster_eval|string}}
{{flink|float|modifier_eval|string|desc=Evaluates a mathematical expression.}}
{{Flink|int|random|int|desc=Generates a random integer between 0 and 1 less than the specified number, inclusive.}}
{{Flink|int|round|float|desc=Returns the value of the specified number as rounded to the nearest integer.}}
{{Flink|float|square_root|float|desc=Returns the square root of the specified value.}}
{{Flink|int|truncate|float|desc=Returns the decimal-stripped value of the specified number as an integer.}}
{{Flink|float|log_n|float|{{opt|float}}|desc=Returns the natural log of the first argument, or with the base of the second argument is specified}}

[[Category:Scripting]]

Miscellaneous ASH Features

2020-06-05T08:58:28Z

Gausie: /* Additional Script Uses */

{{TOCright}}
==Special Features of ASH Scripting==
These features are not exactly ASH commands, but they are used to improve script usage.

===Special Syntax Functions===

'''[[script]]'''

Defines a script's proper name. Mostly for use by a subsequent notify command in case the user saves the script with a custom name.

'''[[notify]]'''

Used to send a simple kmail to the script's author, letting them know you use their script.

'''[[since]]'''

Used to inform KoLmafia of the minimum build necessary to support the script's functionality so it can abort execution with a meaningful error message.

'''[[import]]'''

Used to load an external script into your current one.

'''[[call]]'''

Enables the script writer to invoke a function whose name is known at runtime.

'''[[new]]'''

Constructor function used to populate a record.

===Comments===

Adding '''[[Comments]]''' to your code can make it much easier to maintain, and helps other users understand what's going on.

==Errors==

There are a wide variety of error messages. For help when things go wrong, please see the page on [[ASH Errors]].

==Relay Override Scripts==
A relay override script is a script that modifies a web page in the relay browser. It is only in the relay browser that the effects of this scripts can be seen. The purpose of this is to alter a KoL page to improve functionality or appearance.

Detailed information is at [[Relay_Override_Scripting#Relay_Script|Relay Override Script]].

==User Interface Script==
A User Interface script is a script that creates a web page viewable in the relay browser. It is only in the relay browser that this special page can be seen. The purpose of this is to extend KoLmafia abilities or present information to the user.

Detailed information is at [[Relay_Override_Scripting#User_Interface_Script|User Interface Script]].

==Consult Scripts==
Consult scripts are used to script combat. They can be used in automated adventuring or in the relay browser.

Detailed information is at [[Custom_Combat_Script#Consult_Scripts|Consult Scripts]].

==Additional Script Uses==

In addition to regular scripts, override scripts, UI scripts, and consult scripts, mafia has a few other hooks for adding event-driven scripts. These situations are listed below, along with the preference that you can set a script name to (in parentheses).

=== After Adventure (afterAdventureScript) ===

*Executed just after mafia has finished an adventure.
*The afterAdventureScript setting is executed like a CLI command. If it is the name of an ASH script, that script does not require any special main() declaration.
*By default this only works for automated adventuring. If you wish it to fire when you're using the relay browser then turn it on in General -> Preferences -> - Relay Browser or set the property relayRunsAfterAdventureScript to true.

=== Before Adventure (betweenBattleScript) ===

*Executed whenever mafia is about to enter a combat. That means before every adventure if auto-adventuring, or before using an item that could lead to combat such as black pudding or drum machine.
*The betweenBattleScript setting is executed like a CLI command. If it is the name of an ASH script, that script does not require any special main() declaration.
*By default this only works for automated adventuring. If you wish it to fire when you're using the relay browser then turn it on in General -> Preferences -> - Relay Browser or set the property relayRunsBeforeBattleScript to true.
*Example: Zarqon's [http://kolmafia.us/showthread.php?t=1240 Best Between Battle]

=== Before PvP Script (beforePVPScript) ===
* This will be executed before every PvP attack initiated through the relay browser or CLI command.
* If you want buffs maintained during PvP (and nothing else) you can do that with:
*: <pre>set beforePVPScript = mood execute</pre>

=== Breaking the Prism (kingLiberatedScript) ===

: This will be executed after you break the Prism at the top of the Naughty Sorceress' Lair. This trigger is designed so that a character can be automatically prepared for aftercore. The kingLiberatedScript setting is executed like a CLI command. If it is the name of an ASH script, that script does not require any special main() declaration.

=== Buy (buyScript) ===

*Will execute whenever mafia needs to determine if it is to purchase or create an item.
*Requires a special main declaration boolean main(item itm, int qty, int ingredientLevel, boolean defaultBuy). These values will be supplied by mafia when the script is automatically called. A return value of true will instruct mafia to purchase the item and false will cause it to create the item possibly leading to other buy/create decisions.
**''itm'' and ''qty'' specify the item under consideration.
**''ingredientLevel'' indicates what's already available:
***0 = none of the ingredients
***1 = some of them
***2 = enough to create at least one of the requested item
**defaultBuy indicates what KoLmafia would have done otherwise; returning this value is the safest thing your script could do. It will normally be true if ingredientLevel is 0, false if 2. The default at level 1 depends on the item, and is subject to change - normally, anything made with star charts, pixels, the Malus, or multi-use are bought, anything else is created.
*Example: Bale's [http://kolmafia.us/showthread.php?p=18313#post18313 potionBuy].

=== Chatbot (chatbotScript) ===

*Will execute whenever a private message or an event is received
**When an event is received the message is stripped of HTML, the channel is "Events" and the sender is an empty string.
*Requires a special main declaration which can have an optional third parameter:
*:void main(string sender, string message)
*:void main(string sender, string message, string channel)
**'sender' is the name of the player who sent the message
**'message' is the message that was sent
**'channel' is "/clan" for clan messages, "Events" for chat notifications (e.g. "New message received from Bale."), and the empty string for private messages

=== Counters (counterScript) ===

*Will execute whenever a counter will expire as a result of an intended use of adventures.
*Requires a special main declaration: boolean main(string name, int remain). These values will be supplied by mafia when the script is automatically called and the return value will determine whether mafia continues operation (true) or aborts (false).
**''name'' will be the name of the counter that is about to expire.
**''remain'' is the number of turns remaining before the counter expires. Remain will usually be 0, but may be higher if you are about to multi-create items, adventure underwater, or take a vacation. It may be negative if the counter was informational (one that doesn't abort adventuring), and it actually expired in the middle of an action that used multiple turns at once.
*Example: Bale's [http://kolmafia.us/showthread.php?t=2519 CounterChecker].

=== Login (loginScript) ===

:This script is immediately executed once your character is logged in. The loginScript setting is executed like a CLI command. If it is the name of an ASH script, that script does not require any special main() declaration.

=== Logout (logoutScript) ===

:Same as the loginScript, but runs on logout. Note that an {{f|abort}} in the script won't stop a logout unless the logout was called in (specific ways, please list).

=== Planting (plantingScript) ===

*This script can be used to manage the mushroom fields, which are available when under a muscle zodiac sign. It runs after logging in, if you have a mushroom field. Main function takes no arguments. Generally should take into account current [[moon phase]] so that it can be started in the middle of a cycle.
*The plantingScript has to be the name of an ASH file without the extension (if the plantingScript setting is "plant", KoLMafia will call "plant.ash").
*Example: [http://kolmafia.us/showthread.php?563-Modified-mushroom-script-to-produce-3rd-4th-gen-crop&p=7507&viewfull=1#post7507 Sandiman's mushroom planting script].

=== Post-Ascension (postAscensionScript) ===

:Executed at once when your character starts a new ascension. (Example: Bales's [http://kolmafia.us/showthread.php?t=2769 newLife]). The postAscensionScript setting is executed like a CLI command. If it is the name of an ASH script, that script does not require any special main() declaration.

=== Pre-Ascension (preAscensionScript) ===

:Same as the Post-Ascension, but executed right before entering Valhalla.

=== Recovery (recoveryScript) ===

*Executed whenever mafia would recover your HP / MP.
*Requires a special main() declaration: boolean main(string type, int amount). These values will be supplied when mafia automatically calls the script, and the return value will instruct mafia if it should attempt to use mafia's default healing after the script concludes.
**''type'' is either "HP" or "MP".
**''amount'' is the desired amount of restoration needed or 0 to use mafia's default recovery level and target.
*Example: Bale's [http://kolmafia.us/showthread.php?t=1780 Universal Recovery]

=== Familiar (familiarScript) ===
*Executed after changing familiars but before automatically changing familiar equipment.
*Requires a special main() declaration: boolean main(). Returning true will cause normal familiar equipment switching to be skipped, while false will lead to it running after the script returns.

=== Spading (spadingScript) ===

* Executed at various points throughout the game lifecycle.
* Requires the main() declaration: void main(string event, string meta, string page).
* Depending on the event type, the meta string will represent a different value, but the page is always the HTML of the page that has been loaded
* Values for event include
** ''COMBAT_ROUND'' run after every round of combat. ''meta'' is the monster name
** ''CONSUME_DRINK'' run after consuming a drink. ''meta'' is the item consumed
** ''CONSUME_EAT'' run after consuming a food. ''meta'' is the item consumed
** ''CONSUME_SPLEEN'' run after consuming a spleen item. ''meta'' is the item consumed
** ''MEAT_DROP'' run after the meat drop from a monster is not what mafia expected. Replaces the output that previously came from the ''meatDropSpading'' property being set to true.

==A little CLI help==

Three CLI commands are of great use to ASH scripters:
* [[ashref]] allows one to get a list of ASH functions
* [[ash (CLI)|ash]] or [[ash (CLI)|ashq]] allows one to run ASH directly on the CLI.
* [[ashwiki]] allows you to search this wiki by launching a web browser.

==Useful forum threads==
[http://kolmafia.us/showthread.php?523-Did-you-know...-It-s-a-secret-feature.&p=2968&viewfull=1#post2968 This thread], started by holatuwol, is a tidy compilation of various undocumented features in KoLmafia.

[[Category:Scripting]]

Miscellaneous ASH Features

2020-06-05T08:58:01Z

Gausie: /* Additional Script Uses */

Data Types

2020-03-23T17:52:56Z

Gausie: /* string */ Added template strings

{{TOCright}}
==Primitive Datatypes==

===void===
Can be thought of better as the absence of a datatype. No value can be assigned to '''void''' nor can a value be returned from a function of datatype '''void'''.

===boolean===
A boolean value is either '''true''' or '''false'''. By default, a boolean variable is set to false.

===int===

A whole number (short for "integer"), either positive or negative (or 0). The int used by KoLmafia is a 32-bit signed int, meaning it has a maximum value of 2,147,483,647 and a minimum value of -2,147,483,648. The default value of a integer variable is 0.

Be careful when doing math with integers! As with some other strongly-typed languages, numbers are converted to integers at every step of the operation when only integer types are used. For example:
{{
CodeSample|
code=
<syntaxhighlight>
int a = 1;
int b = 2;
print( a / b * 2 );
</syntaxhighlight>}}
Will give the output "0," not "1" as you may expect. Changing either variable to a float type will "correct" this.

===float===

The float data type is a single-precision 32-bit IEEE 754 floating point. Its range of values is beyond the scope of this discussion, but is specified in [http://java.sun.com/docs/books/jls/third_edition/html/typesValues.html#4.2.3 section 4.2.3 of the Java Language Specification], and a tool to help understand / quickly see how/where imprecisions happen can be found [https://www.h-schmidt.net/FloatConverter/IEEE754.html here].

When assigning to a variable of type float, one should be careful to always enter numbers in decimal form, as unwanted behavior can result from supplying a value that KoLmafia may interpret as an int type without the decimal point.

Note that float is not infinitely precise; it intrinsically rounds off after a certain point. This loss of accuracy is for the sake of storage, but beware of the possibility of small errors compounding from multiple float types.
{{
CodeSample|
description=For instance, try the following code as an example of how rather long post-decimal portions are handled:|
code=
<syntaxhighlight>
float f;
f = 4.9999999;
print( f );
</syntaxhighlight>}}
The default value of a <code>float</code> variable is 0.0.

===string===

A group of characters including, but not limited to: lowercase letters, uppercase characters, numbers, and various control characters. When assigning a value to a string, enclose the desired value in either single quotes (<code>'</code>), double quotes (<code>"</code>) or backticks (<code>`</code>) (note you must use the same quote type on both ends of the string assignment). If you need to include the same character inside of the string itself, you will need to escape it first with a backslash.

{{
CodeSample
|description=For example:
|code=<syntaxhighlight>string s = "This is my \"friend\" Pete.";</syntaxhighlight>
|moreinfo=Will result in the following being stored to s:<pre>This is my "friend" Pete</pre>
}}

The default value of a string is an empty string, or literally <code>""</code>

When using backticks, you can concatenate expressions into your string using curly braces.

{{
CodeSample
|description=For example:
|code=<syntaxhighlight>string s = `Hello {my_name()}, you have {$item[lime].item_amount()} lime(s)!`;</syntaxhighlight>
}}

===buffer===

Similar to a string, but more efficient in certain operations, including concatenation and passing as function arguments. For the most part, you can interchange references to strings and buffers. However, you should test all such actions first, as a few functions require a specific datatype to be supplied as a parameter. (Most notably, those listed under [[String Handling Routines#Regular Expressions|Regular Expressions]].)

==Special Datatypes==

Several datatypes are included in KoLmafia to represent common categories within the KoL universe.

Note that while variables of these types are declared in the same way as for Primitive Datatypes; assigning and referencing them is done differently.
{{CodeSample|
description=For example, to declare an item datatype and assign it a value, you would use the following line of code:|
code=
<syntaxhighlight>
item it = $item[ broken skull ];
</syntaxhighlight>}}
The default values of any variable of one of the following types is <code>$''type''[ none ]</code>. For example, the default value of a <code>item</code> variable is <code>$item[ none ]</code>.

===bounty===

([[Bounty#Related Functions|Related Functions]]) ([[Bounty#Proxy Record Fields|Proxy Record Fields]])

These are the non-items that the bounty hunter asks you to retrieve from monsters around the kingdom. There are quite a lot of them (42 in total) so I won't list them all here. You can find more about bounties at the {{kolwiki|The Bounty Hunter Hunter's Shack}}.

===class===

([[Class#Related Functions|Related Functions]]) ([[Class#Proxy Record Fields|Proxy Record Fields]])

Besides $class[ none ], there are six possible values for this datatype:

* Seal Clubber
* Turtle Tamer
* Pastamancer
* Sauceror
* Disco Bandit
* Accordion Thief

===coinmaster===

([[Coinmaster#Related Functions|Related Functions]]) ([[Coinmaster#Proxy Record Fields|Proxy Record Fields]])

All shops that deal with currency other than meat. Known values include:

* {{kolwiki|The Bounty Hunter Hunter's Shack|Bounty Hunter Hunter}}
* {{kolwiki|Mr. Store}}
* {{kolwiki|Hermit}}
* {{kolwiki|The Shore, Inc. Gift Shop}}
* {{kolwiki|The Trapper's Cabin|The Trapper}}
* {{kolwiki|A Vending Machine|Vending Machine}}
* {{kolwiki|The Swagger Shop}}
* {{kolwiki|The Hippy Camp (Wartime)|Dimemaster}}
* {{kolwiki|The Orcish Frat House|Quartersmaster}}
* {{kolwiki|BURT|Bugbear Token}}
* {{kolwiki|Freshwater Fishbonery}}
* {{kolwiki|Big Brother}}
* {{kolwiki|The Terrified Eagle Inn}}
* {{kolwiki|Ticket Redemption Counter|Arcade Ticket Counter}}
* {{kolwiki|Cashier|Game Shoppe}}
* {{kolwiki|Cashier|Game Shoppe Snacks}}
* {{kolwiki|The Isotope Smithery|Isotope Smithery}}
* {{kolwiki|Dollhawker's Emporium}}
* {{kolwiki|The Lunar Lunch-o-Mat|Lunar Lunch-o-Mat}}
* {{kolwiki|Paul's Boutique}}
* {{kolwiki|The Frozen Brogurt Stand}}
* {{kolwiki|Buff Jimmy's Souvenir Shop}}
* {{kolwiki|Taco Dan's Taco Stand}}
* {{kolwiki|You're the Fudge Wizard Now, Dog|Fudge Wand}}
* {{kolwiki|The Neandermall}}
* {{kolwiki|Legitimate Shoe Repair, Inc.}}
* {{kolwiki|warbear black box|Warbear Black Box}}
* {{kolwiki|The Dinsey Company Store}}
* {{kolwiki|Internet Meme Shop}}

===effect===

([[Effect#Related Functions|Related Functions]]) ([[Effect#Proxy Record Fields|Proxy Record Fields]])

Any effect you can be under in KoL, whether from items, skills, or what-have-you, is valid for this datatype.

The full range, besides $effect[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Effects}} page for more information.

===element===

([[Element#Related Functions|Related Functions]]) ([[Element#Proxy Record Fields|Proxy Record Fields]])

Besides $element[ none ], there are seven possible values for this datatype. (Note that "Bad Spelling" is not considered a true element.)
Also note that these names are case-sensitive (referencing $element[ Spooky ] will generate an error).

* cold
* hot
* sleaze
* spooky
* stench
* slime
* supercold

===familiar===

([[Familiar#Related Functions|Related Functions]]) ([[Familiar#Proxy Record Fields|Proxy Record Fields]])

Any familiar available in KoL is valid for this datatype.

The full range, besides $familiar[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Familiars}} page for more information.

===item===

([[Item#Related Functions|Related Functions]]) ([[Item#Proxy Record Fields|Proxy Record Fields]])

Any item in all of KoL is valid for this datatype. Note that unlike most special datatypes, item references can make use of the item ID number.
{{CodeSample|
description=For example, you could assign the item plexiglass pants as follows:|
code=
<syntaxhighlight>
item it = $item[ 1234 ];
</syntaxhighlight>}}
The full range, besides $item[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Items}} page for more information.

===location===

([[Location#Related Functions|Related Functions]]) ([[Location#Proxy Record Fields|Proxy Record Fields]])

Any location one can adventure at in KoL is valid for this datatype.

The full range, besides $location[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Locations}} page for more information.

===monster===

([[Monster#Related Functions|Related Functions]]) ([[Monster#Proxy Record Fields|Proxy Record Fields]])

Any monster you can encounter in KoL is valid for this datatype.

The full range, besides $monster[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Monster Compendium}} page for more information.

===phylum===

([[Phylum#Related Functions|Related Functions]]) ([[Phylum#Proxy Record Fields|Proxy Record Fields]])

Each monster has a {{kolwiki|Phylum}}. Besides $phylum[none], the possible values for this datatype are:

* beast
* bug
* constellation
* construct
* demon
* dude
* elemental
* elf
* fish
* goblin
* hippy
* hobo
* humanoid
* horror
* mer-kin
* orc
* penguin
* pirate
* plant
* slime
* undead
* weird

===servant===

([[Servant#Related Functions|Related Functions]]) ([[Servant#Proxy Record Fields|Proxy Record Fields]])

Servants are unique to the {{kolwiki|Actually Ed the Undying}} path and located {{kolwiki|The Servants' Quarters}}, replacing familiars.

* Assassin
* Belly-Dancer
* Bodyguard
* Cat
* Maid
* Priest
* Scribe

===skill===

([[Skill#Related Functions|Related Functions]]) ([[Skill#Proxy Record Fields|Proxy Record Fields]])

Any skill you can have in KoL, whether permable or not, granted by items, ''etc''., is valid for this datatype.

The full range, besides $skill[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Skills}} page for more information.

===slot===

([[Slot#Related Functions|Related Functions]]) (slot has no proxy record fields)

Besides $slot[ none ], there are 16 possible values for this datatype.

* hat
* back
* weapon
* off-hand
* shirt
* pants
* acc1
* acc2
* acc3
* familiar
* sticker1
* sticker2
* sticker3
* fakehand
* bootspur
* bootskin

===stat===

([[Stat#Related Functions|Related Functions]]) (stat has no proxy record fields)

Besides $stat[ none ], there are six possible values for this datatype (the last three are for referencing sub-stats).

* muscle
* mysticality
* moxie
* submuscle
* submysticality
* submoxie

===thrall===

([[Thrall#Related Functions|Related Functions]]) ([[Thrall#Proxy Record Fields|Proxy Record Fields]])

Pastamancers have the ability to summon {{kolwiki|Pasta Thralls}}.

* Angel Hair Wisp
* Elbow Macaroni
* Lasagmbie
* Penne Dreadful
* Spaghetti Elemental
* Spice Ghost
* Vampieroghi
* Vermincelli

==aggregate==

An aggregate is a complex datatype composed of two or more primitive or special datatypes. For more information, see [[Data Structures]].

==record==

Records are user-defined datatypes that hold as many sub-datatypes as desired. For more information, see the page for [[Data Structures]].

==Plural Typed Constants==

(see http://kolmafia.us/showthread.php?p=15592, from which this section is reproduced)

Plural typed constants allow you to easily do something with a list of specified objects, without having to replicate code or laboriously build up an array of the objects so that you can iterate over it. Here's a quick example:
{{CodeSample|code=<syntaxhighlight>
foreach weapon in $items[star sword, star staff, star crossbow] {
if (available_amount(weapon) > 0) {
equip(weapon);
break;
}
}</syntaxhighlight>}}
The syntax is basically the same as the existing typed constant feature, but with an "s" or "es" after the type name. (The "es" case is there so that you can properly pluralize "class".) The text between the square brackets is interpreted as a comma-separated list of elements, each of which is converted to the specified type as if it were an individual constant. More details:
* The list can span multiple lines.
* Whitespace before or after elements is ignored.
* Completely empty elements are ignored (so that you can leave a comma at the end of the list).
* You can include a comma or closing square bracket in an element by writing it as "\," or "\]".
* All the other escape sequences allowed in strings are possible, such as "\n" (newline), "\t" (tab), and "\uXXXX" (Unicode character value). To put an actual backslash in an element, you have to write it as "\\".

The value generated by a plural constant is of type boolean[type], with the keys being the specified elements, and the boolean value always being true - although you won't normally do anything with the boolean, you'd use a foreach loop to iterate over the keys. You can assign a plural constant to a variable declared as that type, but note that the value differs from a normal map in three important respects:
* Since the expression that generates it is syntactically a constant, the value has to be immutable. If you were allowed to change it in any way, those changes would appear in every future use of the same constant.
* There can be multiple instances of the same key - $ints[1,1,2,3,5,8] is perfectly valid, and will result in the value 1 appearing twice in a foreach loop.
* The keys will appear in the order you wrote them, rather than being sorted alphanumerically as maps usually do.

In addition to being used in a foreach loop, plural constants also efficiently support membership testing via the 'contains' operator. Here's another example:
{{CodeSample|code=<syntaxhighlight>
for hour from 1 to 12 {
print("It's " + hour + " o'clock.");
if ($ints[10, 2, 4] contains hour) {
print("Time to drink a Dr Pepper!");
}
}</syntaxhighlight>}}
(Yes, that example could just as easily have been done with a switch statement.)

Iterating over an empty list is rather pointless, so plural constants with no elements are given a different meaning: they represent every value of the specified type, where this is practical. (The 'none' value, if defined for a given type, is omitted.) The biggest benefit here is $items[], which lets you loop over every defined item, more efficiently than you could otherwise write in a script (since the list is generated once per session and then cached), and without having to hard-code a maximum item ID number in your script. Example:
{{CodeSample|code=<syntaxhighlight>
foreach it in $items[] {
if (autosell_price(it) == 42) print(it);
}</syntaxhighlight>}}
Enumeration of all possible values works with the following types:
* $booleans[] - false and true.
* $items[]
* $locations[]
* $classes[]
* $stats[] - Muscle, Mysticality, Moxie: the substat values are omitted.
* $skills[]
* $effects[]
* $familiars[]
* $slots[] - includes sticker slots and fake hands, which you might not want to consider as normal slots.
* $monsters[]
* $elements[] - includes slime now, and possibly other not-quite-elements like cute in the future.

The remaining types that can be used in plural constants require an explicit list of elements, since there are too many possible values:
* $ints[] - you don't have enough RAM to store a list with 4 billion elements.
* $floats[] - ditto.
* $strings[] - nobody has that much RAM.

==Custom==

===matcher===

A matcher isn't really a datatype so much as it's a class, but it is included here for reference, as it is used much as datatypes are in ASH. It can only be declared through the function {{f|create_matcher}}, using two strings. One is the string to find matches in, the other a regular expression to test against. For more information on using a matcher, see [[Regular Expressions]].

[[Category:Scripting]]

Faxbot

2019-08-19T21:13:51Z

Gausie: Typo

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

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

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

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

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

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

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

[[Category:Miscellaneous Functions]]

Faxbot

2019-08-19T21:11:24Z

Gausie: Added new overload

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

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

function1={{Function|
name={{#var:name}}|
return_type={{#var:return_type}}|
parameter1={{Param|monster|m}}||
p1desc={{Pspan|m}} is the monster to request a fax of.|
}}|

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

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

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

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

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

[[Category:Miscellaneous Functions]]