Tutorial:Mod changelog format

TODO mod portal doesnt parse changelog like this completely empty lines are ignored?

• Parsing errors can be found in the log file in the user data directory.

Important general format

• Do not use tabs
  • Indentation is done with two spaces
• Do not leave whitespace at the end of lines

Usually, text editors can enforce this automatically, it is recommended to set this up.

Example

It may be simpler to copy this example into your changelog and modify it than to start from scratch.

---------------------------------------------------------------------------------------------------
Version: 1.1.60
Date: 06. 06. 2022
  Features:
    - This is an entry in the "Features" category.
    - This is another entry in the "Features" category.
  Balancing:
    - This is a multiline entry in the "Balancing" category.
      There is some extra information here because it is needed for the example.
      Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
  Bugfixes:
    - Fixed that item requests didn't subtract items picked up from ground when reviving ghosts. (https://forums.factorio.com/102329)
    - Fixed burner inserter would not fuel itself when drop target was full. (https://forums.factorio.com/102449)
---------------------------------------------------------------------------------------------------
Version: 1.1.66
Date: 19. 08. 2022
  Major Features:
    - Initial release.

Formatting rules

#Important general format applies everywhere and will lead to confusing error messages if not followed.

Version start (?) Sections start?

Must start with exactly --------------------------------------------------------------------------------------------------- followed by a newline.

The next line must be a #Version line.

Version

Must start with exactly Version: , note the space after the colon. The remaining part of the line will be parsed as the version TODOthe section is about. TODO version format TODO duplication? TODO must be given

Date

Must start with exactly Date: , note the space after the colon. The remaining part of the line will be parsed as the dateTODO the version was released. TODO data format TODO duplication?

Category

Must start with exactly two spaces. The remaining part of the line will be parsed as the category. Must end with a colon (reminder, no whitespace at end of line!). This colon is removed for the purpose of display. TODO names and sorting

Entry

Must start with exactly four spaces followed by exactly - (note the space after the dash) for a single line entry. For a multiline entry, lines after the first line must start with exactly six spaces. TODO