Compatibility Framework
baldurs-gate-3 — Mods & Enhancements
The Compatibility Framework (CF) is a standalone API mod, split from BG3 Community Library, that provides a unified system for modders to declare dependencies and resolve conflicts between subclass mods, feat packs, and race overhauls. It introduces 'Compatibility Patches' — small scripts that check for the presence of other mods and adjust behavior accordingly, so e.g., 'Subclass Compatibility' mods can share the same subclass ID without overwriting each other. Players install it because it's required by major mods like 'Subclass Compatibility: Sorcerer' and 'Feat Expansion', and it prevents the 'Duplicate Passive' errors that crash character creation.
📦 Full mod page on discovermods
Downloads, ratings, compatibility info, installation guides, and user reviews.
View on discovermods →Syntax
UtilitiesExample
Downloads: 1,533,111 | Endorsements: 14,232💡 Notes
By BG3 Community Library Team | v2.9.2.0 | 14,232 endorsements
🎯 Tips & Tricks
After installing CF, open BG3MM and ensure CF is loaded ABOVE any 'Subclass Compatibility' .pak files (e.g., 'SC: Wizard'). In the mod's config file (found at %LOCALAPPDATA%/Larian Studios/Baldur's Gate 3/Mods/CompatibilityFrameworkConfig.json), set 'EnableDebugLog' to 'true' to see which patches are applied. Then, in-game, open the console (with BG3SE) and type 'cf_list_patches' to verify all active patches.
If two subclass mods both want to add 'Bladesinger' to Wizard, edit the CF config file to set 'PatchPriority' for each mod. For example, set 'SC_Wizard' to priority 10 and 'Homebrew_Wizard' to priority 20; CF will load the higher priority patch last, ensuring that mod's subclass appears in-game. Use the exact mod UUIDs found in the .pak's meta.lsx.
In-game, press F10 to open the CF UI (if you have 'Mod Configuration Menu' installed). Go to 'Compatibility Framework' tab, click 'Check Conflicts', and it will list any mods that are missing required CF patches. For each listed mod, download the corresponding 'CF Patch' from its Nexus page (e.g., 'CF Patch for 5e Spells') to fix it.
🔧 Troubleshooting
Subclass mods load but their subclass selection screen shows blank names or crashes when selecting a subclass.
This is a known conflict with 'ImprovedUI' (v1.0.0) which does not recognize CF's new subclass ID mapping. Install 'ImprovedUI' v1.0.2 (Nexus file ID 366) and ensure it's deployed AFTER CF. If using BG3MM, move 'ImprovedUI' below CF. Additionally, delete the 'Public/UI/Subclass' folder from CF's .pak to let ImprovedUI handle the UI.
CF causes infinite loading screen when combined with 'Party Limit Begone' (PLB) and 'Sit This One Out'.
This is a load order conflict: CF must be loaded AFTER PLB but BEFORE 'Sit This One Out'. In BG3MM, drag CF above 'Sit This One Out' and below PLB. If using Vortex, set CF's 'Deploy After' to PLB and 'Deploy Before' to 'Sit This One Out'. The issue is CF's script that patches party size data, which PLB overrides.
⚠️ Common Mistakes
- [object Object]
- [object Object]
👍 Pros
- 14,232 endorsements
- 1,533,111 downloads
- Category: Utilities
👎 Cons
- Requires mod manager installation
- May conflict with similar mods