# CF Sample Patches
[![GitHub release](https://img.shields.io/github/v/tag/BG3-Community-Library-Team/CF-Sample-Patches?label=Latest%20Version)](https://GitHub.com/BG3-Community-Library-Team/CF-Sample-Patches/releases/) [![GitHub commits](https://img.shields.io/github/commits-since/BG3-Community-Library-Team/CF-Sample-Patches/2.5.0/main)](https://GitHub.com/BG3-Community-Library-Team/CF-Sample-Patches/commit/)

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/O5O8PG8RF)


These are small Patch mods designed to work alongside the Compatibility Framework. They have many purposes, from providing a quick and easy patch between existing mods, to simply making small, inherently compatible changes to progressions or other CF-supported data.

## Includes

### Feats at Every 3 Levels
This small mod uses the Compatibiltiy Framework to patch progressions for vanilla classes, as well as those included in UnlockedLevelCurve, Artificer, Blood Hunter, and Mystic to provide feats every 3 levels, instead of every 4.

### Feats at Every 2 Levels
This small mod uses the Compatibiltiy Framework to patch progressions for vanilla classes, as well as those included in UnlockedLevelCurve, Artificer, Blood Hunter, and Mystic to provide feats every 2 levels, instead of every 4.

### CL Psionic Energy Dice Patch (TODO)
This small mod patches RoguesExtra and Psi Warrior to use the Psionic Energy Dice provided in Community Library, allowing both classes to synergize.

## Contributing
If you'd like to contribute to the Compatibility Framework, make a Fork of this project: [![GitHub forks](https://img.shields.io/github/forks/BG3-Community-Library-Team/CF-Sample-Patches)](https://GitHub.com/BG3-Community-Library-Team/CF-Sample-Patches/network/)

The Compatibility Framework makes it easy to set your mods up for compatibility with other mods, just by utilizing the Framework's API. To find out how, [check out the CF Wiki page](https://github.com/BG3-Community-Library-Team/BG3-Subclass-Compatibility-Framework/wiki/Adding-a-Subclass-to-the-Compatibility-Framework).

For more information on the Compatibility Framework API and JSON-based Config loading methods, take a look at the following pages:
- [Class/Subclass Module](https://github.com/BG3-Community-Library-Team/BG3-Subclass-Compatibility-Framework/wiki/_Class-Module)
- [Selector Module](https://github.com/BG3-Community-Library-Team/BG3-Subclass-Compatibility-Framework/wiki/_Selector-API)
- [Boosts/Passives Module](https://github.com/BG3-Community-Library-Team/BG3-Subclass-Compatibility-Framework/wiki/_Boosts-and-Passives)
- [Lists Module](https://github.com/BG3-Community-Library-Team/BG3-Subclass-Compatibility-Framework/wiki/_Lists-API)

## 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.

[![Compatible with Laughing Leader's Baldur's Gate 3 Mod Manager](https://i.imgur.com/qtdx2Yq.png)](https://github.com/LaughingLeader/BG3ModManager)

#### Load Order

Compatibility Framework should be loaded at the bottom of your mods list. These mods go above it.

### 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 desired .pak.
4. Once it's imported, hit refresh.
5. Hit "Save Load Order to File."

## Recommended Mod Management Tools
- [Laughing Leader's Mod Manager](https://github.com/LaughingLeader/BG3ModManager)

## Other Recommended Mods/Pages
- [Larian Studios Discord](https://discord.com/invite/larianstudios)

## Acknowledgements
- Larian Software, for working on Baldur's Gate 3 and bringing 5th Edition to PC.
- The Baldur's Gate 3 Modding Community.
- [ShinyHobo](https://github.com/ShinyHobo) for their work easing the process of creating .pak files.
- Alana for the creation of the Mod Manager Compatibility Images.