Changelog.txt Question

[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

Code: Select all

Version: 2.5.8
Date: 5. 24. 2018
  Features:
    - Rebalanced Electric items if Bob's is present
    - Added a secont Pellet-Coke recipe if Bob's/Angels

---------------------------------------------------------------------------------------------------
Version: 2.5.7
Date: 5. 19. 2018
  Bugfixes:
    - Fixed Sailine Water color

---------------------------------------------------------------------------------------------------
Version: 2.5.6
Date: 5. 19. 2018
  Bugfixes:
    - Added Lithia Water if only Angels
  Features:
    - Changed color of Sailine Water

---------------------------------------------------------------------------------------------------
Version: 2.5.5
Date: 5. 18. 2018
  Features:
    - New Drill Artwork - Thx YuokiTani - Thx to Darkfrei for helping with positioning
    - Option to change the color of the water - Thx Fishycat

---------------------------------------------------------------------------------------------------
Version: 2.5.4
Date: 5. 14. 2018
  Features:
    - EXPERIMENTAL You have an option to make fluids not be infinite
    - Need help testing and balancing
    - You can now also prospect for these fluids

---------------------------------------------------------------------------------------------------
Version: 2.5.3
Date: 5. 14. 2018
  Bugfixes:
    - Power Rail Fix Should work much better on NEW placed rail
  Features:
    - Moved Solar Entities to the Bio Industries Tab

---------------------------------------------------------------------------------------------------
Version: 2.5.2
Date: 5. 3. 2018
  Bugfixes:
    - Power Rail Fix. 0.16.40 Seemed to cause an issue
  Features:
    - Coke-Coal renamed to Pellet-Coke and now compatible with Angels Mods
    - Re-ordered some Bio Industrie stuff

---------------------------------------------------------------------------------------------------

Thanks.

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

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

[TheSAguy]

I use Notepad ++
Like to know how please.

[orzelek]

In encoding menu make sure it's set to UTF-8 enconding.
Or click convert to UTF-8 just in case.

[steinio]

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 (20.87 KiB) Viewed 1840 times

Or Convert to UTF8 for existing files.

[eradicator]

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.

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

[eradicator]

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 (91.12 KiB) Viewed 1781 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.)

[bobingabout]

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.

[eradicator]

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