afnm-types 0.6.44 → 0.6.45

package/dist/character.d.ts

@@ -4,7 +4,7 @@ import { OverridableComponent } from '@mui/material/OverridableComponent';
 import { Buff } from './buff';
 import { EnemyEntity } from './entity';
 import { EventStep } from './event';
-import { Item, ItemDesc, ItemKind, MountItem } from './item';
+import { Item, ItemKind, MountItem } from './item';
 import { Realm, RealmProgress } from './realm';
 import { IntimateTrait } from './dualCultivation';
 export interface Character {
@@ -16,6 +16,7 @@ export interface Character {
     condition: string;
     definitions: CharacterDefinition[];
     relationship?: CharacterRelationshipDefinition[];
+    relationshipPaths?: Record<string, CharacterRelationshipDefinition[]>;
     followInteraction?: FollowCharacterDefinition;
     portrait: string;
     image: string;
@@ -128,6 +129,7 @@ export interface CharacterState {
     sparCooldown: number;
     approval: number;
     relationshipIndex: number;
+    relationshipPath?: string;
     seenRelationshipProgressEvent: boolean;
     giftedKeys: string[];
     challengeCooldown: number;
@@ -171,9 +173,12 @@ export interface GiftCharacterInteraction extends BaseCharacterInteraction {
     introSteps: EventStep[];
     item: string;
     amount: number;
-    alternates?: ItemDesc[];
     acceptSteps: EventStep[];
     declineSteps: EventStep[];
+    improvedItem?: string;
+    improvedAcceptSteps?: EventStep[];
+    veryImprovedItem?: string;
+    veryImprovedAcceptSteps?: EventStep[];
 }
 export interface CraftingCharacterInteraction extends BaseCharacterInteraction {
     itemKinds: ItemKind[];

package/dist/crafting.d.ts

@@ -17,6 +17,7 @@ export declare const craftingConditionToColour: Record<CraftingCondition, string
 export declare const craftingConditionToIcon: Record<CraftingCondition, OverridableComponent<SvgIconTypeMap<{}, 'svg'>>>;
 export interface RecipeConditionEffect {
     name: string;
+    displayName?: Translatable;
     colour: string;
     conditionEffects: Record<CraftingCondition, {
         tooltip: Translatable;

package/dist/event.d.ts

@@ -33,7 +33,7 @@ export interface GameEvent {
         value: number;
     }[];
 }
-export type EventStep = TextStep | SpeechStep | CombatStep | CraftingStep | ChoiceStep | ConditionalStep | SetFlagStep | ExitStep | CreateBuffStep | ConsumeBuffStep | ChangeLocationStep | AddItemStep | RemoveItemStep | AddQuestStep | ChangeMoneyStep | ChangeFavourStep | AddDestinyStep | ChangeReputationStep | QiStep | UnlockLocationStep | ClearCharacterStep | SetCharacterStep | LabelStep | GotoLabelStep | UnlockCraftingTechniqueStep | TalkToCharacterStep | TradeWithCharacterStep | CraftWithCharacterStep | FightCharacterStep | MarkBeatCharacterStep | MarkDidEncounterStep | ChangeHpStep | PassTimeStep | ReportAnalyticsStep | ApprovalStep | ProgressRelationshipStep | MarkGiftedStep | UpdateCharacterDefinitionStep | AuctionStep | MarkCalendarEventCompleteStep | AddMultipleItemStep | AdvanceMysticalRegionStep | CraftSkillStep | TournamentStep | TeamUpStep | AddFollowerStep | ClearTeamUpStep | UnlockAltarStep | DropItemStep | SetAltarCooldownStep | CompressCoreStep | ChangeScreenStep | UnlockTechniqueStep | UnlockAuctionTechniqueStep | AddRecipeStep | AddManualStep | LearnNpcStancesStep | ReplaceItemStep | DualCultivationStep | ChangeBGMStep | ClearChangeBGMStep | AddGuildApprovalStep | AdvanceGuildRankStep | OverridePlayerRealmStep | SetAidBreakthroughCooldownStep | StoneCuttingStep | GiveItemStep | ChangePhysicalStatStep | ChangeSocialStatStep;
+export type EventStep = TextStep | SpeechStep | CombatStep | CraftingStep | ChoiceStep | ConditionalStep | SetFlagStep | ExitStep | CreateBuffStep | ConsumeBuffStep | ChangeLocationStep | AddItemStep | RemoveItemStep | AddQuestStep | ChangeMoneyStep | ChangeFavourStep | AddDestinyStep | ChangeReputationStep | QiStep | UnlockLocationStep | ClearCharacterStep | SetCharacterStep | LabelStep | GotoLabelStep | UnlockCraftingTechniqueStep | TalkToCharacterStep | TradeWithCharacterStep | CraftWithCharacterStep | FightCharacterStep | MarkBeatCharacterStep | MarkDidEncounterStep | ChangeHpStep | PassTimeStep | ReportAnalyticsStep | ApprovalStep | ProgressRelationshipStep | MarkGiftedStep | UpdateCharacterDefinitionStep | AuctionStep | MarkCalendarEventCompleteStep | AddMultipleItemStep | AdvanceMysticalRegionStep | CraftSkillStep | TournamentStep | TeamUpStep | AddFollowerStep | BreakPartyStep | ClearTeamUpStep | UnlockAltarStep | DropItemStep | SetAltarCooldownStep | CompressCoreStep | ChangeScreenStep | UnlockTechniqueStep | UnlockAuctionTechniqueStep | AddRecipeStep | AddManualStep | LearnNpcStancesStep | ReplaceItemStep | DualCultivationStep | ChangeBGMStep | ClearChangeBGMStep | AddGuildApprovalStep | AdvanceGuildRankStep | OverridePlayerRealmStep | SetAidBreakthroughCooldownStep | StoneCuttingStep | GiveItemStep | ChangePhysicalStatStep | ChangeSocialStatStep | SelectRelationshipPathStep;
 export interface TextStep {
     kind: 'text';
     condition?: string;
@@ -88,7 +88,7 @@ export type EventChoiceCondition = RealmCondition | PhysicalStatisticCondition |
 export interface RealmCondition {
     kind: 'realm';
     realm: Realm;
-    mode?: 'more' | 'exact' | 'less';
+    mode?: 'more' | 'exact' | 'less' | 'lessOrEqual';
 }
 interface PhysicalStatisticCondition {
     kind: 'physicalStatistic';
@@ -370,6 +370,12 @@ export interface ProgressRelationshipStep {
     condition?: string;
     character: string;
 }
+export interface SelectRelationshipPathStep {
+    kind: 'selectRelationshipPath';
+    condition?: string;
+    character: string;
+    path: string;
+}
 export interface UpdateCharacterDefinitionStep {
     kind: 'updateCharacterDefinition';
     condition?: string;
@@ -434,6 +440,10 @@ export interface AddFollowerStep {
     character: string;
     followDef: FollowCharacterDefinition | undefined;
 }
+export interface BreakPartyStep {
+    kind: 'breakParty';
+    condition?: string;
+}
 export interface ClearTeamUpStep {
     kind: 'clearTeamUp';
     condition?: string;

package/dist/gameVersion.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The current game version, injected at compile time from package.json.
+ * Mod authors can use this as the `gameVersion` field in `getMetadata()`.
+ *
+ * @example
+ * import { GAME_VERSION } from 'afnm-types';
+ *
+ * export function getMetadata() {
+ *   return {
+ *     name: 'My Mod',
+ *     version: '1.0.0',
+ *     description: 'My awesome mod',
+ *     author: { name: 'Me' },
+ *     gameVersion: GAME_VERSION,
+ *   };
+ * }
+ */
+export declare const GAME_VERSION: string;

package/dist/gameVersion.js

@@ -0,0 +1,18 @@
+/**
+ * The current game version, injected at compile time from package.json.
+ * Mod authors can use this as the `gameVersion` field in `getMetadata()`.
+ *
+ * @example
+ * import { GAME_VERSION } from 'afnm-types';
+ *
+ * export function getMetadata() {
+ *   return {
+ *     name: 'My Mod',
+ *     version: '1.0.0',
+ *     description: 'My awesome mod',
+ *     author: { name: 'Me' },
+ *     gameVersion: GAME_VERSION,
+ *   };
+ * }
+ */
+export const GAME_VERSION = typeof __GAME_VERSION__ !== 'undefined' ? __GAME_VERSION__ : '';

package/dist/item.d.ts

@@ -12,7 +12,7 @@ import { Realm, RealmProgress } from './realm';
 import { RecipeDifficulty } from './RecipeDifficulty';
 import { CombatStatsMap, CraftingStatsMap, PhysicalStatistic, Scaling, SocialStatistic } from './stat';
 import { Technique, TechniqueEffect } from './technique';
-export declare const itemKinds: readonly ["clothing", "talisman", "artefact", "mount", "cauldron", "flame", "upgrade", "fruit", "elixir", "recipe", "technique", "action", "transport_seal", "enchantment", "pill", "reagent", "concoction", "consumable", "recuperation", "formation", "breakthrough", "pillar_shard", "material", "flare", "mystical_key", "condensation_art", "blueprint", "trophy", "treasure", "token", "life_essence", "device", "manual"];
+export declare const itemKinds: readonly ["clothing", "talisman", "artefact", "mount", "cauldron", "flame", "upgrade", "fruit", "elixir", "recipe", "technique", "action", "transport_seal", "enchantment", "pill", "reagent", "concoction", "consumable", "recuperation", "formation", "breakthrough", "pillar_shard", "material", "flare", "mystical_key", "condensation_art", "blueprint", "trophy", "treasure", "token", "life_essence", "device", "manual", "pillar_pattern"];
 export type ItemKind = (typeof itemKinds)[number];
 export declare const itemKindToName: {
     [key in ItemKind]: string;
@@ -25,7 +25,7 @@ export type ItemCostMap = {
 };
 export declare const buyItemCostMap: ItemCostMap;
 export declare const sellItemCostMap: ItemCostMap;
-export type Item = TechniqueItem | TechniqueCrystalItem | TechniqueShardItem | TechniqueEnhancementDust | TransportSealItem | SpiritFruitItem | RecipeItem | ElixirItem | TreasureItem | CraftingItem | ClothingItem | TalismanItem | ArtefactItem | PillItem | ConcoctionItem | CombatItem | CauldronItem | FlameItem | BreakthroughItem | RecuperationItem | MountItem | FlareItem | CraftingTechniqueItem | EnchantmentItem | MysticalKeyItem | CondensationArtItem | FormationItem | PillarShardItem | TrophyItem | BlueprintItem | TokenItem | UpgradeItem | CraftingReagentItem | LifeEssenceItem | DeviceItem | ManualItem;
+export type Item = TechniqueItem | TechniqueCrystalItem | TechniqueShardItem | TechniqueEnhancementDust | TransportSealItem | SpiritFruitItem | RecipeItem | ElixirItem | TreasureItem | CraftingItem | ClothingItem | TalismanItem | ArtefactItem | PillItem | ConcoctionItem | CombatItem | CauldronItem | FlameItem | BreakthroughItem | RecuperationItem | MountItem | FlareItem | CraftingTechniqueItem | EnchantmentItem | MysticalKeyItem | CondensationArtItem | FormationItem | PillarShardItem | TrophyItem | BlueprintItem | TokenItem | UpgradeItem | CraftingReagentItem | LifeEssenceItem | DeviceItem | ManualItem | PillarPatternItem;
 interface ItemBase {
     kind: ItemKind;
     name: string;
@@ -450,6 +450,9 @@ export interface PillarShardItem extends ItemBase {
     maxInstances?: number;
     variants?: PillarShardVariant[];
     stability?: number;
+    portal?: {
+        type: 'entrance' | 'exit';
+    };
     inputs?: {
         left?: number;
         right?: number;
@@ -491,4 +494,21 @@ export interface LifeEssenceItem extends ItemBase {
         techniques: Technique[];
     }[];
 }
+export interface PillarPatternItem extends ItemBase {
+    kind: 'pillar_pattern';
+    shards: {
+        name: string;
+        pos: {
+            x: number;
+            y: number;
+            rotation: number;
+        };
+        overrideInput?: {
+            top?: number;
+            bottom?: number;
+            left?: number;
+            right?: number;
+        };
+    }[];
+}
 export {};

package/dist/item.js

@@ -32,6 +32,7 @@ export const itemKinds = [
     'life_essence',
     'device',
     'manual',
+    'pillar_pattern',
 ];
 export const itemKindToName = {
     clothing: 'Clothing',
@@ -67,6 +68,7 @@ export const itemKindToName = {
     life_essence: 'Life Essence',
     device: 'Device',
     manual: 'Manual',
+    pillar_pattern: 'Pillar Pattern',
 };
 export const itemKindPluralToName = {
     clothing: 'Clothing',
@@ -102,6 +104,7 @@ export const itemKindPluralToName = {
     life_essence: 'Life Essences',
     device: 'Devices',
     manual: 'Manuals',
+    pillar_pattern: 'Pillar Patterns',
 };
 export const buyItemCostMap = {
     technique: 3000,
@@ -137,6 +140,7 @@ export const buyItemCostMap = {
     life_essence: 5000,
     device: 2500,
     manual: 15000,
+    pillar_pattern: 3000,
 };
 export const sellItemCostMap = {
     technique: 400,
@@ -172,6 +176,7 @@ export const sellItemCostMap = {
     life_essence: 1000,
     device: 600,
     manual: 0,
+    pillar_pattern: 500,
 };
 export const pillKindToName = {
     combat: 'Combat Pill',

package/dist/itemHarmonyType.js

@@ -37,4 +37,5 @@ export const itemTypeToHarmonyType = {
     upgrade: 'forge',
     life_essence: 'resonance',
     manual: 'resonance',
+    pillar_pattern: 'resonance',
 };

package/dist/location.d.ts

@@ -96,6 +96,27 @@ export interface LocationEvent {
         min: number;
         max: number;
     };
+    /**
+     * Marks this event as part of the global pity pool.
+     *
+     * **Pity counter**: All pity events share a single global attempt counter
+     * (`globalSpecialEventPity` flag). Each exploration where at least one pity
+     * event was eligible but none fired increments the counter; any pity event
+     * firing resets it to zero. The event's rarity weight is multiplied by
+     * min(1 + counter × 0.1, 5) — reaching 5× base weight after roughly 40
+     * consecutive failed attempts.
+     *
+     * **Exclusivity multiplier**: Before the pity counter is applied, each pity
+     * event receives a player-specific multiplier drawn from a fixed odds list
+     * (e.g. [10×, 8×, 4×, 2×, 1×]). The list is shuffled per-player using a
+     * hash of their name, so every player has the same distribution of chances
+     * but with different events in each tier. This guarantees every player
+     * stumbles into at least one exclusive event easily while having to actively
+     * seek out others. A floor of 1 weight slot is always kept so the pity
+     * counter can still accumulate and eventually guarantee the event for every
+     * player.
+     */
+    pity?: true;
 }
 export interface LocationMapEvent {
     event: EventStep[];

package/dist/mod.d.ts

@@ -16,6 +16,7 @@ import { Guild } from './guild';
 import { Crop } from './herbField';
 import { Enchantment, EnchantmentDesc, Item, ItemDesc, ManualItem, RecipeItem, UncutStonePool } from './item';
 import { ConditionalLink, ExplorationLink, GameLocation, LocationBuilding, LocationEnemy, LocationEvent, LocationMapEvent, SectMission, CraftingMission } from './location';
+import { Rarity } from './rarity';
 import { MineChamber } from './mine';
 import { Quest } from './quest';
 import { Realm, RealmProgress } from './realm';
@@ -79,6 +80,8 @@ export interface ModMetadata {
     author: {
         name: string;
     };
+    /** The game version this mod was compiled against. Set this to GAME_VERSION imported from afnm-types. */
+    gameVersion?: string;
 }
 export interface ModReduxAPI {
     /**
@@ -271,6 +274,30 @@ export interface ModReduxAPI {
             backgroundImage: string;
             screenEffect: ScreenEffectType;
         }) => void;
+        /**
+         * Execute a crafting technique during an active crafting session.
+         * Has the same effect as clicking the technique button in the crafting UI.
+         * Should only be called while a crafting session is active.
+         * @param technique - The fully resolved CraftingTechnique to execute
+         * @example
+         * const technique = api.craftingTechniqueFromKnown(knownTechnique);
+         * executeCraftingTechnique(technique);
+         */
+        executeCraftingTechnique: (technique: CraftingTechnique) => void;
+        /**
+         * Preview the result of executing a crafting technique without modifying game state.
+         * Deep-clones the provided CraftingState, runs the technique on the copy, and returns
+         * the resulting CraftingState. No Redux actions are dispatched.
+         * @param technique - The fully resolved CraftingTechnique to preview
+         * @param state - The current CraftingState (e.g. from useSelector(s => s.crafting))
+         * @returns A new CraftingState reflecting the outcome of executing the technique
+         * @example
+         * const craftingState = api.useSelector(state => state.crafting);
+         * const technique = api.craftingTechniqueFromKnown(knownTechnique);
+         * const preview = previewCraftingTechnique(technique, craftingState);
+         * console.log('Completion after:', preview.progressState?.completion);
+         */
+        previewCraftingTechnique: (technique: CraftingTechnique, state: CraftingState) => CraftingState;
     };
     components: {
         GameDialog: GameDialogFC;
@@ -600,6 +627,17 @@ export interface ModAPI {
          * addCraftingMissionsToLocation('Crafting Hall', [window.modAPI.utils.createCraftingMission(...)]);
          */
         addCraftingMissionsToLocation: (location: string, missions: CraftingMission[]) => void;
+        /**
+         * Add a quest to a location's request board.
+         * @param quest - Quest to add
+         * @param realm - Realm tier this quest appears for
+         * @param rarity - Rarity of the quest
+         * @param condition - Condition expression for availability (e.g. '1' for always available)
+         * @param location - Location key (must have a request board building)
+         * @example
+         * addQuestToRequestBoard(myQuest, 'qiCondensation', 'qitouched', '1', 'Liang Tiao Village');
+         */
+        addQuestToRequestBoard: (quest: Quest, realm: Realm, rarity: Rarity, condition: string, location: string) => void;
         /**
          * Add a manual to the Manual Pagoda.
          * @param manual - Manual configuration

package/dist/stat.d.ts

@@ -55,7 +55,7 @@ export declare const physicalStatToDescription: {
 };
 export declare const reputationDescription = "Reputation affects a factions attitude towards you. High reputation reduces prices, unlocks quests, and allows the purchase of valuable items.";
 export declare const reputationPerTier = 5;
-export declare const reputationTiers: readonly ["neutral", "friendly", "respected", "honoured", "revered", "exalted", "wary", "disliked", "hated", "reviled"];
+export declare const reputationTiers: readonly ["neutral", "friendly", "respected", "honoured", "revered", "exalted"];
 export type ReputationTier = (typeof reputationTiers)[number];
 export declare const reputationTierToReputation: Record<ReputationTier, number>;
 export declare const reputationTierToName: Record<ReputationTier, string>;

package/dist/stat.js

@@ -300,10 +300,6 @@ export const reputationTiers = [
     'honoured',
     'revered',
     'exalted',
-    'wary',
-    'disliked',
-    'hated',
-    'reviled',
 ];
 export const reputationTierToReputation = {
     neutral: 0,
@@ -312,10 +308,6 @@ export const reputationTierToReputation = {
     honoured: reputationPerTier * 3,
     revered: reputationPerTier * 4,
     exalted: reputationPerTier * 5,
-    wary: -reputationPerTier,
-    disliked: -reputationPerTier * 2,
-    hated: -reputationPerTier * 3,
-    reviled: -reputationPerTier * 4,
 };
 export const reputationTierToName = {
     neutral: 'Neutral (-)',
@@ -324,10 +316,6 @@ export const reputationTierToName = {
     honoured: 'Honoured (III)',
     revered: 'Revered (IV)',
     exalted: 'Exalted (V)',
-    wary: 'Wary (I-)',
-    disliked: 'Disliked (II-)',
-    hated: 'Hated (III-)',
-    reviled: 'Reviled (IV-)',
 };
 export const reputationTierToNameOnly = {
     neutral: 'Neutral',
@@ -336,8 +324,4 @@ export const reputationTierToNameOnly = {
     honoured: 'Honoured',
     revered: 'Revered',
     exalted: 'Exalted',
-    wary: 'Wary',
-    disliked: 'Disliked',
-    hated: 'Hated',
-    reviled: 'Reviled',
 };

package/dist/technique.d.ts

@@ -109,7 +109,7 @@ interface ConsumeTargetTechniqueEffect extends BaseTechniqueEffect {
     amount: Scaling;
     hideBuff?: boolean;
 }
-interface DamageTechniqueEffect extends BaseTechniqueEffect {
+export interface DamageTechniqueEffect extends BaseTechniqueEffect {
     kind: 'damage';
     amount: Scaling;
     hits?: Scaling;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "afnm-types",
-  "version": "0.6.44",
+  "version": "0.6.45",
   "description": "Type definitions for Ascend From Nine Mountains",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",