Modding:Serialization (Saving/Loading): Difference between revisions

Jump to navigation Jump to search

Modding:Serialization (Saving/Loading) (view source)

Revision as of 20:57, 14 December 2020

356 bytes added ,  20:57, 14 December 2020
→‎What is Serialization?: significant rewrite and editing
mNo edit summary
(→‎What is Serialization?: significant rewrite and editing)
Line 2: Line 2:


== What is Serialization? ==
== What is Serialization? ==
Serialization is how games and other programs convert data ''(specifically, C# class fields)'' into a file format, so that it can be stored between sessions. In simpler terms, it's how a game saves its data. The process of loading data from a file is called "Deserialization".


There are many different ways data can be de/serialized, for example, Qud's xml files are a way of storing data in a formatted fashion. The advantage of this is that this data works independent of game versions, however, it also takes up much more storage space. This also makes the data human readable/editable, which is useful for modding, but could allow for save editing if used for game data.
''Serialization'' is how games and other programs convert data (in Qud's case, C# class fields) into a format that can be written to a file, so that it can be stored between sessions. Effectively, it's how a game saves its data. The opposite process, the process of loading data from a file, is called ''deserialization''.  


These reasons are why Qud uses an unformatted save format. In this format, the game simply saves the raw data of in-game objects with only enough information necessary to load the data back into the game. This data takes up less space, and cannot easily be manipulated by players, but is not compatible between game/mod versions.
There are many different ways that data can be (de)serialized. One particular format that Qud uses for its persistent data files is XML. One advantage of XML is that the data can be read by the game independent of the game version, however, it also takes up more storage space. Another consideration is that it makes the data human-readable and -editable, which is useful for modding.
 
Qud uses binary blobs for save data. The format is not easily readable or editable by humans, but it is highly flexible in programming terms and can be used for a wide variety of data. However, to some extent it also relies on certain things not changing across game and mod versions, so it can be easily invalidated by certain types of changes.
 
Due to the modular way in which Qud does serialization, as a mod author you don't have to concern yourself with all the specifics of the save format. The remainder of this article describes how to use the tools that Qud and its engine provide for telling it how you would like to serialize your mod data.


== How Serialization Works for Qud ==
== How Serialization Works for Qud ==
Retrieved from "https://wiki.cavesofqud.com/wiki/Special:MobileDiff/43648"

Navigation menu