s2protocol.NET 0.8.1

dotnet add package s2protocol.NET --version 0.8.1
NuGet\Install-Package s2protocol.NET -Version 0.8.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="s2protocol.NET" Version="0.8.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add s2protocol.NET --version 0.8.1
#r "nuget: s2protocol.NET, 0.8.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install s2protocol.NET as a Cake Addin
#addin nuget:?package=s2protocol.NET&version=0.8.1

// Install s2protocol.NET as a Cake Tool
#tool nuget:?package=s2protocol.NET&version=0.8.1

.NET

Introduction

dotnet wrapper for Blizzards s2protocol for decoding/parsing StarCraft II replays (*.SC2Replay) using IronPython (2.7)

Getting started

Installation

  • dotnet 8:
dotnet add package IronPython.StdLib --version 2.7.12
dotnet add package s2protocol.NET
  • dotnet 6/7:
dotnet add package IronPython.StdLib --version 2.7.12
dotnet add package s2protocol.NET --version 0.6.12

Usage

IronPyhton has a known memory leak Issue - try initializing the ReplayDecoder just once and reusing it.

public static readonly string? assemblyPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
ReplayDecoder decoder = new(assemblyPath);
Sc2Replay? replay = await decoder.DecodeAsync(pathToSC2Replay);
Console.WriteLine(replay.Header.BaseBuild);

Optional options:

ReplayDecoder decoder = new(assemblyPath);

ReplayDecoderOptions options = new ReplayDecoderOptions()
{
    Details = false,
    Metadata = false,
    MessageEvents = false,
    TrackerEvents = true,
    GameEvents = false,
    AttributeEvents = false
};

CancellationTokenSource cts = new();

Sc2Replay? replay = await decoder.DecodeAsync(pathToSC2Replay, options, cts.Token);
Console.WriteLine(replay.TrackerEvents.SUnitBornEvents.FirstOrDefault());

Multiple replays:

ReplayDecoder decoder = new(assemblyPath);
var folder = "path_to_replay_folder";
List<string> replays = Directory.GetFiles(folder, "*.SC2Replay").ToList();
ReplayDecoderOptions options = new ReplayDecoderOptions() { TrackerEvents = false };
int threads = 8;
CancellationTokenSource cts = new();

int decoded = 0;
int errors = 0;
await foreach (DecodeParallelResult decodeResult in decoder.DecodeParallelWithErrorReport(replays, 2, options, cts.Token))
{
    if (decodeResult.Sc2Replay == null)
    {
        Console.WriteLine($"failed decoding replay {decodeResult.ReplayPath}: {decodeResult.Exception}");
        errors++;
    }
    else
    {
        Console.WriteLine($"{decoded} {decodeResult.Sc2Replay.Details?.DateTimeUTC}");
        decoded++;
    }
}

Known Limitations / ToDo

GameEvents

STriggerSoundLengthSyncEvent ⇒ no data SControlGroupUpdateEvent ⇒ no mask

ChangeLog

<details open="open"><summary>v0.8.0</summary>

Breaking Changes

  • dotnet 8
  • SC2 Patch 5.0.13 - s2protocol 92028
  • PingMessageEvents

</details>

<details><summary>v0.8.0-rc1.0</summary>

Breaking Changes

  • dotnet 8
  • removed logging
  • improved error handling

</details>

<details><summary>v0.6.12</summary>

  • Protocol 91115

</details>

<details><summary>v0.6.11</summary>

  • Protocol 90136

</details>

<details><summary>v0.6.10</summary>

  • Protocol 89720

</details>

<details><summary>v0.6.9</summary>

  • Protocol 89634
  • Fix Gametime to UTC

</details>

<details><summary>v0.6.8</summary>

  • Catch UnitIndex BigInteger
  • New parallel decoding with ErrorReport: decoder.DecodeParallelWithErrorReport
  • Parallel decoding tests

</details>

<details><summary>v0.6.7</summary>

  • Catch Currupted Trackerevents
  • Protocoll 88500 fix

</details>

<details><summary>v0.6.6</summary>

  • Call GC.Collect() in dispose to release file locks
  • Disabled default console-logging
  • Added Test for protocol 88500 (5.0.10)

</details>

<details><summary>v0.6.5</summary>

  • Save full path in FileName

</details>

<details><summary>v0.6.4</summary>

  • Patch 5.0.9 - Protocol 87702

</details>

<details><summary>v0.6.3</summary>

  • Python.StdLib to version 2.7.12
  • JsonIgnore on UnitBorn ↔ UnitDied cycles

</details>

<details><summary>v0.6.2</summary>

  • GameEvents
  • AttributeEvents
  • Tracker-Unit-Events mapping (Born → Died ...)
  • Tracker-Unit-Events UnitIndex from protocol.unit_tag(index, recycle)

</details>

<details><summary>v0.6.1</summary>

  • Fixed some types (nullable/BigInteger/long)
  • Initdata is now available
  • Json de-/serialization

</details>

<details><summary>v0.6.0</summary>

  • Init

</details>

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.8.1 88 4/3/2024
0.8.0 94 4/2/2024
0.8.0-rc1.0 169 11/1/2023
0.6.12 477 10/4/2023
0.6.11 650 4/24/2023
0.6.10 748 2/1/2023
0.6.9 808 1/24/2023
0.6.8 841 11/3/2022
0.6.7 807 10/27/2022
0.6.6 863 7/31/2022
0.6.5 923 4/23/2022
0.6.4 916 3/17/2022
0.6.3 875 2/20/2022
0.6.2 936 2/7/2022
0.6.1 924 2/4/2022
0.6.0 882 2/2/2022