-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Include Localization Template - Include meta.lsx Template - Include Readme Template - Add General Folder Structure Signed-off-by: NellsRelo <[email protected]>
- Loading branch information
Showing
3 changed files
with
151 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| <!-- | ||
| You'll want to use Modder's Multitool to generate the contentuid value, by ticking the "Handle" checkbox and hitting Generate | ||
| --> | ||
|
|
||
| <contentList date="9/3/2023 18:38"> | ||
| <content contentuid="hcbbb0c35g4534g4892ga604gc2ec1fc9696c" version="1">Localized Text Here</content> | ||
| </contentList> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!-- | ||
| You'll want to change the following fields: | ||
| - Author - Your Preferred Author Name | ||
| - Description - A Description of your Mod | ||
| - Folder - The Primary Folder used in your Mod - in this case, TemplateMod | ||
| - Name - What to display in the Mod Manager | ||
| - Tags - A semi-colon separated list of keywords for your mod | ||
| - UUID - Generate this with the Modder's Multitool, any extension for your IDE, or at https://www.uuidgenerator.net/version4 | ||
| - Version64 - Both of them. BG3MM has a Version String Generator tool, under Tools -> Toggle Version Generator Window | ||
| --> | ||
|
|
||
| <save> | ||
| <version major="4" minor="0" revision="0" build="49"/> | ||
| <region id="Config"> | ||
| <node id="root"> | ||
| <children> | ||
| <node id="Dependencies"/> | ||
| <node id="ModuleInfo"> | ||
| <attribute id="Author" type="LSWString" value="BG3 Community"/> | ||
| <attribute id="CharacterCreationLevelName" type="FixedString" value=""/> | ||
| <attribute id="Description" type="LSWString" value="A Basic Template for setting up a new BG3 mod"/> | ||
| <attribute id="Folder" type="LSWString" value="TemplateMod"/> | ||
| <attribute id="GMTemplate" type="FixedString" value=""/> | ||
| <attribute id="LobbyLevelName" type="FixedString" value=""/> | ||
| <attribute id="MD5" type="LSString" value=""/> | ||
| <attribute id="MainMenuBackgroundVideo" type="FixedString" value=""/> | ||
| <attribute id="MenuLevelName" type="FixedString" value=""/> | ||
| <attribute id="Name" type="FixedString" value="TemplateMod"/> | ||
| <attribute id="NumPlayers" type="uint8" value="4"/> | ||
| <attribute id="PhotoBooth" type="FixedString" value=""/> | ||
| <attribute id="StartupLevelName" type="FixedString" value=""/> | ||
| <attribute id="Tags" type="LSWString" value="Template"/> | ||
| <attribute id="Type" type="FixedString" value="Add-on"/> | ||
| <attribute id="UUID" type="FixedString" value="faef6819-403e-460d-83f4-c8788a854773"/> | ||
| <attribute id="Version64" type="int64" value="36028797018963968"/> | ||
| <children> | ||
| <node id="PublishVersion"> | ||
| <attribute id="Version64" type="int64" value="36028797018963968"/> | ||
| </node> | ||
| <node id="Scripts" /> | ||
| <node id="TargetModes"> | ||
| <children> | ||
| <node id="Target"> | ||
| <attribute id="Object" type="FixedString" value="Story"/> | ||
| </node> | ||
| </children> | ||
| </node> | ||
| </children> | ||
| </node> | ||
| </children> | ||
| </node> | ||
| </region> | ||
| </save> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # Sample Template Mod | ||
| [](https://GitHub.com/BG3-Community-Library-Team/Sample-Template/releases/) [](https://GitHub.com/BG3-Community-Library-Team/Sample-Template/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. | ||
|
|
||
| It also acts as a compatibility patch for an ever-growing list of subclass mods. You can see [a list of subclasses supported here](https://github.com/BG3-Community-Library-Team/BG3-Community-Library/wiki/Subclass-Compatibility-Framework) | ||
|
|
||
| ## 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 | ||
| 4. Do this again for CommunityLibraryDummies.pak | ||
| 5. Once imported hit refresh | ||
| 6. Drag CommunityLibrary to the top of the Left pane, but beneath any mods that add Subclasses | ||
| 7. Drag CommunityLibraryDummies to the very 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 |