Adding changelogs
Learn how to add changelogs to your mod.
Intro
We're going to add changelogs to our mod that will appear along with changelogs from other enabled mods. When new changelogs are added, a popup will appear for the player, letting them know of the change.
Setting up
Changelogs tend to be quite long. To keep things organized, you generally want to keep all the changelogs in a dedicated file.
Let's create a new file in our mod called changelogs.lua. Make sure you include it in your main.lua file, or else it won't be loaded.
Adding changelogs
Adding changelogs is super easy. Just use the AddChangelog function of the DeadSeaScrollsMenu global.
The first argument is variadic and can be up to 4 arguments long. It is used to categorize your changelogs and place them under up to 4 layers of buttons. Typically, the first argument is your mod's name and the second argument is the version your changelogs are for.
The final argument should be the string that is your changelog. You can define a long string with two square bracket pairs. Long strings can span across multiple lines without needing to define a new line with .
Unlike other strings, the strings provided in these arguments are automatically converted to lowercase. This lets you copy and paste changelogs from other places without needing to edit much.
Formatting codes
You can add formatting codes to your changelogs. These can do various things, such as changing font size and text color.
You can edit the font size of a line by adding a font size tag to the beginning of it. The font size is 1 by default. There is no tag for setting the size to 1.
{FSIZE2}
A large font size.
{FSIZE3}
A very large font size.
Font size codes will remove any text before them in the line, so they should always be used at the start of a new line.
You can download the example mod and inspect how it works below.
Last updated
