Map compatibility mode

5 files changed, 213 insertions, 27 deletions

diff --git a/extension/deps/openvic-simulation b/extension/deps/openvic-simulation
-Subproject 15e960f93ced8c94a6a45ebb2b44d0705ff7f8f
+Subproject 35b038fe91d4f3c4b3ffdc4f48385ac3b208266
diff --git a/extension/src/GameSingleton.cpp b/extension/src/GameSingleton.cpp
index 6b3456a..cb7d0a7 100644
--- a/extension/src/GameSingleton.cpp
+++ b/extension/src/GameSingleton.cpp
@@ -2,7 +2,7 @@
 
 #include <godot_cpp/variant/utility_functions.hpp>
 
-#include "openvic/Logger.hpp"
+#include "openvic/utility/Logger.hpp"
 
 #include "Utilities.hpp"
 
@@ -13,6 +13,7 @@ GameSingleton* GameSingleton::singleton = nullptr;
 
 void GameSingleton::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("load_defines", "file_dict"), &GameSingleton::load_defines);
+	ClassDB::bind_method(D_METHOD("load_defines_compatibility_mode", "file_path"), &GameSingleton::load_defines_compatibility_mode);
 	ClassDB::bind_method(D_METHOD("setup"), &GameSingleton::setup);
 
 	ClassDB::bind_method(D_METHOD("get_province_index_from_uv_coords", "coords"), &GameSingleton::get_province_index_from_uv_coords);
diff --git a/extension/src/GameSingleton.hpp b/extension/src/GameSingleton.hpp
index 4c809af..6bfb741 100644
--- a/extension/src/GameSingleton.hpp
+++ b/extension/src/GameSingleton.hpp
@@ -11,6 +11,8 @@ namespace OpenVic {
 		const godot::Ref<godot::Image> image;
 
 	public:
+		static constexpr size_t MAX_INDEX = 1 << (8 * sizeof(Map::terrain_t));
+
 		TerrainVariant(std::string const& new_identfier, colour_t new_colour,
 			godot::Ref<godot::Image> const& new_image)
 			: HasIdentifier { new_identfier },
@@ -42,12 +44,16 @@ namespace OpenVic {
 		godot::Error _parse_terrain_entry(godot::String const& identifier, godot::Variant const& entry, godot::String const& terrain_texture_dir_path);
 		godot::Error _parse_good_entry(godot::String const& identifier, godot::Variant const& entry);
 
-		godot::Error load_province_identifier_file(godot::String const& file_path);
-		godot::Error load_water_province_file(godot::String const& file_path);
-		godot::Error load_region_file(godot::String const& file_path);
-		godot::Error load_terrain_variants(godot::String const& terrain_identifiers_path, godot::String const& terrain_texture_dir_path);
-		godot::Error load_map_images(godot::String const& province_image_path, godot::String const& terrain_image_path);
-		godot::Error load_goods(godot::String const& defines_path, godot::String const& icons_dir_path);
+		godot::Error _load_province_identifier_file(godot::String const& file_path);
+		godot::Error _load_water_province_file(godot::String const& file_path);
+		godot::Error _load_region_file(godot::String const& file_path);
+		godot::Error _load_terrain_variants(godot::String const& terrain_identifiers_path, godot::String const& terrain_texture_dir_path);
+		godot::Error _generate_terrain_texture_array();
+		godot::Error _load_map_images(godot::String const& province_image_path, godot::String const& terrain_image_path, bool flip_vertical = false);
+		godot::Error _load_goods(godot::String const& defines_path, godot::String const& icons_dir_path);
+
+		godot::Error _load_province_identifier_file_compatibility_mode(godot::String const& file_path);
+		godot::Error _load_terrain_variants_compatibility_mode(godot::String const& terrain_image_path, godot::String const& terrain_texturesheet_path);
 
 		/* Hardcoded data for defining things for which parsing from files has
 		 * not been implemented, currently mapmodes and building types.
@@ -83,6 +89,11 @@ namespace OpenVic {
 		 */
 		godot::Error load_defines(godot::Dictionary const& file_dict);
 
+		/* Load the game's defines in compatiblity mode from the filepath
+		 * pointing to the defines folder.
+		 */
+		godot::Error load_defines_compatibility_mode(godot::String const& file_path);
+
 		/* Post-load/restart game setup - reset the game to post-load state
 		 * and (re)generate starting data, e.g. buildings.
 		 */
diff --git a/extension/src/LoadGameCompatibility.cpp b/extension/src/LoadGameCompatibility.cpp
new file mode 100644
index 0000000..29b773e
--- /dev/null
+++ b/extension/src/LoadGameCompatibility.cpp
@@ -0,0 +1,154 @@
+#include "GameSingleton.hpp"
+
+#include <godot_cpp/classes/file_access.hpp>
+#include <godot_cpp/variant/utility_functions.hpp>
+
+#include "openvic/utility/BMP.hpp"
+
+#include "Utilities.hpp"
+
+using namespace godot;
+using namespace OpenVic;
+
+Error GameSingleton::_load_province_identifier_file_compatibility_mode(String const& file_path) {
+	UtilityFunctions::print("Loading compatibility mode province identifier file: ", file_path);
+
+	const Ref<FileAccess> file = FileAccess::open(file_path, FileAccess::ModeFlags::READ);
+	Error err = FileAccess::get_open_error();
+	if (err != OK || file.is_null()) {
+		UtilityFunctions::push_error("Failed to load compatibility mode province identifier file: ", file_path);
+		return err == OK ? FAILED : err;
+	}
+
+	int line_number = 0;
+	while (!file->eof_reached()) {
+		const PackedStringArray line = file->get_csv_line(";");
+		line_number++;
+
+		if (line.is_empty() || (line.size() == 1 && line[0].is_empty()))
+			continue;
+
+		if (line_number < 2) continue; // skip header line
+		index_t id = NULL_INDEX;
+		colour_t colour = NULL_COLOUR;
+		if (line.size() > 0) {
+			if (line[0].is_empty()) {
+				id = game_manager.map.get_province_count() + 1;
+			} else if (line[0].is_valid_int()) {
+				const int64_t val = line[0].to_int();
+				if (val > NULL_INDEX && val <= MAX_INDEX) id = val;
+			}
+			for (int i = 1; i < 4; ++i) {
+				if (line.size() > i) {
+					if (line[i].is_valid_int()) {
+						const int64_t int_val = line[i].to_int();
+						if (int_val >= NULL_COLOUR && int_val <= FULL_COLOUR) {
+							colour = (colour << 8) | int_val;
+							continue;
+						}
+					} else if (line[i].is_valid_float()) {
+						const double double_val = line[i].to_float();
+						if (std::trunc(double_val) == double_val) {
+							const int64_t int_val = double_val;
+							if (int_val >= NULL_COLOUR && int_val <= FULL_COLOUR) {
+								colour = (colour << 8) | int_val;
+								continue;
+							}
+						}
+					}
+				}
+				colour = NULL_COLOUR;
+				break;
+			}
+		}
+		if (id == NULL_INDEX || colour == NULL_COLOUR) {
+			UtilityFunctions::push_error("Invalid province ID-colour entry \"", line, "\" on line ", line_number, " in file: ", file_path);
+			err = FAILED;
+			continue;
+		}
+		static const std::string province_prefix = "PROV";
+		if (game_manager.map.add_province(province_prefix + std::to_string(id), colour) != SUCCESS) err = FAILED;
+	}
+	game_manager.map.lock_provinces();
+	return err;
+}
+
+Error GameSingleton::_load_terrain_variants_compatibility_mode(String const& terrain_image_path, String const& terrain_texturesheet_path) {
+	// Read BMP's palette to determine terrain variant colours which texture they're associated with
+	BMP bmp;
+	if (bmp.open(godot_to_c_string(terrain_image_path)) != SUCCESS || bmp.read_header() != SUCCESS || bmp.read_palette() != SUCCESS) {
+		UtilityFunctions::push_error("Failed to read BMP palette from compatibility mode terrain image: ", terrain_image_path);
+		return FAILED;
+	}
+	std::vector<colour_t> const& palette = bmp.get_palette();
+	static constexpr int32_t SHEET_DIMS = 8, PALETTE_SIZE = SHEET_DIMS * SHEET_DIMS;
+	if (palette.size() == 0 || palette.size() < PALETTE_SIZE) {
+		UtilityFunctions::push_error("Invalid BMP palette size for terrain image: ", static_cast<uint64_t>(palette.size()), " (expected ", PALETTE_SIZE, ")");
+		return FAILED;
+	}
+
+	// Load the terrain texture sheet and prepare to slice it up
+	Ref<Image> terrain_sheet;
+	terrain_sheet.instantiate();
+	if (terrain_sheet->load(terrain_texturesheet_path) != OK) {
+		UtilityFunctions::push_error("Failed to load terrain texture sheet: ", terrain_texturesheet_path);
+		return FAILED;
+	}
+	terrain_sheet->flip_y();
+	const int32_t sheet_width = terrain_sheet->get_width(), sheet_height = terrain_sheet->get_height();
+	if (sheet_width < 1 || sheet_width % SHEET_DIMS != 0 || sheet_width != sheet_height) {
+		UtilityFunctions::push_error("Invalid terrain texture sheet dims: ", sheet_width, "x", sheet_height, " (must be square with dims positive multiples of ", SHEET_DIMS, ")");
+		return FAILED;
+	}
+	const int32_t slice_size = sheet_width / SHEET_DIMS;
+
+	{
+		Ref<Image> water_image = Image::create(slice_size, slice_size, false, terrain_sheet->get_format());
+		ERR_FAIL_NULL_V_EDMSG(water_image, FAILED, "Failed to create water terrain image");
+		water_image->fill({ 0.0f, 0.0f, 1.0f });
+		terrain_variants.add_item({ "terrain_water", 0xFFFFFF, water_image });
+	}
+	Error err = OK;
+	for (int32_t idx = 0; idx < PALETTE_SIZE; ++idx) {
+		const Rect2i slice { (idx % SHEET_DIMS) * slice_size, (7 - (idx / SHEET_DIMS)) * slice_size, slice_size, slice_size };
+		const Ref<Image> terrain_image = terrain_sheet->get_region(slice);
+		if (terrain_image.is_null() || terrain_image->is_empty()) {
+			UtilityFunctions::push_error("Failed to extract terrain texture slice ", slice, " from ", terrain_texturesheet_path);
+			err = FAILED;
+			continue;
+		}
+		if (terrain_variants.add_item({ "terrain_" + std::to_string(idx), palette[idx], terrain_image }) != SUCCESS) err = FAILED;
+	}
+	terrain_variants.lock();
+	if (_generate_terrain_texture_array() != OK) return FAILED;
+	return err;
+}
+
+Error GameSingleton::load_defines_compatibility_mode(String const& file_path) {
+	static const String province_identifier_file = "/map/definition.csv";
+	static const String province_image_file = "/map/provinces.bmp";
+	static const String terrain_image_file = "/map/terrain.bmp";
+	static const String terrain_texture_dir = "/map/terrain/texturesheet.tga";
+
+	Error err = OK;
+	if (_load_province_identifier_file_compatibility_mode(file_path + province_identifier_file) != OK) {
+		UtilityFunctions::push_error("Failed to load province identifiers!");
+		err = FAILED;
+	}
+	game_manager.map.lock_water_provinces();
+	game_manager.map.lock_regions();
+	if (_load_terrain_variants_compatibility_mode(file_path + terrain_image_file, file_path + terrain_texture_dir) != OK) {
+		UtilityFunctions::push_error("Failed to load terrain variants!");
+		err = FAILED;
+	}
+	if (_load_map_images(file_path + province_image_file, file_path + terrain_image_file, true) != OK) {
+		UtilityFunctions::push_error("Failed to load map images!");
+		err = FAILED;
+	}
+	game_manager.good_manager.lock_goods();
+	if (_load_hardcoded_defines() != OK) {
+		UtilityFunctions::push_error("Failed to hardcoded defines!");
+		err = FAILED;
+	}
+	return err;
+}
diff --git a/extension/src/LoadGameOpenVic.cpp b/extension/src/LoadGameOpenVic.cpp
index 7f33bf5..f856fd6 100644
--- a/extension/src/LoadGameOpenVic.cpp
+++ b/extension/src/LoadGameOpenVic.cpp
@@ -97,7 +97,7 @@ Error GameSingleton::_parse_province_identifier_entry(String const& identifier,
 	return ERR(game_manager.map.add_province(godot_to_std_string(identifier), colour));
 }
 
-Error GameSingleton::load_province_identifier_file(String const& file_path) {
+Error GameSingleton::_load_province_identifier_file(String const& file_path) {
 	const Error err = _parse_json_dictionary_file("province identifier", file_path, "prov_",
 		[this](String const& identifier, Variant const& entry) -> Error {
 			return _parse_province_identifier_entry(identifier, entry);
@@ -106,7 +106,7 @@ Error GameSingleton::load_province_identifier_file(String const& file_path) {
 	return err;
 }
 
-Error GameSingleton::load_water_province_file(String const& file_path) {
+Error GameSingleton::_load_water_province_file(String const& file_path) {
 	Variant json_var;
 	Error err = _load_json_file("water province", file_path, json_var);
 	if (err != OK) return err;
@@ -159,7 +159,7 @@ Error GameSingleton::_parse_region_entry(String const& identifier, Variant const
 	return ERR(game_manager.map.add_region(godot_to_std_string(identifier), province_identifiers));
 }
 
-Error GameSingleton::load_region_file(String const& file_path) {
+Error GameSingleton::_load_region_file(String const& file_path) {
 	const Error err = _parse_json_dictionary_file("region", file_path, "region_",
 		[this](String const& identifier, Variant const& entry) -> Error {
 			return _parse_region_entry(identifier, entry);
@@ -185,20 +185,32 @@ Error GameSingleton::_parse_terrain_entry(String const& identifier, Variant cons
 	return ERR(terrain_variants.add_item({ godot_to_std_string(identifier), colour, terrain_image }));
 }
 
-Error GameSingleton::load_terrain_variants(String const& terrain_identifiers_path, String const& terrain_texture_dir_path) {
-	const Error err = _parse_json_dictionary_file("terrain variants", terrain_identifiers_path, "",
+Error GameSingleton::_load_terrain_variants(String const& terrain_identifiers_path, String const& terrain_texture_dir_path) {
+	Error err = _parse_json_dictionary_file("terrain variants", terrain_identifiers_path, "",
 		[this, terrain_texture_dir_path](String const& identifier, Variant const& entry) -> Error {
 			return _parse_terrain_entry(identifier, entry, terrain_texture_dir_path + String { "/" });
 		});
 	terrain_variants.lock();
+	if (_generate_terrain_texture_array() != OK) return FAILED;
+	return err;
+}
+
+Error GameSingleton::_generate_terrain_texture_array() {
+	Error err = OK;
 	if (terrain_variants.get_item_count() == 0) {
 		UtilityFunctions::push_error("Failed to load terrain textures!");
 		return FAILED;
 	}
+	// TerrainVariant count is limited by the data type representing it in the map image
+	if (terrain_variants.get_item_count() > TerrainVariant::MAX_INDEX) {
+		UtilityFunctions::push_error("Too many terrain textures - all after the first ", MAX_INDEX, " will be ignored");
+		err = FAILED;
+	}
 
 	Array terrain_images;
-	for (TerrainVariant const& var : terrain_variants.get_items()) {
-		terrain_variant_map[var.get_colour()] = terrain_images.size();
+	for (size_t i = 0; i < terrain_variants.get_item_count() && i < TerrainVariant::MAX_INDEX; ++i) {
+		TerrainVariant const& var = *terrain_variants.get_item_by_index(i);
+		terrain_variant_map[var.get_colour()] = i;
 		terrain_images.append(var.get_image());
 	}
 
@@ -210,7 +222,7 @@ Error GameSingleton::load_terrain_variants(String const& terrain_identifiers_pat
 	return err;
 }
 
-Error GameSingleton::load_map_images(String const& province_image_path, String const& terrain_image_path) {
+Error GameSingleton::_load_map_images(String const& province_image_path, String const& terrain_image_path, bool flip_vertical) {
 	if (province_shape_texture.is_valid()) {
 		UtilityFunctions::push_error("Map images have already been loaded, cannot load: ", province_image_path, " and ", terrain_image_path);
 		return FAILED;
@@ -231,6 +243,11 @@ Error GameSingleton::load_map_images(String const& province_image_path, String c
 		return err;
 	}
 
+	if (flip_vertical) {
+		province_image->flip_y();
+		terrain_image->flip_y();
+	}
+
 	// Validate dimensions and format
 	const Vector2i province_dims = province_image->get_size(), terrain_dims = terrain_image->get_size();
 	if (province_dims.x < 1 || province_dims.y < 1) {
@@ -243,13 +260,14 @@ Error GameSingleton::load_map_images(String const& province_image_path, String c
 		err = FAILED;
 	}
 	static constexpr Image::Format expected_format = Image::FORMAT_RGB8;
-	const Image::Format province_format = province_image->get_format(), terrain_format = terrain_image->get_format();
-	if (province_format != expected_format) {
-		UtilityFunctions::push_error("Invalid format (", province_format, ", should be ", expected_format, ") for province image: ", province_image_path);
+	if (province_image->get_format() == Image::FORMAT_RGBA8) province_image->convert(expected_format);
+	if (terrain_image->get_format() == Image::FORMAT_RGBA8) terrain_image->convert(expected_format);
+	if (province_image->get_format() != expected_format) {
+		UtilityFunctions::push_error("Invalid format (", province_image->get_format(), ", should be ", expected_format, ") for province image: ", province_image_path);
 		err = FAILED;
 	}
-	if (terrain_format != expected_format) {
-		UtilityFunctions::push_error("Invalid format (", terrain_format, ", should be ", expected_format, ") for terrain image: ", terrain_image_path);
+	if (terrain_image->get_format() != expected_format) {
+		UtilityFunctions::push_error("Invalid format (", terrain_image->get_format(), ", should be ", expected_format, ") for terrain image: ", terrain_image_path);
 		err = FAILED;
 	}
 	if (err != OK) return err;
@@ -293,6 +311,8 @@ Error GameSingleton::load_map_images(String const& province_image_path, String c
 		err = FAILED;
 	}
 
+	if (_update_colour_image() != OK) err = FAILED;
+
 	return err;
 }
 
@@ -351,7 +371,7 @@ Error GameSingleton::_parse_good_entry(String const& identifier, Variant const&
 		colour, base_price, default_available, tradeable, currency, overseas_maintenance));
 }
 
-Error GameSingleton::load_goods(String const& defines_path, String const& icons_dir_path) {
+Error GameSingleton::_load_goods(String const& defines_path, String const& icons_dir_path) {
 	Error err = _parse_json_dictionary_file("good", defines_path, "good_",
 		[this](String const& identifier, Variant const& entry) -> Error {
 			return _parse_good_entry(identifier, entry);
@@ -417,28 +437,28 @@ StringName const& GameSingleton::get_good_icons_dir_key() {
 
 Error GameSingleton::load_defines(Dictionary const& file_dict) {
 	Error err = OK;
-	if (load_province_identifier_file(file_dict.get(get_province_identifier_file_key(), "")) != OK) {
+	if (_load_province_identifier_file(file_dict.get(get_province_identifier_file_key(), "")) != OK) {
 		UtilityFunctions::push_error("Failed to load province identifiers!");
 		err = FAILED;
 	}
-	if (load_water_province_file(file_dict.get(get_water_province_file_key(), "")) != OK) {
+	if (_load_water_province_file(file_dict.get(get_water_province_file_key(), "")) != OK) {
 		UtilityFunctions::push_error("Failed to load water provinces!");
 		err = FAILED;
 	}
-	if (load_region_file(file_dict.get(get_region_file_key(), "")) != OK) {
+	if (_load_region_file(file_dict.get(get_region_file_key(), "")) != OK) {
 		UtilityFunctions::push_error("Failed to load regions!");
 		err = FAILED;
 	}
-	if (load_terrain_variants(file_dict.get(get_terrain_variant_file_key(), ""),
+	if (_load_terrain_variants(file_dict.get(get_terrain_variant_file_key(), ""),
 		file_dict.get(get_terrain_texture_dir_key(), "")) != OK) {
 		UtilityFunctions::push_error("Failed to load terrain variants!");
 		err = FAILED;
 	}
-	if (load_map_images(file_dict.get(get_province_image_file_key(), ""), file_dict.get(get_terrain_image_file_key(), "")) != OK) {
+	if (_load_map_images(file_dict.get(get_province_image_file_key(), ""), file_dict.get(get_terrain_image_file_key(), "")) != OK) {
 		UtilityFunctions::push_error("Failed to load map images!");
 		err = FAILED;
 	}
-	if (load_goods(file_dict.get(get_goods_file_key(), ""), file_dict.get(get_good_icons_dir_key(), "")) != OK) {
+	if (_load_goods(file_dict.get(get_goods_file_key(), ""), file_dict.get(get_good_icons_dir_key(), "")) != OK) {
 		UtilityFunctions::push_error("Failed to load goods!");
 		err = FAILED;
 	}