ItemIntegrationFramework

Shared F4SE/CommonLibF4 framework for centralized item card injection, runtime hook handling, and integration between Fallout 4 mods.

Mod page and downloads: Item Integration Framework on Nexus Mods

Features

• Centralized JSON-driven item information card injection
• Public C++ API for cards, damage modifiers, and armor modifiers
• Shared runtime hooks for dependent plugins
• Type 0, Type 1, and Type 2 card layouts
• Configurable anchors, ordering, replacement, and value mapping
• In-game ImGui rule and layout editor
• Optional Prisma UI editor source
• Multi-runtime Fallout 4 support through CommonLibF4

Source layout

• src: native backend, public API, hooks, and editor implementation.
• config/ItemIntegrationFramework: default card rules and translations.
• docs/examples: English and Chinese card format examples.
• ui/actionscript/fallui-patches: item card ActionScript integration source.
• ui/prisma: IIF-authored Prisma UI editor frontend.

Compiled DLL, SWF, PEX, plugin, font, and FallUI media assets are not included. Install the complete mod package from Nexus Mods for normal gameplay.

Requirements

• Windows 10 or later
• Visual Studio 2022 Build Tools with Desktop development with C++
• Git
• XMake 3.0 or later
• A CommonLibF4 checkout selected by the build environment
• Fallout 4 Script Extender

Build

This project must be built against an existing CommonLibF4 checkout. When run inside the FO4 workspace, the build script resolves the workspace global CommonLibF4 profile. It also accepts COMMONLIBF4_PATH or an explicit -CommonLibF4Path; it never clones a project-local CommonLibF4:

.\scripts\build.ps1

To use an explicit CommonLibF4 checkout:

.\scripts\build.ps1 -CommonLibF4Path D:\path\to\commonlibf4

The default native build uses the ImGui editor. The alternate Prisma UI editor implementation under src/GUIEditor is retained as source but excluded by the default XMake target.

Integration

Dependent F4SE plugins can include src/IIF_API.h and register cards or combat modifiers through the F4SE messaging interface. Default JSON rules are loaded from:

Data/F4SE/Plugins/ItemIntegrationFramework

See docs/examples and the configuration files for supported card schemas.

License

Original IIF source is released under GPL-3.0-only. Built binaries also contain commonlib-shared code distributed under GPL-3.0 with the CommonLib Modding Exception. Vendored Xbyak remains under its BSD-3-Clause license. Third-party compatibility patch bases remain subject to their respective terms. See COPYRIGHT, THIRD_PARTY_NOTICES.md, and licenses/commonlib-shared.