Modding:Creating meta.lsx: Difference between revisions

Jump to navigation Jump to search
m
no edit summary
mNo edit summary
Line 9: Line 9:
* [https://github.com/ShinyHobo/BG3-Modders-Multitool BG3 Modders Multitool]
* [https://github.com/ShinyHobo/BG3-Modders-Multitool BG3 Modders Multitool]
* [https://www.nexusmods.com/baldursgate3/mods/502 BG3 Mini Tool]
* [https://www.nexusmods.com/baldursgate3/mods/502 BG3 Mini Tool]
* [https://code.visualstudio.com/ vscode] or [https://notepad-plus-plus.org/ Notepad++]
* [https://code.visualstudio.com/ VSCode] or [https://notepad-plus-plus.org/ Notepad++]
* UUID Generator Extension in vscode (right click when its installed to generate a new uuid)
* UUID Generator Extension in VScode OR ToolBucket & XML Tools in Notepad++ found via Plugins > Plugins Admin then search for it and install.
* ToolBucket & XML Tools in Notepad++ found via Plugins > Plugins Admin then search for it and install.


For the UUID generation in Notepad++ once installed ToolBucket 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.
 
To generate a UUID in VSCode, just highlight a section of code, 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.


[[File:Toolbucketuuid.webp]]
[[File:Toolbucketuuid.webp]]
Line 19: Line 21:
== Meta.lsx ==
== Meta.lsx ==


So 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.
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 file path should be: ''ModName''/Mods/''YourShared''/meta.lsx
The file path should be: ''ModName''/Mods/''YourShared''/meta.lsx


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


The only time your mod won't need a meta.lsx if it is classed as a basegame override. You will know them by the mods that get put into the Overrides section of BG3 Mod Manager or have that orange highlight to them. In some cases, you may still add a meta just so people can place the mod into their load order if they prefer.
The only time your mod won't need a meta.lsx if it is classed as a basegame override. You will know them by the mods that get put into the Overrides section of BG3 Mod Manager or have that orange highlight to them. In some cases, you may still add a meta just so people can place the mod into their load order if they prefer.


=== Creating your meta.lsx Manually ===
=== Creating your meta.lsx manually ===
Here is the template for meta.lsx.
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.
  <?xml version="1.0" encoding="UTF-8"?>
  <?xml version="1.0" encoding="UTF-8"?>
  <save>
  <save>
Line 95: Line 97:
                     <attribute id="Version64" type="int64" value="36028797018963968"/>
                     <attribute id="Version64" type="int64" value="36028797018963968"/>


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 version number. This is also the line you change for each new update.
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.


                         <node id="PublishVersion">
                         <node id="PublishVersion">
Line 105: Line 107:
And that is all you need to edit for this file.
And that is all you need to edit for this file.


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


You can generate a version number with multitool, bg3 mod manager and the mini tool. Here is how:
You can generate a version number with Multitool, BG3 Mod Manager or Padme's mini tool. Here is how:


==== Multitool ====
==== Multitool ====
Line 119: Line 121:
[[File:BG3 Multitool version number editor.webp]]
[[File:BG3 Multitool version number editor.webp]]


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:
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:


                     <attribute id="Version64" type="int64" value="36028797018963968"/>
                     <attribute id="Version64" type="int64" value="36028797018963968"/>
Line 125: Line 127:
==== BG3 Mod Manager ====
==== BG3 Mod Manager ====


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


[[File:Bg3mm version number.webp]]
[[File:Bg3mm version number.webp]]
Line 133: Line 135:
[[File:Bg3mm version number01.webp]]
[[File:Bg3mm version number01.webp]]


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 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:


                     <attribute id="Version64" type="int64" value="36028797018963968"/>
                     <attribute id="Version64" type="int64" value="36028797018963968"/>
Line 145: Line 147:
It will open the current extra tools of the mini tool.  
It will open the current extra tools of the mini tool.  


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 use either highlight the text in the box and copy 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:


                     <attribute id="Version64" type="int64" value="36028797018963968"/>
                     <attribute id="Version64" type="int64" value="36028797018963968"/>


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


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


Once your mod is complete and ready to be tested in-game, create a Mods folder in 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:
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:


[[File:Metacreationbg3multitool.webp]]
[[File:Metacreationbg3multitool.webp]]


In the Author box, put the name you go by on nexusmods or whatever you want.
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.
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.
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 it creates and drag your workspace folder again over the blue box.
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 ===
=== 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.
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.


Once you open the tool you will see a button called meta that is the one we want.
Once you open the tool you will see a button called meta that is the one we want.
Line 199: Line 201:
Now you can click save as and go save your file in the ModName/Mods/YourShared folder.
Now you can click save as and go save your file in the ModName/Mods/YourShared folder.


Congrats your meta.lsx is ready to go
Congrats your meta.lsx is ready to go.

Navigation menu