June's Dialogue Reaction Framework

This is a MMAPI mod, installed with MOMI, that serves as a framework for dialogue modders wanting the player to be able to react to conversations with NPCs. It should be used as a dependency, and does nothing on its own.

Have you ever wanted the player to be upset at Holt's puns, or blush after being flirted with by your favorite romanceable? This mod makes that possible!

How it works (at a glance):

Your mod should include a TOML file called jnk_dialogue_reactions.toml in a folder called "fiddle" with tables that look something like this:

npc_owner = "hayden"

bark = "blush"This TOML file will consist of every conversation that Ari can "react" to. The name of the table and the "npc_owner" must match the dialogue you are trying to attach the reaction to, and the "npc_owner" must be defined for every table to avoid triggering on conversations that happen to use the same table name. (This is common for dialogue from romanceables.)

I have included an additional sample mod that uses this framework to give an idea of how it works. To view the content, install both mods and then talk to Hayden. Do not use the "t2 converse" bugger command, as it will not trigger any of this framework's code.

Full reference

What is a "bark"?

A "bark" is the term used by the FoM devs for the speech bubbles and thought bubbles that often appear over the heads of NPCs, and sometimes animals, and Ari (the player) in cutscenes. In cutscenes, Mist files can execute barks from Ari, Void Ari, the player's pet, even animals. However, everyday dialogue (basically .c.toml) is hardcoded to only be able to allow NPCs to emit barks, hence the need for this framework. In this framework, the bark value is the sprite to be used inside of the speech or thought bubble, as explained in the MOMI wiki on dialogue here. It functions just as the regular bark action does for NPCs.

Other options

While "npc_owner" and "bark" must be defined, there is also a third option, "bubble":

npc_owner = "holt"

bark = "annoyed"

bubble = "thought"If you so choose, you can use "thought" to show a thought bubble. The default behavior is a speech bubble, as it is with NPCs.

Limitations

The way this is achieved is by supplying a close_callback() function, which is run when the player closes the last dialogue box of the conversation. Ari will only emit the bark at the end of the conversation, not after a specific line within it. (This is also how barks work for NPCs. Any barks specified throughout the entire conversation table will only occur at the end of the conversation, regardless of where they are placed.)

Some extremely niche conversations already use a close_callback() function, so as this framework overwrites the existing one, it should not be used to edit those conversations. This mostly goes for date_acceptance conversations, which are the most notable examples. However, date_acceptance lines already end with both Ari and their date emitting heart barks anyway.

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_ari_bark/logs/jnk_ari_bark.logError messages are displayed there.

If you are attempting to use the BUGGER command "t2 converse" to test conversations you add barks to, it will not work, as this mod uses the "dialogue.path" hook, which only fires when the game calls the play_conversation() function. The "t2 converse" bugger command does not call play_conversation() but instead instantiates a conversation driver directly to view dialogue, and therefore, no player reactions will occur. I suggest setting your test dialogue to priority = "max" in order to see the conversation play out with the reactions, as I have done in the example mod file provided.

Special thanks