Editing Modding:Creating meta.lsx

}}{{Modding box}}{{Modding sidebar}}

 

== Tools You'll Need ==

* [https://code.visualstudio.com/ VSCode] or [https://notepad-plus-plus.org/ Notepad++]

* UUID Generator Extension in VSCode OR ToolBucket & XML Tools in Notepad++ found via Plugins > Plugins Admin then search for it and install.

 

 

To generate a UUID in VSCode, you can highlight a section or click in a blank area, right click, and select Generate UUID here.

For the UUID generation in Notepad++, once ToolBucket is installed, you want to press Alt + Shift + G. It will bring up a window as shown below. Keep '''Include hyphens''' ticked, and you can also click '''Don't ask again''' if you won't use any of the other options. Then click Generate.

Most pak mods need a meta.lsx. A meta.lsx is a file that tells the mod loader certain "meta" information about your mod. This is information such as author's name, version number, etc.

The ''ModName'' folder is your workspace folder for your mod. Each mod needs one, and it holds all of the other folders. Then you would create a folder called Mods, then a new folder with a custom name (could be same as the mod name) this is what will be known as ''YourShared'' folder, and then finally you want to create a .txt file and rename it to meta.lsx.

=== Creating your meta.lsx manually ===

Here is the template for meta.lsx. Just paste this into the meta.lsx file you created earlier, and then follow the instructions to edit the template.

Version numbers in the meta.lsx are in a Int64 format. When read by BG3 Mod Manager, this line reads as 1.0.0.0. You can use BG3 Mod Manager, the multitool or Padme's mini tool to generate this Int64 version number. This is also the line you change for each new update.

This version number is the version it was when published. Can remain this number even when updating. However, you can make it the same number as the update number. The reason this exists is for Larian more than it is for us. This is because if they ever make a new pak during development their ``PublishVersion`` will be whatever their current game version is when that pak is created.

If your mod is dependent on another mods assets (remember get permission) it is best to add that mod as a dependency learn how [[Modding:Dependencies|here.]]

=== Generating a Version Number with the tools ===

You can generate a version number with Multitool, BG3 Mod Manager or Padme's mini tool. Here is how:

Use the up and down arrows on the Major/Minor/Revision/Build, and it will change the number below. Once set to the version you want, use the copy button on the second line and paste it into the first of this line in your meta:

In BG3 Mod Manager go to Tools > Toggle Version Generator Window, or alternatively while open press Ctrl + G to open it. As below:

Use the up and down arrows on the Major/Minor/Revision/Build, and it will change the number below. Once set to the version you want, use the copy button and paste it into the first of this line in your meta:

Use the up and down arrows on the first and last number and it will change the number below. Once set to the version, you want to either highlight the text in the box and copy and paste it into the first of this line in your meta:

Or use the '''Save to''' button, then locate your meta.lsx and it will override the lines for you.

=== Creating your meta.lsx with the Multitool ===

Once your mod is complete and ready to be tested in-game, create a Mods folder inside your workspace folder, then drag your workspace folder to the blue box that says "Drop mod workspace folder or a mod.pak here". If your Mods folder doesn't have a meta.lsx, it will bring up this popup:

In the Author box, put the name you go by on nexusmods, or whatever you want.

In Description, describe your mod a little, can be anything.

Then choose your version number for your mod. Once ready, you can click the confirm button.

If wanting to update the number, you can delete your meta.lsx and drag your workspace folder again over to the blue box, which will trigger this popup again.

=== Creating your meta.lsx with bg3 mini tool by Padme4000 ===

If you find it easier to follow videos or have a video alongside a written tutorial, please find my video [https://youtu.be/tanDAq3JKPU?si=P4aJ3Rul4MeKIxdU here] on how to use that section of my tool.

* use the generated unique uuid button and then click update once it's generated.

Congrats! Your meta.lsx is ready to go.