Community Mod Framework – 1.3 Pavia

The Community Mod Framework (CMF) is a utility mod that aims to improve mod inter-operability while giving modders tools for creating new features.

CMF should be loaded first in your mod load order.

Any questions, feel free to reach out on the EU5 Mod Coop Discord: https://discord.gg/aqAAcCZsY7

• Community Mod Menu (CMM):[github.com] A shared in-game mod menu. Mod authors register settings dynamically through a simple API.
  
  • Toggle, button, numeric, slider (double click to drag), dropdown, text (singleplayer-only), and list settings
  • Per-mod tabs, groups, and search
  • Global settings with host-only multiplayer editing
  • Reset to Defaults (all mods, or just the selected mod)
  • Draggable window
  • Can be opened from the escape menu in-game. Or via the keybind (‘m’ by default, can be rebound).
  • CMM Visual Editor[github.com]: browser-based tool for creating your mod menu
• Custom Alerts:[github.com] Create and show custom alerts in the alert bar through localization keys.
• Action Bar:[github.com] Add custom action bar buttons with localization keys.
• Mod Banners:[github.com] Display your mod as a banner on the pre-game lobby screen, with an icon, name, and description. Opt in with cmf_register_lobby_banner.
• Country Transfer:[github.com] CMM settings automatically transfer when switching countries (tag switches, inheritance, etc.).
• is_host Trigger:[github.com] Check if the current country is controlled by the host player.
• Unrestricted Tools Toggle:[github.com] Gate restricted features behind an "Enable Unrestricted Tools" setting (cmf_can_use_unrestricted_tools trigger, cmm_set_requires_unrestricted_tools_enabled per-setting flag). Only available for the host in multiplayer.
• Mod Detection:[github.com] Check whether another mod is active with the cmf_is_mod_active trigger.
• cmf_suppress Effect:[github.com] Suppress "used but never set" and "set but never used" engine warnings with a single effect call.
• GUI Macros:[github.com] Nand, Nor, and Xor logical operator macros.
• On-Action Hooks:[github.com] Post-lobby game start and save load hooks (on_game_start_after_lobby, on_game_load, on_game_load_after_lobby) with player country variants. Also includes shared yearly and monthly pulses for human players.
• Variable Map Utilities:[github.com] Safe variable map mutation helpers (cmf_change_variable_map and local/global variants).
• Mod Action Log:[github.com] Global in-game log for recording mod actions (e.g. host tool actions in multiplayer, as the log is unable to be cleared in MP).
• Community Mod Toolkit (CMT):[github.com] A companion set of development tools, such as a mod template, workshop uploader, and mod translator.

• GitHub Wiki[github.com]: Full documentation
• EU5 Paradox Wiki[eu5.paradoxwikis.com]: Quick reference
• GitHub Repository[github.com]

• Bahmut
• CaesarVincens
• Conner
• Glorp
• Pickle
• RomanImperator

• See the Mods using Community Mod Framework Collection

See the Change Notes on the workshop page.

Please Read Before Reporting Issues:

If you are on the 1.3 open beta, disable the mod and verify the issue is not present without it. There are TONS of issues with the beta, which need to be reported to Paradox, not CMF.

Additionally whether reporting on 1.2, or 1.3, please include your game version. CMF is compatible with both versions, but we need to know which version you are on to address relevant issues.