Trinket Tinker

TrinketTinker - Stardew Valley Trinket Framework
This is a framework for creating trinkets that can have advanced abilities using just Content Patcher.

What can this framework do?

• Animated companions with various movement patterns.
• A skin system (variants) for companions, and related features to set/change companion variants
• Dynamic event based abilities that work through the companions rather than the player.
• Support for custom effects from other C# mods, through the use of actions.
• Have the player obtain trinket effects without actually having the trinket slot unlocked, through the use of special trigger actions.
  

If you are looking to make mods using this framework, refer to the Modder Guide.

This mod is licensed under MIT, contributions are welcome.

Example Mods for TrinketTinker

• [CP] Sinister Servants: Playable mod for TrinketTinker, adds 6 monster trinkets.
• [CP] Pack Possum and Critter Cages: Playable mod for TrinketTinker, adds 3 "box" trinkets that hold more trinkets, and a hireable opossum.
• : Example mod for a NPC style trinket, which are unique across the world and hides the corresponding NPC.
• [CP] Abigail Axcellent Adventure: Example mod showing how frame set repeat animation works.
• [CP] Trinket Tinker Examples: Test mod, a bit messy.
  

Translations

• English default.json
• Simplified Chinese zh.json
• French fr.json (by Caranud)
  

Compatibility

• Compatible with Stardew Valley 1.6.9+ on Windows/Mac/Linux, see manifest.json for the exact game and SMAPI version this mod is built against.
• Somewhat works on Android, with the exception of Inventory related features. This is unlikely to be fixed anytime soon.
  

User Configuration

These keybinds are shared across mods using this framework, for the user to set to their liking.

• Do Interact Key: Press this key to interact with your companion, while you are close enough. This is used for talking and putting hats on companions.
• Open Tinker Inventory Key: Press this key to open the inventory of your equipped trinket(s).
• Tinker Inventory Next Key: While a Tinker Inventory is open and multiple trinkets with inventory are equipped, press this to go to the next inventory.
• Tinker Inventory Prev Key: While a Tinker Inventory is open and multiple trinkets with inventory are equipped, press this to go to the previous inventory.
  

These settings are global across all trinkets created using this framework, but have no effect on other trinkets (base game, added via other C# mods).

• Hide During Events: Hide all trinket companions during events. Only affects trinkets added via trinket tinker.
• [font=Courier New]Draw Debug Mode[font]: Enable a draw debug mode that highlights the bounds of the companion and show their current frame number. If you are not a mod developer and you see a magenta background around your trinkets, turn this off.
  

Troubleshooting

If you ever end up with a trinket or a companion "stuck" on your player character, use tt.unequip_trinket console command to remove all trinkets.

Links

Modder Guide

Source Code