cstdotnet/changelog.md
Tony Bark f01ac8970a Nuget badge in README
- Explained UIText and Release Cycle a lot more clearly, I hope
2022-10-10 04:27:15 -04:00

2.1 KiB

Change Log

2.0.100

This version supports both .NET Standard 2.1 and .NET 6 and brings with it (much needed) quality of life changes internally. Apart from that, nothing has changed to the API itself apart from much needed documentation.

New Release Cycle

Because this library has no third-party dependencies, CST.NET's release cycle will generally follow .NET's LTS cycle. This is why .NET 5 was skipped. Minor releases will consist of targeting latest LTS. For example, 2.1 will drop Standard 2.1 (ironically) in favor of .NET 8.0, 6.0 will continue to be targeted until it's end of life and 2.2 will strictly target 8.0. This should ensure continues security updates and Enterprise-grade support.

UIText class and interface

Based on FreeSO's API, the UIText class allows for traversing in /<directory>/<language>.dir directories and searching CST files by their Id number. (e.g. _154_miscstrings.cst). By defualt, the base path is /<program directory>/uitext/<language>.dir. You may also create your own implementation based on these APIs using the IUIText interface which mine also uses.

For more info, see usage.md.

1.0.300

  • Minor patch.

1.0.3

  • Backport switch to CSTNet namespace
  • Internal improvements.

1.0.2

  • Fixed the multiple line parsing in the v2 format.
  • Replaced "[ENTRY NOT FOUND]" message with "***MISSING***".

1.0.1

Despite only being a patch release, this includes a major refinement to the normalizing algorithm.

Rewrote normalizing algorithm

The normalizing algorithm has been rewritten to be more efficient and hopefully more reliable. The new algorithm de-constructs each line after converting it to the system's native line ending. Then it searches for the key and returns value. The rewrite also normalizes line endings to match the system's within the entry itself before returning the final output. This should make things more stable and predictable.

Known issues

  • Skipping comments is still a little buggy.
  • Multiline parsing with the v2 format is still a little unpredictable.

1.0.0

  • Initial release.