Kolmafia - User contributions [en]

Quest Tracking Preferences

2023-10-27T16:26:57Z

3BH: /* questLTTQuestByWire */

{{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
=== questLTTQuestByWire ===

Note: the quest name is in the property lttQuestName, and the difficulty is in lttQuestDifficulty

* started - acquire plaintive telegram by choosing quest from Telegram Office
* step1 - Adventured in The Investigation Begins
* step2 - The Investigation Continues; choice id 1635
* step3 - The Investigation Continues (2); choice id 1645
* step4 - The Investigation Thrillingly Concludes! choice id 1655
* unstarted: After you beat the boss, it changes the step back to unstarted and clears lttQuestName and lttQuestDifficulty

==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}}

Quest Tracking Preferences

2023-10-27T16:07:31Z

3BH: whoops moving to correct header, granted by plaintive telegram

{{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
=== questLTTQuestByWire ===

Note: the quest name is in the property lttQuestName, and the difficulty is in lttQuestDifficulty

* started - Seen the intro adventure in Investigating a Plaintive Telegram
* step1 - Adventured in The Investigation Begins
* step2 - The Investigation Continues; choice id 1635
* step3 - The Investigation Continues (2); choice id 1645
* step4 - The Investigation Thrillingly Concludes! choice id 1655
* unstarted: After you beat the boss, it changes the step back to unstarted and clears lttQuestName and lttQuestDifficulty

==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}}

Quest Tracking Preferences

2023-10-27T16:05:52Z

3BH: adding Plaintive Telegram office quests

{{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

=== questLTTQuestByWire ===

Note: the quest name is in the property lttQuestName, and the difficulty is in lttQuestDifficulty

* started - Seen the intro adventure in Investigating a Plaintive Telegram
* step1 - Adventured in The Investigation Begins
* step2 - The Investigation Continues; choice id 1635
* step3 - The Investigation Continues (2); choice id 1645
* step4 - The Investigation Thrillingly Concludes! choice id 1655
* unstarted: After you beat the boss, it changes the step back to unstarted and clears lttQuestName and lttQuestDifficulty

==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}}

Compiling from Source

2021-09-29T15:19:55Z

3BH: removing ci specific thing

=== GREAT BIG NEWS ===

==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==
Exactly nothing below here is accurate, and we'll need to do a thorough cleanup of this page and the IDE setup page.

The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the SVN and be comfortable writing Java Code. Instructions for the first two are included below:

==Windows==
# Download Tools
## Download and install Java Development Kit 1.8 or newer, available from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptopenjdk.net AdoptOpenJDK]
## Download and install Subversion, from [https://subversion.apache.org/packages.html apache.org]
## Download and install Tortoise SVN (or of course, another SVN program)from [https://tortoisesvn.net/downloads.html tortoisesvn]
## Download and install ANT, from [https://ant.apache.org/bindownload.cgi apache.org]
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit ANT_HOME, JAVA_HOME, and PATH variables ''PATH should include ANT_HOME/bin and JAVA_HOME''If ANT or JAVA installers have already set these variables, they can be updated or left alone.
# Get Source and Build
## Connect to the SVN server and download the source code for the Mafia Project. Using Tortoise SVN, you have to right-click on your desktop, select "SVN Checkout", and put the URL of the repository as "svn://svn.code.sf.net/p/kolmafia/code/". Leave all other settings as they are, and click OK.
## Copy %ANT_HOME%/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up ANT correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.
===Troubleshooting===
====Double-Clicking ''ant.bat''====
Due to how bat files work when you double-click them, ''ant.bat'' will auto-close before you can read its output.
# ant assumes that builds are done from a command shell. You'll need to run from the command shell to execute any ant target other than the default, such as ''ant.bat update exec'' or ''ant.bat dailyant -projecthelp'' will list all main targets
# An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you. When you run it again, you'll be able to read its output and it will exit after you ''Press any key to continue...''
# Alternatively, you can create a wrapper batch file that calls the existing ''ant.bat'' file and adds a pause after executing it. This method allows you to set different ant targets and also prevents updates to ant from overwriting your modifications.
<blockquote>Example of a very simple MyWrapper.bat file<pre>
# This is a wrapper batch file
# First it runs ant
call ant.bat daily
# Then it pauses
pause</pre></blockquote>

====''tools.jar'' not found====
If you get an error message about "tools.jar" not being found, this means you're trying to build with the JRE (which doesn't contain this file) rather than the JDK (which contains it). 
To fix this, right click on ''my computer'' -> ''properties'' -> ''advanced system settings'' -> ''Environment Variables...'' then make sure your PATH contains a reference to the location of your JDK directory.

==Linux==

# Install Sun Java Development Kit ( debian: apt-get install sun-java6-jdk )
# Install Subversion ( debian: apt-get install svn )
# Install Ant ( debian: apt-get install ant )
# Connect to the SVN server and download the source code for the Mafia Project. ( svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia )
# Verify tou are using sun-java with ( debian: update-alternatives --all )
# I had to change $JAVA_HOME to compile ( export JAVA_HOME=/usr/lib/jvm/java-6-sun-1.6.0.12 )
# Compile kolmafia with Ant ( debian: cd kolmafia && ant debian )
# Install kolmafia ( debian: cd dist && dpkg -i kolmafia*.deb )

'''Above may be out of date.''' As of the move to github the following commands were successful to build from source on Ubuntu 20.04.1 LTS. You will still have to have a jdk installed.<pre>git clone https://github.com/kolmafia/kolmafia.git
cd kolmafia
./gradlew clean shadowJar</pre>
===Fedora (or probably other RPM systems)===

# Install Subversion: <pre>sudo yum install sqlite-devel subversion </pre>
# Install Java JDK: <pre>sudo yum install java-latest-openjdk-devel</pre>
# Install Ant: <pre>sudo yum install ant</pre>
# Checkout: <pre>svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia</pre>
# Build: <pre>cd kolmafia && ant</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==MacOSX==
# Install required packages''MacOS X packages for Java, subversion, and ANT may also be installed via a package manager like [https://brew.sh Homebrew] or [https://www.macports.org MacPorts]. The instructions are written for a direct installation of the packages.''
## Install Java Development Kit version 1.8 or newer from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptium.net Adoptium Temurin]
## Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environmentMost of these steps can be included in ''.profile'' or the equivalent for your terminal of choice.
## In the terminal set JAVA_HOME to the java home directory. ''/usr/libexec/java_home -V'' will list all known values for java_home.If you have multiple copies of java, choose the version you want to us''e.
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. cd ~/Projects, or some similar directory)
# Clone the source code for the KoLmafia Project.''git clone git@github.com:kolmafia/kolmafia.git''
# Compile KoLmafia with the Gradle wrapper (''cd kolmafia && ./gradlew runShadow'')
''There are more instructions on setting up your token in GitHub and then setting up ssh-agent, as well as how to update your cloned copy. TBD''

''[[Category:Tech Support]]''

Compiling from Source

2021-09-29T15:18:03Z

3BH: updating to be the most generic it can be

=== GREAT BIG NEWS ===

==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==
Exactly nothing below here is accurate, and we'll need to do a thorough cleanup of this page and the IDE setup page.

The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the SVN and be comfortable writing Java Code. Instructions for the first two are included below:

==Windows==
# Download Tools
## Download and install Java Development Kit 1.8 or newer, available from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptopenjdk.net AdoptOpenJDK]
## Download and install Subversion, from [https://subversion.apache.org/packages.html apache.org]
## Download and install Tortoise SVN (or of course, another SVN program)from [https://tortoisesvn.net/downloads.html tortoisesvn]
## Download and install ANT, from [https://ant.apache.org/bindownload.cgi apache.org]
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit ANT_HOME, JAVA_HOME, and PATH variables ''PATH should include ANT_HOME/bin and JAVA_HOME''If ANT or JAVA installers have already set these variables, they can be updated or left alone.
# Get Source and Build
## Connect to the SVN server and download the source code for the Mafia Project. Using Tortoise SVN, you have to right-click on your desktop, select "SVN Checkout", and put the URL of the repository as "svn://svn.code.sf.net/p/kolmafia/code/". Leave all other settings as they are, and click OK.
## Copy %ANT_HOME%/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up ANT correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.
===Troubleshooting===
====Double-Clicking ''ant.bat''====
Due to how bat files work when you double-click them, ''ant.bat'' will auto-close before you can read its output.
# ant assumes that builds are done from a command shell. You'll need to run from the command shell to execute any ant target other than the default, such as ''ant.bat update exec'' or ''ant.bat dailyant -projecthelp'' will list all main targets
# An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you. When you run it again, you'll be able to read its output and it will exit after you ''Press any key to continue...''
# Alternatively, you can create a wrapper batch file that calls the existing ''ant.bat'' file and adds a pause after executing it. This method allows you to set different ant targets and also prevents updates to ant from overwriting your modifications.
<blockquote>Example of a very simple MyWrapper.bat file<pre>
# This is a wrapper batch file
# First it runs ant
call ant.bat daily
# Then it pauses
pause</pre></blockquote>

====''tools.jar'' not found====
If you get an error message about "tools.jar" not being found, this means you're trying to build with the JRE (which doesn't contain this file) rather than the JDK (which contains it). 
To fix this, right click on ''my computer'' -> ''properties'' -> ''advanced system settings'' -> ''Environment Variables...'' then make sure your PATH contains a reference to the location of your JDK directory.

==Linux==

# Install Sun Java Development Kit ( debian: apt-get install sun-java6-jdk )
# Install Subversion ( debian: apt-get install svn )
# Install Ant ( debian: apt-get install ant )
# Connect to the SVN server and download the source code for the Mafia Project. ( svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia )
# Verify tou are using sun-java with ( debian: update-alternatives --all )
# I had to change $JAVA_HOME to compile ( export JAVA_HOME=/usr/lib/jvm/java-6-sun-1.6.0.12 )
# Compile kolmafia with Ant ( debian: cd kolmafia && ant debian )
# Install kolmafia ( debian: cd dist && dpkg -i kolmafia*.deb )

'''Above may be out of date.''' As of the move to github the following commands were successful to build from source on Ubuntu 20.04.1 LTS. You will still have to have a jdk installed.<pre>git clone https://github.com/kolmafia/kolmafia.git
cd kolmafia
./gradlew --no-daemon clean shadowJar</pre>
===Fedora (or probably other RPM systems)===

# Install Subversion: <pre>sudo yum install sqlite-devel subversion </pre>
# Install Java JDK: <pre>sudo yum install java-latest-openjdk-devel</pre>
# Install Ant: <pre>sudo yum install ant</pre>
# Checkout: <pre>svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia</pre>
# Build: <pre>cd kolmafia && ant</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==MacOSX==
# Install required packages''MacOS X packages for Java, subversion, and ANT may also be installed via a package manager like [https://brew.sh Homebrew] or [https://www.macports.org MacPorts]. The instructions are written for a direct installation of the packages.''
## Install Java Development Kit version 1.8 or newer from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptium.net Adoptium Temurin]
## Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environmentMost of these steps can be included in ''.profile'' or the equivalent for your terminal of choice.
## In the terminal set JAVA_HOME to the java home directory. ''/usr/libexec/java_home -V'' will list all known values for java_home.If you have multiple copies of java, choose the version you want to us''e.
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. cd ~/Projects, or some similar directory)
# Clone the source code for the KoLmafia Project.''git clone git@github.com:kolmafia/kolmafia.git''
# Compile KoLmafia with the Gradle wrapper (''cd kolmafia && ./gradlew runShadow'')
''There are more instructions on setting up your token in GitHub and then setting up ssh-agent, as well as how to update your cloned copy. TBD''

''[[Category:Tech Support]]''

Compiling from Source

2021-09-29T15:03:16Z

3BH: Adding build steps for Linux, someone who knows more please fix

=== GREAT BIG NEWS ===

==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==
Exactly nothing below here is accurate, and we'll need to do a thorough cleanup of this page and the IDE setup page.

The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.

To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the SVN and be comfortable writing Java Code. Instructions for the first two are included below:

==Windows==
# Download Tools
## Download and install Java Development Kit 1.8 or newer, available from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptopenjdk.net AdoptOpenJDK]
## Download and install Subversion, from [https://subversion.apache.org/packages.html apache.org]
## Download and install Tortoise SVN (or of course, another SVN program)from [https://tortoisesvn.net/downloads.html tortoisesvn]
## Download and install ANT, from [https://ant.apache.org/bindownload.cgi apache.org]
# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
## Windows 10
### Go to settings
### type 'enviro' in the search
### click on the 'edit environment variables' suggestion
### add or edit ANT_HOME, JAVA_HOME, and PATH variables ''PATH should include ANT_HOME/bin and JAVA_HOME''If ANT or JAVA installers have already set these variables, they can be updated or left alone.
# Get Source and Build
## Connect to the SVN server and download the source code for the Mafia Project. Using Tortoise SVN, you have to right-click on your desktop, select "SVN Checkout", and put the URL of the repository as "svn://svn.code.sf.net/p/kolmafia/code/". Leave all other settings as they are, and click OK.
## Copy %ANT_HOME%/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up ANT correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.
===Troubleshooting===
====Double-Clicking ''ant.bat''====
Due to how bat files work when you double-click them, ''ant.bat'' will auto-close before you can read its output.
# ant assumes that builds are done from a command shell. You'll need to run from the command shell to execute any ant target other than the default, such as ''ant.bat update exec'' or ''ant.bat dailyant -projecthelp'' will list all main targets
# An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you. When you run it again, you'll be able to read its output and it will exit after you ''Press any key to continue...''
# Alternatively, you can create a wrapper batch file that calls the existing ''ant.bat'' file and adds a pause after executing it. This method allows you to set different ant targets and also prevents updates to ant from overwriting your modifications.
<blockquote>Example of a very simple MyWrapper.bat file<pre>
# This is a wrapper batch file
# First it runs ant
call ant.bat daily
# Then it pauses
pause</pre></blockquote>

====''tools.jar'' not found====
If you get an error message about "tools.jar" not being found, this means you're trying to build with the JRE (which doesn't contain this file) rather than the JDK (which contains it). 
To fix this, right click on ''my computer'' -> ''properties'' -> ''advanced system settings'' -> ''Environment Variables...'' then make sure your PATH contains a reference to the location of your JDK directory.

==Linux==

# Install Sun Java Development Kit ( debian: apt-get install sun-java6-jdk )
# Install Subversion ( debian: apt-get install svn )
# Install Ant ( debian: apt-get install ant )
# Connect to the SVN server and download the source code for the Mafia Project. ( svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia )
# Verify tou are using sun-java with ( debian: update-alternatives --all )
# I had to change $JAVA_HOME to compile ( export JAVA_HOME=/usr/lib/jvm/java-6-sun-1.6.0.12 )
# Compile kolmafia with Ant ( debian: cd kolmafia && ant debian )
# Install kolmafia ( debian: cd dist && dpkg -i kolmafia*.deb )

'''Above may be out of date.''' As of the move to github the following commands were successful to build from source on Ubuntu 20.04.1 LTS. You will still have to have a jdk installed.<pre>mkdir kolmafia
cd kolmafia
git init
git remote add origin https://github.com/kolmafia/kolmafia.git
git fetch
git reset --hard origin/main
./gradlew --no-daemon clean shadowJar</pre>
===Fedora (or probably other RPM systems)===

# Install Subversion: <pre>sudo yum install sqlite-devel subversion </pre>
# Install Java JDK: <pre>sudo yum install java-latest-openjdk-devel</pre>
# Install Ant: <pre>sudo yum install ant</pre>
# Checkout: <pre>svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia</pre>
# Build: <pre>cd kolmafia && ant</pre>

You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>

Do other installation steps as you wish.

==MacOSX==
# Install required packages''MacOS X packages for Java, subversion, and ANT may also be installed via a package manager like [https://brew.sh Homebrew] or [https://www.macports.org MacPorts]. The instructions are written for a direct installation of the packages.''
## Install Java Development Kit version 1.8 or newer from [https://www.oracle.com/java/technologies/javase-downloads.html Oracle] or [https://adoptium.net Adoptium Temurin]
## Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
# Configure development environmentMost of these steps can be included in ''.profile'' or the equivalent for your terminal of choice.
## In the terminal set JAVA_HOME to the java home directory. ''/usr/libexec/java_home -V'' will list all known values for java_home.If you have multiple copies of java, choose the version you want to us''e.
# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. cd ~/Projects, or some similar directory)
# Clone the source code for the KoLmafia Project.''git clone git@github.com:kolmafia/kolmafia.git''
# Compile KoLmafia with the Gradle wrapper (''cd kolmafia && ./gradlew runShadow'')
''There are more instructions on setting up your token in GitHub and then setting up ssh-agent, as well as how to update your cloned copy. TBD''

''[[Category:Tech Support]]''