https://github.com/ipax77/s2protocol.net
C# dotnet 6 wrapper for Blizzards s2protocol for decoding SC2Replays
https://github.com/ipax77/s2protocol.net
blizzard decoder ironpython replays s2protocol starcraft2 wrapper-library
Last synced: 3 months ago
JSON representation
C# dotnet 6 wrapper for Blizzards s2protocol for decoding SC2Replays
- Host: GitHub
- URL: https://github.com/ipax77/s2protocol.net
- Owner: ipax77
- License: mit
- Created: 2022-01-31T23:07:57.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-13T17:41:46.000Z (10 months ago)
- Last Synced: 2025-05-28T02:48:02.978Z (4 months ago)
- Topics: blizzard, decoder, ironpython, replays, s2protocol, starcraft2, wrapper-library
- Language: Python
- Homepage:
- Size: 1.49 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/ipax77/s2protocol.NET/actions/workflows/dotnet.yml)
# Introduction
dotnet wrapper for [Blizzards s2protocol](https://github.com/Blizzard/s2protocol) for decoding/parsing StarCraft II replays (*.SC2Replay)
using IronPython (2.7)
# Getting started
## Installation
```bash
dotnet add package IronPython.StdLib --version 2.7.12
dotnet add package s2protocol.NET
```
## Usage
IronPyhton has a known memory leak [Issue](https://github.com/IronLanguages/ironpython2/issues/322) - try initializing the ReplayDecoder just once and reusing it.
```csharp
public static readonly string? assemblyPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
```
```csharp
ReplayDecoder decoder = new(assemblyPath);
Sc2Replay? replay = await decoder.DecodeAsync(pathToSC2Replay);
Console.WriteLine(replay.Header.BaseBuild);
```
Optional options:
```csharp
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:
```csharp
ReplayDecoder decoder = new(assemblyPath);
var folder = "path_to_replay_folder";
List 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
v0.8.4
>- s2protocol v5.0.14.93333.0
v0.8.3
>- s2protocol v5.0.14.93272.0
v0.8.2
>- s2protocol v5.0.13.92440.0
v0.8.0
**Breaking Changes**
>- dotnet 8
>- SC2 Patch 5.0.13 - s2protocol 92028
>- PingMessageEvents
v0.8.0-rc1.0
**Breaking Changes**
>- dotnet 8
>- removed logging
>- improved error handling
v0.6.12
>- Protocol 91115
v0.6.11
>- Protocol 90136
v0.6.10
>- Protocol 89720
v0.6.9
>- Protocol 89634
>- Fix Gametime to UTC
v0.6.8
>- Catch UnitIndex BigInteger
>- New parallel decoding with ErrorReport: decoder.DecodeParallelWithErrorReport
>- Parallel decoding tests
v0.6.7
>- Catch Currupted Trackerevents
>- Protocoll 88500 fix
v0.6.6
>- Call GC.Collect() in dispose to release file locks
>- Disabled default console-logging
>- Added Test for protocol 88500 (5.0.10)
v0.6.5
>- Save full path in FileName
v0.6.4
>- Patch 5.0.9 - Protocol 87702
v0.6.3
>- Python.StdLib to version 2.7.12
>- JsonIgnore on UnitBorn <-> UnitDied cycles
v0.6.2
>- GameEvents
>- AttributeEvents
>- Tracker-Unit-Events mapping (Born -> Died ...)
>- Tracker-Unit-Events UnitIndex from ```protocol.unit_tag(index, recycle)```
v0.6.1
>- Fixed some types (nullable/BigInteger/long)
>- Initdata is now available
>- Json de-/serialization
v0.6.0
>- Init