diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..4bbf63f --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,17 @@ +## Expected Behavior + + +## Actual Behavior + + +## Steps to Reproduce the Problem + + 1. + 1. + 1. + +## Specifications + + - Version: + - Platform: + - Subsystem: \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d5e3ee4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,7 @@ +# Fixes + +## Proposed Changes + + - + - + - \ No newline at end of file diff --git a/.github/funding.yml b/.github/funding.yml new file mode 100644 index 0000000..fe7f127 --- /dev/null +++ b/.github/funding.yml @@ -0,0 +1,2 @@ +ko_fi: tonytins +github: tonytins diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml index c0febd3..2bb59f8 100644 --- a/.github/workflows/dotnet.yml +++ b/.github/workflows/dotnet.yml @@ -2,9 +2,9 @@ name: .NET on: push: - branches: [master] + branches: [master, develop] pull_request: - branches: [master] + branches: [master, develop] jobs: build: diff --git a/README.md b/README.md index b5c69b9..c11accb 100644 --- a/README.md +++ b/README.md @@ -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