Buff frame

Allows modders to trigger buffs using Content Patcher

Buff Framework

✨ **Make module development easier! ** This framework opens up new possibilities for the game buff system, allowing modders to flexibly trigger various buff effects based on Content Patcher conditions.

---

🎯 Core Functions

• **Flexible Triggering**: Automatically activate buffs based on various game conditions
• **Highly Customizable**: Supports custom gain attributes and icons
• **Seamless Integration**: Perfectly compatible with Content Patcher and SMAPI

📝 Usage example

Here is a simple configuration example that automatically applies the Squid Ink Wonton buff when the player wears the "Midnight Dog Jacket":

```json

{

"Format": "1.28.4",

"Changes": [

{

"Action": "EditData",

"Target": "aedenthorn.BuffFramework/dictionary",

"Entries": {

"aedenthorn.JacketBuff": {

"shirt": "Midnight Dog Jacket",

"which": 28,

"source": "aedenthorn.MidnightDogJacketBuff",

"displaySource": "Midnight Dog Jacket Buff"

}

}

}

]

}

```

🎮 Gain type

The framework supports all buffs built into the game, including:

• **6** - Full stomach
• **7** - Quench your thirst
• **12** - Burns
• **13** - Slime
• **14** - Curse
• **17** - Tipsy
• **18** - Frightened
• **20** - Warrior Energy
• **21** - Invincible
• **22** - Adrenaline rush
• **28** - Squid ink ravioli

⚙️ Advanced configuration

You can customize the following properties:

• **Skill Bonus**: Farming, Fishing, Mining, Excavation, Luck, Foraging, Crafting
• **Attribute improvement**: maximum physical strength, magnetic radius, speed, defense, attack
• **Visual effects**: glow effects, custom icons
• **Sound Effect**: Special sound effect when triggered
• **Duration**: Precisely control the gain duration

🎪 Trigger conditions

Buffs can be triggered in a variety of ways:

• **Edible items**: Set the `consume` field to specify the food
• **Equipment Wear**: through `hat`, `shirt`, `pants`, `boots`, `ring` fields
• **Custom Conditions**: Powerful condition system combined with Content Patcher

🔧 Technical characteristics

• **SMAPI Compatible**: SMAPI support required
• **Configuration Menu**: Integrated universal module configuration menu
• **Open Source Code**: Full source code available on GitHub

🌟 Practical application

This framework is already used by several popular mods:

• **Speed ​​Buff After Midnight**
• **Birthday Buff**

💡 Development suggestions

• Use the `which` field to reference a built-in buff, or use `buffId` to create a custom buff
• Select the game's built-in icon through `sheetIndex`, or use `texturePath` to set a custom icon
• Properly set the `duration` field to control the gain duration

---

🚀 **Start your buff module creation journey! ** This framework brings endless possibilities to Stardew Valley module development, allowing your creativity to be perfectly realized in the game.