Tutorial:Mod changelog format: Difference between revisions
(Added example and info easily found in source code, added more todos) |
(More version and date info, decide to call the thing between the dash lines "version section") |
||
| Line 3: | Line 3: | ||
mod portal doesnt parse changelog like this | mod portal doesnt parse changelog like this | ||
completely empty lines are ignored? | completely empty lines are ignored? | ||
mod structure tutorial link for where the file should be | |||
* Parsing errors can be found in the [[log file]] in the [[user data directory]]. | * Parsing errors can be found in the [[log file]] in the [[user data directory]]. | ||
| Line 13: | Line 14: | ||
* Do not use tabs | * Do not use tabs | ||
** Indentation is done with two spaces | ** Indentation is done with two spaces | ||
* Do not leave whitespace at the end of lines | * Do not leave whitespace at the end of lines ("trailing spaces") | ||
Usually, text editors can enforce this automatically, it is recommended to set this up. | Usually, text editors can enforce this automatically, it is recommended to set this up. | ||
| Line 42: | Line 43: | ||
[[#Important general format]] applies everywhere and will lead to confusing error messages if not followed. | [[#Important general format]] applies everywhere and will lead to confusing error messages if not followed. | ||
=== Version start | TODO One section per version. | ||
=== Version section start === | |||
Must start with exactly <code>---------------------------------------------------------------------------------------------------</code> followed by a newline. | Must start with exactly <code>---------------------------------------------------------------------------------------------------</code> followed by a newline. | ||
The next line must be a [[#Version]] line. | The next line must be a [[#Version]] line. | ||
=== Version === | === Version === | ||
Must start with exactly <code>Version: </code>, note the space after the colon. The remaining part of the line will be parsed as the version | Must start with exactly <code>Version: </code>, note the space after the colon. The remaining part of the line will be parsed as the version the section is about. TODO version format<br> | ||
There may not be two version sections with the same version.<br> | |||
This line is mandatory. | |||
=== Date === | === Date === | ||
Must start with exactly <code>Date: </code>, note the space after the colon. The remaining part of the line will be parsed as the | Must start with exactly <code>Date: </code>, note the space after the colon. The remaining part of the line will be parsed as the date the version was released. TODO no format restrictions (beside not putting a newline in there lol) | ||
TODO duplication | TODO duplication is fine<br> | ||
This line is optional. | |||
=== Category === | === Category === | ||
| Line 59: | Line 63: | ||
=== Entry === | === Entry === | ||
Must start with exactly four spaces followed by exactly <code>- </code> (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. | Must start with exactly four spaces followed by exactly <code>- </code> (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.<br> | ||
Entries in the same version and the same category may not be exact duplicates. | |||
TODO | TODO | ||
Revision as of 15:27, 10 November 2022
TODO mod portal doesnt parse changelog like this completely empty lines are ignored? mod structure tutorial link for where the file should be
- 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 ("trailing spaces")
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.
TODO One section per version.
Version section 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 the section is about. TODO version format
There may not be two version sections with the same version.
This line is mandatory.
Date
Must start with exactly Date: , note the space after the colon. The remaining part of the line will be parsed as the date the version was released. TODO no format restrictions (beside not putting a newline in there lol)
TODO duplication is fine
This line is optional.
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.
Entries in the same version and the same category may not be exact duplicates.
TODO