Mod Detection Triggers

Overview

The Community Mod Triggers is a small utility file within Community Mod Framework meant to streamline the process of mod de-confliction by giving us a single file we can share between ourselves that contains scripted triggers to detect each others mods. This file is maintained on the CMF GitHub repo. If you wish to add your own trigger, either submit a request here or open a pull request on the repo.

Once your trigger is added, it will never be changed.

Usage

1. Submit a scripted trigger key for use in CMF. It should take a format as follows: YOURMOD_is_active_trigger

2. Ensure users of your mod are also using CMF. The scripted triggers in 00_community_mod_compatibility_triggers.txt are all set to return false by default. This is intentional. How your trigger will look in CMF.

YOURMODNAME_is_active_trigger = {
   always = no
}

3. Create a file in the \common\scripted_triggers folder of your mod that contains the following:

REPLACE_OR_CREATE:YOURMODNAME_is_active_trigger = {
   always = yes
}

Ensure that this file loads after CMF's file.

If everything was done correctly, CMF will return your trigger as false when your mod is not loaded, and true when it is loaded.

Resources:

• Post by 1230James about why using this form of scripted trigger is less convoluted for everyone: https://discord.com/channels/827163966551621662/827163966828183557/1234653102939049984
• Guide for file loading behaviors: https://vic3.paradoxwikis.com/Mod_compatibility#File_loading_order
• Dev Diary explaining database entry modes: https://forum.paradoxplaza.com/forum/developer-diary/victoria-3-dev-diary-164-marvelous-modding-monday.1868975/

Currently Participating

Mod Name	Trigger
Gates of the Bosphorus	grefm_is_active