[1.13] Community Mod Framework

If you liked this item, please rate it up on Steam Workshop page.

Authors: CaelReader, Bahmut, CaesarVincens, Lord R, Alexedishi, Taylor, Paradox Mod Manager

Last revision: 31 May at 16:21 UTC (61)

File size: 134.63 MB

On Steam Workshop

Description:
Community Mod Framework

The Community Mod Framework is a utility mod that aims to improve mod inter-operability while giving modders tools for GUI, Political Movements, Parties and mod detection. This framework makes several changes to GUI files, political movements, and parties. While generally scripted for compatibility, it will collide with other mods that touch these files.

This framework is structured to be load order agnostic by using Victoria 3’s file loading behavior, but it is good practice to place this mod before/above any other mods in your mod loader.

Documentation available on GitHub: https://github.com/Victoria-3-Modding-Co-op/Community-Mod-Framework

Any questions, feel free to reach out via the Modding Co-op: https://discord.gg/C2tpZzg9Qc

Compatibility

Current Scope
GUI Framework

This part of the framework intends to deconflict mods that require GUI changes which inherently lead to incompatibilities.

Current Features:
  • A way to add new buttons to the Sidebar (Credit to Bahmut, LordR, & Alexedishi)
  • Situation style Journal Entries (Credit to Bahmut & CaesarVincens)
  • Modification to the GUI template fullscreen_hide to hide the outliner whenever a scripted widget window is open (Credit to Bahmut & Alexedishi)
  • Modification to objective_types to add a scrollbar to the objectives screens. (Credit to Bahmut, KarafuruAmamiya and Xier)
  • Integration of the Modded DLC Framework (Credit to 1230james)
  • Modification to the outliner and journal GUIs to hide custom objectives during gameplay (Credit to Taylor)
  • Several event windows for extra flavor (Credit to Bananaman & Klein for the Newspaper window, credit to Alexedishi for all others)
  • Integration of the Multi-line PM Framework (Credit to 1230james)
  • Modification to Journal Entry GUI to allow players to show characters (Credit to Bahmut and Mori)
  • Alerts can now open custom windows (Credit to Bahmut)
  • More than three local goods can now be shown in state building panel correctly (Credit to Bahmut)
  • The ability to hide and show specific Journal Entry Groups (Credit to rskhm)
  • Additional Modifier Icons + PSD template (Credit to CaelReader)
  • Additional Modifier Icons + PSD template (Credit to Bahmut)
  • Configurable Character portraits (Credit to Bahmut & CaesarVincens)
  • Journal progress bars can be styled with ‘drift’ and target effects (Credit to CaesarVincens, idea from MasterOfGrey)
  • Framework for a two character journal entry (Credit to Bagel)

Scripting Framework

This part of the framework intends to provide helper functions to modders that by default are not part of the game.

Current Features:
  • Simple Structs to manage Variables (Credit to Bahmut)
  • Unified Keybind configuration to allow multiple mods to define Keybinds (Credit to Lord R)
  • Ability to block randomly-generated heirs (Credit to 1230james)
  • Ability to block Country Formation notifications (Credit to Alexedishi)
  • Community Mod triggers to detect other active mods
  • Framework for running weekly events without a Journal Entry (Credit to Dingbat32 and LordR)
  • Logical Nor, Nand, and Xor GUI script macros (Credit to CaesarVincens)
  • Custom, indexed float arrays (Credit to BigBruh and CaesarVincens)

Community Politics Framework
  • Shared Party definition to deconflict mods that change base game parties
  • Shared Political Movement to deconflict mods that change base game parties

Community Mod Triggers

These triggers allow mods to detect each other. This does not automatically make mods compatible, but rather is a tool to allow modders to build script around the presence of other mods.

Special Thanks to all to have contributed:

  • 1230james
  • Alexedishi
  • Bagel
  • Bahmut
  • Bananaman
  • BrokenRobot
  • CaelReader
  • CaesarVincens
  • Dingbat32
  • KarafuruAmamiya
  • Klein
  • LordR
  • MasterofGrey
  • Mori
  • rskhm
  • Taylor
  • Xier
  • Marmot

#CMF #COM

Download
Revisions:

Old revisions of this mod are available below. Click the link to download.