tonytins/cstdotnet
1
0
Fork 0
mirror of https://github.com/tonytins/cstdotnet.git synced 2025-10-16 01:03:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Support for funding

Browse source 
- Issue and pull request templates
This commit is contained in:
Tony Bark 2020-12-09 22:34:45 -05:00
parent 0e6ba4f99d
commit ccb4da5b86
5 changed files with 39 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -2,11 +2,14 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)
Caret-Separated Text (or CST) is a key-value pair format represented by numbers or words as keys and the value is the string enclosed between carets (^) that contains the contents. CST.NET is a library for parsing the CST format.
Caret-Separated Text (or CST) is a key-value pair format represented by numbers or words as keys and the value is the string enclosed between carets (^) that contains the contents. Any text which is not enclosed with carets is considered a comment and ignored. Neither strings nor comments may use the caret character.
CST.NET is a library for parsing the CST format.
## Usage
```csharp
#r "nuget:CSTNet,1.0.0"
using System;
using System.IO;
using CSTNet;
@ -19,15 +22,19 @@ Console.WriteLine(example);
In production, CST files were used in The Sims Online to provide translations. Each translation was split into their respective directories:
- ``uitext/english.dir/hints/toolbar.cst``
- ``uitext/swedish.dir/hints/toolbar.cst``
- ``uitext/english.dir/hints/_154_miscstrings.cst``
- ``uitext/swedish.dir/hints/_154_miscstrings.cst``
As long as the key remained the same, it didn't matter what directory the file was located in.
CST.NET only provides the basic parsing functionality.
## To-do
- [ ] Support for arguments (e.g. ``%1``)
## Known issues
- Reading multiple lines
## Requirements
### Prerequisites