Post in this thread with what name you want for your registration.
Please keep everything else outside of this thread.

The recommended format is <Username>_<Mod_Name>, though it doesn't have to be the full name of your mod, just something that uniquely identifies you and your mod for easy association and to differentiate if you want to add multiple files into this system.

One file registration per mod is recommended, but if multiple mods of yours use the exact same script, this is of course not necessary.

By default I register the same files to both the Eye of the Vortex and Mortal Empires campaigns, so if you want to edit both separately, then please list separate file names.

If you require direct access into an existing vanilla file, then please state this and at which point of the file.

Please link your mod if it already exists, so that I can add it to the list of compatible mods, otherwise link it once it is present and tell me what file you tied it to.


All you have to do is import the file that is assigned to you, insert your code into the function that is present in the file and switch the mod registration within the file to true.

function Faction_Unlocker()
cm:set_saved_value("Faction_Unlocker", false);

<Random Scripting>
end;

For example this is the placeholder for my Faction Unlocker scripts. You will insert your core scripts within this primary function, which will be called upon from wh_start, so it will by default be started up once at the creation of the campaign.

You can of course still create subfunctions and have them sit outside of this initial function, but they have to be referred to from it in some way to work and will have to stay within the same file.

Finally, please switch the set_saved_value from false to true in your file.


Each mod within this system will be required to register itself within its own code.
This way every other mod that is currently in use can check whether another specific mod is currently also in use and modify its own behaviour accordingly.

if cm:get_saved_value("Faction_Unlocker") == true then
<Script 1>
else
<Script 2>
end

This example executes Script 1 if the Faction Unlocker is in use together with this framework, while Script 2 will be used instead the Faction Unlocker was not detected.


Although checking for other mods and reacting accordingly should resolve pretty much any potential problems between very similar or normally conflicting mods, there may be rare cases where this is not sufficient.

By default I will add all files in an alphabetical order (= later changes overwrite identical earlier ones), so if problems remain and you can't solve them via such a mod detection check, please talk to me about it.

All of the mod registration IDs that you can use to check if another mod registrated within this system is also being used will be linked in the full list of compatible mods.