Parsec is a simple .NET parsing library for Shaiya file formats which provides easy to use APIs
for serialization and deserialization of the game's file formats, including JSON and CSV support.
Parsec works on any .NET Standard 2.0 compliant platform, including .NET 5+, .NET Framework 4.6.1+, .NET Core 2.0+, Unity and Godot.
data.sah/safNpcQuest.SDataKillStatus.SDataCash.SDataSetItem.SDataDualLayerClothes.SDataGuildHouse.SDataMonster.SDataItem.SDataSkill.SDataNpcSkill.SDatasvmapWLDdgANI3DC3DO3DEMLTITMSMODEFTseffzonALTVAniMAniMLXMONCTLdat(Cloth/Emblem)DBItemData.SDataDBItemText.SDataDBMonsterData.SDataDBMonsterText.SDataDBSkillData.SDataDBSkillText.SDataDBItemSellData.SDataDBItemSellText.SDataDBNpcSkillData.SDataDBNpcSkillText.SDataDBDualLayerClothesData.SDataDBSetItemData.SDataDBSetItemText.SDataDBTransformModelData.SDataDBTransformWeaponModelData.SData
NOTE: These file formats have been tested on Episodes 5, 6 & 8. Other episodes might differ slightly and this library might not work with them.
- Shaiya file formats parsing and serialization (including JSON and CSV support)
dataextraction, building and patchingSDataencryption/decryption
.NET 8 SDK (recommended)or any.NET Standard 2.0compliant platform
// Read file with default episode (EP5) and encoding (ASCII)
var svmap = ParsecReader.FromFile<Svmap>("0.svmap");
// Read file with a specific episode and default encoding
var svmap = ParsecReader.FromFile<Svmap>("0.svmap", Episode.Ep6);
// Read file with a specific episode and a specific encoding
var windows1252Encoding = CodePagesEncodingProvider.Instance.GetEncoding(1252);
var svmap = ParsecReader.FromFile<Svmap>("0.svmap", Episode.Ep6, windows1252Encoding);// Load data (sah and saf)
var data = new Data("data.sah", "data.saf");
// Find the file you want to read
var file = data.GetFile("world/0.svmap");
// Read and parse the file's content directly from the saf file
var svmap = ParsecReader.FromBuffer<Svmap>(file.Name, data.GetFileBuffer(file));Parsec supports importing a file as JSON, which can be later exported as its original format. The user must make sure
that the JSON file is properly formatted to match the JSON standards and contain all the fields present in the chosen
format.
// Read JSON file
var svmap = ParsecReader.FromJsonFile<Svmap>("0_svmap.json");It is advised to first read a file from its original format, export it as JSON, edit it, and import it once again as JSON, so that all the original fields are present in the JSON file.
Only some pre-Ep8 SData formats support reading as CSV.
All of the Episode 8 BinarySData formats have CSV support.
// Read csv file
var item = Item.FromCsv("Item.csv");When reading files, the default encoding is ASCII. If you want to read a file with a different encoding, you can
specify it as a parameter when calling the FromFile/Json/Csv methods.
After modifying the file, you can save it in its original format by calling the Write method. If you specified
the episode and encoding when reading the file, you don't need to specify them again when writing it.
// Write file with previously defined episode and encoding (defined when reading the file)
svmap.Write("0_modified.svmap");
// Write file with a specific episode and default encoding
svmap.Write("0_modified.svmap", Episode.Ep6);
// Write file with a specific episode and a specific encoding
var windows1252Encoding = CodePagesEncodingProvider.Instance.GetEncoding(1252);
svmap.Write("0_modified.svmap", Episode.Ep6, windows1252Encoding);Call the WriteJson method
svmap.WriteJson("map0.json");Only some pre-Ep8 SData formats support exporting as CSV.
All of the Episode 8 BinarySData formats have CSV support.
// Write as csv
item.WriteCsv("Item.csv")When writing files, the default encoding is ASCII. If you want to write a file with a different encoding, you can
specify it as a parameter when calling the Write, WriteJson and WriteCsv methods.
// Load data (sah and saf)
var data = new Data("data.sah", "data.saf");
// Find the file you want to extract
var file = data.GetFile("world/2.svmap");
// Extract the selected file
data.Extract(file, "extracted");// Create data from directory
DataBuilder.CreateFromDirectory("input", "output");// Load target data and patch data
var data = new Data("data.sah", "data.saf");
var update = new Data("update.sah", "update.saf");
// Patch data
using (var dataPatcher = new DataPatcher())
{
dataPatcher.Patch(data, update);
}SData encryption is slightly different for pre-Ep8 and Ep8 SData files. The SDataVersion enum is used to specify
which version of SData is being encrypted (it's not necessary when decrypting);
// Encrypt
SData.EncryptFile("NpcQuest.SData", "NpcQuest.encrypted.SData", SDataVersion.Regular);
// Decrypt
SData.DecryptFile("NpcQuest.SData", "NpcQuest.decrypted.SData");More examples can be found in the samples directory.