Serialization and Atlan Mod Packager
Overview of serialization and Atlan Mod Packager
Overview
Doom Eternal's entitydefs, logic decls, and map entities files are stored natively in plaintext. What you see when editing them, is how they actually look when stored in the game files. At runtime, the game parses these text files and converts them into data.
Doom The Dark Ages changes everything. All of these files are pre-serialized into a binary format. Modding them now requires:
- Deserializing them into a human-readable format. Atlan Resource Extractor does this for you.
- Editing the files as desired. As a modder, you'll do this step.
- Reserializing the files before distributing your mod. Atlan Mod Packager does this for you.
- Installing the modded files using Atlan Mod Loader.
Those interested in the technical details can check out the source code for all these tools here!
Atlan Mod Packager
Download Atlan Mod Packager here!
Please read everything on the download page carefully! It tells you how to use Atlan Mod Packager, and how to optimize your workflow when developing your mods!
Serialized Files vs Regular Decls
This section highlights differences between regular Dark Ages decls and Atlan-Serialized files. You must keep all of these in consideration when editing these files.
Colors
Serialized files use Linear RGB for color values. Example:
127.5 / 255 = 0.5
my_idColor = {
r = 0.5;
g = 0.5;
b = 0.5;
a = 0.5;
}
File Paths
With normal decls, a reference to an entityDef file might look like this:
entity = "projectile_ent/my_projectile_entity"
Inside serialized files, this same filepath will look like:
entity = "entityDef/projectile_ent/my_projectile_entity"
The string before the first / is the file type. To correctly reserialize the file, you MUST ensure the file type is there, and capitalized accurately. Atlan Resource Extractor's extra scripts output a list of correctly capitalized resource types. This file is located in the extra_scripts folder.
Additional Example: Let's say we have an idDeclAbility_Dash* variable named dashDecl:
Full Asset Path: "rs_streamfile/generated/decls/ability_dash/modded/my_dash.decl
Regular Decl Files: dashDecl = "modded/my_dash";
Atlan-Serialized Files: dashDecl = "ability_Dash/modded/my_dash"
Type Info Object Pointers
If you've spent extensive time editing decl files, you'll have noticed variables with the following format:
some_variable = {
className = "Class_Name_String";
object = {
<Object Properties>
}
}
These are idTypeInfoObjectPtr variables. They are polymorphic object references whose exact class is determined by the className variable.
In Atlan-Serialized files, the syntax of these variables is simplified to:
some_variable "Class_Name_String" {
<Object Properties>
}
The goal of this change is to simplify the syntax of these variables and remove a layer of indentation.
No comments to display
No comments to display