AnnoMods.BBDom 3.0.1

AnnoMods.BBDom

A library for working with BlueBytes proprietary DOM format for Anno 1800.

For the full documentation, visit: https://github.com/anno-mods/FileDBReader/wiki

Some short codesnippets to get you started:

IO

Loading

using var inStream = new MemoryStream(); 
var doc = BBDocument.LoadStream(inStream);

Writing

BBDocument doc; 
using var outStream = new MemoryStream(); 
doc.WriteToStream(outStream);

V3 is used as the default version.

To use a custom version for writing, use:

doc.WriteToStream(outStream, BBDocumentVersion.V3);

Creating your own Documents

BBDocument doc; 

//create Nodes
var tag = doc.CreateTag("MyNodeName");
var attrib1 = doc.CreateAttrib("MyAttribName");
var attrib2 = doc.CreateAttrib("MyAttribWithContent", 53);
var stringAttrib = doc.CreateAttrib("MyStringAttribName", "Content", Encoding.UTF8);

//create Node Structure
tag.AddChildren(attrib1, attrib2, stringAttrib);
doc.AddRoot(tag);

Serialization

For serialization to a stream, you do

BBDocument doc; 
MyType obj; 
BBConvert.SerializeObject(obj, new BBSerializerOptions(), new MemoryStream());

If you wish to instead serialize to a BBDocument, you can do the following:

BBDocument doc; 
MyType obj; 
BBConvert.SerializeObjectToDocument(obj, new BBSerializerOptions());

For more info how to create object models for serialization, check out the Documentation on Github

Xml ↔ BBDocument

The library allows for conversion between Bluebytes custom formats and an XML representation of it, representing the Binary Data in the BBDocument as Hex Strings.

BBDocument doc; 
XmlDocument xmlDoc = doc.ToXmlDocument(); 

XmlDocument doc; 
BBDocument bbDoc = doc.ToBBDocument();