From 97d58d2f3890b6ac5c4b34960b6d7ba130670211 Mon Sep 17 00:00:00 2001 From: Mod Documentation Updater Date: Fri, 22 May 2026 00:45:22 +0000 Subject: [PATCH] docs: update modding documentation --- docs/crafting/buffs.md | 10 +++++----- docs/crafting/recipes.md | 9 +++++++++ 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/crafting/buffs.md b/docs/crafting/buffs.md index a36cce5..8988399 100644 --- a/docs/crafting/buffs.md +++ b/docs/crafting/buffs.md @@ -27,9 +27,9 @@ interface CraftingBuff { stacksAreMonths?: boolean; // If true, stacks represent in-game months (used for time-limited buffs) // Visual properties - effectHint?: string; // Brief hint text + effectHint?: string; // Brief hint text shown in the crafting UI tooltip?: string; // Custom description - statsTooltip?: string; // Stats-specific tooltip + statsTooltip?: string; // Stats-specific tooltip override displayLocation: CraftingBuffDisplayLocation; // Where buff appears in UI // Locations: 'none' | 'avatar' | 'companion' | 'stabilityLeft' | 'stabilityRight' | // 'perfectionLeft' | 'perfectionRight' | 'completionLeft' | 'completionRight' @@ -48,11 +48,11 @@ interface CraftingBuff { onSupport?: CraftingBuffEffect[]; // Triggers on support techniques // Scaling properties - baseScaling?: number; // Base scaling value - stacksScaling?: number; // Per-stack scaling + baseScaling?: number; // Base scaling value for stat effects + stacksScaling?: number; // Per-stack scaling multiplier // Upgrade flag - cantUpgrade?: boolean; // If true, cannot be upgraded + cantUpgrade?: boolean; // If true, cannot be upgraded via mastery // Advanced fields bonusHiddenPotential?: Scaling; // Grants bonus hidden potential to the crafted item when this buff is active diff --git a/docs/crafting/recipes.md b/docs/crafting/recipes.md index b449347..59f9f32 100644 --- a/docs/crafting/recipes.md +++ b/docs/crafting/recipes.md @@ -37,6 +37,7 @@ interface RecipeItem { // Optional overrides conditionEffectOverride?: RecipeConditionEffect; // Override default condition type harmonyTypeOverride?: RecipeHarmonyType; // Override default harmony system + perfectionEffectOverride?: 'quality'; // Controls what perfection affects in the crafted item } ``` @@ -69,6 +70,14 @@ Each recipe uses one of four harmony systems during crafting. By default the gam | `inscription` | Inscription — pattern-block system | | `resonance` | Resonance — technique-type matching resonance system | +## Perfection Effect Override + +Set `perfectionEffectOverride` to `'quality'` to make perfection affect the quality tier of the crafted item (basic/perfect/sublime) rather than applying a stat modifier. This is used by most recipes in the game. + +```typescript +perfectionEffectOverride: 'quality'; +``` + ## Registering Recipes via the Mod API ### Add to the Sect Recipe Library