What is the Baldur's Gate 3 Oath Framework?

The Oath Framework is an API designed to allow Custom Paladin mods to take advantage of the Oathbreaking features of Baldur's Gate 3, while providing a unique way to Break their Oaths, separate from how Vanilla Paladins would. It also provides the capability for Redemption events, allowing a way to regain your oath without bribing the Oathbreaker Knight. In the future, it is also planned to add ways to allow Clerics and Warlocks to have similar functionality.

What Problems Does the Oath Framework Solve?

Custom Paladin subclasses all run into the problem of having to piggy-back off of Vanilla Oathbreaking triggers. This is both due to the complexity of the game's Dialog/Flag/Tag system, and due to SE still seeming "scary" to some. While Oath Framework doesn't resolve the second piece, it does provide an easy configuration method to register your custom tags and flags for Paladins, as well as API functions that can be used to both Break and Redeem an Oath.

How Can I Get Involved?

Whether you want to contribute directly to the framework, or if you just want to make your mod's goals work, the Community Library Team welcomes you. The Issues tab is a place for reporting issues, proposing new additions, and discussing the future of the project.

I Want to Contribute to the Project

We're excited to have you! See our page on How to Contribute to learn how to contribute. Whether you want to move parts of your existing mod into the library, or add brand new content, anyone is welcome to propose a feature and add to the project.