0 of 0
About this mod
A Framework to enable Mod Authors to implement Inspiration Points in their Custom Backgrounds.
- Requirements
- Permissions and credits
- Changelogs
- Donations
The Inspiration Framework is an API designed to allow Custom Background mods and mods aiming to provide custom Background Goals for vanilla Backgrounds to take advantage of the Inspiration Point feature of Baldur's Gate 3.
If you like my work, please consider leaving a tip on Ko-fi! Neither my mods, nor support for them, will ever be gated behind or be based on payment or donation - this is just for if you feel like encouraging my coffee habit
About
Inspiration Points are notoriously difficult to set up for Custom Backgrounds - the code behind them for vanilla Backgrounds is hidden away in the story.div.osi, written entirely in Osiris code that we can't really directly edit at this time. Inspiration Framework allows you to leverage the game Databases in conjunction with Script Extenders Listeners to both register your custom background correctly, and mark goals as completed when certain conditions are met.Contributing
Whether you want to contribute directly to the framework, report issues, or if you just want to make your mod's goals work, the Community Library Team welcomes you. The Issues tab on Github is a place for reporting issues, proposing new additions, and discussing the future of the project.
Usage
Our Wiki on GitHub has useful documentation on using the Inspiration Framework.
Installation
This mod works with Baldur's Gate 3 Mod Manager, and possibly Vortex and Manual Installations. BG3 Mod Managers is by far the simplest method, and as such is recommended one.
Load Order
Inspiration Framework should load near the beginning of your load order, just after Community Library. It should load before any mods using Inspiration Framework.BG3 Mod Manager
- Download the latest release, and unzip the .pak file.
- Open BG3 Mod Manager, click File->Import Mod.
- Select the mod's .pak or .zip file.
- Once imported, click refresh
- Drag Inspiration Framework to the Left pane.
- Hit "Save Load Order to File."
Recommended Mod Management Tools
Other Recommended Mods/Pages
Acknowledgements
- Larian Software, for working on Baldur's Gate 3 and bringing 5th Edition to PC.
- LaughingLeader, for explaining how to do Configuration Loading
- The Baldur's Gate 3 Modding Community.
- Kvalyr for explaining how to Expose an API effectively
- https://github.com/ShinyHobo for their work easing the process of creating .pak files.
- Alana for the creation of the Mod Manager Compatibility Images.
- Focus for providing guidance on handling Background Goals