cstdotnet/README.md

CST.NET

CST.NET is a library for parsing Maxis' key-value pair format. It can be used in conjunction with your own custom frameworks, or the original UIText APIs.

Caret-Separated Text (or CST) is a key-value pair format represented by digits or words as keys and the value as text enclosed between carets. (e.g. <key> ^<text>^) Any text which is not enclosed with carets is considered a comment and ignored. Neither strings nor comments may use the caret character.

Changelog

See changelog.md

Usage

See /docs.

To-do

• Support for parameters (e.g. %1)

Known issues

• Skipping comments is a little unpredictable.

Requirements

• .NET 6 or later.
• IDEs or Editors
  • Visual Studio Code
  • Visual Studio 2022
• .NET Interactive for notebooks (optional).
  • VSCode Extension or nteract.

License

I license this project under the BSD-3-Clause license - see LICENSE for details.