ruffk.ZwiftPacketMonitor
1.2.9.1
dotnet add package ruffk.ZwiftPacketMonitor --version 1.2.9.1
NuGet\Install-Package ruffk.ZwiftPacketMonitor -Version 1.2.9.1
<PackageReference Include="ruffk.ZwiftPacketMonitor" Version="1.2.9.1" />
paket add ruffk.ZwiftPacketMonitor --version 1.2.9.1
#r "nuget: ruffk.ZwiftPacketMonitor, 1.2.9.1"
// Install ruffk.ZwiftPacketMonitor as a Cake Addin #addin nuget:?package=ruffk.ZwiftPacketMonitor&version=1.2.9.1 // Install ruffk.ZwiftPacketMonitor as a Cake Tool #tool nuget:?package=ruffk.ZwiftPacketMonitor&version=1.2.9.1
ZwiftPacketMonitor
This project implements a TCP and UDP packet monitor for the Zwift cycling simulator. It listens for packets on a specific port of a local network adapter, and when found, deserializes the payload and dispatches events that can be consumed by the caller.
NOTE: Because this utilizes a network packet capture to intercept the UDP packets, your system may require this code to run using elevated privileges.
Prerequisites
- Packet capture relies on SharpPcap and requires the installation of libpcap (Linux), Npcap (Windows) or similar packet capture library.
Usage
See the included ZwiftPacketMonitor.Demo project for a complete working example.
var serviceCollection = new ServiceCollection();
serviceCollection.AddZwiftPacketMonitoring();
var serviceProvider = serviceCollection.BuildServiceProvider();
var logger = serviceProvider.GetService<ILogger<Program>>();
var monitor = serviceProvider.GetService<Monitor>();
monitor.IncomingPlayerEvent += (s, e) => {
logger.LogInformation($"INCOMING: {e.PlayerState}");
};
monitor.OutgoingPlayerEvent += (s, e) => {
logger.LogInformation($"OUTGOING: {e.PlayerState}");
};
monitor.IncomingChatMessageEvent += (s, e) => {
logger.LogInformation($"CHAT: {e.Message}");
};
monitor.IncomingPlayerEnteredWorldEvent += (s, e) => {
logger.LogInformation($"WORLD: {e.PlayerUpdate}");
};
monitor.IncomingRideOnGivenEvent += (s, e) => {
logger.LogInformation($"RIDEON: {e.RideOn}");
};
// network interface name or IP address
monitor.StartCaptureAsync("en0").Wait();
// This won't get called until the above Wait finishes
monitor.StopCaptureAsync().Wait();
Credit
This project is a .NET port of the zwift-packet-monitor project and borrows heavily from its packet handling and protobuf implementation.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
-
net5.0
- Google.Protobuf (>= 3.17.3)
- Microsoft.Extensions.Logging (>= 5.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 5.0.0)
- PacketDotNet (>= 1.3.0)
- SharpPcap (>= 6.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Added support for SharpPcap 6.0 after breaking changes. Changed TargetFramework to net5.0