Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Saving and Loading a Game

How to save and load a game using Qt’s JSON or CBOR classes.

Many games provide save functionality, so that the player’s progress through the game can be saved and loaded at a later time. The process of saving a game generally involves serializing each game object’s member variables to a file. Many formats can be used for this purpose, one of which is JSON. With QJsonDocument , you also have the ability to serialize a document in a CBOR format, which is great if you don’t want the save file to be easy to read (but see Parsing and displaying CBOR data for how it can be read), or if you need to keep the file size down.

In this example, we’ll demonstrate how to save and load a simple game to and from JSON and binary formats.

The Character Class

The Character class represents a non-player character (NPC) in our game, and stores the player’s name, level, and class type.

It provides static fromJson() and non-static toJson() functions to serialise itself.

Note

This pattern (fromJson()/toJson()) works because QJsonObjects can be constructed independent of an owning QJsonDocument , and because the data types being (de)serialized here are value types, so can be copied. When serializing to another format — for example XML or QDataStream , which require passing a document-like object — or when the object identity is important ( QObject subclasses, for example), other patterns may be more suitable. See the dombookmarks example for XML, and the implementation of QListWidgetItem::read() and QListWidgetItem::write() for idiomatic QDataStream serialization. The print() functions in this example are good examples of QTextStream serialization, even though they, of course, lack the deserialization side.

class Character():

    Q_GADGET
# public
    ClassType = { Warrior, Mage, Archer }
    Q_ENUM(ClassType)
    Character()
    Character(QString name, int level, ClassType classType)
    name = QString()
    def setName(name):
    level = int()
    def setLevel(level):
    classType = ClassType()
    def setClassType(classType):
    fromJson = Character(QJsonObject json)
    toJson = QJsonObject()
    def print(s, 0):
# private
    mName = QString()
    mLevel = 0
    mClassType = Warrior()

Of particular interest to us are the fromJson() and toJson() function implementations:

def fromJson(self, QJsonObject json):

    result = Character()
    if QJsonValue v = json["name"]; v.isString():
        result.mName = v.toString()
    if QJsonValue v = json["level"]; v.isDouble():
        result.mLevel = v.toInt()
    if QJsonValue v = json["classType"]; v.isDouble():
        result.mClassType = ClassType(v.toInt())
    return result

In the fromJson() function, we construct a local result Character object and assign result's members values from the QJsonObject argument. You can use either operator[]() or value() to access values within the JSON object; both are const functions and return Undefined if the key is invalid. In particular, the is... functions (for example isString() , isDouble() ) return false for Undefined , so we can check for existence as well as the correct type in a single lookup.

If a value does not exist in the JSON object, or has the wrong type, we don’t write to the corresponding result member, either, thereby preserving any values the default constructor may have set. This means default values are centrally defined in one location (the default constructor) and need not be repeated in serialisation code ( DRY ).

Observe the use of C++17 if-with-initializer to separate scoping and checking of the variable v. This means we can keep the variable name short, because its scope is limited.

Compare that to the naïve approach using QJsonObject::contains():

if (json.contains("name") && json["name"].isString())
    result.mName = json["name"].toString();

which, beside being less readable, requires a total of three lookups (no, the compiler will not optimize these into one), so is three times slower and repeats "name" three times (violating the DRY principle).

def toJson(self):

    json = QJsonObject()
    json["name"] = mName
    json["level"] = mLevel
    json["classType"] = mClassType
    return json

In the toJson() function, we do the reverse of the fromJson() function; assign values from the Character object to a new JSON object we then return. As with accessing values, there are two ways to set values on a QJsonObject : operator[]() and insert() . Both will override any existing value at the given key.

The Level Class

class Level():

# public
    Level() = default
    Level = explicit(QString name)
    name = QString()
npcs = QList()
    def setNpcs(npcs):
    fromJson = Level(QJsonObject json)
    toJson = QJsonObject()
    def print(s, 0):
# private
    mName = QString()
mNpcs = QList()

We want the levels in our game to each each have several NPCs, so we keep a QList of Character objects. We also provide the familiar fromJson() and toJson() functions.

def fromJson(self, QJsonObject json):

    result = Level()
    if QJsonValue v = json["name"]; v.isString():
        result.mName = v.toString()
    if QJsonValue v = json["npcs"]; v.isArray():
        npcs = v.toArray()
        result.mNpcs.reserve(npcs.size())
        for npc in npcs:
            result.mNpcs.append(Character.fromJson(npc.toObject()))

    return result

Containers can be written to and read from JSON using QJsonArray . In our case, we construct a QJsonArray from the value associated with the key "npcs". Then, for each QJsonValue element in the array, we call toObject() to get the Character’s JSON object. Character::fromJson() can then turn that QJSonObject into a Character object to append to our NPC array.

Note

Associate containers can be written by storing the key in each value object (if it’s not already). With this approach, the container is stored as a regular array of objects, but the index of each element is used as the key to construct the container when reading it back in.

def toJson(self):

    json = QJsonObject()
    json["name"] = mName
    npcArray = QJsonArray()
    for npc in mNpcs:
        npcArray.append(npc.toJson())
    json["npcs"] = npcArray
    return json

Again, the toJson() function is similar to the fromJson() function, except reversed.

The Game Class

Having established the Character and Level classes, we can move on to the Game class:

class Game():

# public
    SaveFormat = { Json, Binary }
    player = Character()
levels = QList()
    def newGame():
    loadGame = bool(SaveFormat saveFormat)
    saveGame = bool(SaveFormat saveFormat)
    def read(json):
    toJson = QJsonObject()
    def print(s, 0):
# private
    mPlayer = Character()
mLevels = QList()

First of all, we define the SaveFormat enum. This will allow us to specify the format in which the game should be saved: Json or Binary.

Next, we provide accessors for the player and levels. We then expose three functions: newGame(), saveGame() and loadGame().

The read() and toJson() functions are used by saveGame() and loadGame().

Note

Despite Game being a value class, we assume that the author wants a game to have identity, much like your main window would have. We therefore don’t use a static fromJson() function, which would create a new object, but a read() function we can call on existing objects. There’s a 1:1 correspondence between read() and fromJson(), in that one can be implemented in terms of the other:

void read(const QJsonObject &json) { *this = fromJson(json); }
static Game fromObject(const QJsonObject &json) { Game g; g.read(json); return g; }

We just use what’s more convenient for callers of the functions.

def newGame(self):

    mPlayer = Character()
    mPlayer.setName("Hero")
    mPlayer.setClassType(Character.Archer)
    mPlayer.setLevel(QRandomGenerator.global().bounded(15, 21))
    mLevels.clear()
    mLevels.reserve(2)
    village = Level("Village")
villageNpcs = QList()
    villageNpcs.reserve(2)
    villageNpcs.append(Character("Barry the Blacksmith",
                                 QRandomGenerator.global().bounded(8, 11), Character.Warrior))
    villageNpcs.append(Character("Terry the Trader",
                                 QRandomGenerator.global().bounded(6, 8), Character.Warrior))
    village.setNpcs(villageNpcs)
    mLevels.append(village)
    dungeon = Level("Dungeon")
dungeonNpcs = QList()
    dungeonNpcs.reserve(3)
    dungeonNpcs.append(Character("Eric the Evil",
                                 QRandomGenerator.global().bounded(18, 26), Character.Mage))
    dungeonNpcs.append(Character("Eric's Left Minion",
                                 QRandomGenerator.global().bounded(5, 7), Character.Warrior))
    dungeonNpcs.append(Character("Eric's Right Minion",
                                 QRandomGenerator.global().bounded(4, 9), Character.Warrior))
    dungeon.setNpcs(dungeonNpcs)
    mLevels.append(dungeon)

To setup a new game, we create the player and populate the levels and their NPCs.

def read(self, json):

    if QJsonValue v = json["player"]; v.isObject():
        mPlayer = Character.fromJson(v.toObject())
    if QJsonValue v = json["levels"]; v.isArray():
        levels = v.toArray()
        mLevels.clear()
        mLevels.reserve(levels.size())
        for level in levels:
            mLevels.append(Level.fromJson(level.toObject()))

The read() function starts by replacing the player with the one read from JSON. We then clear() the level array so that calling loadGame() on the same Game object twice doesn’t result in old levels hanging around.

We then populate the level array by reading each Level from a QJsonArray .

def toJson(self):

    json = QJsonObject()
    json["player"] = mPlayer.toJson()
    levels = QJsonArray()
    for level in mLevels:
        levels.append(level.toJson())
    json["levels"] = levels
    return json

Writing the game to JSON is similar to writing a level.

def loadGame(self, Game.SaveFormat saveFormat):

    loadFile = QFile(saveFormat == Json if "save.json" else "save.dat")
    if not loadFile.open(QIODevice.ReadOnly):
        qWarning("Couldn't open save file.")
        return False

    saveData = loadFile.readAll()
    QJsonDocument loadDoc(saveFormat == Json
                          ? QJsonDocument.fromJson(saveData)
    super().__init__(QCborValue.fromCbor(saveData).toMap().toJsonObject()))
    read(loadDoc.object())
    QTextStream(stdout) << "Loaded save for " << loadDoc["player"]["name"].toString()
                        << " using " << (saveFormat != Json if "CBOR" else "JSON") << "...\n"
    return True

When loading a saved game in loadGame(), the first thing we do is open the save file based on which format it was saved to; "save.json" for JSON, and "save.dat" for CBOR. We print a warning and return false if the file couldn’t be opened.

Since fromJson() and fromCbor() both take a QByteArray , we can read the entire contents of the save file into one, regardless of the save format.

After constructing the QJsonDocument , we instruct the Game object to read itself and then return true to indicate success.

def saveGame(self, Game.SaveFormat saveFormat):

    saveFile = QFile(saveFormat == Json if "save.json" else "save.dat")
    if not saveFile.open(QIODevice.WriteOnly):
        qWarning("Couldn't open save file.")
        return False

    gameObject = toJson()
    saveFile.write(saveFormat == Json ? QJsonDocument(gameObject).toJson()
    super().__init__(gameObject).toCbor())
    return True

Not surprisingly, saveGame() looks very much like loadGame(). We determine the file extension based on the format, print a warning and return false if the opening of the file fails. We then write the Game object to a QJsonObject . To save the game in the format that was specified, we convert the JSON object into either a QJsonDocument for a subsequent toJson() call, or a QCborValue for toCbor() .

Tying It All Together

We are now ready to enter main():

if __name__ == "__main__":

    app = QCoreApplication(argc, argv)
    args = QCoreApplication.arguments()
    bool newGame
            = args.size() <= 1 or QString.compare(args[1], "load", Qt.CaseInsensitive) != 0
    bool json
            = args.size() <= 2 or QString.compare(args[2], "binary", Qt.CaseInsensitive) != 0
    game = Game()
    if newGame:
        game.newGame()
    elif not game.loadGame(json if Game.Json else Game.Binary):
        return 1
    # Game is played; changes are made...

Since we’re only interested in demonstrating serialization of a game with JSON, our game is not actually playable. Therefore, we only need QCoreApplication and have no event loop. On application start-up we parse the command-line arguments to decide how to start the game. For the first argument the options “new” (default) and “load” are available. When “new” is specified a new game will be generated, and when “load” is specified a previously saved game will be loaded in. For the second argument “json” (default) and “binary” are available as options. This argument will decide which file is saved to and/or loaded from. We then move ahead and assume that the player had a great time and made lots of progress, altering the internal state of our Character, Level and Game objects.

s = QTextStream(stdout)
s << "Game ended in the following state:\n"
game.print(s)
if not game.saveGame(json if Game.Json else Game.Binary):
    return 1
return 0

When the player has finished, we save their game. For demonstration purposes, we can serialize to either JSON or CBOR. You can examine the contents of the files in the same directory as the executable (or re-run the example, making sure to also specify the “load” option), although the binary save file will contain some garbage characters (which is normal).

That concludes our example. As you can see, serialization with Qt’s JSON classes is very simple and convenient. The advantages of using QJsonDocument and friends over QDataStream , for example, is that you not only get human-readable JSON files, but you also have the option to use a binary format if it’s required, without rewriting any code.

See also

JSON Support in Qt CBOR Support in Qt Data Input Output

Example project @ code.qt.io