search

BG3-Community-Library-Team / BG3-Compatibility-Framework

An API-based Driven Compatibility Framework for Baldur's Gate 3 Mods
MIT License
38 stars 13 forks source link

Typo in the filename suggested to create in the "Adding a Subclass to the Compatibility Framework" documentation #61

Closed fparent closed 9 months ago

fparent commented 9 months ago

To use the CF's API, be sure you have your mod set up for the Script Extender. Adjacent to your BootstrapClient.lua and BootstrapServer.lua files, create a file titled InitCompatabilityFramework.lua. In your BoostrapClient.lua and BootstrapServer.lua files, paste the following:

Ext.Require("InitCompatibilityFramework.lua").

Now paste this into your InitCompatibilityFramework.lua file:

The filename suggested to created is "InitCompatabilityFramework" (notice the "Compata") but then the required statement specificies the correct filename "InitCompati"

People blindly copying that name from the documentation will get an error in their mod importing the file