README.md

Universal Dive Data Format

This is a C# library for reading and writing the Universal Dive Data Format.

Currently, the library primarily consists of the Models required to deserialize UDDF files using either the built-in XmlSerializer or the custom UddfDeserilizer.

The UddfDeserializer resolves all links within the UDDF file and maps them onto the object graph.

If you use the built-in XmlSerializer, you have to use the LinkResolutionService to resolve these links.

Future versions might include extra services for enforcing constraints and validation.

Usage

The library is available on NuGet.

You can install it using your package manager or with the cli:

dotnet add package UniversalDiveDataFormat

using System.Xml.Serialization;
using UniversalDiveDataFormat.Models;

UniversalDiveDataFormatRoot uddf = _uddfDeserialiser.Deserialise<UniversalDiveDataFormatRoot>(xml);

Contributing

I haven't written an application using this library yet, so it's entirely possible that I've missed things when I was going through the UDDF specification.

If you find a bug or have a feature request, please open an issue or a pull request.

License

This project is licensed under The Unlicense. Do whatever you want with it but don't blame me for the results.