GDSerializer 2.0.3

GDSerializer

GDSerializer is an XML serialization (and deserialization) library developed with Godot's C# API in mind.

It supports (de)serialization of almost any C# type including collections and managed types, and provides an interface to create custom (de)serializers that can then be used by the default implementation to further increase its capabilities.

Installation

GDSerializer is available as a NuGet package, which can be installed either through an IDE or by manually including the following lines in a Godot project's .csproj file:

<ItemGroup>
    <PackageReference Include="GDSerializer" Version="2.0.3"/>
</ItemGroup>

Its dependencies may need to be installed as well, in a similar fashion.

Due to a bug in Godot, the following lines will also need to be included in the .csproj file to properly compile along with NuGet packages:

<PropertyGroup>
    <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
</PropertyGroup>

Note that GDSerializer targets .NET Standard 2.1 whereas Godot projects target .NET Framework 4.7.2 by default, so the target framework may need to be changed either through an IDE or by manually editing the .csproj file like so:

<TargetFramework>netstandard2.1</TargetFramework>

It is also recommended to enable nullability warnings in the project; however, this is completely optional. Again, this can be done either through an IDE or by including the following lines in the .csproj file:

<PropertyGroup>
    <Nullable>enable</Nullable>
</PropertyGroup>

Usage

Creating a new serializer instance:

Serializer serializer = new(); // or new Serializer() for older language versions that do not recognise target-typed new()

Serializing an object as an XML node:

XmlNode xml = serializer.Serialize(obj);

Deserializing an XML node as an object:

object? obj = serializer.Deserialize(xml);

An optional type argument can be provided for both serialization and deserialization, in order to assist the serializer with figuring out the object's Type.
Generic versions of the methods can also be used.

More detailed instructions on using the Serializer class can be found on the GDSerializer wiki.