MageeSoft.StellarisSaveParser 0.0.1

Stellaris Save Parser

A .NET library for parsing Stellaris save files (.sav), providing easy access to both gamestate and meta information. The library supports both regular and Ironman save files.

Features

• Parse Stellaris .sav files (regular and Ironman)
• Access both gamestate and meta information
• JsonDocument-like API for easy navigation
• Full support for all Stellaris data types

Installation

dotnet add package StellarisSaveParser

Quick Start

using StellarisSaveParser;

// Load and parse a save file
var saveFile = new FileInfo("mysave.sav");
var documents = GameSaveZip.Unzip(saveFile);

// Access meta information
var version = documents.Meta.RootElement
    .EnumerateObject()
    .First(p => p.Key == "version")
    .Value.ToString();

Console.WriteLine($"Game Version: {version}");

// Access basic game information
var date = documents.Meta.RootElement
    .EnumerateObject()
    .First(p => p.Key == "date")
    .Value.ToString();

var empireName = documents.Meta.RootElement
    .EnumerateObject()
    .First(p => p.Key == "name")
    .Value.ToString();

Console.WriteLine($"Empire: {empireName}");
Console.WriteLine($"Date: {date}");

Common Usage Examples

Accessing Empire Information

// Get player empire details
var player = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "player")
    .Value;

// Get empire flag
var flag = documents.Meta.RootElement
    .EnumerateObject()
    .First(p => p.Key == "flag")
    .Value;

// Get empire's fleet count
var fleetCount = documents.Meta.RootElement
    .EnumerateObject()
    .First(p => p.Key == "meta_fleets")
    .Value.ToString();

Accessing Galaxy Information

// Get galaxy information
var galaxy = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "galaxy")
    .Value;

// Get all planets
var planets = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "planets")
    .Value;

// Get all fleets
var fleets = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "fleet")
    .Value;

Accessing Species Information

// Get species database
var speciesDb = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "species_db")
    .Value;

// Get all pops
var pops = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "pop")
    .Value;

Accessing Market and Economy

// Get market information
var market = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "market")
    .Value;

// Get trade routes
var tradeRoutes = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "trade_routes")
    .Value;

Accessing Diplomatic Information

// Get federations
var federations = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "federation")
    .Value;

// Get wars
var wars = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "war")
    .Value;

// Get agreements
var agreements = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "agreements")
    .Value;

Accessing Military Information

// Get all ships
var ships = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "ships")
    .Value;

// Get all armies
var armies = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "army")
    .Value;

// Get ship designs
var shipDesigns = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "ship_design")
    .Value;

Advanced Usage

Handling Arrays

// Example: Reading an array of values
var values = element.EnumerateArray().ToList();
foreach (var value in values)
{
    Console.WriteLine(value.ToString());
}

Handling Objects

// Example: Reading object properties
var properties = element.EnumerateObject().ToList();
foreach (var prop in properties)
{
    Console.WriteLine($"{prop.Key}: {prop.Value}");
}

Handling Nested Structures

// Example: Navigating nested structures
var countryName = documents.GameState.RootElement
    .EnumerateObject()
    .First(p => p.Key == "country")
    .Value
    .EnumerateObject()
    .First(p => p.Key == "name")
    .Value
    .EnumerateObject()
    .First(p => p.Key == "key")
    .Value;

Error Handling

The library throws appropriate exceptions for common error cases:

try
{
    var documents = GameSaveZip.Unzip(saveFile);
}
catch (FileNotFoundException)
{
    // Handle missing save file
}
catch (InvalidDataException)
{
    // Handle invalid or corrupted save file
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.