Nodsoft.WowsReplaysUnpack 1.0.11

.NET 6.0
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Nodsoft.WowsReplaysUnpack --version 1.0.11
NuGet\Install-Package Nodsoft.WowsReplaysUnpack -Version 1.0.11
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="Nodsoft.WowsReplaysUnpack" Version="1.0.11" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Nodsoft.WowsReplaysUnpack --version 1.0.11
#r "nuget: Nodsoft.WowsReplaysUnpack, 1.0.11"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Nodsoft.WowsReplaysUnpack as a Cake Addin
#addin nuget:?package=Nodsoft.WowsReplaysUnpack&version=1.0.11

// Install Nodsoft.WowsReplaysUnpack as a Cake Tool
#tool nuget:?package=Nodsoft.WowsReplaysUnpack&version=1.0.11

<img align="right" src="logo.png" alt="logo" width="200"/>

WoWS-ReplaysUnpack

A C# file unpacking library for World of Warships Replays, inspired by Monstrofil's replays_unpack.

Information before using the library

The library supports only World of Warships replays starting with version 0.10.10. Trying to use an older replay can result in unexpected errors when processing the replay.

How to install

Install NuGet

Then, install from the package manager console:

PM> Install-Package Nodsoft.WowsReplaysUnpack

Or from the .NET CLI as:

dotnet add package Nodsoft.WowsReplaysUnpack

How to use

Add the service to an IServiceCollection

services.AddWowsReplayUnpacker();

Get the factory with DI, get the IReplayUnpackerService from the factory and call the Unpack method with either a Stream or byte[]

ReplayUnpackerFactory replayUnpackerFactory = serviceProvider.GetService<ReplayUnpackerFactory>();
UnpackedReplay unpackedReplay = replayUnpackerFactory
	.GetUnpacker()
	.Unpack(File.OpenRead("my-replay.wowsreplay"));

Custom Implementations

You can provide custom implementations of certain services.

services.Snippet.AddWowsReplayUnpacker(builder =>
{
	builder.AddReplayController<MyCustomReplayController>();
	builder.WithReplayDataParser<MyCustomReplayDataParser>();
	builder.WithDefinitionStore<MyCustomDefinitionStore>();
})

DefinitionStore

Responsible for managing, accessing and caching the .def files (used for type and property mapping).

Your custom definition store has to implement IDefinitionStore or extend DefaultDefinitionStore

ReplayDataParser

Responsible for parsing the binary packets to the specific network packets.

Your custom replay data parser has to implement IReplayDataParser or extend DefaultReplayParser

ReplayController

Responsible for handling parsed network packets and filling the UnpackedReplay with information.

Your custom replay controller has to implement IReplayController but it is strongly suggested to use ReplayControllerBase<T> where T is your custom controller class.

To use your custom controller add the type to the GetUnpacker() method.

UnpackedReplay unpackedReplay = replayUnpackerFactory
	.GetUnpacker<MyCustomReplayController>()
	.Unpack(File.OpenRead("my-replay.wowsreplay"));

CVE Check Only Implementation

In the library you get a custom implementation ready to use for when you only want to check the CVE . CveCheckOnlyController

It skips all network packets except the affected ones.

You have to add it with the AddReplayController<CveCheckOnlyController>() method and get the unpacker with GetUnpacker<CveCheckOnlyController>()

Extend the replay data

When implementing your own controller and extending ReplayControllerBase<T> you can overwrite the CreateUnpackedReplay method to create an instance of your own replay class. The replay class has to extend UnpackedReplay. That way you can add extra properties. It is important that you set the Replay property so the ReplayControllerBase can work with it.

Example:

public override UnpackedReplay CreateUnpackedReplay(ArenaInfo arenaInfo)
{
	Replay = new MyCustomUnpackedReplay(arenaInfo);
	return Replay;
}

You can see this in action here

Method/Property Subscriptions

When implementing your own controller and extending ReplayControllerBase<T> you can subscribe to EntityMethods and EntityProperty calls by adding a method with an attribute.

MethodSubscription("EntityName", "MethodName")

You have a few extra properties on the attribute to configure how the method will be called: bool IncludeEntity ⇒ When true it will include the Entity entity parameter

bool IncludePacketTime ⇒ When true it will include the float packetTime parameter

bool ParamsAsDictionary ⇒ When true the last paremeter will be Dictionary<string, object?> arguments / When false the parameters have to match the actual packet parameters in order and type exactly. When they don't match you will get an exception telling you the required parameters.

bool Priority ⇒ Defines the order in which methods are called when you have multiple subscriptions on the same method. Smaller = Earlier. Don't use -1.

Example:

[MethodSubscription("Avatar", "onArenaStateReceived")]
public void OnArenaStateReceived(Entity entity, float packetTime, ...)
{
}

PropertySubscription("EntityName", "PropertyName")

There are no extra properties available and the Entity entity parameter is always there.

Example:

[PropertySubscription("Avatar", "selectedWeapon")]
public void SelectedWeaponChanged(Entity entity, uint selectedWeaponId)
{
}

ExtendedData Library

You can install the Nodsoft.WowsReplaysUnpack.ExtendedData package from nuget to get a ready to use implementation that fills the replay with more information than the default controller.

Currently included in the ExtendedDataReplay:

  • Player Information
  • Chat Messages

How to use

services.AddWowsReplayUnpacker(builder =>
{
	builder.AddExtendedData();
});

ExtendedDataReplay unpackedReplay = (ExtendedDataReplay)replayUnpackerFactory
	.GetExtendedDataUnpacker()
	.Unpack(File.OpenRead("my-replay.wowsreplay"));
Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Nodsoft.WowsReplaysUnpack:

Package Downloads
Nodsoft.WowsReplaysUnpack.ExtendedData

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.9-alpha-g02ef2eaf60 40 1/19/2023
2.0.8-alpha-g2a9a24924f 45 12/12/2022
2.0.6-alpha-gcbcb7f6a80 50 12/8/2022
2.0.5-alpha-g7ea078df7a 73 11/19/2022
2.0.3-alpha-g12f645426c 119 10/6/2022
2.0.2-alpha-g6916206934 109 9/24/2022
2.0.1-alpha-g920402ee9e 66 9/9/2022
1.0.11 350 9/8/2022
1.0.11-gaf2ec4da01 59 9/9/2022
1.0.10 330 9/8/2022
1.0.10-gf865b963c8 69 9/8/2022
1.0.9-pre-g35415cdef7 71 9/8/2022
1.0.8-pre-g8097eaf5af 72 9/8/2022
1.0.7-pre-gba54b08e7a 69 9/8/2022
1.0.5-pre-gb7fb7564ee 79 8/5/2022
1.0.4-pre-g1025b3c13d 69 8/5/2022
1.0.3-pre-g0b9499d17c 74 7/26/2022
1.0.0 394 7/25/2022
1.0.0-pre1 82 7/23/2022
0.5.3 273 7/16/2022
0.5.2 406 5/27/2022
0.5.1 279 3/18/2022
0.5.0 376 1/19/2022
0.5.0-pre1 171 12/9/2021
0.4.0 230 12/5/2021
0.3.0 866 12/1/2021
0.2.0-dev1 1,078 11/28/2021