Documentation
Readme
View as plain text
# Oath Framework
[](https://GitHub.com/BG3-Community-Library-Team/OathFramework/releases/) [](https://GitHub.com/BG3-Community-Library-Team/OathFramework/commit/)
A Framework to enable Mod Authors to implement Oath-Breaking and Oath-Redeeming events for Paladins.
## Installation
This mod works with [Baldur's Gate 3 Mod Manager](https://github.com/LaughingLeader/BG3ModManager), and possibly Vortex and Manual
Installations. BG3 Mod Managers is by far the simplest method, and as such is recommended one.
[](https://github.com/LaughingLeader/BG3ModManager)
### BG3 Mod Manager
1. Download the latest release, and unzip the .pak file.
2. Open BG3 Mod Manager, click File->Import Mod.
3. Select the mod's .pak or .zip file.
5. Once imported hit refresh.
6. Drag Oath Framework to the Left pane.
8. Hit "Save Load Order to File."
## Recommended Mod Management Tools
- [Laughing Leader's Mod Manager](https://github.com/LaughingLeader/BG3ModManager)
## Other Recommended Mods/Pages
- List any useful Mods or Pages you would recommend here. Below are some examples.
- [Larian Studios Discord](https://discord.com/invite/larianstudios)
- #bg3-modding and #bg3-scripting are useful channels for learning how to mod, and connecting with the modding community.
- [Awesome-bg3](https://github.com/bg3mods/awesome-bg3) - A page with several links to useful guides and tutorials.
## Acknowledgements
- Larian Software, for working on Baldur's Gate 3 and bringing 5th Edition to PC.
- The Baldur's Gate 3 Modding Community.
- Bethesda Studios for creating The Elder Scrolls.
- [https://github.com/ShinyHobo](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