Skip to content

[Docs] Document perfectionEffectOverride and missing CraftingBuff fields #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Lyeeedar merged 1 commit into from
May 22, 2026
Merged

[Docs] Document perfectionEffectOverride and missing CraftingBuff fields #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/crafting/buffs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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
Expand Down
9 changes: 9 additions & 0 deletions docs/crafting/recipes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
```

Expand Down Expand Up @@ -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
Expand Down