Change Log

CHANGELOG.md

The main changelog is located in the repo at: https://github.com/CitiesSkylinesMods/TMPE/blob/master/CHANGELOG.md

The badges and their links which appear at the top are automatically updated, so you don't need to change those. The Legend section only needs updating when a new workshop page is created to provide some brief details of the history of the mod.

The heading format is important because What's New panel can link to them. Example below:

The resulting anchor link to a heading (when you hover mouse over the rendered markdown) should look something like:

The general sequence of entries should be:

• Added

• Fixed

• Updated

• Removed

• Meta (if applicable)

• Steam (link to the workshop page of the release)

README.md

Again, this has some badges at top, most of which automatically update. However, you'll need to update the game version badge manually each time CO/PDX release a new DLC or CCP.

In the HTML above, update the version as applicable (it's showing version v1.13.0-f8 in the example above).

The page also contains release notes for the most recent STABLE and TEST releases — these can be copied and pasted from CHANGELOG.md.

What's New panel

A curated changelog is displayed in-game whenever the mod is updated. The details are pulled from the what's_new.txt resource in the TLM/TLM/Resources folder.

Each release has a [Version] ... [/Version] block in the file, for example:

The tags are:

• [Version] — postfix the mod version number (see above for example)

  • This appears in purple panel in the UI

• [Stable] — this keyword indicates a version has been released to STABLE workshop page

  • In STABLE releases, only the [Stable] versions are displayed (others hidden)

• [Released] — postfix the release date (month day year)

  • This appears next to the version number in the UI

• [Link] (optional) - the anchor link (excluding #) for the CHANGELOG.md file as discussed earlier on this page

  • If present, the date shown in UI will be hyperlinked to the changelog

• Changelog items (there can be zero or more of each of these):

  • [New] (green lozenge in UI) - for new features or major overhauls (e.g. rewrite of speed limits UI)

  • [Mod] (amber lozenge in UI) - anything relating to other mods (e.g. marked (in)compatible, etc.)

  • [Fixed] (blue lozenge in UI) - bug fixes or other resolved issues

  • [Updated] (blue lozenge in UI) - an existing feature was updated (e.g. to improve performance etc.)

  • [Removed] (red lozenge in UI) - when obsolete code/feature is removed

  • Note: Changelog items are automatically sorted in to the order shown above

• [/Version] - must appear at end of each version block

The TMPE.log file will detail any errors in the parsing process (you'll usually see an error on the main menu screen as well).