June's Inspect Framework

This is a MMAPI mod, installed with MOMI, that serves as a framework for modders wanting image popups for furniture items. It should be used as a dependency, and does nothing on its own.

Want to create a glorious pixel art render of your favorite wall hanging or other furniture piece? With this mod framework, you can!

How it works:

To make your furniture item "inspectable", your mod should add a subtable called "jnk_inspect_framework" in the object prototypes TOML (fiddle/object_prototypes/furniture.toml):

# adds inspect framework to existing furniture item "spring_potted_tree_orange"

# the sprite displayed when inspected is spr_your_custom_sprite_here.

inspect_sprite = "spr_your_custom_sprite_here"The furniture item can be an existing one or a new one, and the same is the case for the sprite. Basically, if you want to add items that are inspectable and give them inspect image popups, you'll have to add the sprites and furniture into the asset pool yourself, like you normally would with any other mod.

Limitations

As of right now, the sprite is restricted to non-animated sprites. If you pass it an animated sprite, it will simply use the first frame. The reason for this is that the system the game uses for UI handles animations differently than animations that are displayed in the overworld, and so it's generally confusing to deal with both, as frame durations specified in sprite .meta.toml files are completely ignored.

Please do not use this framework on existing objects that are already interactable. This mod will overwrite the interact in the primary interaction "slot" and the object will lose its vanilla functionality.

Troubleshooting

As with other MMAPI-based mods, the log for this mod is located in your local app data, specifically:

%LOCALAPPDATA%/FieldsOfMistria/mod_data/jnk_inspect_framework/logs/jnk_inspect_framework.logError messages are displayed there. You can also run the game from Powershell using Write-Host, and the mmapi log will also output there.

Special thanks

Huge shoutout to the FoM modding discord community for their continued support on my work on the MOMI wiki and my other modding endeavors, specifically Crys, ATD, Felix, Anna, and Gareth. Let's keep supporting each other in creating! Additionally, a big thanks to Cacti, who originally brought up the idea for this framework, and Lyhs, who saved me a bunch of time finding a number of key engine functions I needed for this all to be possible!

This framework is REAL level 0. No generative AI, AI tools, or AI agents were used at any point, for any reason. I create because it is my passion and to hone my skills.