About this mod
Framework for customizing pretty much everything about NPC dialogue boxes. Lets you add friendship hearts, character sprites, custom text and images, and more.
- Requirements
- Permissions and credits
- Changelogs
- Donations
About
This mod is a modder's resource, it doesn't do anything by itself. It allows multiple creators to simultaneously change individual parts of the display of dialogue boxes while doing so using patches customizable in text format, no code required. More complex mods may also use this framework's API if changes can't be handled by CP.
For examples of mods implementing this framework, see:
- Changing Skies & Portraited Changing Skies
- Hearts and Gifts Dialogue Display (works, but uses outdated code)
- Compatibility patches in optional files
See mod author documentation to create your own content packs, complete with examples.
See changelogs for version changes.
Compatibility Patch
The compatibility patch under optional files fixes issues until they're fixed in the next stable version of their respective mod.
Currently, it allows support for the following mods:
- Hearts & Gifts - fixes misaligned values and removes the missing ID warning messages
- Hearts & Gifts + Changing Skies / Portraited Changing Skies
Known Compatibility
Compatible with:
- Content packs that change portraits and/or UI assets (recolors)
- Mods that add custom NPCs/dialogues, such as Unique Children Talk
- Content Patcher Animations can animate UI assets and portraits
- Portraiture should work with portraits of same-size proportions
- Farmer Portraits includes a compatibility patch.
Some incompatibility with:
- Animal NPC dialogues made with MEEP may appear blank. Currently looking for a fix.
NOT compatible with:
- SMAPI for Android and I currently have no plans on making it compatible. Code PRs are welcomed.
- Animations made with SpaceCore (let me know if you'd like compatibility)
Technical
Requires SMAPI, uses Harmony.
The source code and changelogs are available on GitHub.
Support & Credits
If you have issues, suggestions, or feedback, comment here or join my Discord for a quicker response. If you like my mods, donating is the best way to show appreciation while supporting both me and future updates.
Big thanks to:
- aedenthorn for the original mod version.
- Doragoun for helping with the documentation.
- MistySpring for the compatibility patch on Farmer's Portrait.

