Documentation
Readme
View as plain text
# Baldur's Gate 3 Community Library
[](https://GitHub.com/BG3-Community-Library-Team/BG3-Community-Library/releases/) [](https://GitHub.com/BG3-Community-Library-Team/BG3-Community-Library/commit/)
Baldur's Gate 3 Community Library exists to provide a common collection of
Spells, Scripts, Items, Statuses, Passives, and other useful material that will
assist modders in creating new content.
Note that some of this information may be out of date - we're working on cleaning off the cobwebs as we raise the project back from the dead.
## For Mod Authors:
In addition to the stated purpose of this mod, feel free to use the contents of
this mod as examples of how to create certain content for Baldur's Gate 3 if you
wish. See [here](https://github.com/BG3-Community-Library-Team/BG3-Community-Library/wiki/Using-Community-Library-Content) to find out how to use the
library's content in your own mods!
You're welcome to submit pieces of your mod that you think would be useful for
others to use in their mods as well, be it scripts, spells, statuses, passives,
models, textures, sounds, etc.
## For Players:
Some mods will rely on this one, and require it as a dependency, as it provides the content it contains. If none of your mods require this one, you don't need to install it.
### I heard this mod makes Subclasses Compatible?
As of 2.0.5.0, this mod no longer includes the [Subclass Compatibility Framework](https://github.com/BG3-Community-Library-Team/BG3-Subclass-Compatibility-Framework), which has been separated out into it's own project.
## Contributing
If you would like to contribute to Baldur's Gate 3 Community Library, there are
a few ways: You can join the team, make independent contributions, or make
suggestions!
#### Joining the Team
Ask! Ping @NellsRelo on the official Baldur's Gate 3 Discord's modding section, or via the Nexus release.
#### Independent Contribution
[](https://GitHub.com/BG3-Community-Library-Team/BG3-Community-Library/network/)
If you'd like to make contributions, please make a fork of the repository, add
and test your changes, and then submit a pullrequest to this repo. We'll review
it, and if all goes well, we'll either add your contribution, or provide
reasoning as to why we won't.
Whether you join the team or want to make an independent contribution, there's
a [quick summary](https://github.com/BG3-Community-Library-Team/BG3-Community-Library/wiki/Making-Contributions)
and a [more in-depth](https://github.com/BG3-Community-Library-Team/BG3-Community-Library/wiki/Setting-up-a-Development-Environment)
guide on contributing to the project.
#### Making Suggestions
This is the easiest way to contribute - Create an [Issue](https://github.com/BG3-Community-Library-Team/BG3-Community-Library/issues)
with either a Bug Report or Feature Request template, depending on whether you
are encountering a bug or requesting a feature be added. Please be very detailed
when creating an issue - the more detail you add, the easier it is to be
addressed.
More detail on making contributions can be found [here](https://github.com/BG3-Community-Library-Team/BG3-Community-Library/wiki/Making-Contributions).
#### Not interesting in contributing, but want to make use of the pack, or just curious?
That's what this pack is here for! See how to use content from this library in your own mods [here!](https://github.com/BG3-Community-Library-Team/BG3-Community-Library/wiki/Using-Community-Library-Content)
## Installation
This mod works with [Baldur's Gate 3 Mod Manager](https://github.com/LaughingLeader/BG3ModManager), and possible 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 CommunityLibrary.pak
5. Once imported hit refresh
6. Drag CommunityLibrary to the top of 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
- [ImprovedUI](https://github.com/TheRealDjmr/BG3ImprovedUI)
- Makes improvements to the UI during Character Creation, and removed an error
that only appears when using mods.
- [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
- [BG3 Best Practices Wiki](https://github.com/Baldurs-Gate-3-modders/Best-Practices-Wiki/wiki)
## Acknowledgements
- Larian Software, for working on Baldur's Gate 3 and bringing 5th Edition to PC
- The Baldur's Gate 3 Modding Community
- [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