Migration

Migration from v0.10.x to v1.0

Introduction

This document describes the changes that need to be made to your code to migrate from v0.10.x to v1.0.

Being version 1.0.0 it is the first complete release of the library. It is a breaking change and the API has changed significantly. The fundamental change of this release was to split the entire engine into independent modules. This allows for a more modular and flexible design, making it easier to use the engine in different contexts. The size of packages has been reduced significantly (150 MB to 50 MB) and the engine is now more efficient and faster.

The Game namespace object has been introduced for the which contains all the functionality that exploits multiple modules. This is the main entry point for the engine and is used to access all the functions of the engine.

The stepHistory module has been introduced to manage the history of the game. Previously the entire management of the game's history was handled by narration.

clearAllGameDatas(); 
Game.clear(); 

canvas 
    .initialize(body, { 
        height: 1080, 
        width: 1920, 
        backgroundColor: "#303030", 
    }) 
    .then(() => { 
        // Pixi.JS UI Layer //
        canvas.addLayer(CANVAS_UI_LAYER_NAME, new Container()); 
Game.init(body, { 
    height: 1080, 
    width: 1920, 
    backgroundColor: "#303030", 
}).then(() => { 
    // Pixi.JS UI Layer //
    canvas.addLayer(CANVAS_UI_LAYER_NAME, new Container()); 

getSaveData(); 
Game.exportGameState(); 

getSaveJson(); 
JSON.stringify(Game.exportGameState()); 

loadSaveData(data, navigate); 
Game.restoreGameState(data, navigate); 

loadSaveJson(data, navigate); 
Game.restoreGameState(JSON.parse(dataString) as GameState, navigate); 

loadSaveJson(data, navigate); 
Game.restoreGameState(JSON.parse(dataString) as GameState, navigate); 

jsonToSaveData(json); 
JSON.parse(json); 

narration.canGoBack; 
stepHistory.canGoBack; 

narration.goBack(); 
stepHistory.goBack(); 

narration.narrativeHistory; 
stepHistory.narrativeHistory;