libram 0.8.28 → 0.8.30

package/dist/actions/Banish.d.ts

@@ -0,0 +1,16 @@
+import { ActionSource, FindActionSourceConstraints } from "./ActionSource";
+/**
+ * Find an available banish source subject to constraints.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Banish source satisfying constraints, or null.
+ */
+export declare function tryFindBanish(constraints?: FindActionSourceConstraints): ActionSource | null;
+/**
+ * Ensure an available banish source subject to constraints.
+ * Throws an error if no source can be found.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Banish source satisfying constraints.
+ */
+export declare function ensureBanish(constraints?: FindActionSourceConstraints): ActionSource;

package/dist/actions/Banish.js

@@ -0,0 +1,121 @@
+import { canEquip, cliExecute, myTurncount, restoreMp, retrieveItem, visitUrl, } from "kolmafia";
+import { Macro } from "../combat";
+import { getFoldGroup, have } from "../lib";
+import { Requirement } from "../maximize";
+import { get } from "../property";
+import * as AsdonMartin from "../resources/2017/AsdonMartin";
+import { $item, $items, $skill } from "../template-string";
+import { ActionSource, findActionSource, } from "./ActionSource";
+// Value of _lastCombatStarted the last time we updated scrapbook charges.
+let scrapbookChargesLastUpdated = get("_lastCombatStarted");
+// Free unlimited source every 30 turns.
+// Does not work on special monsters so needs a backup, see tryFindFreeRun.
+// banishedMonsters isn't updated if the banish succeeds on an unbanishable monster
+const asdonMartinSource = new ActionSource($skill `Asdon Martin: Spring-Loaded Front Bumper`, () => {
+    if (!AsdonMartin.installed())
+        return 0;
+    const banishes = get("banishedMonsters").split(":");
+    const bumperIndex = banishes
+        .map((string) => string.toLowerCase())
+        .indexOf("spring-loaded front bumper");
+    if (bumperIndex === -1)
+        return 1;
+    return myTurncount() - parseInt(banishes[bumperIndex + 1]) > 30 ? 1 : 0;
+}, Macro.trySkill($skill `Asdon Martin: Spring-Loaded Front Bumper`), {
+    preparation: () => AsdonMartin.fillTo(50),
+});
+const banishSources = [
+    // Free limited sources
+    new ActionSource($skill `Snokebomb`, () => (have($skill `Snokebomb`) ? 3 - get("_snokebombUsed") : 0), Macro.skill($skill `Snokebomb`), {
+        preparation: () => restoreMp(50),
+    }),
+    new ActionSource($skill `Emotionally Chipped`, () => (have($skill `Emotionally Chipped`) ? 3 - get("_feelHatredUsed") : 0), Macro.skill($skill `Feel Hatred`)),
+    new ActionSource($item `Kremlin's Greatest Briefcase`, () => have($item `Kremlin's Greatest Briefcase`)
+        ? 3 - get("_kgbTranquilizerDartUses")
+        : 0, Macro.skill($skill `KGB tranquilizer dart`), {
+        equipmentRequirements: () => new Requirement([], {
+            forceEquip: $items `Kremlin's Greatest Briefcase`,
+        }),
+    }),
+    new ActionSource($item `latte lovers member's mug`, () => have($item `latte lovers member's mug`) && !get("_latteBanishUsed")
+        ? 1
+        : 0, Macro.skill($skill `Throw Latte on Opponent`), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `latte lovers member's mug` }),
+    }),
+    new ActionSource($item `Lil' Doctor™ bag`, () => (have($item `Lil' Doctor™ bag`) ? 3 - get("_reflexHammerUsed") : 0), Macro.skill($skill `Reflex Hammer`), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `Lil' Doctor™ bag` }),
+    }),
+    new ActionSource($item `mafia middle finger ring`, () => have($item `mafia middle finger ring`) &&
+        canEquip($item `mafia middle finger ring`) &&
+        !get("_mafiaMiddleFingerRingUsed")
+        ? 1
+        : 0, Macro.skill($skill `Show them your ring`), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `mafia middle finger ring` }),
+    }),
+    new ActionSource($item `V for Vivala mask`, () => have($item `V for Vivala mask`) && !get("_vmaskBanisherUsed") ? 1 : 0, Macro.skill($skill `Creepy Grin`), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `V for Vivala mask` }),
+        preparation: () => restoreMp(30),
+    }),
+    new ActionSource($item `stinky cheese eye`, () => getFoldGroup($item `stinky cheese eye`).some((item) => have(item)) &&
+        !get("_stinkyCheeseBanisherUsed")
+        ? 1
+        : 0, Macro.skill($skill `Give Your Opponent the Stinkeye`), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `stinky cheese eye` }),
+        preparation: () => {
+            if (!have($item `stinky cheese eye`)) {
+                cliExecute(`fold stinky cheese eye`);
+            }
+            return have($item `stinky cheese eye`);
+        },
+    }),
+    new ActionSource($skill `Show your boring familiar pictures`, () => {
+        if (have($item `familiar scrapbook`)) {
+            if (scrapbookChargesLastUpdated !== get("_lastCombatStarted")) {
+                visitUrl("desc_item.php?whichitem=463063785");
+                scrapbookChargesLastUpdated = get("_lastCombatStarted");
+            }
+            return Math.floor(get("scrapbookCharges") / 100);
+        }
+        return 0;
+    }, Macro.skill($skill `Show your boring familiar pictures`), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `familiar scrapbook` }),
+    }),
+    new ActionSource($item `human musk`, () => Math.max(0, 3 - get("_humanMuskUses")), Macro.item($item `human musk`), {
+        preparation: () => retrieveItem($item `human musk`),
+        cost: () => ActionSource.defaultPriceFunction($item `human musk`),
+    }),
+    // Expensive unlimited sources
+    ...$items `Louder Than Bomb, divine champagne popper, tennis ball`.map((item) => new ActionSource(item, () => Infinity, Macro.item(item), {
+        preparation: () => retrieveItem(item),
+        cost: () => ActionSource.defaultPriceFunction(item),
+    })),
+];
+/**
+ * Find an available banish source subject to constraints.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Banish source satisfying constraints, or null.
+ */
+export function tryFindBanish(constraints) {
+    let source = findActionSource(banishSources, constraints);
+    // Always try to use Asdon Martin: Spring-Loaded Front Bumper first,
+    // but only if another source has been found.
+    if (source && asdonMartinSource.available()) {
+        source = asdonMartinSource.merge(source);
+    }
+    return source;
+}
+/**
+ * Ensure an available banish source subject to constraints.
+ * Throws an error if no source can be found.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Banish source satisfying constraints.
+ */
+export function ensureBanish(constraints) {
+    const source = tryFindBanish(constraints);
+    if (!source) {
+        throw new Error("Failed to ensure Banish source");
+    }
+    return source;
+}

package/dist/actions/FreeKill.d.ts

@@ -0,0 +1,16 @@
+import { ActionSource, FindActionSourceConstraints } from "./ActionSource";
+/**
+ * Find an available free kill source subject to constraints.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Free kill source satisfying constraints, or null.
+ */
+export declare function tryFindFreeKill(constraints?: FindActionSourceConstraints): ActionSource | null;
+/**
+ * Ensure an available free kill source subject to constraints.
+ * Throws an error if no source can be found.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Free kill source satisfying constraints.
+ */
+export declare function ensureFreeKill(constraints?: FindActionSourceConstraints): ActionSource;

package/dist/actions/FreeKill.js

@@ -0,0 +1,94 @@
+import { canEquip, myLightning, restoreMp, retrieveItem, use } from "kolmafia";
+import { Macro } from "../combat";
+import { have } from "../lib";
+import { Requirement } from "../maximize";
+import { get } from "../property";
+import * as AsdonMartin from "../resources/2017/AsdonMartin";
+import { $familiar, $item, $items, $skill } from "../template-string";
+import { ActionSource, findActionSource, } from "./ActionSource";
+const freeKillSources = [
+    // Free limited sources
+    new ActionSource($skill `Gingerbread Mob Hit`, () => !get("_gingerbreadMobHitUsed") && have($skill `Gingerbread Mob Hit`)
+        ? 1
+        : 0, Macro.skill($skill `Gingerbread Mob Hit`), {
+        preparation: () => restoreMp(30),
+    }),
+    new ActionSource($skill `Shattering Punch`, () => have($skill `Shattering Punch`) ? 3 - get("_shatteringPunchUsed") : 0, Macro.skill($skill `Shattering Punch`), {
+        preparation: () => restoreMp(30),
+    }),
+    new ActionSource($item `replica bat-oomerang`, () => have($item `replica bat-oomerang`)
+        ? 3 - get("_usedReplicaBatoomerang")
+        : 0, Macro.item($item `replica bat-oomerang`)),
+    new ActionSource($item `The Jokester's gun`, () => !get("_firedJokestersGun") &&
+        have($item `The Jokester's gun`) &&
+        canEquip($item `The Jokester's gun`)
+        ? 1
+        : 0, Macro.skill($skill `Fire the Jokester's Gun`), {
+        equipmentRequirements: () => new Requirement([], {
+            forceEquip: $items `The Jokester's gun`,
+        }),
+    }),
+    new ActionSource($item `Lil' Doctor™ bag`, () => (have($item `Lil' Doctor™ bag`) ? 3 - get("_chestXRayUsed") : 0), Macro.skill($skill `Chest X-Ray`), {
+        equipmentRequirements: () => new Requirement([], {
+            forceEquip: $items `Lil' Doctor™ bag`,
+        }),
+    }),
+    new ActionSource($skill `Asdon Martin: Missile Launcher`, () => (!get("_missileLauncherUsed") && AsdonMartin.installed() ? 1 : 0), Macro.skill($skill `Asdon Martin: Missile Launcher`), {
+        preparation: () => AsdonMartin.fillTo(100),
+    }),
+    // Heavy Rains
+    new ActionSource($skill `Lightning Strike`, () => (have($skill `Lightning Strike`) ? Math.floor(myLightning() / 20) : 0), Macro.skill($skill `Lightning Strike`)),
+    // Expensive limited sources
+    new ActionSource($item `powdered madness`, () => 5 - get("_powderedMadnessUses"), Macro.item($item `powdered madness`), {
+        preparation: () => retrieveItem($item `powdered madness`),
+        cost: () => ActionSource.defaultPriceFunction($item `powdered madness`),
+    }),
+    new ActionSource($familiar `Puck Man`, () => (have($familiar `Puck Man`) ? 20 - get("_powerPillUses") : 0), Macro.item($item `power pill`), {
+        familiar: () => $familiar `Puck Man`,
+        preparation: () => retrieveItem($item `power pill`),
+        cost: () => ActionSource.defaultPriceFunction($item `power pill`),
+    }),
+    new ActionSource($familiar `Ms. Puck Man`, () => (have($familiar `Ms. Puck Man`) ? 20 - get("_powerPillUses") : 0), Macro.item($item `power pill`), {
+        familiar: () => $familiar `Ms. Puck Man`,
+        preparation: () => retrieveItem($item `power pill`),
+        cost: () => ActionSource.defaultPriceFunction($item `power pill`),
+    }),
+    // Expensive unlimited sources
+    new ActionSource($skill `Shocking Lick`, () => Infinity, Macro.skill($skill `Shocking Lick`), {
+        preparation: () => {
+            if (get("shockingLickCharges") === 0 &&
+                retrieveItem($item `battery (9-Volt)`)) {
+                use($item `battery (9-Volt)`);
+            }
+            return get("shockingLickCharges") > 0;
+        },
+        cost: () => ActionSource.defaultPriceFunction($item `battery (AAA)`) * 4,
+    }),
+    ...$items `Daily Affirmation: Think Win-Lose, superduperheated metal`.map((item) => new ActionSource(item, () => Infinity, Macro.item(item), {
+        preparation: () => retrieveItem(item),
+        cost: () => ActionSource.defaultPriceFunction(item),
+    })),
+];
+/**
+ * Find an available free kill source subject to constraints.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Free kill source satisfying constraints, or null.
+ */
+export function tryFindFreeKill(constraints) {
+    return findActionSource(freeKillSources, constraints);
+}
+/**
+ * Ensure an available free kill source subject to constraints.
+ * Throws an error if no source can be found.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Free kill source satisfying constraints.
+ */
+export function ensureFreeKill(constraints) {
+    const source = tryFindFreeKill(constraints);
+    if (!source) {
+        throw new Error("Failed to ensure Free Kill source");
+    }
+    return source;
+}

package/dist/actions/FreeRun.d.ts

@@ -0,0 +1,16 @@
+import { ActionSource, FindActionSourceConstraints } from "./ActionSource";
+/**
+ * Find an available free run source subject to constraints.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Free run source satisfying constraints, or null.
+ */
+export declare function tryFindFreeRun(constraints?: FindActionSourceConstraints): ActionSource | null;
+/**
+ * Ensure an available free run source subject to constraints.
+ * Throws an error if no source can be found.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Free run source satisfying constraints.
+ */
+export declare function ensureFreeRun(constraints?: FindActionSourceConstraints): ActionSource;

package/dist/actions/FreeRun.js

@@ -0,0 +1,81 @@
+import { retrieveItem } from "kolmafia";
+import { Macro } from "../combat";
+import { ensureEffect, getSongCount, getSongLimit, have } from "../lib";
+import { Requirement } from "../maximize";
+import { get } from "../property";
+import * as Bandersnatch from "../resources/2009/Bandersnatch";
+import * as StompingBoots from "../resources/2011/StompingBoots";
+import { $effect, $familiar, $item, $items, $skill } from "../template-string";
+import { ActionSource, findActionSource, } from "./ActionSource";
+// eslint-disable-next-line libram/verify-constants
+const EVERYTHING_LOOKS_GREEN = $effect `Everything Looks Green`;
+const freeRunSources = [
+    // Free unlimited source
+    new ActionSource($item `spring shoes`, () => (have(EVERYTHING_LOOKS_GREEN) ? 1 : 0), Macro.skill($skill `Spring Away`), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `spring shoes` }),
+    }),
+    // Free limited sources
+    new ActionSource($familiar `Frumious Bandersnatch`, () => (have($effect `Ode to Booze`) || getSongCount() < getSongLimit()) &&
+        Bandersnatch.couldRunaway()
+        ? Bandersnatch.getRemainingRunaways()
+        : 0, Macro.step("runaway"), {
+        equipmentRequirements: () => new Requirement(["Familiar Weight"], {}),
+        preparation: () => {
+            ensureEffect($effect `Ode to Booze`);
+            return have($effect `Ode to Booze`);
+        },
+        familiar: () => $familiar `Frumious Bandersnatch`,
+    }),
+    new ActionSource($familiar `Pair of Stomping Boots`, () => StompingBoots.couldRunaway() ? StompingBoots.getRemainingRunaways() : 0, Macro.step("runaway"), {
+        equipmentRequirements: () => new Requirement(["Familiar Weight"], {}),
+        familiar: () => $familiar `Pair of Stomping Boots`,
+    }),
+    new ActionSource($item `navel ring of navel gazing`, () => have($item `navel ring of navel gazing`)
+        ? Math.max(0, 3 - get("_navelRunaways"))
+        : 0, Macro.step("runaway"), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `navel ring of navel gazing` }),
+    }),
+    new ActionSource($item `Greatest American Pants`, () => have($item `Greatest American Pants`)
+        ? Math.max(0, 3 - get("_navelRunaways"))
+        : 0, Macro.step("runaway"), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `Greatest American Pants` }),
+    }),
+    new ActionSource($item `peppermint parasol`, () => Math.max(0, 3 - get("_navelRunaways")), Macro.item($item `peppermint parasol`), {
+        preparation: () => retrieveItem($item `peppermint parasol`),
+        cost: () => Math.min(ActionSource.defaultPriceFunction($item `peppermint sprout`) * 5, ActionSource.defaultPriceFunction($item `peppermint parasol`)) / 10, // Breaks after 10 successful runaways.
+    }),
+    // unlimited items that trigger everything looks green
+    ...$items `green smoke bomb, tattered scrap of paper, GOTO, T.U.R.D.S. Key`.map((item) => new ActionSource(item, () => (have(EVERYTHING_LOOKS_GREEN) ? 0 : 1), Macro.item(item), {
+        preparation: () => retrieveItem(item),
+        cost: () => ActionSource.defaultPriceFunction(item),
+    })),
+    // limited quest items
+    ...$items `fish-oil smoke bomb, giant eraser`.map((item) => new ActionSource(item, () => (!have(item) ? 0 : 1), Macro.item(item), {
+        preparation: () => have(item),
+        cost: () => 0,
+    })),
+];
+/**
+ * Find an available free run source subject to constraints.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Free run source satisfying constraints, or null.
+ */
+export function tryFindFreeRun(constraints) {
+    const source = findActionSource(freeRunSources, constraints);
+    return source;
+}
+/**
+ * Ensure an available free run source subject to constraints.
+ * Throws an error if no source can be found.
+ *
+ * @param constraints Preexisting constraints that restrict possible sources.
+ * @returns Free run source satisfying constraints.
+ */
+export function ensureFreeRun(constraints) {
+    const source = tryFindFreeRun(constraints);
+    if (!source) {
+        throw new Error("Failed to ensure Free Run source");
+    }
+    return source;
+}

package/dist/actions/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./ActionSource";
+export * from "./Banish";
+export * from "./FreeKill";
+export * from "./FreeRun";

package/dist/actions/index.js

@@ -0,0 +1,4 @@
+export * from "./ActionSource";
+export * from "./Banish";
+export * from "./FreeKill";
+export * from "./FreeRun";

package/dist/ascend.d.ts

@@ -0,0 +1,83 @@
+import { Skill, Class, Item, Path, MafiaClass } from "kolmafia";
+import { MoonSign } from "./moonSign";
+import { ChateauMantegna } from "./resources";
+export declare enum Lifestyle {
+    casual = 1,
+    softcore = 2,
+    normal = 2,
+    hardcore = 3
+}
+export declare enum KolGender {
+    male = 1,
+    female = 2
+}
+/**
+ * Get a mapping of permed skills to the extent to which they're permed.
+ *
+ * If a skill is not permed at all, it will not appear in the mapping.
+ *
+ * @returns Permed skills mapping
+ */
+export declare function permedSkills(): Map<Skill, Lifestyle>;
+export declare class AscendError extends Error {
+}
+declare const gardens: readonly ["packet of pumpkin seeds", "Peppermint Pip Packet", "packet of dragon's teeth", "packet of beer seeds", "packet of winter seeds", "packet of thanksgarden seeds", "packet of tall grass seeds", "packet of mushroom spores", "packet of rock seeds"];
+declare type Garden = typeof gardens[number];
+declare const eudorae: readonly ["My Own Pen Pal kit", "GameInformPowerDailyPro subscription card", "Xi Receiver Unit", "New-You Club Membership Form", "Our Daily Candles™ order form"];
+declare type Eudora = typeof eudorae[number];
+export declare class AscensionPrepError extends Error {
+    cause: string;
+    constructor(cause: string, original?: MafiaClass | string);
+}
+declare type InputMoonSign = number | Lowercase<MoonSign> | "degrassi" | "degrassi knoll" | "friendly degrassi knoll" | "knoll" | "canada" | "canadia" | "little canadia" | "gnomads" | "gnomish" | "gnomish gnomads camp";
+/**
+ * Hops the gash, perming no skills by default
+ *
+ * @param options Configuration for the ascension
+ * @param options.path Your path of choice for this ascension
+ * @param options.playerClass Your class of choice for this ascension
+ * @param options.lifestyle 1 for casual, 2 for softcore, 3 for hardcore. Alternately, use the Lifestyle enum
+ * @param options.kolGender An entry from the KolGender enum: 1 for male, 2 for female (sorry that it's limited to those). Defaults to 2 or the corresponding value for defaultGenderOverride pref (which should be 'male' or 'female')
+ * @param options.moon Your moon sign as a string, or the zone you're looking for as a string
+ * @param options.consumable From the astral deli. Pick the container item, not the product. Defaults to astral six-pack, provide $item`none` for nothing.
+ * @param options.pet From the astral pet store.
+ * @param options.permOptions Options for perming during a player's stay in Valhalla
+ * @param options.permOptions.permSkills A Map<Skill, Lifestyle> of skills you'd like to perm, ordered by priority.
+ * @param options.permOptions.neverAbort Whether the ascension should abort on failure
+ */
+export declare function ascend(options: {
+    path: Path;
+    playerClass: Class;
+    lifestyle: Lifestyle;
+    kolGender?: KolGender;
+    moon: InputMoonSign;
+    consumable?: Item;
+    pet?: Item;
+    permOptions?: {
+        permSkills: Map<Skill, Lifestyle>;
+        neverAbort: boolean;
+    };
+}): void;
+/**
+ * Sets up various iotms you may want to use in the coming ascension
+ *
+ * @param ascensionPrep Configuration for various ascension prep settings. Any ommitted key will be kept as-is
+ * @param ascensionPrep.garden Garden to which to switch
+ * @param ascensionPrep.eudora Eudora to which to switch
+ * @param ascensionPrep.chateau Chateau configuration
+ * @param ascensionPrep.chateau.desk Chateau desk configuration
+ * @param ascensionPrep.chateau.ceiling Chateau ceiling configuration
+ * @param ascensionPrep.chateau.nightstand Chateau nightstand configuration
+ * @param ascensionPrep.throwOnFail If true, this will throw an error when it fails to switch something
+ */
+export declare function prepareAscension({ garden, eudora, chateau, throwOnFail, }?: {
+    garden?: Garden;
+    eudora?: Eudora;
+    chateau?: {
+        desk?: ChateauMantegna.Desk;
+        ceiling?: ChateauMantegna.Ceiling;
+        nightstand?: ChateauMantegna.Nightstand;
+    };
+    throwOnFail?: boolean;
+}): void;
+export {};