Ticket #3258: replay_menu_wip_v5_r16812.patch

binaries/data/mods/public/gui/common/functions_utility.js

@@ -81 +81 @@
         return text;
 
     return text.substr(0, 255).replace(/\\/g, "\\\\").replace(/\[/g, "\\[");
 }
 
+//====================================================================
+
+function capitalizeFirstLetter(text) {
+    return text.charAt(0).toUpperCase() + text.slice(1);
+}
+
 // ====================================================================
 
 // Load default player data, for when it's not otherwise specified
 function initPlayerDefaults()
 {

binaries/data/mods/public/gui/common/functions_utility_loadsave.js

@@ -23 +23 @@
 /**
  * Check the version compatibility between the saved game to be loaded and the engine
  */
 function hasSameVersion(metadata, engineInfo)
 {
-    return (metadata.version_major == engineInfo.version_major);
+    return (metadata.version_major == engineInfo.version_major && metadata.hasOwnProperty("engine_version") && metadata.engine_version == engineInfo.engine_version);
 }
 
 /**
  * Check the mod compatibility between the saved game to be loaded and the engine
  */

binaries/data/mods/public/gui/gamesetup/gamesetup.js

@@ -487 +487 @@
         }
         Engine.SwitchGuiPage("page_loading.xml", {
             "attribs": g_GameAttributes,
             "isNetworked" : g_IsNetworked,
             "playerAssignments": g_PlayerAssignments,
-            "isController": g_IsController
+            "isController": g_IsController,
+            "g_IsReplay" : false
         });
         break;
 
     case "chat":
         addChatMessage({ "type": "message", "guid": message.guid, "text": message.text });

binaries/data/mods/public/gui/page_replay.xml

@@ +1 @@
+<?xml version="1.0" encoding="utf-8"?>
+<page>
+    <include>common/modern/setup.xml</include>
+    <include>common/modern/styles.xml</include>
+    <include>common/modern/sprites.xml</include>
+
+    <include>common/setup.xml</include>
+    <include>common/sprite1.xml</include>
+    <include>common/styles.xml</include>
+    <include>common/common_sprites.xml</include>
+    <include>common/common_styles.xml</include>
+
+    <include>replay/styles.xml</include>
+    <include>replay/replay.xml</include>
+</page>

binaries/data/mods/public/gui/pregame/mainmenu.xml

@@ -344 +344 @@
                         Engine.PushGuiPage("page_locale.xml");
                         ]]>
                     </action>
                 </object>
 
+                <object name="submenuReplayButton"
+                    type="button"
+                    style="StoneButtonFancy"
+                    size="0 64 100% 92"
+                    tooltip_style="pgToolTip"
+                >
+                    <translatableAttribute id="caption">Replay</translatableAttribute>
+                    <translatableAttribute id="tooltip">Shows a replay of a past game.</translatableAttribute>
+                    <action on="Press">
+                        closeMenu();
+                        Engine.SwitchGuiPage("page_replay.xml");
+                    </action>
+                </object>
+
                 <object name="submenuEditorButton"
                     style="StoneButtonFancy"
                     type="button"
-                    size="0 64 100% 92"
+                    size="0 96 100% 124"
                     tooltip_style="pgToolTip"
                 >
                     <translatableAttribute id="caption">Scenario Editor</translatableAttribute>
                     <translatableAttribute id="tooltip">Open the Atlas Scenario Editor in a new window. You can run this more reliably by starting the game with the command-line argument &quot;-editor&quot;.</translatableAttribute>
                     <action on="Press">
@@ -360 +374 @@
                 </object>
 
                 <object name="submenuWelcomeScreenButton"
                     style="StoneButtonFancy"
                     type="button"
-                    size="0 96 100% 124"
+                    size="0 128 100% 156"
                     tooltip_style="pgToolTip"
                 >
                     <translatableAttribute id="caption">Welcome Screen</translatableAttribute>
                     <translatableAttribute id="tooltip">Show the Welcome Screen. Useful if you hid it by mistake.</translatableAttribute>
                     <action on="Press">
@@ -375 +389 @@
                     </action>
                 </object>
                 <object name="submenuModSelection"
                     style="StoneButtonFancy"
                     type="button"
-                    size="0 128 100% 156"
+                    size="0 156 100% 188"
                     tooltip_style="pgToolTip"
                 >
                     <translatableAttribute id="caption">Mod Selection</translatableAttribute>
                     <translatableAttribute id="tooltip">Select mods to use.</translatableAttribute>
                     <action on="Press">
@@ -482 +496 @@
                 >
                     <translatableAttribute id="caption">Tools &amp; Options</translatableAttribute>
                     <translatableAttribute id="tooltip">Game options and scenario design tools.</translatableAttribute>
                     <action on="Press">
                         closeMenu();
-                        openMenu("submenuToolsAndOptions", (this.parent.size.top+this.size.top), (this.size.bottom-this.size.top), 5);
+                        openMenu("submenuToolsAndOptions", (this.parent.size.top+this.size.top), (this.size.bottom-this.size.top), 6);
                     </action>
                 </object>
 
                 <!-- EXIT BUTTON -->
                 <object name="menuExitButton"

binaries/data/mods/public/gui/replay/replay.js

@@ +1 @@
+var g_Replays = []; // All replays found including metadata
+var g_ReplaysFiltered = []; // List of replays after filtering
+var g_Playernames = []; // All playernames of all replays, used for autocomplete
+var g_ReplayListSortBy = "name"; // Used for sorting
+var g_ReplayListOrder = -1; // Used for sorting
+var g_mapSizes = initMapSizes();
+var g_CivData = loadCivData();
+var g_EngineInfo = Engine.GetEngineInfo();
+var g_DefaultPlayerData = initPlayerDefaults();
+var g_maxPlayerlistChars = 70;
+var g_DurationFilterMin = [ 0,  0, 15, 30, 45, 60,  90, 120];
+var g_DurationFilterMax = [-1, 15, 30, 45, 60, 90, 120,  -1];
+
+function init()
+{
+    loadReplays();
+    updateReplayList();
+}
+
+function loadReplays()
+{
+    g_Playernames = [];
+    g_Replays = Engine.GetReplays();
+    for (let replay of g_Replays)
+    {
+        // TODO: enhancement: remove those copies for better performance
+        replay.settings = replay.attribs.settings;
+        replay.playerData = replay.settings.PlayerData;
+
+        // Use time saved in file, otherwise file mod date
+        replay.timestamp = replay.attribs.hasOwnProperty("timestamp") ? replay.attribs.timestamp : replay.filemod_timestamp;
+        
+        // Skirmish maps don't have that attribute 
+        if (!replay.settings.hasOwnProperty("Size"))
+            replay.settings.Size = -1;
+
+        for (var i in replay.playerData)
+        {
+            // I've encountered a file where 'null' was added to the playerData array...
+            if (!replay.playerData[i])
+            {
+                error("Replay " + replay.directory + " has bogus player data!");
+                continue;
+            }
+            var name = replay.playerData[i].Name;
+            if (g_Playernames.indexOf(name) == -1)
+                g_Playernames.push({"name": name});
+        }
+    }
+}
+
+function updateReplayListOrderSelection()
+{
+    g_ReplayListSortBy = Engine.GetGUIObjectByName("replaySelection").selected_column;
+    g_ReplayListOrder = Engine.GetGUIObjectByName("replaySelection").selected_column_order;
+    applyFilters();
+}
+
+function updateReplayList()
+{
+    var replaySelection = Engine.GetGUIObjectByName("replaySelection");
+    
+    // Filters depend on the replay list
+    initFilters();
+
+    if (g_Replays.length == 0)
+        replaySelection.selected = -1;
+
+    // Sort replays
+    g_Replays.sort(function(a,b) 
+    {
+        var cmpA, cmpB;
+        switch (g_ReplayListSortBy)
+        {
+        case 'name':
+            cmpA = a.timestamp;
+            cmpB = b.timestamp;
+            break;
+        case 'duration':
+            cmpA = a.duration;
+            cmpB = b.duration;
+            break;
+        case 'players':
+            cmpA = a.playerData.length;
+            cmpB = b.playerData.length;
+            break;
+        case 'mapName':
+            cmpA = getReplayMapName(a);
+            cmpB = getReplayMapName(b);
+            break;
+        case 'mapSize':
+            cmpA = a.settings.Size;
+            cmpB = b.settings.Size;
+            break;
+        case 'popCapacity':
+            cmpA = a.settings.PopulationCap;
+            cmpB = b.settings.PopulationCap;
+            break;
+        }
+
+        // Sort by selected column
+        if (cmpA < cmpB)
+            return -g_ReplayListOrder;
+        else if (cmpA > cmpB)
+            return g_ReplayListOrder;
+
+        // Sort by date/time as a tiebreaker and keep most recent replays at the top
+        if (a.timestamp < b.timestamp)
+            return 1;
+        else if (a.timestamp > b.timestamp)
+            return -1;
+
+        return 0;
+    });
+    
+    // Filter replays and create GUI list data
+    var replayListLabels = [];
+    var replayListDirectories = [];
+    var list_name = [];
+    var list_players = [];
+    var list_mapName = [];
+    var list_mapSize = [];
+    var list_popCapacity = [];
+    var list_duration = [];
+    g_ReplaysFiltered = [];
+    for (var replay of g_Replays)
+    {
+        if (filterReplay(replay))
+            continue;
+
+        g_ReplaysFiltered.push(replay);
+        
+        // TODO: enhancement: if (settings.GameType != "conquest") use other color
+
+        replayListLabels.push(replay.directory);
+        replayListDirectories.push(replay.directory);
+
+        list_name.push(Greyout(replay, getReplayDateTime(replay)));
+        list_players.push(Greyout(replay, getReplayPlayernames(replay, true)));
+        list_mapName.push(Greyout(replay, getReplayMapName(replay)));
+        list_mapSize.push(Greyout(replay, getReplayMapSizeText(replay.settings.Size)));
+        list_popCapacity.push(Greyout(replay, getReplayPopCap(replay)));
+        list_duration.push(Greyout(replay, getReplayDuration(replay)));
+    }
+
+    // TODO: enhancement: remember last selection, like #3244
+    if (replaySelection.selected >= list_name.length)
+        replaySelection.selected = -1;
+    
+    // Update list
+    replaySelection.list_name = list_name;
+    replaySelection.list_players = list_players;
+    replaySelection.list_mapName = list_mapName; 
+    replaySelection.list_mapSize = list_mapSize;
+    replaySelection.list_popCapacity = list_popCapacity;
+    replaySelection.list_duration = list_duration;
+
+    replaySelection.list = replayListLabels;
+    replaySelection.list_data = replayListDirectories;
+}
+
+function Greyout(replay, text)
+{
+    if (isReplayCompatible(replay))
+        return text;
+    else
+        return '[color="128 128 128"]' + text + '[/color]';
+}
+
+function getReplayDateTime(replay)
+{
+    return Engine.FormatMillisecondsIntoDateString(replay.timestamp * 1000, translate("yyyy-MM-dd HH:mm"))
+}
+
+function getReplayPlayernames(replay, shorten)
+{
+    // Extract playernames
+    var playernames = [];
+    for (let i in replay.playerData)
+    {
+        // I've encountered a file where 'null' was added to the playerData array...
+        if (!replay.playerData[i])
+        {
+            error("Replay " + replay.directory + " has bogus player data!");
+            continue;
+        }
+        
+        var playername = escapeText(replay.playerData[i].Name);
+        
+        // TODO: enhancement: colorize playernames like in lobby using colorPlayerName
+        // #3205 moves the function to common/color.js
+        playernames.push(playername);
+    }
+    
+    if (!shorten)
+        return playernames;
+    
+    playernames = playernames.join(", ");
+    
+    // Shorten if too long
+    if (playernames.length > g_maxPlayerlistChars)
+        return playernames.substr(0, g_maxPlayerlistChars) + "...";
+    else
+        return playernames;
+}
+
+function getReplayMapName(replay)
+{
+    return escapeText(translate(replay.settings.Name));
+}
+
+function getReplayMapSizeText(tiles)
+{
+    var index = g_mapSizes.tiles.indexOf(tiles);
+    if (index > -1)
+        return g_mapSizes.shortNames[index]
+    else 
+        return translateWithContext("map size", "Default");
+}
+
+function getReplayPopCap(replay)
+{
+    if (replay.settings.PopulationCap == 10000)
+        return translateWithContext("population capacity", "Unlimited");
+    else
+        return replay.settings.PopulationCap;   
+}
+
+function getReplayDuration(replay)
+{
+    return timeToString(replay.duration * 1000);
+}
+
+function getReplayTeamText(replay)
+{
+    var spoiler = Engine.GetGUIObjectByName("showSpoiler").checked;
+
+    // Extract players and civs by team
+    var teams = {};
+    var teamCount = 0;
+    for (var i in replay.playerData)
+    {
+        var playerData = replay.playerData[i];
+        
+        // I've encountered a file where 'null' was added to the playerData array...
+        if (!playerData)
+            continue;
+
+        var team = playerData.Team;
+        // TODO: enhancement: too few contrast, see #3205
+        var col = playerData.Color ? playerData.Color : g_DefaultPlayerData[parseInt(i)+1].Color;
+        var civ = g_CivData[playerData.Civ];
+        // TODO: requirement: refactoring with aiconfig.js
+        var aiDiff = [translateWithContext("aiDiff", "Sandbox"), translateWithContext("aiDiff", "Very Easy"), translateWithContext("aiDiff", "Easy"), translateWithContext("aiDiff", "Medium"), translateWithContext("aiDiff", "Hard"), translateWithContext("aiDiff", "Very Hard")];
+        
+        // Create player text
+        var playername = '[color="' + col.r + " " + col.g + " " + col.b + '"]' + escapeText(playerData.Name) + "[/color]";
+        var playerDetails = translate(civ.Name);
+        if (playerData.AI != "")
+            playerDetails += ", " + sprintf(translateWithContext("replay AI text", "%(difficulty)s %(name)s AI"), { "difficulty": aiDiff[playerData.AIDiff], "name": capitalizeFirstLetter(playerData.AI) });
+        if (spoiler && replay.defeatedPlayers.indexOf(parseInt(i) + 1) > -1)
+            playerDetails += ", resigned";
+
+        // Add player text to playerlist
+        var player = playername + escapeText(" (" + playerDetails + ")");
+        if (teams.hasOwnProperty(team))
+        {
+            teams[team].push(player);
+        }
+        else
+        {
+            teams[team] = [player];
+            teamCount++;
+        }
+    }
+    
+    // Create player info text sorted by team
+    var teamString = "";
+    for(var team in teams)
+    {
+        if (teamCount > 1)
+        {
+            if (team == -1)
+                teamString += '[font="sans-bold-14"]No Team:[/font]\n';
+            else
+                teamString += '[font="sans-bold-14"]Team ' + (parseInt(team) + 1) + "[/font]:\n";
+        }
+        teamString += teams[team].join("\n") + "\n";
+    }
+    
+    return teamString;
+}
+
+function isReplayCompatible(replay)
+{
+    if (!isReplayCompatible_EngineVersion(replay))
+        return false;
+    
+    // Now check mods
+    if (replay.attribs.mods)
+        var gameMods = replay.attribs.mods;
+    else
+        var gameMods = [];
+
+    if (gameMods.length != g_EngineInfo.mods.length)
+        return false;
+    
+    for (var i = 0; i < gameMods.length; ++i)
+        if (gameMods[i] != g_EngineInfo.mods[i])
+            return false;
+    
+    return true;
+}
+
+function isReplayCompatible_EngineVersion(replay)
+{
+    return replay.attribs.hasOwnProperty("engine_version")
+            && replay.attribs.engine_version == g_EngineInfo.engine_version;
+}
+
+function initFilters()
+{
+    initDateFilter();
+    initMapNameFilter();
+    initMapSizeFilter();
+    initPopCapFilter();
+    initDurationFilter();
+}
+
+function initDateFilter()
+{
+    var months = ["Any"];
+    for (var replay of g_Replays)
+    {
+        var month = getDateTimeFilterVal(replay);
+            
+        if (months.indexOf(month) == -1)
+            months.push(month);
+    }
+    
+    var dateTimeFilter = Engine.GetGUIObjectByName("dateTimeFilter");
+    dateTimeFilter.list = months;
+    dateTimeFilter.list_data = months;
+    
+    if (dateTimeFilter.selected == -1 || dateTimeFilter.selected >= months.length)
+        dateTimeFilter.selected = 0;
+}
+
+function getDateTimeFilterVal(replay)
+{
+    var date = new Date(replay.timestamp * 1000);
+    return date.getFullYear() + "-" + ('0' + (date.getMonth() + 1)).slice(-2)
+}
+
+function initMapSizeFilter()
+{
+    // Get tilecounts actually used by maps
+    var tiles = [];
+    for (let replay of g_Replays)
+    {
+        if (tiles.indexOf(replay.settings.Size) == -1)
+            tiles.push(replay.settings.Size);
+    }
+    tiles.sort();
+
+    // Add translated names
+    var names = [];
+    for (var size of tiles)
+        names.push(getReplayMapSizeText(size));
+    
+    // Add "Any"
+    names.unshift(translateWithContext("map size", "Any"));
+    tiles.unshift("");
+
+    // Save values to filter
+    var mapSizeFilter = Engine.GetGUIObjectByName("mapSizeFilter");
+    mapSizeFilter.list = names;
+    mapSizeFilter.list_data = tiles;
+    
+    if (mapSizeFilter.selected == -1 || mapSizeFilter.selected >= tiles.length)
+        mapSizeFilter.selected = 0;
+}
+
+function initMapNameFilter()
+{
+    var mapNames = [];
+    for (var replay of g_Replays)
+    {
+        var mapName = escapeText(replay.settings.Name);
+        
+        if (mapNames.indexOf(mapName) == -1)
+            mapNames.push(mapName);
+    }
+
+    mapNames.sort();
+    mapNames.unshift("Any");
+    
+    var mapNameFilter = Engine.GetGUIObjectByName("mapNameFilter");
+    mapNameFilter.list = mapNames;
+    mapNameFilter.list_data = mapNames;
+    
+    if (mapNameFilter.selected == -1 || mapNameFilter.selected >= mapNames.length)
+        mapNameFilter.selected = 0;
+}
+
+function initPopCapFilter()
+{
+    var popCaps = [];
+    for (var replay of g_Replays)
+    {
+        var popCap = getReplayPopCap(replay);
+        if (popCaps.indexOf(popCap) == -1)
+            popCaps.push(popCap);
+    }
+    popCaps.sort();
+    
+    popCaps.unshift("Any");
+    var populationFilter = Engine.GetGUIObjectByName("populationFilter");
+    populationFilter.list = popCaps;
+    populationFilter.list_data = popCaps;
+    
+    if (populationFilter.selected == -1 || populationFilter.selected >= popCaps.length)
+        populationFilter.selected = 0;
+}
+
+function initDurationFilter()
+{
+    var data = [-1];
+    var labels = ["Any"];
+
+    for (var i in g_DurationFilterMin)
+    {
+        if (i == 0)
+            continue;
+        else if (i == 1)
+            var label = sprintf(translateWithContext("duration filter", "< %(min)s min"), { "min": g_DurationFilterMax[i] });
+        else if (i == g_DurationFilterMin.length -1)
+            var label = sprintf(translateWithContext("duration filter", "> %(min)s min"), { "min": g_DurationFilterMin[i] });
+        else
+            var label = sprintf(translateWithContext("duration filter", "%(min1)s - %(min2)s min"), { "min1": g_DurationFilterMin[i], "min2": g_DurationFilterMax[i] });
+        
+        data.push(i);
+        labels.push(label);
+    }
+    
+    var durationFilter = Engine.GetGUIObjectByName("durationFilter");
+    durationFilter.list = labels;
+    durationFilter.list_data = data;
+    
+    if (durationFilter.selected == -1 || durationFilter.selected >= data.length)
+        durationFilter.selected = 0;
+}
+
+function applyFilters()
+{
+    // Update the list of replays
+    updateReplayList();
+
+    // Update info box about the replay currently selected
+    updateReplaySelection();
+}
+
+// Returns true if the replay should not be listed.
+function filterReplay(replay)
+{
+    var dateTimeFilter = Engine.GetGUIObjectByName("dateTimeFilter");
+    var playersFilter = Engine.GetGUIObjectByName("playersFilter");
+    var mapNameFilter = Engine.GetGUIObjectByName("mapNameFilter");
+    var mapSizeFilter = Engine.GetGUIObjectByName("mapSizeFilter");
+    var populationFilter = Engine.GetGUIObjectByName("populationFilter");
+    var durationFilter = Engine.GetGUIObjectByName("durationFilter");
+    var compabilityFilter = Engine.GetGUIObjectByName("compabilityFilter");
+
+    // Check for compability first (most likely to filter)
+    if (compabilityFilter.checked && !isReplayCompatible(replay))
+        return true;
+    
+    // Filter date/time (select a month)
+    if (dateTimeFilter.selected > 0)
+    {
+        let selectedMonth = dateTimeFilter.list_data[dateTimeFilter.selected];
+        if (getDateTimeFilterVal(replay) != selectedMonth)  
+            return true;
+    }
+
+    // Filter selected players
+    let playerText = playersFilter.caption;
+    if (playerText.length)
+    {
+        // Player and botnames can contain spaces
+        // We just check if all words of all players are somewhere in the playerlist
+        playerText = playerText.toLowerCase().split(" ");
+        let replayPlayers = replay.playerData.map(function(player){ return player.Name.toLowerCase() }).join(" ");
+        for (let word of playerText)
+        {
+            if (replayPlayers.indexOf(word) == -1)
+                return true;
+        }
+    }
+
+    // Filter map name
+    if (mapNameFilter.selected > 0)
+    {
+        if (getReplayMapName(replay) != mapNameFilter.list_data[mapNameFilter.selected])
+            return true;
+    }
+
+    // Filter map size
+    if (mapSizeFilter.selected > 0)
+    {
+        let selectedMapSize = mapSizeFilter.list_data[mapSizeFilter.selected];
+        if (replay.settings.Size != selectedMapSize)
+            return true;
+    }
+
+    // Filter population capacity
+    if (populationFilter.selected > 0 &&
+            getReplayPopCap(replay) != populationFilter.list_data[populationFilter.selected])
+    {
+        return true;
+    }
+
+    // Filter game duration
+    if (durationFilter.selected > 0)
+    {
+        let minutes = replay.duration / 60;
+        let min = g_DurationFilterMin[durationFilter.selected];
+        let max = g_DurationFilterMax[durationFilter.selected];
+        
+        if (minutes < min || (max > -1 && minutes > max))
+            return true;
+    }
+
+    return false;
+}
+
+function updateReplaySelection()
+{
+    var selected = Engine.GetGUIObjectByName("replaySelection").selected;
+    var replaySelected = selected > -1;
+    
+    Engine.GetGUIObjectByName("replayInfo").hidden = !replaySelected;
+    Engine.GetGUIObjectByName("replayInfoEmpty").hidden = replaySelected;
+    Engine.GetGUIObjectByName("startReplayButton").enabled = replaySelected;
+    Engine.GetGUIObjectByName("deleteReplayButton").enabled = replaySelected;
+    
+    if (!replaySelected)
+        return;
+    
+    var replay = g_ReplaysFiltered[selected];
+
+    // Load map data
+    if (replay.settings.mapType == "random" && replay.attribs.map == "random")
+        var mapData = {"settings": {"Description": translate("A randomly selected map.")}};
+    else if (replay.settings.mapType == "random" && Engine.FileExists(replay.attribs.map + ".json"))
+        var mapData = Engine.ReadJSONFile(replay.attribs.map + ".json");
+    else if (Engine.FileExists(replay.attribs.map + ".xml"))
+        var mapData = Engine.LoadMapSettings(replay.attribs.map + ".xml");
+    else
+        // Warn the player if we can't find the map. 
+        warn(sprintf("Map '%(mapName)s' not found locally.", { mapName: replay.attribs.map }));
+    
+    // Load map description
+    if (mapData && mapData.settings.Description)
+        var mapDescription = translate(mapData.settings.Description);
+    else
+        var mapDescription = translate("Sorry, no description available.");
+
+    // Load map preview image
+    if (mapData && mapData.settings.Preview)
+        var mapPreview = mapData.settings.Preview;
+    else
+        var mapPreview = "nopreview.png";
+
+    // Update GUI
+    Engine.GetGUIObjectByName("sgMapName").caption = translate(replay.settings.Name);
+    Engine.GetGUIObjectByName("sgMapSize").caption = getReplayMapSizeText(replay.settings.Size);
+    Engine.GetGUIObjectByName("sgMapType").caption = capitalizeFirstLetter(replay.settings.mapType);
+    Engine.GetGUIObjectByName("sgVictory").caption = capitalizeFirstLetter(replay.settings.GameType);
+    Engine.GetGUIObjectByName("sgNbPlayers").caption = replay.playerData.length;
+    Engine.GetGUIObjectByName("sgPlayersNames").caption = getReplayTeamText(replay);
+    Engine.GetGUIObjectByName("sgMapDescription").caption = mapDescription;
+    Engine.GetGUIObjectByName("sgMapPreview").sprite = "cropped:(0.7812,0.5859)session/icons/mappreview/" + mapPreview;
+}
+
+function startReplay()
+{
+    var selected = Engine.GetGUIObjectByName("replaySelection").selected;
+    if (selected == -1)
+        return;
+    
+    var replay = g_ReplaysFiltered[selected];
+    if (isReplayCompatible(replay))
+        reallyStartVisualReplay(replay.directory);
+    else
+        displayReplayCompatibilityError(replay);
+}
+
+function reallyStartVisualReplay(replayDirectory)
+{
+    Engine.StartVisualReplay(replayDirectory);
+    Engine.SwitchGuiPage("page_loading.xml", {
+        "attribs": Engine.GetVisualReplayAttributes(replayDirectory),
+        "isNetworked" : false,
+        "playerAssignments": {},
+        "savedGUIData": "",
+        "isReplay" : true
+    });
+}
+
+function displayReplayCompatibilityError(replay)
+{
+    if (isReplayCompatible_EngineVersion(replay))
+    {
+        if (replay.attribs.mods)
+            var gameMods = replay.attribs.mods;
+        else
+            var gameMods = [];
+
+        var errMsg = translate("The replay is compatible with your version of the game, but you don't have the same mods as in the replay.") + "\n";
+        errMsg += sprintf(translate("Mods enabled in the replay: %(mods)s"), { "mods": gameMods.join(",") }) + "\n";
+        errMsg += sprintf(translate("Currently enabled mods: %(mods)s"), { "mods": g_EngineInfo.mods.join(",") });
+    }
+    else
+    {
+        var errMsg = translate("This replay is not compatible with your version of the game!");
+    }
+
+    var btCaptions = [translate("Ok")];
+    var btCode = [null];
+    messageBox(500, 200, errMsg, translate("REPLAY INCOMPATIBLE"), 0, btCaptions, btCode);
+}
+
+function deleteReplay()
+{
+    var selected = Engine.GetGUIObjectByName("replaySelection").selected;
+    if (selected == -1)
+        return;
+
+    // Ask for confirmation
+    var replay = g_ReplaysFiltered[selected];
+    var btCaptions = [translate("Yes"), translate("No")];
+    var btCode = [function(){ reallyDeleteReplay(replay.directory); }, null];
+    messageBox(500, 200, translate("Are you sure to delete this replay permanently?") + "\n" +  replay.file, translate("DELETE"), 0, btCaptions, btCode);
+}
+
+function deleteReplayWithoutConfirmation()
+{
+    var selected = Engine.GetGUIObjectByName("replaySelection").selected;
+    if (selected > -1)
+        reallyDeleteReplay(g_ReplaysFiltered[selected].directory);
+}
+
+function reallyDeleteReplay(replayDirectory)
+{
+    if (!Engine.DeleteReplay(replayDirectory))
+        error(sprintf("Could not delete replay '%(id)s'", { id: replayDirectory }));
+
+    // Refresh replay list
+    init();
+}
+ No newline at end of file

binaries/data/mods/public/gui/replay/replay.xml

@@ +1 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<objects>
+
+    <script file="gui/common/functions_civinfo.js" />
+    <script file="gui/common/functions_global_object.js" />
+    <script file="gui/common/functions_utility.js" />
+    <script file="gui/replay/replay.js" />
+
+    <object type="image" style="ModernWindow" size="0 0 100% 100%" name="replayWindow">
+
+        <object style="ModernLabelText" type="text" size="50%-128 0%+4 50%+128 36">
+            <translatableAttribute id="caption">Replay Games</translatableAttribute>
+        </object>
+        
+        <!-- Left Panel: Filters & Replay List -->
+        <object name="leftPanel" size="3% 5% 100%-255 100%-80">
+
+            <!-- Filters -->
+            <object name="filterPanel" size="0 0 100% 24">
+                <object name="dateTimeFilter"
+                    type="dropdown"
+                    style="ModernDropDown"
+                    size="5 0 110-10 100%"
+                    font="sans-bold-13">
+                    <action on="SelectionChange">applyFilters();</action>
+                </object>
+                <object name="playersFilter"
+                    type="input"
+                    style="ModernInput"
+                    size="110-5 0 110+400-10 100%"
+                    font="sans-bold-13">
+                    <action on="Press">applyFilters();</action>
+                    <action on="Tab">autoCompleteNick("playersFilter", g_Playernames);</action>
+                </object>
+                <object name="mapNameFilter"
+                    type="dropdown"
+                    style="ModernDropDown"
+                    size="110+400-5 0 110+400+140-10 100%"
+                    font="sans-bold-13">
+                    <action on="SelectionChange">applyFilters();</action>
+                </object>
+                <object name="mapSizeFilter"
+                    type="dropdown"
+                    style="ModernDropDown"
+                    size="110+400+140-5 0 110+400+140+80-10 100%"
+                    font="sans-bold-13">
+                    <action on="SelectionChange">applyFilters();</action>
+                </object>
+                <object name="populationFilter"
+                    type="dropdown"
+                    style="ModernDropDown"
+                    size="110+400+140+80-5 0 110+400+140+80+80-10 100%"
+                    font="sans-bold-13">
+                    <action on="SelectionChange">applyFilters();</action>
+                </object>
+                <object name="durationFilter"
+                    type="dropdown"
+                    style="ModernDropDown"
+                    size="110+400+140+80+80-5 0 110+400+140+80+80+80-10 100%"
+                    font="sans-bold-13">
+                    <action on="SelectionChange">applyFilters();</action>
+                </object>
+                <object name="compabilityFilter"
+                    type="checkbox"
+                    checked="true"
+                    style="ModernTickBox"
+                    size="110+400+140+80+80+73 4 110+400+140+80+80+70+20 100%"
+                    font="sans-bold-13">
+                    <action on="Press">applyFilters();</action>
+                </object>
+                <object type="text" size="110+400+140+80+80+80+10 2 100% 100%" text_align="left" textcolor="white">
+                    <translatableAttribute id="caption">Compatible</translatableAttribute>
+                </object>
+            </object>
+
+            <!-- Replay list -->
+            <object name="replaySelection" size="0 35 100% 100%"  style="ModernList" type="olist" sortable="true" default_column="name" sprite_asc="ModernArrowDown" sprite_desc="ModernArrowUp" sprite_not_sorted="ModernNotSorted" font="sans-stroke-13">
+                <action on="SelectionChange">updateReplaySelection();</action>
+                <action on="SelectionColumnChange">updateReplayListOrderSelection();</action>
+                <!-- Columns -->
+                <!-- 0ad crashes if there is no column with the id "name"! -->
+                <def id="name" color="0 128 128" width="110">
+                    <translatableAttribute id="heading" context="replay">Date / Time</translatableAttribute>
+                </def>
+                <def id="players" color="0 128 128" width="400">
+                    <translatableAttribute id="heading" context="replay">Players</translatableAttribute>
+                </def>
+                <def id="mapName" color="0 128 128" width="140">
+                    <translatableAttribute id="heading" context="replay">Map Name</translatableAttribute>
+                </def>
+                <def id="mapSize" color="0 128 128" width="80">
+                    <translatableAttribute id="heading" context="replay">Size</translatableAttribute>
+                </def>
+                <def id="popCapacity" color="0 128 128" width="80">
+                    <translatableAttribute id="heading" context="replay">Population</translatableAttribute>
+                </def>
+                <def id="duration" color="0 128 128" width="80">
+                    <translatableAttribute id="heading" context="replay">Duration</translatableAttribute>
+                </def>
+            </object>
+        </object>
+        
+        <!-- Right Panel: Replay Details -->
+        <object name="rightPanel" size="100%-250 30 100%-20 100%-20" >
+            
+            <object name="replayInfoEmpty" size="0 0 100% 100%-60" type="image" sprite="ModernDarkBoxGold" hidden="false">
+                <object name="logo" size="50%-110 40 50%+110 140" type="image" sprite="logo"/>
+                <object name="subjectBox" type="image" sprite="ModernDarkBoxWhite" size="3% 180 97% 99%">
+                    <object name="subject" size="5 5 100%-5 100%-5" type="text" style="ModernText" text_align="center"/>
+                </object>
+            </object>
+            
+            <object name="replayInfo" size="0 0 100% 100%-60" type="image" sprite="ModernDarkBoxGold" hidden="true">
+
+                <!-- Map Name -->
+                <object name="sgMapName" size="0 5 100% 20" type="text" style="ModernLabelText"/>
+
+                <!-- Map Preview -->
+                <object name="sgMapPreview" size="5 25 100%-5 190"  type="image" sprite=""/>
+
+                <object size="5 194 100%-5 195" type="image" sprite="ModernWhiteLine" z="25"/>
+
+                <!-- Map Type -->
+                <object size="5 195 50% 225" type="image" sprite="ModernItemBackShadeLeft">
+                    <object size="0 0 100%-10 100%" type="text" style="ModernLabelText" text_align="right">
+                        <translatableAttribute id="caption">Map Type:</translatableAttribute>
+                    </object>
+                </object>
+                <object size="50% 195 100%-5 225" type="image" sprite="ModernItemBackShadeRight">
+                    <object name="sgMapType" size="0 0 100% 100%" type="text" style="ModernLabelText" text_align="left"/>
+                </object>
+
+                <object size="5 224 100%-5 225" type="image" sprite="ModernWhiteLine" z="25"/>
+
+                <!-- Map Size -->
+                <object size="5 225 50% 255" type="image" sprite="ModernItemBackShadeLeft">
+                    <object size="0 0 100%-10 100%" type="text" style="ModernLabelText" text_align="right">
+                        <translatableAttribute id="caption">Map Size:</translatableAttribute>
+                    </object>
+                </object>
+                <object size="50% 225 100%-5 255" type="image" sprite="ModernItemBackShadeRight">
+                    <object name="sgMapSize" size="0 0 100% 100%" type="text" style="ModernLabelText" text_align="left"/>
+                </object>
+
+                <object size="5 254 100%-5 255" type="image" sprite="ModernWhiteLine" z="25"/>
+
+                <!-- Victory Condition -->
+                <object size="5 255 50% 285" type="image" sprite="ModernItemBackShadeLeft">
+                    <object size="0 0 100%-10 100%" type="text" style="ModernLabelText" text_align="right">
+                        <translatableAttribute id="caption">Victory:</translatableAttribute>
+                    </object>
+                </object>
+                <object size="50% 255 100%-5 285" type="image" sprite="ModernItemBackShadeRight">
+                    <object name="sgVictory" size="0 0 100% 100%" type="text" style="ModernLabelText" text_align="left"/>
+                </object>
+
+                <object size="5 284 100%-5 285" type="image" sprite="ModernWhiteLine" z="25"/>
+
+                <!-- Map Description -->
+                <object type="image" sprite="ModernDarkBoxWhite" size="3% 290 97% 70%">
+                    <object name="sgMapDescription" size="0 0 100% 100%" type="text" style="ModernText" font="sans-12"/>
+                </object>
+
+                <object type="image" sprite="ModernDarkBoxWhite" size="3% 70%+5 97% 100%-30">
+                    <!-- Number of Players -->
+                    <object size="0% 3% 57% 12%" type="text" style="ModernRightLabelText">
+                        <translatableAttribute id="caption">Players:</translatableAttribute>
+                    </object>
+                    <object name="sgNbPlayers" size="58% 3% 70% 12%" type="text" style="ModernLeftLabelText" text_align="left"/>
+
+                    <!-- Player Names -->
+                    <object name="sgPlayersNames" size="0 15% 100% 100%" type="text" style="MapPlayerList"/>
+                </object>
+                
+                <object name="showSpoiler"
+                    type="checkbox"
+                    checked="false"
+                    style="ModernTickBox"
+                    size="10 100%-27 30 100%"
+                    font="sans-bold-13">
+                    <action on="Press">updateReplaySelection();</action>
+                </object>
+                <object type="text" size="30 100%-28 100% 100%" text_align="left" textcolor="white">
+                    <translatableAttribute id="caption">Spoiler</translatableAttribute>
+                </object>
+                
+            </object>
+        </object>
+
+        <!-- Bottom Panel: Buttons. -->
+        <object name="bottomPanel" size="25 100%-55 100%-5 100%-25" >
+        
+            <object type="button" style="StoneButton" size="0%+25 0 17%+25 100%">
+                <translatableAttribute id="caption">Main Menu</translatableAttribute>
+                <action on="Press">
+                    Engine.SwitchGuiPage("page_pregame.xml");
+                </action>
+            </object>
+
+            <object name="deleteReplayButton" type="button" style="StoneButton" size="65%-50 0 82%-50 100%" hotkey="session.savedgames.delete">
+                <translatableAttribute id="caption">Delete</translatableAttribute>
+                <action on="Press">
+                    if (!this.enabled)
+                        return;
+                    if (Engine.HotkeyIsPressed("session.savedgames.noConfirmation"))
+                        deleteReplayWithoutConfirmation();
+                    else
+                        deleteReplay();
+                </action>
+            </object>
+
+            <object name="startReplayButton" type="button" style="StoneButton" size="83%-25 0 100%-25 100%">
+                <translatableAttribute id="caption">Start Replay</translatableAttribute>
+                <action on="Press">
+                    startReplay();
+                </action>
+            </object>
+            
+        </object>
+    </object>
+</objects>
+ No newline at end of file

binaries/data/mods/public/gui/replay/styles.xml

@@ +1 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<styles>
+    <style name="MapPlayerList"
+        buffer_zone="8"
+        font="sans-14"
+        scrollbar="true"
+        scrollbar_style="ModernScrollBar"
+        scroll_bottom="true"
+        textcolor="white"
+        text_align="left"
+        text_valign="top"
+    />
+</styles>

binaries/data/mods/public/gui/session/session.js

@@ -5 +5 @@
 var g_IsController;
 // Match ID for tracking
 var g_MatchID;
 // Is this user an observer?
 var g_IsObserver = false;
+var g_IsReplay = false;
 
 // Cache the basic player data (name, civ, color)
 var g_Players = [];
 // Cache the useful civ data
 var g_CivData = {};
@@ -149 +150 @@
 {
     if (initData)
     {
         g_IsNetworked = initData.isNetworked; // Set network mode
         g_IsController = initData.isController; // Set controller mode
+        g_IsReplay = initData.isReplay; // Set replay mode
         g_PlayerAssignments = initData.playerAssignments;
         g_MatchID = initData.attribs.matchID;
 
         // Cache the player data
         // (This may be updated at runtime by handleNetMessage)
@@ -352 +354 @@
     Engine.SwitchGuiPage("page_summary.xml", {
                             "gameResult"  : gameResult,
                             "timeElapsed" : extendedSimState.timeElapsed,
                             "playerStates": extendedSimState.players,
                             "players": g_Players,
-                            "mapSettings": mapSettings
+                            "mapSettings": mapSettings,
+                            "isReplay" : g_IsReplay
                          });
 }
 
 // Return some data that we'll use when hotloading this file after changes
 function getHotloadData()

binaries/data/mods/public/gui/summary/summary.js

@@ -28 +28 @@
 const INCOME_COLOR = '[color="201 255 200"]';
 const OUTCOME_COLOR = '[color="255 213 213"]';
 
 const DEFAULT_DECIMAL = "0.00";
 const INFINITE_SYMBOL = "\u221E";
+var g_IsReplay = false;
 // Load data
 var g_CivData = loadCivData();
 var g_Teams = [ ];
 // TODO set g_MaxPlayers as playerCounters.length
 var g_MaxPlayers = 0;
@@ -132 +133 @@
 
 function init(data)
 {
     updateObjectPlayerPosition();
     g_GameData = data;
-
+    g_IsReplay = data.isReplay;
     // Map
     var mapDisplayType = translate("Scenario");
 
     Engine.GetGUIObjectByName("timeElapsed").caption = sprintf(translate("Game time elapsed: %(time)s"), { time: timeToString(data.timeElapsed) });
 
@@ -165 +166 @@
     g_MaxPlayers = data.playerStates.length - 1;
 
     if (data.mapSettings.LockTeams) // teams ARE locked
     {
         // count teams
-        for(var t = 0; t < g_MaxPlayers; ++t)
+        for (var t = 0; t < g_MaxPlayers; ++t)
         {
             if (!g_Teams[data.playerStates[t+1].team])
             {
                 g_Teams[data.playerStates[t+1].team] = 1;
                 continue;
@@ -184 +185 @@
         g_Teams = false;
 
     // Erase teams data if teams are not displayed
     if (!g_Teams)
     {
-        for(var p = 0; p < g_MaxPlayers; ++p)
+        for (var p = 0; p < g_MaxPlayers; ++p)
             data.playerStates[p+1].team = -1;
     }
 
     g_WithoutTeam = g_MaxPlayers;
     if (g_Teams)

binaries/data/mods/public/gui/summary/summary.xml

@@ -155 +155 @@
         </object>
 
         <object type="button" style="ModernButtonRed" size="100%-160 100%-48 100%-20 100%-20">
             <translatableAttribute id="caption">Continue</translatableAttribute>
             <action on="Press"><![CDATA[
-                if (!Engine.HasXmppClient())
+                if (Engine.HasXmppClient())
                 {
-                    Engine.SwitchGuiPage("page_pregame.xml");
+                    Engine.LobbySetPlayerPresence("available");
+                    Engine.SwitchGuiPage("page_lobby.xml");
+                }
+                else if (g_IsReplay)
+                {
+                    Engine.SwitchGuiPage("page_replay.xml"); 
                 }
                 else
                 {
-                    Engine.LobbySetPlayerPresence("available");
-                    Engine.SwitchGuiPage("page_lobby.xml");
+                    Engine.SwitchGuiPage("page_pregame.xml");
                 }
                 ]]>
             </action>
         </object>
     </object>

binaries/data/mods/public/simulation/data/game_speeds.json

@@ -31 +31 @@
             "Speed": 1.5
         },
         {
             "Name": "Insane (2x)",
             "Speed": 2.0
+        },
+        {
+            "Name": "Fast forward (5x)",
+            "Speed": 5.0
+        },
+        {
+            "Name": "Faster forward (10x)",
+            "Speed": 10.0
+        },
+        {
+            "Name": "Very fast forward (20x)",
+            "Speed": 20.0
         }
     ]
 }

source/gui/scripting/ScriptFunctions.cpp

@@ -48 +48 @@
 #include "ps/Globals.h" // g_frequencyFilter
 #include "ps/Hotkey.h"
 #include "ps/ProfileViewer.h"
 #include "ps/Pyrogenesis.h"
 #include "ps/SavedGame.h"
+#include "ps/VisualReplay.h"
 #include "ps/UserReport.h"
 #include "ps/World.h"
 #include "ps/scripting/JSInterface_ConfigDB.h"
 #include "ps/scripting/JSInterface_Console.h"
 #include "ps/scripting/JSInterface_Mod.h"
@@ -281 +282 @@
     shared_ptr<ScriptInterface::StructuredClone> GUIMetadataClone = pCxPrivate->pScriptInterface->WriteStructuredClone(GUIMetadata);
     if (SavedGames::SavePrefix(prefix, description, *g_Game->GetSimulation2(), GUIMetadataClone, g_Game->GetPlayerID()) < 0)
         LOGERROR("Failed to save game");
 }
 
+JS::Value StartVisualReplay(ScriptInterface::CxPrivate* pCxPrivate, std::wstring directoryName)
+{
+    JSContext* cxGui = pCxPrivate->pScriptInterface->GetContext();
+    JSAutoRequest rq(cxGui);
+    JS::RootedValue guiContextMetadata(cxGui);
+
+    ENSURE(!g_NetServer);
+    ENSURE(!g_NetClient);
+    ENSURE(!g_Game);
+
+    CStrW replayFilePath = OsPath(VisualReplay::GetDirectoryName() / directoryName / L"commands.txt").string();
+    std::string replayFile( replayFilePath.begin(), replayFilePath.end() );
+
+    if (FileExists(OsPath(replayFile)))
+    {
+        g_Game = new CGame(false, false);
+        g_Game->StartReplay(replayFile);
+    }
+
+    return guiContextMetadata;
+}
+
+JS::Value GetVisualReplayAttributes(ScriptInterface::CxPrivate* pCxPrivate, std::wstring directoryName)
+{
+    CStrW replayFilePath = OsPath(VisualReplay::GetDirectoryName() / directoryName / "commands.txt").string();
+    std::string replayFile( replayFilePath.begin(), replayFilePath.end() );
+
+    if (!FileExists(OsPath(replayFile)))
+        return {};
+
+    std::istream* replayStream = new std::ifstream(replayFile.c_str());
+    std::string type, line;
+    ENSURE((*replayStream >> type).good() && type == "start");
+
+    std::getline(*replayStream, line);
+    JS::RootedValue attribs(pCxPrivate->pScriptInterface->GetContext());
+    pCxPrivate->pScriptInterface->ParseJSON(line, &attribs);
+    delete replayStream;
+    return attribs;
+}
+
 void SetNetworkGameAttributes(ScriptInterface::CxPrivate* pCxPrivate, JS::HandleValue attribs1)
 {
     ENSURE(g_NetServer);
     //TODO: This is a workaround because we need to pass a MutableHandle to a JSAPI functions somewhere
     // (with no obvious reason).
@@ -415 +457 @@
 bool DeleteSavedGame(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), std::wstring name)
 {
     return SavedGames::DeleteSavedGame(name);
 }
 
+JS::Value GetReplays(ScriptInterface::CxPrivate* pCxPrivate)
+{
+    return VisualReplay::GetReplays(*(pCxPrivate->pScriptInterface));
+}
+
+bool DeleteReplay(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), std::wstring replayFile)
+{
+    return VisualReplay::DeleteReplay(replayFile);
+}
+
 void OpenURL(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), std::string url)
 {
     sys_open_url(url);
 }
 
@@ -974 +1026 @@
     scriptInterface.RegisterFunction<void, std::wstring, std::wstring, JS::HandleValue, &SaveGame>("SaveGame");
     scriptInterface.RegisterFunction<void, std::wstring, std::wstring, JS::HandleValue, &SaveGamePrefix>("SaveGamePrefix");
     scriptInterface.RegisterFunction<void, &QuickSave>("QuickSave");
     scriptInterface.RegisterFunction<void, &QuickLoad>("QuickLoad");
 
+    // Visual replay
+    scriptInterface.RegisterFunction<JS::Value, &GetReplays>("GetReplays");
+    scriptInterface.RegisterFunction<bool, std::wstring, &DeleteReplay>("DeleteReplay");
+    scriptInterface.RegisterFunction<JS::Value, std::wstring, &StartVisualReplay>("StartVisualReplay");
+    scriptInterface.RegisterFunction<JS::Value, std::wstring, &GetVisualReplayAttributes>("GetVisualReplayAttributes");
+
     // Misc functions
     scriptInterface.RegisterFunction<std::wstring, std::wstring, &SetCursor>("SetCursor");
     scriptInterface.RegisterFunction<int, &GetPlayerID>("GetPlayerID");
     scriptInterface.RegisterFunction<void, int, &SetPlayerID>("SetPlayerID");
     scriptInterface.RegisterFunction<void, std::string, &OpenURL>("OpenURL");

source/lobby/XmppClient.cpp

@@ -22 +22 @@
 #include "glooxwrapper/glooxwrapper.h"
 #include "i18n/L10n.h"
 #include "lib/utf8.h"
 #include "ps/CLogger.h"
 #include "ps/ConfigDB.h"
+#include "ps/EngineVersion.h"
 #include "scriptinterface/ScriptInterface.h"
 
 //debug
 #if 1
 #define DbgXMPP(x)
@@ -95 +96 @@
     const int mechs = gloox::SaslMechAll ^ gloox::SaslMechPlain;
     m_client->setSASLMechanisms(mechs);
 
     m_client->registerConnectionListener(this);
     m_client->setPresence(gloox::Presence::Available, -1);
-    m_client->disco()->setVersion("Pyrogenesis", "0.0.19");
+    m_client->disco()->setVersion("Pyrogenesis", utf8_from_wstring(engine_version));
     m_client->disco()->setIdentity("client", "bot");
     m_client->setCompression(false);
 
     m_client->registerStanzaExtension(new GameListQuery());
     m_client->registerIqHandler(this, EXTGAMELISTQUERY);

source/ps/EngineVersion.h

@@ +1 @@
+const wchar_t engine_version[] = L"0.0.19";

source/ps/Game.cpp

@@ -134 +134 @@
         if (type == "turn")
         {
             u32 turn = 0;
             u32 turnLength = 0;
             *m_ReplayStream >> turn >> turnLength;
+
+            if (turn == 0 && turn != currentTurn)
+                LOGERROR("Looks like you tried to replay a commands.txt file of a rejoined client.\n");
+
             ENSURE(turn == currentTurn);
+
             replayTurnMgr->StoreReplayTurnLength(currentTurn, turnLength);
         }
         else if (type == "cmd")
         {
             player_id_t player;
@@ -162 +167 @@
         else
         {
             CancelLoad(L"Failed to load replay data (unrecognized content)");
         }
     }
+    m_ReplayStream->close();
     m_FinalReplayTurn = currentTurn;
     replayTurnMgr->StoreFinalReplayTurn(currentTurn);
     return 0;
 }
 
@@ -173 +179 @@
 {
     m_IsReplay = true;
     ScriptInterface& scriptInterface = m_Simulation2->GetScriptInterface();
 
     SetTurnManager(new CNetReplayTurnManager(*m_Simulation2, GetReplayLogger()));
+    SetPlayerID(-1);
 
     m_ReplayPath = replayPath;
     m_ReplayStream = new std::ifstream(m_ReplayPath.c_str());
 
     std::string type;

source/ps/Game.h

@@ -176 +176 @@
     bool m_IsSavedGame; // true if loading a saved game; false for a new game
 
     int LoadReplayData();
     std::string m_ReplayPath;
     bool m_IsReplay;
-    std::istream* m_ReplayStream;
+    std::ifstream* m_ReplayStream;
     u32 m_FinalReplayTurn;
 };
 
 extern CGame *g_Game;
 

source/ps/GameSetup/GameSetup.cpp

@@ -879 +879 @@
     srand(time(NULL));  // NOTE: this rand should *not* be used for simulation!
 }
 
 bool Autostart(const CmdLineArgs& args);
 
-// Returns true if and only if the user has intended to replay a file
-bool VisualReplay(const std::string replayFile);
+bool StartVisualReplay(const std::string replayFile);
 
 bool Init(const CmdLineArgs& args, int flags)
 {
     h_mgr_init();
 
@@ -1078 +1077 @@
     if (VfsDirectoryExists(L"maps/"))
         CXeromyces::AddValidator(g_VFS, "map", "maps/scenario.rng");
 
     try
     {
-        if (!VisualReplay(args.Get("replay-visual")) && !Autostart(args))
+        if (!StartVisualReplay(args.Get("replay-visual")) && !Autostart(args))
         {
             const bool setup_gui = ((flags & INIT_NO_GUI) == 0);
             // We only want to display the splash screen at startup
             shared_ptr<ScriptInterface> scriptInterface = g_GUI->GetScriptInterface();
             JSContext* cx = scriptInterface->GetContext();
@@ -1475 +1474 @@
     }
 
     return true;
 }
 
-bool VisualReplay(const std::string replayFile)
+bool StartVisualReplay(const std::string replayFile)
 {
     if (!FileExists(OsPath(replayFile)))
         return false;
 
     g_Game = new CGame(false, false);
-    g_Game->SetPlayerID(-1);
     g_Game->StartReplay(replayFile);
 
     // TODO: Non progressive load can fail - need a decent way to handle this
     LDR_NonprogressiveLoad();
 

source/ps/Pyrogenesis.cpp

@@ -1 @@
-/* Copyright (C) 2009 Wildfire Games.
+/* Copyright (C) 2015 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 2 of the License, or
@@ -19 +19 @@
 
 #include <cstdio>
 
 #include "Pyrogenesis.h"
 
+#include "ps/EngineVersion.h"
 #include "lib/sysdep/sysdep.h"
 #include "lib/svn_revision.h"
 
 static const wchar_t* translate_no_mem = L"(no mem)";
 
@@ -71 +72 @@
 
 // for user convenience, bundle all logs into this file:
 void psBundleLogs(FILE* f)
 {
     fwprintf(f, L"SVN Revision: %ls\n\n", svn_revision);
+    fwprintf(f, L"Engine Version: %ls\n\n", engine_version);
 
     fwprintf(f, L"System info:\n\n");
     OsPath path1 = psLogDir()/"system_info.txt";
     AppendAsciiFile(f, path1);
     fwprintf(f, L"\n\n====================================\n\n");

source/ps/Replay.cpp

@@ -22 +22 @@
 #include "graphics/TerrainTextureManager.h"
 #include "lib/timer.h"
 #include "lib/file/file_system.h"
 #include "lib/res/h_mgr.h"
 #include "lib/tex/tex.h"
+#include "ps/EngineVersion.h"
 #include "ps/Game.h"
 #include "ps/Loader.h"
 #include "ps/Profile.h"
+#include "ps/Mod.h"
 #include "ps/ProfileViewer.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "scriptinterface/ScriptStats.h"
 #include "simulation2/Simulation2.h"
 #include "simulation2/helpers/SimulationCommand.h"
@@ -52 +54 @@
 }
 
 CReplayLogger::CReplayLogger(ScriptInterface& scriptInterface) :
     m_ScriptInterface(scriptInterface)
 {
+    m_Stream = NULL;
+}
+
+CReplayLogger::~CReplayLogger()
+{
+    delete m_Stream;
+}
+
+void CReplayLogger::StartGame(JS::MutableHandleValue attribs)
+{
     // Construct the directory name based on the PID, to be relatively unique.
     // Append "-1", "-2" etc if we run multiple matches in a single session,
     // to avoid accidentally overwriting earlier logs.
 
     std::wstringstream name;
@@ -65 +77 @@
     if (++run)
         name << "-" << run;
 
     OsPath path = psLogDir() / L"sim_log" / name.str() / L"commands.txt";
     CreateDirectories(path.Parent(), 0700);
-    m_Stream = new std::ofstream(OsString(path).c_str(), std::ofstream::out | std::ofstream::trunc);
-}
 
-CReplayLogger::~CReplayLogger()
-{
-    delete m_Stream;
-}
+    // Add timestamp and engine version to game attributes
+    m_ScriptInterface.SetProperty(attribs, "timestamp", std::time(0));
+    m_ScriptInterface.SetProperty(attribs, "engine_version", utf8_from_wstring(engine_version));
+    m_ScriptInterface.SetProperty(attribs, "mods", g_modsLoaded);
 
-void CReplayLogger::StartGame(JS::MutableHandleValue attribs)
-{
+    m_Stream = new std::ofstream(OsString(path).c_str(), std::ofstream::out | std::ofstream::trunc);
     *m_Stream << "start " << m_ScriptInterface.StringifyJSON(attribs, false) << "\n";
 }
 
 void CReplayLogger::Turn(u32 n, u32 turnLength, std::vector<SimulationCommand>& commands)
 {
@@ -157 +166 @@
     JSContext* cx = g_Game->GetSimulation2()->GetScriptInterface().GetContext();
     JSAutoRequest rq(cx);
     std::string type;
     while ((*m_Stream >> type).good())
     {
-//      if (turn >= 1400) break;
-
         if (type == "start")
         {
             std::string line;
             std::getline(*m_Stream, line);
             JS::RootedValue attribs(cx);
@@ -198 +205 @@
             std::string replayHash;
             *m_Stream >> replayHash;
 
             bool quick = (type == "hash-quick");
 
-//          if (turn >= 1300)
-//          if (turn >= 0)
             if (turn % 100 == 0)
             {
                 std::string hash;
                 bool ok = g_Game->GetSimulation2()->ComputeStateHash(hash, quick);
                 ENSURE(ok);
@@ -224 +229 @@
 
                 g_Game->GetSimulation2()->Update(turnLength, commands);
                 commands.clear();
             }
 
-//          std::string hash;
-//          bool ok = g_Game->GetSimulation2()->ComputeStateHash(hash, true);
-//          ENSURE(ok);
-//          debug_printf("%s\n", Hexify(hash).c_str());
-
             g_Profiler.Frame();
 
-//          if (turn % 1000 == 0)
-//              JS_GC(g_Game->GetSimulation2()->GetScriptInterface().GetContext());
-
             if (turn % 20 == 0)
                 g_ProfileViewer.SaveToFile();
         }
         else
         {
             debug_printf("Unrecognised replay token %s\n", type.c_str());
         }
     }
     }
-
+    m_Stream->close();
     g_Profiler2.SaveToFile();
 
     std::string hash;
     bool ok = g_Game->GetSimulation2()->ComputeStateHash(hash, false);
     ENSURE(ok);

source/ps/Replay.h

@@ -90 +90 @@
 
     void Load(const std::string& path);
     void Replay(bool serializationtest, bool ooslog);
 
 private:
-    std::istream* m_Stream;
+    std::ifstream* m_Stream;
 };
 
 #endif // INCLUDED_REPLAY

source/ps/SavedGame.cpp

@@ -1 @@
-/* Copyright (C) 2014 Wildfire Games.
+/* Copyright (C) 2015 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 2 of the License, or
@@ -24 +24 @@
 #include "lib/allocators/shared_ptr.h"
 #include "lib/file/archive/archive_zip.h"
 #include "i18n/L10n.h"
 #include "lib/utf8.h"
 #include "ps/CLogger.h"
+#include "ps/EngineVersion.h"
 #include "ps/Filesystem.h"
 #include "ps/Game.h"
 #include "ps/Mod.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "simulation2/Simulation2.h"
@@ -84 +85 @@
     JS::RootedValue metadata(cx);
     JS::RootedValue initAttributes(cx, simulation.GetInitAttributes());
     simulation.GetScriptInterface().Eval("({})", &metadata);
     simulation.GetScriptInterface().SetProperty(metadata, "version_major", SAVED_GAME_VERSION_MAJOR);
     simulation.GetScriptInterface().SetProperty(metadata, "version_minor", SAVED_GAME_VERSION_MINOR);
+    simulation.GetScriptInterface().SetProperty(metadata, "engine_version", utf8_from_wstring(engine_version));
+
     simulation.GetScriptInterface().SetProperty(metadata, "mods", g_modsLoaded);
     simulation.GetScriptInterface().SetProperty(metadata, "time", (double)now);
     simulation.GetScriptInterface().SetProperty(metadata, "player", playerID);
     simulation.GetScriptInterface().SetProperty(metadata, "initAttributes", initAttributes);
 
@@ -296 +299 @@
     JSContext* cx = scriptInterface.GetContext();
     JSAutoRequest rq(cx);
     
     JS::RootedValue metainfo(cx); 
     scriptInterface.Eval("({})", &metainfo); 
-    scriptInterface.SetProperty(metainfo, "version_major", SAVED_GAME_VERSION_MAJOR); 
-    scriptInterface.SetProperty(metainfo, "version_minor", SAVED_GAME_VERSION_MINOR); 
-    scriptInterface.SetProperty(metainfo, "mods"         , g_modsLoaded);
+    scriptInterface.SetProperty(metainfo, "version_major", SAVED_GAME_VERSION_MAJOR);
+    scriptInterface.SetProperty(metainfo, "version_minor", SAVED_GAME_VERSION_MINOR);
+    scriptInterface.SetProperty(metainfo, "engine_version", utf8_from_wstring(engine_version));
+
+    scriptInterface.SetProperty(metainfo, "mods", g_modsLoaded);
     return metainfo;
 }
 

source/ps/VisualReplay.cpp

@@ +1 @@
+/* Copyright (C) 2015 Wildfire Games.
+ * This file is part of 0 A.D.
+ *
+ * 0 A.D. is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 0 A.D. is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "precompiled.h"
+
+#include "VisualReplay.h"
+
+#include "graphics/GameView.h"
+#include "gui/GUIManager.h"
+#include "lib/allocators/shared_ptr.h"
+#include "lib/utf8.h"
+#include "ps/CLogger.h"
+#include "ps/EngineVersion.h"
+#include "ps/Filesystem.h"
+#include "ps/Game.h"
+#include "scriptinterface/ScriptInterface.h"
+
+OsPath VisualReplay::GetDirectoryName()
+{
+    return OsPath(psLogDir() / L"sim_log");
+}
+
+JS::Value VisualReplay::GetReplays(ScriptInterface& scriptInterface)
+{
+    // TODO: enhancement: load from cache
+
+    TIMER(L"GetReplays");
+    JSContext* cx = scriptInterface.GetContext();
+    JSAutoRequest rq(cx);
+    
+    u32 i = 0;
+    DirectoryNames directories;
+    JS::RootedObject replays(cx, JS_NewArrayObject(cx, 0));
+    GetDirectoryEntries(GetDirectoryName(), NULL, &directories);
+    for (auto& directory : directories)
+    {
+        JS::RootedValue replayData(cx, LoadReplayData(scriptInterface, directory));
+        if (!replayData.isNull())
+            JS_SetElement(cx, replays, i++, replayData);
+    }
+    return JS::ObjectValue(*replays);
+}
+
+// Works similar to CGame::LoadReplayData()
+// Extracts metadata from file header, loads commands and computes duration of the game
+JS::Value VisualReplay::LoadReplayData(ScriptInterface& scriptInterface, OsPath directory)
+{
+    OsPath replayFile(GetDirectoryName() / directory / L"commands.txt");
+
+    if (!FileExists(replayFile))
+        return JSVAL_NULL;
+
+    // Get fileinfo (size, timestamp)
+    CFileInfo fileInfo;
+    GetFileInfo(replayFile, &fileInfo);
+    u64 fileTime = (u64)fileInfo.MTime() & ~1; // skip lowest bit, since zip and FAT don't preserve it (according to CCacheLoader::LooseCachePath)
+    u64 fileSize = (u64)fileInfo.Size();
+
+    if (fileSize == 0)
+        return JSVAL_NULL;
+
+    // Open file
+    std::wstring filenameW = replayFile.string();
+    std::string filename( filenameW.begin(), filenameW.end() );
+    std::ifstream* replayStream = new std::ifstream(filename.c_str());
+
+    // File must begin with "start"
+    std::string type;
+    ENSURE((*replayStream >> type).good() && type == "start");
+
+    // Parse header
+    std::string header;
+    std::getline(*replayStream, header);
+    JSContext* cx = scriptInterface.GetContext();
+    JSAutoRequest rq(cx);
+    JS::RootedValue attribs(cx);
+    if (!scriptInterface.ParseJSON(header, &attribs))
+        return JSVAL_NULL;
+
+    // Parse commands & turns
+    u32 currentTurn = 0;
+    u32 currentMinute = 0;
+    u64 duration = 0;
+    std::vector<player_id_t> defeatedPlayers;
+    std::map<player_id_t, u16> currentCommandCount;
+    std::map<player_id_t, u16> commandsPerMinute;
+    while ((*replayStream >> type).good())
+    {
+        if (type == "turn")
+        {
+            // Store turn & turn length
+            u32 turn = 0;
+            u32 turnLength = 0;
+            *replayStream >> turn >> turnLength;
+            if (turn != currentTurn) // Happens for replays of rejoined clients
+                return JSVAL_NULL;
+
+            // Compute game duration
+            duration += turnLength;
+
+            // Compute commands per minute
+            u32 min = duration / 1000 / 60;
+            if (min > currentMinute)
+            {
+                //commandsPerMinute[player][currentMinute] = currentCommandCount[player];
+                currentMinute = min;
+            }
+        }
+        else if (type == "cmd")
+        {
+            // Extract player id
+            player_id_t player;
+            *replayStream >> player;
+
+            // Increase command count
+            if (currentCommandCount.find(player) == currentCommandCount.end())
+                currentCommandCount[player] = 1;
+            else
+                currentCommandCount[player]++;
+
+            // Store command
+            std::string command;
+            std::getline(*replayStream, command);
+
+            // Parse command
+            JS::RootedValue commandData(scriptInterface.GetContext());
+            std::wstring commandType;
+            if (!scriptInterface.ParseJSON(command, &commandData))
+            {
+                LOGERROR("Corrupted replay command '%s' in file '%s'", command, filename.c_str());
+                return JSVAL_NULL;
+            }
+            scriptInterface.GetProperty(commandData, "type", commandType);
+
+            // Save defeated players {"type":"defeat-player","playerId":2}
+            if (commandType == L"defeat-player")
+            {
+                player_id_t defeatedPlayer;
+                scriptInterface.GetProperty(commandData, "playerId", defeatedPlayer);
+                defeatedPlayers.push_back(defeatedPlayer);
+            }
+        }
+        else if (type == "hash" || type == "hash-quick")
+        {
+            // Skip hash values
+            std::string replayHash;
+            *replayStream >> replayHash;
+        }
+        else if (type == "end")
+        {
+            currentTurn++;
+        }
+        else
+        {
+            LOGERROR("Unrecognized replay data '%s' in file %s", type, filename.c_str());
+        }
+    }
+    replayStream->close();
+
+    duration = duration / 1000;
+    if (duration < 5) // Don't list too short replays
+        return JSVAL_NULL;
+
+    // finalReplayTurn = currentTurn;
+    // TODO: compute average turn time, if turn length varies
+
+    JS::RootedValue replayData(cx);
+    scriptInterface.Eval("({})", &replayData);
+    scriptInterface.SetProperty(replayData, "file", replayFile);
+    scriptInterface.SetProperty(replayData, "directory", directory);
+    scriptInterface.SetProperty(replayData, "filemod_timestamp", fileTime);
+    scriptInterface.SetProperty(replayData, "attribs", attribs);
+    scriptInterface.SetProperty(replayData, "duration", duration);
+    scriptInterface.SetProperty(replayData, "defeatedPlayers", defeatedPlayers);
+    return replayData;
+}
+
+bool VisualReplay::DeleteReplay(const std::wstring replayDirectory)
+{
+    if (replayDirectory == L"")
+        return false;
+
+    const OsPath directory = OsPath(GetDirectoryName() / replayDirectory);
+    return DirectoryExists(directory) && DeleteDirectory(directory) == INFO::OK;
+}

source/ps/VisualReplay.h

@@ +1 @@
+/* Copyright (C) 2015 Wildfire Games.
+ * This file is part of 0 A.D.
+ *
+ * 0 A.D. is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 0 A.D. is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef INCLUDED_REPlAY
+#define INCLUDED_REPlAY
+
+#include "scriptinterface/ScriptInterface.h"
+class CSimulation2;
+class CGUIManager;
+
+/**
+ * Contains functions for visually replaying past games.
+ */
+
+namespace VisualReplay
+{
+
+/**
+ * Start replaying the given commands.txt.
+ *
+ * @param name filename of the commands.txt file (including path)
+ * @param scriptInterface
+ * @param[out] savedState serialized simulation state stored as string of bytes,
+ *  loaded from simulation.dat inside the archive.
+ * @return INFO::OK if successfully loaded, else an error Status
+ */
+Status Load(const std::wstring& name, ScriptInterface& scriptInterface, std::string& savedState);
+
+/**
+ * Returns the path to the sim-log directory (that contains the directories with the replay files.
+ *
+ * @param scriptInterface the ScriptInterface in which to create the return data.
+ * @return OsPath with an absolte file path
+ */
+OsPath GetDirectoryName();
+
+/**
+ * Get a list of replays (filenames and timestamps [later more information like playernames]) for GUI script usage
+ *
+ * @param scriptInterface the ScriptInterface in which to create the return data.
+ * @return array of objects containing saved game data
+ */
+JS::Value GetReplays(ScriptInterface& scriptInterface);
+
+/**
+ * Parses a commands.txt file and extracts metadata.
+ */
+JS::Value LoadReplayData(ScriptInterface& scriptInterface, OsPath replayFile);
+
+/**
+ * Permanently deletes the visual replay (including the parent directory)
+ *
+ * @param replayFile path to commands.txt, whose parent directory will be deleted
+ * @return true if deletion was successful, or false on error
+ */
+bool DeleteReplay(const std::wstring replayFile);
+}
+
+#endif