libram 0.5.4 → 0.5.5

package/dist/actions/ActionSource.js

@@ -3,7 +3,9 @@ import { Macro } from "../combat";
 import { Requirement } from "../maximize";
 import { sum } from "../utils";
 function mergeConstraints(...allConstraints) {
-    const familiars = allConstraints.map((constraints) => constraints.familiar);
+    const familiars = allConstraints
+        .map((constraints) => constraints.familiar)
+        .filter((familiar) => familiar);
     if (familiars.length > 1) {
         // Inconsistent requirements.
         return null;
@@ -20,7 +22,7 @@ function mergeConstraints(...allConstraints) {
             }
             return success;
         },
-        familiar: familiars[0],
+        familiar: familiars.find((familiar) => familiar),
         cost: () => sum(allConstraints, (constraints) => constraints.cost?.() ?? 0),
     };
 }
@@ -138,7 +140,8 @@ function filterAction(action, constraints) {
 export function findActionSource(actions, constraints = {}) {
     return (actions
         .filter((actions) => filterAction(actions, constraints))
-        .sort((a, b) => a.cost() - b.cost())[0] ?? null);
+        .sort((a, b) => a.cost() - b.cost())
+        .find((action) => action) ?? null);
 }
 /**
  * Count available action sources subject to constraints. Note that, if

package/dist/actions/FreeRun.js

@@ -3,14 +3,16 @@ import { Macro } from "../combat";
 import { ensureEffect, getFoldGroup, getSongCount, getSongLimit, have, } from "../lib";
 import { Requirement } from "../maximize";
 import { get } from "../property";
-import { $effect, $familiar, $item, $items, $skill } from "../template-string";
+import { $effect, $item, $items, $skill } from "../template-string";
 import { ActionSource, findActionSource, } from "./ActionSource";
 import * as Bandersnatch from "../resources/2009/Bandersnatch";
+import * as StompingBoots from "../resources/2011/StompingBoots";
 import * as AsdonMartin from "../resources/2017/AsdonMartin";
 // 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 free run succeeds on an unbanishable monster
 const asdonMartinSource = new ActionSource($skill `Asdon Martin: Spring-Loaded Front Bumper`, () => {
     if (!AsdonMartin.installed())
         return 0;
@@ -21,29 +23,25 @@ const asdonMartinSource = new ActionSource($skill `Asdon Martin: Spring-Loaded F
     if (bumperIndex === -1)
         return 1;
     return myTurncount() - parseInt(banishes[bumperIndex + 1]) > 30 ? 1 : 0;
-}, Macro.skill($skill `Asdon Martin: Spring-Loaded Front Bumper`), {
+}, Macro.trySkill($skill `Asdon Martin: Spring-Loaded Front Bumper`), {
     preparation: () => AsdonMartin.fillTo(50),
 });
 const freeRunSources = [
     // Free limited sources
-    new ActionSource($familiar `Frumious Bandersnatch`, () => have($familiar `Frumious Bandersnatch`) &&
-        (have($effect `Ode to Booze`) || getSongCount() < getSongLimit()) &&
-        Bandersnatch.getRemainingRunaways() > 0
-        ? 0
+    new ActionSource(Bandersnatch.familiar, () => (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`,
+        familiar: () => Bandersnatch.familiar,
     }),
-    new ActionSource($familiar `Pair of Stomping Boots`, () => have($familiar `Pair of Stomping Boots`) &&
-        Bandersnatch.getRemainingRunaways() > 0
-        ? 0
-        : 0, Macro.step("runaway"), {
+    new ActionSource(StompingBoots.familiar, () => StompingBoots.couldRunaway() ? StompingBoots.getRemainingRunaways() : 0, Macro.step("runaway"), {
         equipmentRequirements: () => new Requirement(["Familiar Weight"], {}),
-        familiar: () => $familiar `Pair of Stomping Boots`,
+        familiar: () => StompingBoots.familiar,
     }),
     new ActionSource($skill `Snokebomb`, () => (have($skill `Snokebomb`) ? 3 - get("_snokebombUsed") : 0), Macro.skill($skill `Snokebomb`), {
         preparation: () => restoreMp(50),

package/dist/resources/2009/Bandersnatch.d.ts

@@ -1,7 +1,7 @@
 export declare const familiar: Familiar;
 /**
  * Returns true if the player has the Frumious Bandersnatch in their
- * terrariukm
+ * terrarium
  */
 export declare function have(): boolean;
 /**
@@ -38,7 +38,7 @@ export declare function canRunaway(): boolean;
 /**
  * Prepare a Bandersnatch runaway.
  *
- * This will cast Ode to Booze and equip take your Bandersnatch with you.
+ * This will cast Ode to Booze and take your Bandersnatch with you.
  * If any of those steps fail, it will return false.
  *
  * @param songsToRemove Ordered list of songs that could be shrugged to make room for Ode to Booze

package/dist/resources/2009/Bandersnatch.js

@@ -5,7 +5,7 @@ import { have as _have, canRememberSong, getActiveSongs, isCurrentFamiliar, unef
 export const familiar = $familiar `Frumious Bandersnatch`;
 /**
  * Returns true if the player has the Frumious Bandersnatch in their
- * terrariukm
+ * terrarium
  */
 export function have() {
     return _have(familiar);
@@ -57,7 +57,7 @@ export function canRunaway() {
 /**
  * Prepare a Bandersnatch runaway.
  *
- * This will cast Ode to Booze and equip take your Bandersnatch with you.
+ * This will cast Ode to Booze and take your Bandersnatch with you.
  * If any of those steps fail, it will return false.
  *
  * @param songsToRemove Ordered list of songs that could be shrugged to make room for Ode to Booze

package/dist/resources/2011/StompingBoots.d.ts

@@ -0,0 +1,44 @@
+export declare const familiar: Familiar;
+/**
+ * Returns true if the player has the Pair of Stomping Boots in their
+ * terrarium
+ */
+export declare function have(): boolean;
+/**
+ * Returns the number of free runaways that have already been used
+ * @see Bandersnatch with which the Stomping Boots shares a counter
+ */
+export declare function getRunaways(): number;
+/**
+ * Returns the total number of free runaways that the player can
+ * get from their Stomping Boots
+ *
+ * @param considerWeightAdjustment Include familiar weight modifiers
+ */
+export declare function getMaxRunaways(considerWeightAdjustment?: boolean): number;
+/**
+ * Returns the number of remaining free runaways the player can
+ * get from their Stomping Boots
+ *
+ * @param considerWeightAdjustment
+ */
+export declare function getRemainingRunaways(considerWeightAdjustment?: boolean): number;
+/**
+ * Returns true if the player could use their Stomping Boots to
+ * get a free run in theory
+ *
+ * @param considerWeightAdjustment Include familiar weight modifiers
+ */
+export declare function couldRunaway(considerWeightAdjustment?: boolean): boolean;
+/**
+ * Returns true if the player can use their Stomping Boots to get a
+ * free run right now
+ */
+export declare function canRunaway(): boolean;
+/**
+ * Prepare a Stomping Boots runaway.
+ *
+ * This will take your Stomping Boots with you.
+ * If any of those steps fail, it will return false.
+ */
+export declare function prepareRunaway(): boolean;

package/dist/resources/2011/StompingBoots.js

@@ -0,0 +1,63 @@
+import { familiarWeight, useFamiliar, weightAdjustment } from "kolmafia";
+import { get } from "../../property";
+import { $familiar } from "../../template-string";
+import { have as _have, isCurrentFamiliar } from "../../lib";
+export const familiar = $familiar `Pair of Stomping Boots`;
+/**
+ * Returns true if the player has the Pair of Stomping Boots in their
+ * terrarium
+ */
+export function have() {
+    return _have(familiar);
+}
+/**
+ * Returns the number of free runaways that have already been used
+ * @see Bandersnatch with which the Stomping Boots shares a counter
+ */
+export function getRunaways() {
+    return get("_banderRunaways");
+}
+/**
+ * Returns the total number of free runaways that the player can
+ * get from their Stomping Boots
+ *
+ * @param considerWeightAdjustment Include familiar weight modifiers
+ */
+export function getMaxRunaways(considerWeightAdjustment = true) {
+    const weightBuffs = considerWeightAdjustment ? weightAdjustment() : 0;
+    return Math.floor((familiarWeight(familiar) + weightBuffs) / 5);
+}
+/**
+ * Returns the number of remaining free runaways the player can
+ * get from their Stomping Boots
+ *
+ * @param considerWeightAdjustment
+ */
+export function getRemainingRunaways(considerWeightAdjustment = true) {
+    return Math.max(0, getMaxRunaways(considerWeightAdjustment) - getRunaways());
+}
+/**
+ * Returns true if the player could use their Stomping Boots to
+ * get a free run in theory
+ *
+ * @param considerWeightAdjustment Include familiar weight modifiers
+ */
+export function couldRunaway(considerWeightAdjustment = true) {
+    return have() && getRemainingRunaways(considerWeightAdjustment) > 0;
+}
+/**
+ * Returns true if the player can use their Stomping Boots to get a
+ * free run right now
+ */
+export function canRunaway() {
+    return isCurrentFamiliar(familiar) && couldRunaway();
+}
+/**
+ * Prepare a Stomping Boots runaway.
+ *
+ * This will take your Stomping Boots with you.
+ * If any of those steps fail, it will return false.
+ */
+export function prepareRunaway() {
+    return useFamiliar(familiar);
+}

package/dist/resources/2017/AsdonMartin.js

@@ -2,6 +2,12 @@ import "core-js/modules/es.object.values";
 import { canInteract, cliExecute, getFuel, getWorkshed, haveEffect, historicalAge, historicalPrice, isNpcItem, mallPrice, mallPrices, retrieveItem, toInt, visitUrl, } from "kolmafia";
 import { getAverageAdventures, have as haveItem } from "../../lib";
 import { $effect, $item, $items } from "../../template-string";
+var PriceAge;
+(function (PriceAge) {
+    PriceAge[PriceAge["HISTORICAL"] = 0] = "HISTORICAL";
+    PriceAge[PriceAge["RECENT"] = 1] = "RECENT";
+    PriceAge[PriceAge["TODAY"] = 2] = "TODAY";
+})(PriceAge || (PriceAge = {}));
 /**
  * Returns whether or not we have the Asdon installed in the workshed at present.
  */
@@ -18,13 +24,34 @@ const fuelSkiplist = $items `cup of "tea", thermos of "whiskey", Lucky Lindy, Be
 function priceTooOld(item) {
     return historicalPrice(item) === 0 || historicalAge(item) >= 7;
 }
-function price(item) {
-    return priceTooOld(item) ? mallPrice(item) : historicalPrice(item);
+// Return mall max if historicalPrice returns -1.
+function historicalPriceOrMax(item) {
+    const historical = historicalPrice(item);
+    return historical < 0 ? 999999999 : historical;
+}
+// Return mall max if mallPrice returns -1.
+function mallPriceOrMax(item) {
+    const mall = mallPrice(item);
+    return mall < 0 ? 999999999 : mall;
+}
+function price(item, priceAge) {
+    switch (priceAge) {
+        case PriceAge.HISTORICAL: {
+            const historical = historicalPriceOrMax(item);
+            return historical === 0 ? mallPriceOrMax(item) : historical;
+        }
+        case PriceAge.RECENT:
+            return priceTooOld(item)
+                ? mallPriceOrMax(item)
+                : historicalPriceOrMax(item);
+        case PriceAge.TODAY:
+            return mallPriceOrMax(item);
+    }
 }
 // Efficiency in meat per fuel.
-function calculateFuelEfficiency(it, targetUnits, usePrecisePrice = false) {
+function calculateFuelUnitCost(it, targetUnits, priceAge = PriceAge.RECENT) {
     const units = getAverageAdventures(it);
-    return ((usePrecisePrice ? price(it) : mallPrice(it)) / Math.min(targetUnits, units));
+    return price(it, priceAge) / Math.min(targetUnits, units);
 }
 function isFuelItem(it) {
     return (!isNpcItem(it) &&
@@ -34,21 +61,33 @@ function isFuelItem(it) {
         it.discardable &&
         !fuelSkiplist.includes(it));
 }
-const potentialFuel = $items ``.filter(isFuelItem);
 function getBestFuel(targetUnits) {
-    if (potentialFuel.filter(priceTooOld).length > 100) {
+    // Three stages.
+    // 1. Filter to reasonable items using historical cost (within 5x of historical best).
+    const allFuel = $items ``.filter(isFuelItem);
+    if (allFuel.filter((item) => historicalPrice(item) === 0).length > 100) {
+        mallPrices("food");
+        mallPrices("booze");
+    }
+    const keyHistorical = (item) => calculateFuelUnitCost(item, targetUnits, PriceAge.HISTORICAL);
+    allFuel.sort((x, y) => keyHistorical(x) - keyHistorical(y));
+    const bestUnitCost = keyHistorical(allFuel[0]);
+    const firstBadIndex = allFuel.findIndex((item) => keyHistorical(item) > 5 * bestUnitCost);
+    const potentialFuel = firstBadIndex > 0 ? allFuel.slice(0, firstBadIndex) : allFuel;
+    // 2. Filter to top 10 candidates using prices at most a week old.
+    if (potentialFuel.filter((item) => priceTooOld(item)).length > 100) {
         mallPrices("food");
         mallPrices("booze");
     }
     const key1 = (item) => -getAverageAdventures(item);
-    const key2 = (item) => calculateFuelEfficiency(item, targetUnits);
+    const key2 = (item) => calculateFuelUnitCost(item, targetUnits, PriceAge.RECENT);
     potentialFuel.sort((x, y) => key1(x) - key1(y));
     potentialFuel.sort((x, y) => key2(x) - key2(y));
-    // Get precise price for the top candidates.
+    // 3. Find result using precise price for those top candidates.
     const candidates = potentialFuel.slice(0, 10);
-    const key3 = (item) => calculateFuelEfficiency(item, targetUnits, true);
+    const key3 = (item) => calculateFuelUnitCost(item, targetUnits, PriceAge.TODAY);
     candidates.sort((x, y) => key3(x) - key3(y));
-    if (calculateFuelEfficiency(candidates[0], targetUnits, true) > 100) {
+    if (calculateFuelUnitCost(candidates[0], targetUnits, PriceAge.TODAY) > 100) {
         throw new Error("Could not identify any fuel with efficiency better than 100 meat per fuel. " +
             "This means something went wrong.");
     }

package/dist/resources/index.d.ts

@@ -15,9 +15,10 @@ import * as Snapper from "./2019/Snapper";
 import * as SongBoom from "./2018/SongBoom";
 import * as SourceTerminal from "./2016/SourceTerminal";
 import * as SpookyPutty from "./2009/SpookyPutty";
+import * as StompingBoots from "./2011/StompingBoots";
 import * as TunnelOfLove from "./2017/TunnelOfLove";
 import * as WinterGarden from "./2014/WinterGarden";
 import * as Witchess from "./2016/Witchess";
-export { AsdonMartin, Bandersnatch, BeachComb, ChateauMantegna, CrownOfThrones, CrystalBall, DNALab, FloristFriar, Guzzlr, Latte, MayoClinic, ObtuseAngel, RainDoh, SongBoom, SourceTerminal, Snapper, SpookyPutty, TunnelOfLove, WinterGarden, Witchess, };
+export { AsdonMartin, Bandersnatch, BeachComb, ChateauMantegna, CrownOfThrones, CrystalBall, DNALab, FloristFriar, Guzzlr, Latte, MayoClinic, ObtuseAngel, RainDoh, Snapper, SongBoom, SourceTerminal, SpookyPutty, StompingBoots, TunnelOfLove, WinterGarden, Witchess, };
 export * from "./putty-likes";
 export * from "./LibramSummon";

package/dist/resources/index.js

@@ -15,9 +15,10 @@ import * as Snapper from "./2019/Snapper";
 import * as SongBoom from "./2018/SongBoom";
 import * as SourceTerminal from "./2016/SourceTerminal";
 import * as SpookyPutty from "./2009/SpookyPutty";
+import * as StompingBoots from "./2011/StompingBoots";
 import * as TunnelOfLove from "./2017/TunnelOfLove";
 import * as WinterGarden from "./2014/WinterGarden";
 import * as Witchess from "./2016/Witchess";
-export { AsdonMartin, Bandersnatch, BeachComb, ChateauMantegna, CrownOfThrones, CrystalBall, DNALab, FloristFriar, Guzzlr, Latte, MayoClinic, ObtuseAngel, RainDoh, SongBoom, SourceTerminal, Snapper, SpookyPutty, TunnelOfLove, WinterGarden, Witchess, };
+export { AsdonMartin, Bandersnatch, BeachComb, ChateauMantegna, CrownOfThrones, CrystalBall, DNALab, FloristFriar, Guzzlr, Latte, MayoClinic, ObtuseAngel, RainDoh, Snapper, SongBoom, SourceTerminal, SpookyPutty, StompingBoots, TunnelOfLove, WinterGarden, Witchess, };
 export * from "./putty-likes";
 export * from "./LibramSummon";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libram",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "description": "JavaScript helper library for KoLmafia",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",