Community Mod Framework - 1.3 Pavia

The Community Mod Framework (CMF) is a utility mod designed to improve compatibility between mods and provide mod authors with tools to create new features.

CMF should be placed first in your mod load order.

If you have any questions, please feel free to contact via the EU5 Mod Coop Discord:

Function

Community Mod Menu (CMM): [github.com] A shared in-game mod menu. Mod authors can dynamically register settings through a simple API, eliminating the need to build a custom settings interface.

Switches, buttons, values, sliders (double-click to drag), drop-down menus, text (single-player mode only) and list settings

Supports independent tabs, grouping and search functions for each module

Global settings, editable only by the host in multiplayer mode

reset to default

Draggable window

Can be opened from the in-game exit menu (Esc menu) or via shortcut key (default is "m", rebindable).

CMM Visual Editor [github.com]: Browser-side tool for creating module menus

Custom reminders: [github.com] Create and display custom reminders in the reminder bar through localized keystrokes.

Action Bar: [github.com] Add custom action bar buttons using localized keystrokes.

Country transfer: [github.com] CMM settings are automatically transferred when switching countries (Tag switching, inheritance, etc.).

is_host trigger: [github.com] Check if the current country is controlled by the host player.

Unrestricted tools switch: [github.com] Restrict specific functions through the "Turn on unrestricted tools" setting (cmf_can_use_unrestricted_tools trigger, cmm_set_requires_unrestricted_tools_enabled single setting flag). Available only to homeowners in multiplayer mode.

Mod detection: [github.com] Use the cmf_is_mod_active trigger to check if another mod is active.

cmf_suppress effect: [github.com] Suppress "used but never set" and "set but never used" warnings in the engine with a single effect call.

GUI Macros: [github.com] Nand, Nor and Xor logical operator macros.

On-Action Hooks: [github.com] After-lobby game-start and save-load loading hooks (on_game_start_after_lobby, on_game_load, on_game_load_after_lobby) and player country variants. Also included are shared annual and monthly pulses for human players.

Variable Map Tool: [github.com] Secure Variable Map change aid (cmf_change_variable_map and its local/global variants) that handles "delete first, then add" operations atomically.

Module action log: [github.com] Global in-game log, used to record module actions (such as homeowner tool actions in multiplayer mode, because this log cannot be cleared in multiplayer mode).

Community Modding Toolbox (CMT): [github.com] A set of supporting development tools such as mod templates, workshop uploader, and mod translator.

document

GitHub Wiki [github.com]: Complete documentation

EU5 Paradox Wiki [eu5.paradoxwikis.com]: Quick reference

GitHub repository [github.com]

Contributor

Bahmut

CaesarVincens

Conner

Glorp

Pickle

RomanImperator

Mods using CMF

See Mod Collections using the Community Mod Framework

Update log:

Please see the update notes on the Workshop page.

Please read before reporting an issue:

If you are using the 1.3 public beta, please disable this mod and verify if the issue persists without it. There are a number of issues with the public beta that need to be reported to Paradox, not CMF.

Also, whether reporting an issue with version 1.2 or 1.3, be sure to include your game version number. CMF is compatible with both versions, but we need to know which version you are using in order to resolve the issue.