Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 1.52 KB

README.md

File metadata and controls

34 lines (28 loc) · 1.52 KB

fcarstat.net

fcarstat is a .NET Standard library designed to make it easier to consume telemetry data from Forza Horizon 5 (and possibly 4, currently untested). Please note that while this is a .NET Standard library, it requires that the platform you use it on is compatible with the UDP Client. Some platforms (e.g. Blazor WASM) will not work.

Versioning/ Changes

Until version 1.0.0, breaking changes may be shipped in any version. While I will try to avoid this, it may happen due to rapid development and changes in strategy. After version 1.0.0, standard versioning practices will be followed with 0.0.x changes having patches 0.x.0 changes containing additive changes, and x.0.0 changes containing breaking changes. Please use caution when upgrading to preview packages and to major versions.

Usage

Basic Usage

ForzaHorizonClient implements IDisposable, plan accordingly.

public void Main()
{
    using ForzaHorizonClient client = new ForzaHorizonClient();
    client.ReceivedTelemetryData += Client_ReceivedTelemetryData;
    // If using something like a console app, you will need to add something (like a loop) to keep your code running while the client listens for new data asynchronously.
 }


private void Client_ReceivedTelemetryData(object sender, Fcarstat.TelemetryPacket packet)
{
    // Process new data here 
}

Custom Port

By default the client will use port 5005. If you have a conflict, you can pass a custom port.

int port = 5006;
ForzaHorizonClient client = new ForzaHorizonClient(port);