tonytins/cstdotnet
1
0
Fork 0
mirror of https://github.com/tonytins/cstdotnet.git synced 2025-03-22 08:22:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated README to the QuickFennec.CST name

Browse source
This commit is contained in:
Tony Bark 2020-12-11 01:44:45 -05:00
parent a6926ee6f6
commit 8ad3dd76e5
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,18 +1,18 @@
# CSTNet # QuickFennec.CST
[![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) [![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. Any text which is not enclosed with carets is considered a comment and ignored. Neither strings nor comments may use the caret character. 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.
CSTNet is a library for parsing the CST format. QuickFennec.CST is a library for parsing the CST format.
## Usage ## Usage
```csharp ```csharp
#r "nuget:CSTNet,1.0.0" #r "nuget:CSTNet,1.0.1"
using System; using System;
using System.IO; using System.IO;
using CSTNet; using QuickFennec.CST;
var file = File.ReadAllText("example.cst"); var file = File.ReadAllText("example.cst");
var example = CaretSeparatedText.Parse(file, 1); var example = CaretSeparatedText.Parse(file, 1);
@ -22,10 +22,10 @@ Console.WriteLine(example);
In production, CST files were used in The Sims Online to provide translations. Each translation was split into their respective directories: 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/_154_miscstrings.cst`` - ``uitext/english.dir/misc/_154_miscstrings.cst``
- ``uitext/swedish.dir/hints/_154_miscstrings.cst`` - ``uitext/swedish.dir/misc/_154_miscstrings.cst``
CST.NET only provides the basic parsing functionality. QuickFennec.CST only provides the basic parsing functionality.
## To-do ## To-do
@ -33,7 +33,8 @@ CST.NET only provides the basic parsing functionality.
## Known issues ## Known issues
- Reading multiple lines - Skipping comments is a little buggy.
- Multiline parsing with the v2 format is still unpredictable.
## Requirements ## Requirements
### Prerequisites ### Prerequisites