Ticket #3258: replay_menu_v8_16864.patch

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

@@ -1 +1 @@
 var g_AIs; // [ {"id": ..., "data": {"name": ..., "description": ..., ...} }, ... ]
+var g_AIDiffs; // translated AI difficulties
 var g_PlayerSlot;
 
 function init(settings)
 {
     g_PlayerSlot = settings.playerSlot;
 
-    translateObjectKeys(settings.ais, ["name", "description"]);
     g_AIs = [
         {id: "", data: {name: translateWithContext("ai", "None"), description: translate("AI will be disabled for this player.")}}
     ].concat(settings.ais);
 
     var aiSelection = Engine.GetGUIObjectByName("aiSelection");
@@ -22 +22 @@
             break;
         }
     }
     aiSelection.selected = selected;
 
+    g_AIDiffs = initAIDifficulties(); // translated AI difficulties
     var aiDiff = Engine.GetGUIObjectByName("aiDifficulty");
-    // Translation: AI difficulty level.
-    aiDiff.list = [translateWithContext("aiDiff", "Sandbox"), translateWithContext("aiDiff", "Very Easy"), translateWithContext("aiDiff", "Easy"), translateWithContext("aiDiff", "Medium"), translateWithContext("aiDiff", "Hard"), translateWithContext("aiDiff", "Very Hard")];
+    aiDiff.list = g_AIDiffs.titles;
     aiDiff.selected = settings.difficulty;
 }
 
 function selectAI(idx)
 {

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

@@ -1 +1 @@
 <?xml version="1.0" encoding="utf-8"?>
 
 <objects>
 
     <script file="gui/aiconfig/aiconfig.js"/>
+    <script file="gui/common/functions_utility.js"/>
 
     <!-- Add a translucent black background to fade out the menu page -->
     <object type="image" sprite="ModernFade"/>
 
     <object type="image" style="ModernDialog" size="50%-230 50%-130 50%+230 50%+130">

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

@@ -101 +101 @@
 // ====================================================================
 
 // Load map size data
 function initMapSizes()
 {
-    var sizes = {
+    let sizes = {
         "shortNames":[],
         "names":[],
         "tiles": [],
         "default": 0
     };
 
-    var data = Engine.ReadJSONFile("simulation/data/map_sizes.json");
+    let data = Engine.ReadJSONFile("simulation/data/map_sizes.json");
     if (!data || !data.Sizes)
     {
         error("Failed to parse map sizes in map_sizes.json (check for valid JSON data)");
         return sizes;
     }
 
     translateObjectKeys(data, ["Name", "LongName"]);
-    for (var i = 0; i < data.Sizes.length; ++i)
+    for (let i = 0; i < data.Sizes.length; ++i)
     {
         sizes.shortNames.push(data.Sizes[i].Name);
         sizes.names.push(data.Sizes[i].LongName);
         sizes.tiles.push(data.Sizes[i].Tiles);
 
         if (data.Sizes[i].Default)
-            sizes["default"] = i;
+            sizes.default = i;
     }
 
     return sizes;
 }
 
+// Returns translated map size for a given a numeric size. Requires g_MapSizes to be present.
+function translateMapSize(mapSize)
+{
+    let index = g_MapSizes.tiles.indexOf(parseInt(mapSize))
+    if (index > -1)
+        return g_MapSizes.shortNames[index];
+    else
+        return translateWithContext("map size", "Default");
+}
+
+// ====================================================================
+
+// Load map size data
+function initPopulationCapacity()
+{
+    let population = {
+        "population":[],
+        "titles": [],
+        "default": 0
+    };
+
+    let data = Engine.ReadJSONFile("simulation/data/population_capacity.json");
+    if (!data || !data.PopulationCapacity)
+    {
+        error("Failed to parse map sizes in population_capacity.json (check for valid JSON data)");
+        return population;
+    }
+
+    translateObjectKeys(data, ["Title"]);
+    for (let i = 0; i < data.PopulationCapacity.length; ++i)
+    {
+        population.population.push(data.PopulationCapacity[i].Population);
+        population.titles.push(data.PopulationCapacity[i].Title);
+
+        if (data.PopulationCapacity[i].Default)
+            population.default = i;
+    }
+
+    return population;
+}
+
+// Returns the translation for a given numeric value. Requires g_PopCaps to be present.
+function translatePopulationCapacity(popCap)
+{
+    let index = g_PopCaps.population.indexOf(parseInt(popCap))
+    if (index > -1)
+        return g_PopCaps.titles[index];
+    else
+        return translateWithContext("population capacity", "Unknown");
+}
+
+// ====================================================================
+
+// Load map type data
+function initMapTypes()
+{
+    let types = {
+        "names":[],
+        "titles":[],
+        "default": 0
+    };
+
+    let data = Engine.ReadJSONFile("simulation/data/map_types.json");
+    if (!data || !data.Types)
+    {
+        error("Failed to parse map types in map_types.json (check for valid JSON data)");
+        return types;
+    }
+
+    translateObjectKeys(data, ["Title"]);
+    for (let i = 0; i < data.Types.length; ++i)
+    {
+        types.names.push(data.Types[i].Name);
+        types.titles.push(data.Types[i].Title);
+
+        if (data.Types[i].Default)
+            types.default = i;
+    }
+
+    return types;
+}
+
+// Returns the translation of the given map type. Requires g_MapTypes to be present.
+function translateMapType(mapType)
+{
+    let index = g_MapTypes.names.indexOf(mapType)
+    if (index > -1)
+        return g_MapTypes.titles[index];
+    else
+        return translateWithContext("map type", "Unknown");
+}
+
+// ====================================================================
+
+function initAIDescription()
+{
+    let AIs = Engine.GetAIs();
+    translateObjectKeys(AIs, ["name", "description"]);
+    // Sort AIs by displayed name
+    AIs.sort(function (a, b) {
+        return a.data.name < b.data.name ? -1 : b.data.name < a.data.name ? +1 : 0;
+    });
+    return AIs;
+}
+
+// Returns the translation of the given AI name (like "petra"). Requires g_AIs to be present.
+function translateAIName(aiName)
+{
+    let AI_description = g_AIs.filter(ai => ai.id == aiName);
+    if (AI_description.length > 0)
+        return translate(AI_description[0].data.name);
+    else
+        return translateWithContext("AI name", "Unknown");
+}
+
+// ====================================================================
+
+function initAIDifficulties()
+{
+    let difficulties = {
+        "names":[],
+        "titles":[],
+        "default": 0
+    };
+
+    let data = Engine.ReadJSONFile("simulation/ai/difficulties.json");
+    if (!data || !data.Difficulties)
+    {
+        error("Failed to parse AI difficulties (check difficulties.json for valid data)");
+        return ["Default"];
+    }
+
+    translateObjectKeys(data, ["Title"]);
+    for (let i = 0; i < data.Difficulties.length; ++i)
+    {
+        difficulties.names.push(data.Difficulties[i].Name);
+        difficulties.titles.push(data.Difficulties[i].Title);
+
+        if (data.Difficulties[i].Default)
+            difficulties.default = i;
+    }
+    return difficulties;
+}
+
+// Returns the translation of the given AI difficulty. Requires g_AIDiffs to be present.
+function translateAIDifficulty(index)
+{
+    if (0 <= index && index < g_AIDiffs.titles.length)
+        return g_AIDiffs.titles[index];
+    else
+        return translateWithContext("aiDiff", "Unknown");
+}
+
+// ====================================================================
+
+// Returns the translation of the given map type. Requires g_VictoryConditions to be present.
+function translateGameType(gameType)
+{
+    if (g_VictoryConditions.hasOwnProperty(gameType))
+        return g_VictoryConditions[gameType].name;
+    else
+        return translateWithContext("game type", "Unknown");
+}
+
 // ====================================================================
 
 // Load game speed data
 function initGameSpeeds()
 {

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

@@ -2 +2 @@
 // Constants
 const DEFAULT_NETWORKED_MAP = "Acropolis 01";
 const DEFAULT_OFFLINE_MAP = "Acropolis 01";
 
 const VICTORY_DEFAULTIDX = 1;
-
 // TODO: Move these somewhere like simulation\data\game_types.json, Atlas needs them too
-// Translation: Type of victory condition.
-const POPULATION_CAP = ["50", "100", "150", "200", "250", "300", translate("Unlimited")];
-const POPULATION_CAP_DATA = [50, 100, 150, 200, 250, 300, 10000];
-const POPULATION_CAP_DEFAULTIDX = 5;
 // Translation: Amount of starting resources.
 const STARTING_RESOURCES = [translateWithContext("startingResources", "Very Low"), translateWithContext("startingResources", "Low"), translateWithContext("startingResources", "Medium"), translateWithContext("startingResources", "High"), translateWithContext("startingResources", "Very High"), translateWithContext("startingResources", "Deathmatch")];
 const STARTING_RESOURCES_DATA = [100, 300, 500, 1000, 3000, 50000];
 const STARTING_RESOURCES_DEFAULTIDX = 1;
 // Translation: Ceasefire.
@@ -55 +50 @@
 var g_DefaultPlayerData = [];
 var g_GameAttributes = {
     settings: {}
 };
 
-var g_GameSpeeds = {};
-var g_MapSizes = {};
-
+var g_GameSpeeds = [];
+var g_MapSizes = [];
+var g_MapTypes = [];
 var g_AIs = [];
-
+var g_PopCaps = [];
 var g_ChatMessages = [];
 
 // Data caches
 var g_MapData = {};
 var g_CivData = {};
@@ -116 +111 @@
 
 // Called after the map data is loaded and cached
 function initMain()
 {
     // Load AI list
-    g_AIs = Engine.GetAIs();
-
-    // Sort AIs by displayed name
-    g_AIs.sort(function (a, b) {
-        return a.data.name < b.data.name ? -1 : b.data.name < a.data.name ? +1 : 0;
-    });
+    g_AIs = initAIDescription();
 
     // Get default player data - remove gaia
     g_DefaultPlayerData = initPlayerDefaults();
     g_DefaultPlayerData.shift();
     for (var i = 0; i < g_DefaultPlayerData.length; ++i)
         g_DefaultPlayerData[i].Civ = "random";
 
     g_GameSpeeds = initGameSpeeds();
     g_MapSizes = initMapSizes();
+    g_MapTypes = initMapTypes();
+    g_PopCaps = initPopulationCapacity();
 
     // Init civs
     initCivNameList();
 
     // Init map types
     var mapTypes = Engine.GetGUIObjectByName("mapTypeSelection");
-    mapTypes.list = [translateWithContext("map", "Skirmish"), translateWithContext("map", "Random"), translate("Scenario")];
-    mapTypes.list_data = ["skirmish","random","scenario"];
+    mapTypes.list = g_MapTypes.titles;
+    mapTypes.list_data = g_MapTypes.names;
 
     // Setup map filters - will appear in order they are added
     addFilter("default", translate("Default"), function(settings) { return settings && (settings.Keywords === undefined || !keywordTestOR(settings.Keywords, ["naval", "demo", "hidden"])); });
     addFilter("naval", translate("Naval Maps"), function(settings) { return settings && settings.Keywords !== undefined && keywordTestAND(settings.Keywords, ["naval"]); });
     addFilter("demo", translate("Demo Maps"), function(settings) { return settings && settings.Keywords !== undefined && keywordTestAND(settings.Keywords, ["demo"]); });
@@ -186 +178 @@
             updateGameAttributes();
         }
         gameSpeed.selected = g_GameSpeeds["default"];
 
         var populationCaps = Engine.GetGUIObjectByName("populationCap");
-        populationCaps.list = POPULATION_CAP;
-        populationCaps.list_data = POPULATION_CAP_DATA;
-        populationCaps.selected = POPULATION_CAP_DEFAULTIDX;
+        populationCaps.list = g_PopCaps.titles;
+        populationCaps.list_data = g_PopCaps.population;
+        populationCaps.selected = g_PopCaps.default;
         populationCaps.onSelectionChange = function() {
             if (this.selected != -1)
-                g_GameAttributes.settings.PopulationCap = POPULATION_CAP_DATA[this.selected];
+                g_GameAttributes.settings.PopulationCap = g_PopCaps.population[this.selected];
 
             updateGameAttributes();
         }
 
         var startingResourcesL = Engine.GetGUIObjectByName("startingResources");
@@ -487 +479 @@
         }
         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 });
@@ -1222 +1215 @@
     }
     else
         enableRatingText.caption = "Unknown";
     gameSpeedText.caption = g_GameSpeeds.names[speedIdx];
     gameSpeedBox.selected = speedIdx;
-    populationCap.selected = (mapSettings.PopulationCap !== undefined && POPULATION_CAP_DATA.indexOf(mapSettings.PopulationCap) != -1 ? POPULATION_CAP_DATA.indexOf(mapSettings.PopulationCap) : POPULATION_CAP_DEFAULTIDX);
-    populationCapText.caption = POPULATION_CAP[populationCap.selected];
+    populationCap.selected = (mapSettings.PopulationCap !== undefined && g_PopCaps.population.indexOf(mapSettings.PopulationCap) != -1 ? g_PopCaps.population.indexOf(mapSettings.PopulationCap) : g_PopCaps.default);
+    populationCapText.caption = g_PopCaps.titles[populationCap.selected];
     startingResources.selected = (mapSettings.StartingResources !== undefined && STARTING_RESOURCES_DATA.indexOf(mapSettings.StartingResources) != -1 ? STARTING_RESOURCES_DATA.indexOf(mapSettings.StartingResources) : STARTING_RESOURCES_DEFAULTIDX);
     startingResourcesText.caption = STARTING_RESOURCES[startingResources.selected];
     ceasefire.selected = (mapSettings.Ceasefire !== undefined && CEASEFIRE_DATA.indexOf(mapSettings.Ceasefire) != -1 ? CEASEFIRE_DATA.indexOf(mapSettings.Ceasefire) : CEASEFIRE_DEFAULTIDX);
     ceasefireText.caption = CEASEFIRE[ceasefire.selected];
 

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

@@ -1 +1 @@
 <?xml version="1.0" encoding="utf-8"?>
 
 <objects>
 
+    <script file="gui/aiconfig/aiconfig.js"/>
     <script file="gui/common/network.js"/>
     <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/gamesetup/gamesetup.js"/>

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

@@ -7 +7 @@
 var g_PlayerListOrder = 1;
 var g_specialKey = Math.random();
 // This object looks like {"name":[numMessagesSinceReset, lastReset, timeBlocked]} when in use.
 var g_spamMonitor = {};
 var g_timestamp = Engine.ConfigDB_GetValue("user", "lobby.chattimestamp") == "true";
-var g_mapSizes = {};
-const g_mapTypesText = [translateWithContext("map", "Skirmish"), translateWithContext("map", "Random"), translate("Scenario")];
-const g_mapTypes = ["skirmish", "random", "scenario"];
+var g_MapSizes = {};
+var g_MapTypes = {};
 var g_userRating = ""; // Rating of user, defaults to Unrated
 var g_modPrefix = "@";
 var g_joined = false;
 // Block spammers for 30 seconds.
 var SPAM_BLOCK_LENGTH = 30;
@@ -26 +25 @@
     initMusic();
     global.music.setState(global.music.states.MENU);
 
     g_Name = Engine.LobbyGetNick();
 
-    g_mapSizes = initMapSizes();
-    g_mapSizes.shortNames.splice(0, 0, translateWithContext("map size", "Any"));
-    g_mapSizes.tiles.splice(0, 0, "");
+    g_MapSizes = initMapSizes();
+    g_MapSizes.shortNames.splice(0, 0, translateWithContext("map size", "Any"));
+    g_MapSizes.tiles.splice(0, 0, "");
 
     var mapSizeFilter = Engine.GetGUIObjectByName("mapSizeFilter");
-    mapSizeFilter.list = g_mapSizes.shortNames;
-    mapSizeFilter.list_data = g_mapSizes.tiles;
+    mapSizeFilter.list = g_MapSizes.shortNames;
+    mapSizeFilter.list_data = g_MapSizes.tiles;
 
     var playersNumberFilter = Engine.GetGUIObjectByName("playersNumberFilter");
     playersNumberFilter.list = [translateWithContext("player number", "Any"),2,3,4,5,6,7,8];
     playersNumberFilter.list_data = ["",2,3,4,5,6,7,8];
 
+    g_MapTypes = initMapTypes();
+    g_MapTypes.titles.splice(0, 0, translateWithContext("map type", "Any"));
+    g_MapTypes.names.splice(0, 0, "");
+
     var mapTypeFilter = Engine.GetGUIObjectByName("mapTypeFilter");
-    mapTypeFilter.list = [translateWithContext("map", "Any")].concat(g_mapTypesText);
-    mapTypeFilter.list_data = [""].concat(g_mapTypes);
+    mapTypeFilter.list = g_MapTypes.titles;
+    mapTypeFilter.list_data = g_MapTypes.names;
 
     Engine.LobbySetPlayerPresence("available");
     Engine.SendGetGameList();
     Engine.SendGetBoardList();
     Engine.SendGetRatingList();
@@ -468 +471 @@
             else
                 name = '[color="255 0 0"]' + name + '[/color]';
             list_name.push(name);
             list_ip.push(g.ip);
             list_mapName.push(translate(g.niceMapName));
-            list_mapSize.push(translatedMapSize(g.mapSize));
-            let idx = g_mapTypes.indexOf(g.mapType);
-            list_mapType.push(idx != -1 ? g_mapTypesText[idx] : "");
+            list_mapSize.push(translateMapSize(g.mapSize));
+            list_mapType.push(translateMapType(g.mapType));
             list_nPlayers.push(g.nbp + "/" +g.tnbp);
             list.push(name);
             list_data.push(c);
         }
         c++;
@@ -546 +548 @@
     // Push this player's name and status onto the list
     return [formattedName, formattedStatus, formattedRating];
 }
 
 /**
- * Given a map size, returns that map size translated into the current
- * language.
- */
-function translatedMapSize(mapSize)
-{
-    if (+mapSize !== +mapSize) // NaN
-        return translate(mapSize);
-    else
-        return g_mapSizes.shortNames[g_mapSizes.tiles.indexOf(+mapSize)];
-}
-
-/**
  * Populate the game info area with information on the current game selection.
  */
 function updateGameSelection()
 {
     var selected = Engine.GetGUIObjectByName("gamesBox").selected;
@@ -595 +585 @@
 
     // Display the map name, number of players, the names of the players, the map size and the map type.
     Engine.GetGUIObjectByName("sgMapName").caption = translate(g_GameList[g].niceMapName);
     Engine.GetGUIObjectByName("sgNbPlayers").caption = g_GameList[g].nbp + "/" + g_GameList[g].tnbp;
     Engine.GetGUIObjectByName("sgPlayersNames").caption = g_GameList[g].players;
-    Engine.GetGUIObjectByName("sgMapSize").caption = translatedMapSize(g_GameList[g].mapSize);
-    let idx = g_mapTypes.indexOf(g_GameList[g].mapType);
-    Engine.GetGUIObjectByName("sgMapType").caption = idx != -1 ? g_mapTypesText[idx] : "";
+    Engine.GetGUIObjectByName("sgMapSize").caption = translateMapSize(g_GameList[g].mapSize);
+    Engine.GetGUIObjectByName("sgMapType").caption = translateMapType(g_GameList[g].mapType);
 
     // Display map description if it exists, otherwise display a placeholder.
     if (mapData && mapData.settings.Description)
         var mapDescription = translate(mapData.settings.Description);
     else

binaries/data/mods/public/gui/page_replaymenu.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>replaymenu/styles.xml</include>
+    <include>replaymenu/replaymenu.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_replaymenu.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/replaymenu/replaymenu.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_MapNames = []; // All map names of all replays
+var g_ReplayListSortBy = "name"; // Used by sorting
+var g_ReplayListOrder = -1; // Used by sorting
+var g_AIs = initAIDescription(); // translated AI names and description
+var g_AIDiffs = initAIDifficulties(); // translated AI difficulties
+const g_VictoryConditions = {}; // translated game types
+const g_MapSizes = initMapSizes(); // translated map sizes
+const g_MapTypes = initMapTypes(); // translated map types
+const g_PopCaps = initPopulationCapacity(); // translated population capacities
+const g_CivData = loadCivData(); // names and description of civs
+const g_EngineInfo = Engine.GetEngineInfo(); // current engine version
+const g_DefaultPlayerData = initPlayerDefaults();
+const g_maxPlayerlistChars = 70;
+const g_DurationFilterMin = [ 0,  0, 15, 30, 45, 60,  90, 120];
+const 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)
+    {
+        // 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.attribs.settings.hasOwnProperty("Size"))
+            replay.attribs.settings.Size = -1;
+
+        // Extract all map names
+        if (g_MapNames.indexOf(replay.attribs.settings.Name) == -1)
+            g_MapNames.push(replay.attribs.settings.Name);
+
+        // Extract all playernames, used by autocomplete feature
+        for (let playerData of replay.attribs.settings.PlayerData)
+        {
+            if (playerData)
+            {
+                let name = playerData.Name;
+                if (g_Playernames.indexOf(name) == -1)
+                    g_Playernames.push({"name": name});
+            }
+        }
+    }
+    g_MapNames.sort();
+}
+
+function updateReplayList()
+{
+    let 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)
+    {
+        let 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.attribs.settings.PlayerData.length;
+            cmpB = b.attribs.settings.PlayerData.length;
+            break;
+        case 'mapName':
+            cmpA = getReplayMapName(a);
+            cmpB = getReplayMapName(b);
+            break;
+        case 'mapSize':
+            cmpA = a.attribs.settings.Size;
+            cmpB = b.attribs.settings.Size;
+            break;
+        case 'popCapacity':
+            cmpA = a.attribs.settings.PopulationCap;
+            cmpB = b.attribs.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
+    let replayListLabels = [];
+    let replayListDirectories = [];
+    let list_name = [];
+    let list_players = [];
+    let list_mapName = [];
+    let list_mapSize = [];
+    let list_popCapacity = [];
+    let list_duration = [];
+    g_ReplaysFiltered = [];
+    for (let replay of g_Replays)
+    {
+        if (filterReplay(replay))
+            continue;
+
+        g_ReplaysFiltered.push(replay);
+        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, translateMapSize(replay.attribs.settings.Size)));
+        list_popCapacity.push(Greyout(replay, translatePopulationCapacity(replay.attribs.settings.PopulationCap)));
+        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 updateReplayListOrderSelection()
+{
+    g_ReplayListSortBy = Engine.GetGUIObjectByName("replaySelection").selected_column;
+    g_ReplayListOrder = Engine.GetGUIObjectByName("replaySelection").selected_column_order;
+    applyFilters();
+}
+
+function Greyout(replay, text)
+{
+    if (isReplayCompatible(replay))
+        return text;
+    else
+        return '[color="128 128 128"]' + text + '[/color]';
+}
+
+function getReplayDateTime(replay)
+{
+    // TODO: enhancement: use local time instead of UTC
+    return Engine.FormatMillisecondsIntoDateString(replay.timestamp * 1000, translate("yyyy-MM-dd HH:mm"))
+}
+
+function getReplayPlayernames(replay, shorten)
+{
+    // Extract playernames
+    let playernames = [];
+    for (let playerData of replay.attribs.settings.PlayerData)
+    {
+        if (playerData)
+        {
+            let playername = escapeText(playerData.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.attribs.settings.Name));
+}
+
+function getReplayMonth(replay)
+{
+    return Engine.FormatMillisecondsIntoDateString(replay.timestamp * 1000, translate("yyyy-MM"));
+}
+
+function getReplayDuration(replay)
+{
+    return timeToString(replay.duration * 1000);
+}
+
+function getReplayTeamText(replay)
+{
+    let metadata = Engine.GetReplayMetadata(replay.directory);
+    let spoiler = Engine.GetGUIObjectByName("showSpoiler").checked;
+
+    // Extract players and civs by team
+    let teams = {};
+    let teamCount = 0;
+    let i = 1;
+    for (let playerData of replay.attribs.settings.PlayerData)
+    {
+        if (!playerData)
+            continue;
+
+        // Get player info
+        let playerCiv = translate(g_CivData[playerData.Civ].Name);
+        // TODO: enhancement: too few contrast, see #3205
+        let playerColor = playerData.Color ? playerData.Color : g_DefaultPlayerData[i].Color;
+        let playerName = '[color="' + playerColor.r + " " + playerColor.g + " " + playerColor.b + '"]' + escapeText(playerData.Name) + "[/color]";
+        let showDefeated = spoiler && metadata.playerStates && metadata.playerStates[i].state == "defeated";
+        let isAI = (playerData.AI);
+        let AIname = translateAIName(playerData.AI);
+        let AIdiff = translateAIDifficulty(playerData.AIDiff);
+
+        // Create player text
+        let playerDetails;
+        if (!isAI && !showDefeated)
+            playerDetails = sprintf(translateWithContext("replay player description", "%(playerName)s (%(civilization)s)"),
+                { "playerName": playerName, "civilization": playerCiv});
+        else if (isAI && !showDefeated)
+            playerDetails = sprintf(translateWithContext("replay player description", "%(playerName)s (%(civilization)s, %(AIdifficulty)s %(AIname)s)"),
+                { "playerName": playerName, "civilization": playerCiv, "AIdifficulty": AIdiff, "AIname": AIname });
+        else if (!isAI && showDefeated)
+            playerDetails = sprintf(translateWithContext("replay player description", "%(playerName)s (%(civilization)s, defeated)"),
+                { "playerName": playerName, "civilization": playerCiv});
+        else
+            playerDetails = sprintf(translateWithContext("replay player description", "%(playerName)s (%(civilization)s, %(AIdifficulty)s %(AIname)s, defeated)"),
+                { "playerName": playerName, "civilization": playerCiv, "AIdifficulty": AIdiff, "AIname": AIname });
+
+        // Add player text to playerlist
+        let team = playerData.Team;
+        if (teams.hasOwnProperty(team))
+            teams[team].push(playerDetails);
+        else
+        {
+            teams[team] = [playerDetails];
+            teamCount++;
+        }
+        i++;
+    }
+
+    // Create player info text sorted by team
+    let teamString = "";
+    for (let 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
+    let gameMods = replay.attribs.mods ? replay.attribs.mods : [];
+
+    if (gameMods.length != g_EngineInfo.mods.length)
+        return false;
+
+    for (let 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()
+{
+    let months = [translateWithContext("DateTime", "Any")];
+    for (let replay of g_Replays)
+    {
+        let month = getReplayMonth(replay);
+
+        if (months.indexOf(month) == -1)
+            months.push(month);
+    }
+
+    let dateTimeFilter = Engine.GetGUIObjectByName("dateTimeFilter");
+    dateTimeFilter.list = months;
+    dateTimeFilter.list_data = months;
+
+    if (dateTimeFilter.selected == -1 || dateTimeFilter.selected >= dateTimeFilter.list.length)
+        dateTimeFilter.selected = 0;
+}
+
+function initMapSizeFilter()
+{
+    let mapSizeFilter = Engine.GetGUIObjectByName("mapSizeFilter");
+    mapSizeFilter.list = [translateWithContext("map size", "Any")].concat(g_MapSizes.names);
+    mapSizeFilter.list_data = [-1].concat(g_MapSizes.tiles);
+
+    if (mapSizeFilter.selected == -1 || mapSizeFilter.selected >= mapSizeFilter.list.length)
+        mapSizeFilter.selected = 0;
+}
+
+function initMapNameFilter()
+{
+    let mapNameFilter = Engine.GetGUIObjectByName("mapNameFilter");
+    mapNameFilter.list = [translateWithContext("map name", "Any")].concat(g_MapNames);
+    mapNameFilter.list_data = [""].concat(g_MapNames.map(mapName => translate(mapName)));
+
+    if (mapNameFilter.selected == -1 || mapNameFilter.selected >= mapNameFilter.list.length)
+        mapNameFilter.selected = 0;
+}
+
+function initPopCapFilter()
+{
+    let populationFilter = Engine.GetGUIObjectByName("populationFilter");
+    populationFilter.list = [translateWithContext("population capacity", "Any")].concat(g_PopCaps.titles);
+    populationFilter.list_data = [""].concat(g_PopCaps.population);
+
+    if (populationFilter.selected == -1 || populationFilter.selected >= populationFilter.list.length)
+        populationFilter.selected = 0;
+}
+
+function initDurationFilter()
+{
+    let data = [-1];
+    let labels = ["Any"];
+
+    for (let i in g_DurationFilterMin)
+    {
+        let label;
+        if (i == 0)
+            continue;
+        else if (i == 1)
+            label = sprintf(translateWithContext("duration filter", "< %(min)s min"), { "min": g_DurationFilterMax[i] });
+        else if (i == g_DurationFilterMin.length -1)
+            label = sprintf(translateWithContext("duration filter", "> %(min)s min"), { "min": g_DurationFilterMin[i] });
+        else
+            label = sprintf(translateWithContext("duration filter", "%(min1)s - %(min2)s min"), { "min1": g_DurationFilterMin[i], "min2": g_DurationFilterMax[i] });
+
+        data.push(i);
+        labels.push(label);
+    }
+
+    let 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)
+{
+    let dateTimeFilter = Engine.GetGUIObjectByName("dateTimeFilter");
+    let playersFilter = Engine.GetGUIObjectByName("playersFilter");
+    let mapNameFilter = Engine.GetGUIObjectByName("mapNameFilter");
+    let mapSizeFilter = Engine.GetGUIObjectByName("mapSizeFilter");
+    let populationFilter = Engine.GetGUIObjectByName("populationFilter");
+    let durationFilter = Engine.GetGUIObjectByName("durationFilter");
+    let 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 (getReplayMonth(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.attribs.settings.PlayerData.map(function(player){ return player ? player.Name.toLowerCase() : "" }).join(" ");
+        for (let word of playerText)
+        {
+            if (replayPlayers.indexOf(word) == -1)
+                return true;
+        }
+    }
+
+    // Filter map name
+    if (mapNameFilter.selected > 0 && getReplayMapName(replay) != mapNameFilter.list_data[mapNameFilter.selected])
+            return true;
+
+    // Filter map size
+    if (mapSizeFilter.selected > 0 && replay.attribs.settings.Size != mapSizeFilter.list_data[mapSizeFilter.selected])
+            return true;
+
+    // Filter population capacity
+    if (populationFilter.selected > 0 && replay.attribs.settings.PopulationCap != 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()
+{
+    let selected = Engine.GetGUIObjectByName("replaySelection").selected;
+    let replaySelected = selected > -1;
+
+    Engine.GetGUIObjectByName("replayInfo").hidden = !replaySelected;
+    Engine.GetGUIObjectByName("replayInfoEmpty").hidden = replaySelected;
+    Engine.GetGUIObjectByName("startReplayButton").enabled = replaySelected;
+    Engine.GetGUIObjectByName("deleteReplayButton").enabled = replaySelected;
+    Engine.GetGUIObjectByName("summaryButton").enabled = replaySelected;
+
+    if (!replaySelected)
+        return;
+
+    let replay = g_ReplaysFiltered[selected];
+
+    // Load map data
+    let mapData = {};
+    if (replay.attribs.settings.mapType == "random" && replay.attribs.map == "random")
+        mapData = {"settings": {"Description": translate("A randomly selected map.")}};
+    else if (replay.attribs.settings.mapType == "random" && Engine.FileExists(replay.attribs.map + ".json"))
+        mapData = Engine.ReadJSONFile(replay.attribs.map + ".json");
+    else if (Engine.FileExists(replay.attribs.map + ".xml"))
+        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
+    let mapDescription;
+    if (mapData && mapData.settings.Description)
+        mapDescription = translate(mapData.settings.Description);
+    else
+        mapDescription = translate("Sorry, no description available.");
+
+    // Load map preview image
+    let mapPreview;
+    if (mapData && mapData.settings.Preview)
+        mapPreview = mapData.settings.Preview;
+    else
+        mapPreview = "nopreview.png";
+
+    // Update GUI, compare with gamesetup.js for translations
+    Engine.GetGUIObjectByName("sgMapName").caption = translate(replay.attribs.settings.Name);
+    Engine.GetGUIObjectByName("sgMapSize").caption = translateMapSize(replay.attribs.settings.Size);
+    Engine.GetGUIObjectByName("sgMapType").caption = translateMapType(replay.attribs.settings.mapType);
+    Engine.GetGUIObjectByName("sgVictory").caption = translateGameType(replay.attribs.settings.GameType);
+    Engine.GetGUIObjectByName("sgNbPlayers").caption = replay.attribs.settings.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()
+{
+    let selected = Engine.GetGUIObjectByName("replaySelection").selected;
+    if (selected == -1)
+        return;
+
+    let replay = g_ReplaysFiltered[selected];
+    if (isReplayCompatible(replay))
+        reallyStartVisualReplay(replay.directory);
+    else
+        displayReplayCompatibilityError(replay);
+}
+
+function reallyStartVisualReplay(replayDirectory)
+{
+    // TODO: enhancement: remember filter settings and selected item. restore settings when returning from the replay.
+    Engine.StartVisualReplay(replayDirectory);
+    Engine.SwitchGuiPage("page_loading.xml", {
+        "attribs": Engine.GetReplayAttributes(replayDirectory),
+        "isNetworked" : false,
+        "playerAssignments": {},
+        "savedGUIData": "",
+        "isReplay" : true
+    });
+}
+
+function displayReplayCompatibilityError(replay)
+{
+    let errMsg;
+    if (isReplayCompatible_EngineVersion(replay))
+    {
+        let gameMods;
+        if (replay.attribs.mods)
+            gameMods = replay.attribs.mods;
+        else
+            gameMods = [];
+
+        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
+    {
+        errMsg = translate("This replay is not compatible with your version of the game!");
+    }
+
+    let btCaptions = [translate("Ok")];
+    let btCode = [null];
+    messageBox(500, 200, errMsg, translate("REPLAY INCOMPATIBLE"), 0, btCaptions, btCode);
+}
+
+function showReplaySummary()
+{
+    let selected = Engine.GetGUIObjectByName("replaySelection").selected;
+    if (selected == -1)
+        return;
+
+    let replay = g_ReplaysFiltered[selected];
+    let summary = Engine.GetReplayMetadata(replay.directory);
+
+    if (Object.keys(summary) == 0)
+    {
+        let btCaptions = [translate("Ok")];
+        let btCode = [null];
+        messageBox(500, 200, translateWithContext("replay", "No summary data found!"), translate("ERROR"), 0, btCaptions, btCode);
+        return;
+    }
+
+    summary.isReplay = true;
+    summary.gameResult = translateWithContext("replay", "Scores at the end of the game.");
+
+    Engine.SwitchGuiPage("page_summary.xml", summary);
+}
+
+function deleteReplay()
+{
+    let selected = Engine.GetGUIObjectByName("replaySelection").selected;
+    if (selected == -1)
+        return;
+
+    // Ask for confirmation
+    let replay = g_ReplaysFiltered[selected];
+    let btCaptions = [translate("Yes"), translate("No")];
+    let 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()
+{
+    let 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/replaymenu/replaymenu.xml

@@ +1 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<objects>
+
+    <script file="gui/aiconfig/aiconfig.js"/>
+    <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/replaymenu/replaymenu.js" />
+    <script directory="gui/gamesetup/victory_conditions/"/>
+
+    <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="20%+25 0 37%+25 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="summaryButton" type="button" style="StoneButton" size="65%-50 0 82%-50 100%">
+                <translatableAttribute id="caption">Summary</translatableAttribute>
+                <action on="Press">
+                    showReplaySummary();
+                </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>

binaries/data/mods/public/gui/replaymenu/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)
@@ -310 +312 @@
  * @param willRejoin If player is going to be rejoining a networked game.
  */
 function leaveGame(willRejoin)
 {
     var extendedSimState = Engine.GuiInterfaceCall("GetExtendedSimulationState");
-    var mapSettings = Engine.GetMapSettings();
     var gameResult;
-
     if (g_IsObserver)
     {
         // Observers don't win/lose.
         gameResult = translate("You have left the game.");
         global.music.setState(global.music.states.VICTORY);
@@ -342 +342 @@
             }
         }
     }
 
     stopAmbient();
-    Engine.EndGame();
 
+    // Save summary screen data before ending the game
+    // TODO: enhancement: how to save the data if the user exits with Alt+F4?
+    let summary = {
+            "timeElapsed" : extendedSimState.timeElapsed,
+            "playerStates": extendedSimState.players,
+            "players": g_Players,
+            "mapSettings": Engine.GetMapSettings()
+    };
+    if (!g_IsReplay)
+        Engine.SaveReplayMetadata(JSON.stringify(summary));
+    summary.isReplay = g_IsReplay;
+    summary.gameResult = gameResult;
+
+    Engine.EndGame();
     if (g_IsController && Engine.HasXmppClient())
         Engine.SendUnregisterGame();
 
-    Engine.SwitchGuiPage("page_summary.xml", {
-                            "gameResult"  : gameResult,
-                            "timeElapsed" : extendedSimState.timeElapsed,
-                            "playerStates": extendedSimState.players,
-                            "players": g_Players,
-                            "mapSettings": mapSettings
-                         });
+    Engine.SwitchGuiPage("page_summary.xml", summary);
 }
 
 // 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) });

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_replaymenu.xml");
                 }
                 else
                 {
-                    Engine.LobbySetPlayerPresence("available");
-                    Engine.SwitchGuiPage("page_lobby.xml");
+                    Engine.SwitchGuiPage("page_pregame.xml");
                 }
                 ]]>
             </action>
         </object>
     </object>

binaries/data/mods/public/l10n/messages.json

@@ -463 +463 @@
                 }
             },
             {
                 "extractor": "json",
                 "filemasks": [
+                    "simulation/data/map_types.json"
+                ],
+                "options": {
+                    "keywords": [
+                        "Title"
+                    ]
+                }
+            },
+            {
+                "extractor": "json",
+                "filemasks": [
                     "simulation/data/map_sizes.json"
                 ],
                 "options": {
                     "keywords": [
                         "Name",
@@ -475 +486 @@
                 }
             },
             {
                 "extractor": "json",
                 "filemasks": [
+                    "simulation/data/population_capacity.json"
+                ],
+                "options": {
+                    "keywords": [
+                        "Title"
+                    ]
+                }
+            },
+            {
+                "extractor": "json",
+                "filemasks": [
                     "simulation/ai/**.json"
                 ],
                 "options": {
                     "keywords": [
                         "name",
                         "description"
                     ]
                 }
-            }
+            },
+            {
+                "extractor": "json",
+                "filemasks": [
+                    "simulation/ai/difficulties.json"
+                ],
+                "options": {
+                    "keywords": [
+                        "Title"
+                    ]
+                }
+            },
         ]
     },
     {
         "output": "public-maps.pot",
         "inputRoot": "..",

binaries/data/mods/public/simulation/ai/difficulties.json

@@ +1 @@
+{
+    "Difficulties":
+    [
+        {
+            "Name": "sandbox",
+            "Title": "Sandbox"
+        },
+        {
+            "Name": "very easy",
+            "Title": "Very Easy"
+        },
+        {
+            "Name": "easy",
+            "Title": "Easy"
+        },
+        {
+            "Name": "medium",
+            "Title": "Medium",
+            "Default": true
+        },
+        {
+            "Name": "hard",
+            "Title": "Hard"
+        },
+        {
+            "Name": "very hard",
+            "Title": "Very Hard"
+        }
+    ]
+}
+ No newline at end of file

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
         }
     ]
 }

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

@@ +1 @@
+{
+    "Types":
+    [
+        {
+            "Name": "skirmish",
+            "Title": "Skirmish",
+            "Default": true
+        },
+        {
+            "Name": "random",
+            "Title": "Random"
+        },
+        {
+            "Name": "scenario",
+            "Title": "Scenario"
+        }
+    ]
+}
+ No newline at end of file

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

@@ +1 @@
+{
+    "PopulationCapacity":
+    [
+        {
+            "Population": 50,
+            "Title": "50"
+        },
+        {
+            "Population": 100,
+            "Title": "100"
+        },
+        {
+            "Population": 150,
+            "Title": "150"
+        },
+        {
+            "Population": 200,
+            "Title": "200"
+        },
+        {
+            "Population": 250,
+            "Title": "250"
+        },
+        {
+            "Population": 300,
+            "Title": "300",
+            "Default": true
+        },
+        {
+            "Population": 10000,
+            "Title": "Unlimited"
+        }
+    ]
+}

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");
 }
 
+void StartVisualReplay(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), std::wstring directoryName)
+{
+    ENSURE(!g_NetServer);
+    ENSURE(!g_NetClient);
+    ENSURE(!g_Game);
+
+    std::wstring 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);
+    }
+}
+
+JS::Value GetReplayAttributes(ScriptInterface::CxPrivate* pCxPrivate, std::wstring directoryName)
+{
+    return VisualReplay::GetReplayAttributes(pCxPrivate, directoryName);
+}
+
+void SaveReplayMetadata(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), std::wstring data)
+{
+    VisualReplay::SaveReplayMetadata(data);
+}
+
+JS::Value GetReplayMetadata(ScriptInterface::CxPrivate* pCxPrivate, std::wstring directoryName)
+{
+    return VisualReplay::GetReplayMetadata(pCxPrivate, directoryName);
+}
+
 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 +447 @@
 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 +1016 @@
     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<void, std::wstring, &StartVisualReplay>("StartVisualReplay");
+    scriptInterface.RegisterFunction<JS::Value, std::wstring, &GetReplayAttributes>("GetReplayAttributes");
+    scriptInterface.RegisterFunction<JS::Value, std::wstring, &GetReplayMetadata>("GetReplayMetadata");
+    scriptInterface.RegisterFunction<void, std::wstring, &SaveReplayMetadata>("SaveReplayMetadata");
+
     // 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/network/NetTurnManager.cpp

@@ -533 +533 @@
     ENSURE(m_Simulation2.ComputeStateHash(hash, quickHash));
     hash = Hexify(hash);
 
     if (hash != expectedHash)
         DisplayOOSError(turn, hash, expectedHash, true);
+
+    if (turn == m_FinalReplayTurn)
+        g_GUI->SendEventToAll("ReplayFinished");
 }
 
 void CNetReplayTurnManager::DoTurn(u32 turn)
 {
     // Save turn length

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")
         {
@@ -162 +164 @@
         else
         {
             CancelLoad(L"Failed to load replay data (unrecognized content)");
         }
     }
+    m_ReplayStream->close();
     m_FinalReplayTurn = currentTurn;
     replayTurnMgr->StoreFinalReplayTurn(currentTurn);
     return 0;
 }
 
@@ -389 +392 @@
         {
             {
                 PROFILE3("gui sim update");
                 g_GUI->SendEventToAll("SimulationUpdate");
             }
-            if (m_IsReplay && m_TurnManager->GetCurrentTurn() == m_FinalReplayTurn - 1)
-                g_GUI->SendEventToAll("ReplayFinished");
 
             GetView()->GetLOSTexture().MakeDirty();
         }
-        
+
         if (CRenderer::IsInitialised())
             g_Renderer.GetTimeManager().Update(deltaSimTime);
     }
 
     if (doInterpolate)

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);

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"
@@ -50 +52 @@
         str << std::setfill('0') << std::setw(2) << (int)(unsigned char)s[i];
     return str.str();
 }
 
 CReplayLogger::CReplayLogger(ScriptInterface& scriptInterface) :
-    m_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.
 
@@ -63 +74 @@
 
     static int run = -1;
     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;
-}
-
-void CReplayLogger::StartGame(JS::MutableHandleValue attribs)
-{
+    // 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);
+
+    // Remember the directory, so that we can save additional files to it
+    m_Directory = psLogDir() / L"sim_log" / name.str();
+    OsPath filepath = m_Directory / L"commands.txt";
+
+    // Open the file when starting the game to prevent empty files
+    CreateDirectories(m_Directory, 0700);
+    m_Stream = new std::ofstream(OsString(filepath).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)
 {
@@ -100 +111 @@
         *m_Stream << "hash-quick " << Hexify(hash) << "\n";
     else
         *m_Stream << "hash " << Hexify(hash) << "\n";
 }
 
+OsPath CReplayLogger::GetReplayDirectory()
+{
+    return m_Directory;
+}
 ////////////////////////////////////////////////////////////////
 
 CReplayPlayer::CReplayPlayer() :
     m_Stream(NULL)
 {
@@ -157 +172 @@
     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 +211 @@
             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 +235 @@
 
                 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

@@ -45 +45 @@
 
     /**
      * Optional hash of simulation state (for sync checking).
      */
     virtual void Hash(const std::string& hash, bool quick) = 0;
+
+    /**
+     * Returns the directory that contains the replay file.
+     */
+    virtual OsPath GetReplayDirectory() = 0;
 };
 
 /**
  * Implementation of IReplayLogger that simply throws away all data.
  */
@@ -56 +61 @@
 {
 public:
     virtual void StartGame(JS::MutableHandleValue UNUSED(attribs)) { }
     virtual void Turn(u32 UNUSED(n), u32 UNUSED(turnLength), std::vector<SimulationCommand>& UNUSED(commands)) { }
     virtual void Hash(const std::string& UNUSED(hash), bool UNUSED(quick)) { }
+    virtual OsPath GetReplayDirectory() { return OsPath();}
 };
 
 /**
  * Implementation of IReplayLogger that saves data to a file in the logs directory.
  */
@@ -71 +77 @@
     ~CReplayLogger();
 
     virtual void StartGame(JS::MutableHandleValue attribs);
     virtual void Turn(u32 n, u32 turnLength, std::vector<SimulationCommand>& commands);
     virtual void Hash(const std::string& hash, bool quick);
+    virtual OsPath GetReplayDirectory();
 
 private:
     ScriptInterface& m_ScriptInterface;
     std::ostream* m_Stream;
+    OsPath m_Directory;
 };
 
 /**
  * Replay log replayer. Runs the log with no graphics and dumps some info to stdout.
  */
@@ -90 +98 @@
 
     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);
 
@@ -298 +300 @@
     
     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, "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 "ps/Replay.h"
+#include "scriptinterface/ScriptInterface.h"
+
+OsPath VisualReplay::GetDirectoryName()
+{
+    return OsPath(psLogDir() / L"sim_log");
+}
+
+JS::Value VisualReplay::GetReplays(ScriptInterface& scriptInterface)
+{
+    // TODO: enhancement: make a cache file, so that only one file needs to be loaded
+    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);
+}
+
+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;
+    u64 duration = 0;
+    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;
+        }
+        else if (type == "cmd")
+        {
+            // Read command
+            std::string command;
+            std::getline(*replayStream, command);
+        }
+        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;
+
+    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);
+    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;
+}
+
+
+JS::Value VisualReplay::GetReplayAttributes(ScriptInterface::CxPrivate* pCxPrivate, std::wstring directoryName)
+{
+    std::wstring replayFilePath = OsPath(VisualReplay::GetDirectoryName() / directoryName / "commands.txt").string();
+    std::string replayFile( replayFilePath.begin(), replayFilePath.end() );
+
+    JSContext* cx = pCxPrivate->pScriptInterface->GetContext();
+    JSAutoRequest rq(cx);
+    JS::RootedValue attribs(cx);
+    pCxPrivate->pScriptInterface->Eval("({})", &attribs);
+
+    if (!FileExists(OsPath(replayFile)))
+        return attribs;
+
+    std::ifstream* replayStream = new std::ifstream(replayFile.c_str());
+    std::string type, line;
+    ENSURE((*replayStream >> type).good() && type == "start");
+
+    std::getline(*replayStream, line);
+    pCxPrivate->pScriptInterface->ParseJSON(line, &attribs);
+    replayStream->close();
+    return attribs;
+}
+
+void VisualReplay::SaveReplayMetadata(std::wstring data)
+{
+    // Returns directory of the currently active replay
+    // TODO: enhancement: use JS::HandleValue similar to SaveGame
+    if (!g_Game)
+        return;
+
+    OsPath directory = g_Game->GetReplayLogger().GetReplayDirectory();
+    CreateDirectories(directory, 0700);
+
+    OsPath filepath = OsPath(directory / L"metadata.json");
+
+    std::wstring filenameW = filepath.string();
+    std::string filename( filenameW.begin(), filenameW.end() );
+
+    std::ofstream stream (filename.c_str(), std::ofstream::out | std::ofstream::trunc);
+    stream << utf8_from_wstring(data);
+    stream.close();
+}
+
+JS::Value VisualReplay::GetReplayMetadata(ScriptInterface::CxPrivate* pCxPrivate, std::wstring directoryName)
+{
+    std::wstring filePathW = OsPath(VisualReplay::GetDirectoryName() / directoryName / "metadata.json").string();
+    std::string filePath( filePathW.begin(), filePathW.end() );
+
+    JSContext* cx = pCxPrivate->pScriptInterface->GetContext();
+    JSAutoRequest rq(cx);
+    JS::RootedValue metadata(cx);
+
+    if (FileExists(OsPath(filePathW)))
+    {
+        std::ifstream* stream = new std::ifstream(filePath.c_str());
+        ENSURE(stream->good());
+
+        std::string type, line;
+        std::getline(*stream, line);
+        pCxPrivate->pScriptInterface->ParseJSON(line, &metadata);
+        stream->close();
+    }
+    else
+    {
+        pCxPrivate->pScriptInterface->Eval("({})", &metadata);
+    }
+
+    return metadata;
+}

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.
+ * Works similarly to CGame::LoadReplayData().
+ */
+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);
+
+/**
+ * Returns the parsed header of the replay file (commands.txt).
+ */
+JS::Value GetReplayAttributes(ScriptInterface::CxPrivate* pCxPrivate, std::wstring directoryName);
+
+/**
+ * Returns the metadata of a replay.
+ */
+JS::Value GetReplayMetadata(ScriptInterface::CxPrivate* pCxPrivate, std::wstring directoryName);
+
+/**
+ * Saves the metadata from the session to metadata.json
+ */
+void SaveReplayMetadata(std::wstring data);
+
+}
+
+#endif

source/simulation2/components/ICmpAIManager.cpp

@@ -47 +47 @@
         m_AIs.set(JS_NewArrayObject(cx, 0));
     }
 
     void Run()
     {
-        vfs::ForEachFile(g_VFS, L"simulation/ai/", Callback, (uintptr_t)this, L"*.json", vfs::DIR_RECURSIVE);
+        vfs::ForEachFile(g_VFS, L"simulation/ai/", Callback, (uintptr_t)this, L"data.json", vfs::DIR_RECURSIVE);
     }
 
     static Status Callback(const VfsPath& pathname, const CFileInfo& UNUSED(fileInfo), const uintptr_t cbData)
     {
         GetAIsHelper* self = (GetAIsHelper*)cbData;