Page 1 of 1

Changelog.txt Question

Posted: Thu May 24, 2018 5:54 pm
by TheSAguy
What are the formatting requirements of the Changelog.txt?

I know you can't use a tab in there, but what else?
A lot of the time, mine is not showing up and it's due to a formatting issue, but I don't know what it is.
Log
Thanks.

Re: Changelog.txt Question

Posted: Thu May 24, 2018 6:10 pm
by Bilka
Usually, the issue is described in the log file. But for the changelog the rule is just: Copy everything about the vanilla one. Date formatting, section names, everything.

Re: Changelog.txt Question

Posted: Thu May 24, 2018 7:47 pm
by steinio
The file format needs to be UTF8 without BOM

I only now how to setup this in Notepad++ or VSCode if you use this.

Re: Changelog.txt Question

Posted: Thu May 24, 2018 9:58 pm
by TheSAguy
I use Notepad ++
Like to know how please.

Re: Changelog.txt Question

Posted: Fri May 25, 2018 3:57 pm
by orzelek
In encoding menu make sure it's set to UTF-8 enconding.
Or click convert to UTF-8 just in case.

Re: Changelog.txt Question

Posted: Fri May 25, 2018 6:15 pm
by steinio
orzelek wrote:In encoding menu make sure it's set to UTF-8 enconding.
Or click convert to UTF-8 just in case.
notepad++_2018-05-25_20-12-53.png
notepad++_2018-05-25_20-12-53.png (20.87 KiB) Viewed 2436 times
Or Convert to UTF8 for existing files.

Re: Changelog.txt Question

Posted: Sat May 26, 2018 8:41 pm
by eradicator
steinio wrote:The file format needs to be UTF8 without BOM
This is a myth that people need to stop spreading, with/without BOM or plain ASCII all work fine.
My guess would be on the superflous newlines at the end of each entry.

Re: Changelog.txt Question

Posted: Tue May 29, 2018 8:51 am
by bobingabout
I tried starting to write these official changelog files in my mods.

then I realised... I couldn't even figure out how to make them show up in the game. like, where do you even go to see a mod's changelog? I just couldn't find it anywhere.

so I stopped updating them.

Re: Changelog.txt Question

Posted: Tue May 29, 2018 4:25 pm
by eradicator
bobingabout wrote:then I realised... I couldn't even figure out how to make them show up in the game
Right there in the mod manager....
changelog.jpg
changelog.jpg (91.12 KiB) Viewed 2377 times
The button is generated when entering the menu btw, so when you want to add a changelog to a mod you don't have to restart the whole game, just go back to the main menu and then back to the mod menu. (If changelog.txt is malformed the button does not appear.)

Re: Changelog.txt Question

Posted: Wed May 30, 2018 8:56 am
by bobingabout
eradicator wrote:
bobingabout wrote:then I realised... I couldn't even figure out how to make them show up in the game
Right there in the mod manager....
changelog.jpg
The button is generated when entering the menu btw, so when you want to add a changelog to a mod you don't have to restart the whole game, just go back to the main menu and then back to the mod menu. (If changelog.txt is malformed the button does not appear.)
Well, I looked there, and my change logs didn't seem to show up. Check some of my mods, I can't remember which have the files, maybe bobplates and boblogistics.

Re: Changelog.txt Question

Posted: Wed May 30, 2018 4:27 pm
by eradicator
bobingabout wrote:
eradicator wrote:
bobingabout wrote:then I realised... I couldn't even figure out how to make them show up in the game
Right there in the mod manager....
changelog.jpg
The button is generated when entering the menu btw, so when you want to add a changelog to a mod you don't have to restart the whole game, just go back to the main menu and then back to the mod menu. (If changelog.txt is malformed the button does not appear.)
Well, I looked there, and my change logs didn't seem to show up. Check some of my mods, I can't remember which have the files, maybe bobplates and boblogistics.
Like i said. If the file is malformed the button won't show. And malformed can be something as annoyingly trivial as one(!) extra space >_<#.