2024-04-09 09:26:59 -04:00
# [CST.NET](http://CST.NET)
2020-12-08 17:56:38 -05:00
2024-04-09 09:26:59 -04:00
< p align="center"> < a href="https://github.com/tonytins/cstdotnet/blob/main/LICENSE"> < img src="https://img.shields.io/github/license/tonytins/cstdotnet" alt="GitHub license"> < /a> < a href="https://github.com/tonytins/cstdotnet/actions?query=workflow%3Abuild.yml"> < img src="https://img.shields.io/github/actions/workflow/status/tonytins/cstdotnet/build.yml" alt="GitHub Workflow Status"> < /a> < img src="https://img.shields.io/github/commit-activity/w/tonytins/cstdotnet" alt="GitHub commit activity"> < a href="code_of_conduct.md"> < /br> < img src="https://img.shields.io/codeclimate/maintainability-percentage/tonytins/cstdotnet" alt="Code Climate maintainability"> < img src="https://img.shields.io/nuget/dt/CSTNet" alt="NuGet Downloads"> < a href="https://www.nuget.org/packages/tonybark.updatetools"> < img src="https://img.shields.io/nuget/v/cstnet.svg" /> < /a> < /br> < img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant"> < /a> < /br> < /p>
2023-01-07 12:36:03 -05:00
2024-04-09 09:26:59 -04:00
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.
2023-08-18 01:46:47 -04:00
2024-04-09 09:26:59 -04:00
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.
2022-04-29 06:39:56 -04:00
2022-10-10 04:27:15 -04:00
## Changelog
2023-08-10 22:41:12 -04:00
See [changelog.md ](./doc/changelog.md )
2022-10-10 04:27:15 -04:00
2020-12-08 20:13:18 -05:00
## Usage
2020-12-08 17:56:38 -05:00
2023-08-10 22:41:12 -04:00
See [/docs ](./doc/README.md ).
2020-12-08 20:13:18 -05:00
2020-12-08 17:56:38 -05:00
## To-do
2024-04-09 09:26:59 -04:00
- [ ] Support for parameters (e.g. `%1` )
2020-12-08 18:46:52 -05:00
2020-12-09 22:34:45 -05:00
## Known issues
2021-11-19 13:52:26 -05:00
- Skipping comments is a little unpredictable.
2020-12-09 22:34:45 -05:00
2020-12-08 18:46:52 -05:00
## Requirements
2022-04-29 06:39:56 -04:00
- [.NET ](https://dotnet.microsoft.com/download ) 6 or later.
2022-07-21 10:23:31 -04:00
- IDEs or Editors
- [Visual Studio Code ](https://code.visualstudio.com/ )
- [Visual Studio 2022 ](https://visualstudio.microsoft.com/ )
2021-11-19 13:52:26 -05:00
- [.NET Interactive ](https://github.com/dotnet/interactive/blob/main/README.md ) for notebooks (optional).
2022-10-10 02:54:46 -04:00
- [VSCode Extension ](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.dotnet-interactive-vscode ) or [nteract ](https://nteract.io/ ).
2020-12-08 17:56:38 -05:00
2024-04-09 09:26:59 -04:00
# Contributing
You can contribute to CST.NET by testing cutting edge features in the latest releases, filing bugs, and joining in the discussion on our forums!
* [Getting Started ](https://github.com/tonytins/cstdotnet/wiki )
* [Project Structure ](https://github.com/tonytins/cstdotnet/wiki/Project-structure )
* [Coding Standards ](https://github.com/tonytins/cstdotnet/wiki/Coding-standards )
* [Pull Requests ](https://github.com/tonytins/cstdotnet/pulls ): [Open ](https://github.com/tonytins/cstdotnet/pulls )/[Closed ](https://github.com/tonytins/cstdotnet/issues?q=is%3Apr+is%3Aclosed )
Looking for something to do? Check out the issues tagged as [help wanted ](https://github.com/tonytins/cstdotnet/labels/help%20wanted ) to get started.
Regarding translations, full object and UI translations should currently be released on the forums. This is far from perfect and is due to be reworked. Stay tuned!
2020-12-08 17:56:38 -05:00
## License
2024-04-09 09:26:59 -04:00
I license this project under the BSD-3-Clause license - see [LICENSE ](LICENSE ) for details.
