Terrain textures + province colour alpha channel

18 files changed, 252 insertions, 116 deletions

diff --git a/extension/src/GameSingleton.cpp b/extension/src/GameSingleton.cpp
index 64f6fc1..3476ac5 100644
--- a/extension/src/GameSingleton.cpp
+++ b/extension/src/GameSingleton.cpp
@@ -5,7 +5,6 @@
 #include <godot_cpp/classes/json.hpp>
 
 #include "openvic2/Logger.hpp"
-#include "openvic2/Types.hpp"
 
 using namespace godot;
 using namespace OpenVic2;
@@ -18,7 +17,8 @@ void GameSingleton::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("load_province_identifier_file", "file_path"), &GameSingleton::load_province_identifier_file);
 	ClassDB::bind_method(D_METHOD("load_water_province_file", "file_path"), &GameSingleton::load_water_province_file);
 	ClassDB::bind_method(D_METHOD("load_region_file", "file_path"), &GameSingleton::load_region_file);
-	ClassDB::bind_method(D_METHOD("load_province_shape_file", "file_path"), &GameSingleton::load_province_shape_file);
+	ClassDB::bind_method(D_METHOD("load_terrain_file", "file_path"), &GameSingleton::load_terrain_file);
+	ClassDB::bind_method(D_METHOD("load_map_images", "province_image_path", "terrain_image_path"), &GameSingleton::load_map_images);
 	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);
@@ -26,6 +26,7 @@ void GameSingleton::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("get_width"), &GameSingleton::get_width);
 	ClassDB::bind_method(D_METHOD("get_height"), &GameSingleton::get_height);
 	ClassDB::bind_method(D_METHOD("get_aspect_ratio"), &GameSingleton::get_aspect_ratio);
+	ClassDB::bind_method(D_METHOD("get_terrain_texture"), &GameSingleton::get_terrain_texture);
 	ClassDB::bind_method(D_METHOD("get_province_shape_image_subdivisions"), &GameSingleton::get_province_shape_image_subdivisions);
 	ClassDB::bind_method(D_METHOD("get_province_shape_texture"), &GameSingleton::get_province_shape_texture);
 	ClassDB::bind_method(D_METHOD("get_province_colour_texture"), &GameSingleton::get_province_colour_texture);
@@ -57,27 +58,31 @@ GameSingleton* GameSingleton::get_singleton() {
 /* REQUIREMENTS:
  * MAP-21, MAP-25
  */
-GameSingleton::GameSingleton() : game_manager{ [this]() { emit_signal("state_updated"); } } {
+GameSingleton::GameSingleton() : game_manager{ [this]() { emit_signal("state_updated"); } }, terrain_variants{ "terrain variants" } {
 	ERR_FAIL_COND(singleton != nullptr);
 	singleton = this;
 
 	Logger::set_info_func([](std::string&& str) { UtilityFunctions::print(str.c_str()); });
 	Logger::set_error_func([](std::string&& str) { UtilityFunctions::push_error(str.c_str()); });
 
+	static constexpr colour_t HIGH_ALPHA_VALUE = to_alpha_value(0.5f);
+	static constexpr colour_t LOW_ALPHA_VALUE = to_alpha_value(0.2f);
 	using mapmode_t = std::pair<std::string, Mapmode::colour_func_t>;
 	const std::vector<mapmode_t> mapmodes = {
-		{ "mapmode_province", [](Map const&, Province const& province) -> colour_t { return province.get_colour(); } },
+		{ "mapmode_terrain", [](Map const&, Province const& province) -> colour_t {
+			return LOW_ALPHA_VALUE | (province.is_water() ? 0x4287F5 : 0x0D7017);
+		} },
+		{ "mapmode_province", [](Map const&, Province const& province) -> colour_t {
+			return HIGH_ALPHA_VALUE | province.get_colour();
+		} },
 		{ "mapmode_region", [](Map const&, Province const& province) -> colour_t {
 			Region const* region = province.get_region();
-			if (region != nullptr) return region->get_colour();
-			return province.get_colour();
-		} },
-		{ "mapmode_terrain", [](Map const&, Province const& province) -> colour_t {
-			return province.is_water() ? 0x4287F5 : 0x0D7017;
+			if (region != nullptr) return (0xCC << 24) | region->get_colour();
+			return NULL_COLOUR;
 		} },
 		{ "mapmode_index", [](Map const& map, Province const& province) -> colour_t {
 			const uint8_t f = static_cast<float>(province.get_index()) / static_cast<float>(map.get_province_count()) * 255.0f;
-			return (f << 16) | (f << 8) | f;
+			return HIGH_ALPHA_VALUE | (f << 16) | (f << 8) | f;
 		} }
 	};
 	for (mapmode_t const& mapmode : mapmodes)
@@ -99,7 +104,7 @@ GameSingleton::~GameSingleton() {
 	singleton = nullptr;
 }
 
-static Error load_json_file(String const& file_description, String const& file_path, Variant& result) {
+static Error _load_json_file(String const& file_description, String const& file_path, Variant& result) {
 	result.clear();
 	UtilityFunctions::print("Loading ", file_description, " file: ", file_path);
 	const Ref<FileAccess> file = FileAccess::open(file_path, FileAccess::ModeFlags::READ);
@@ -122,10 +127,10 @@ static Error load_json_file(String const& file_description, String const& file_p
 
 using parse_json_entry_func_t = std::function<godot::Error (godot::String const&, godot::Variant const&)>;
 
-static Error parse_json_dictionary_file(String const& file_description, String const& file_path,
+static Error _parse_json_dictionary_file(String const& file_description, String const& file_path,
 	String const& identifier_prefix, parse_json_entry_func_t parse_entry) {
 	Variant json_var;
-	Error err = load_json_file(file_description, file_path, json_var);
+	Error err = _load_json_file(file_description, file_path, json_var);
 	if (err != OK) return err;
 	const Variant::Type type = json_var.get_type();
 	if (type != Variant::DICTIONARY) {
@@ -150,40 +155,37 @@ static Error parse_json_dictionary_file(String const& file_description, String c
 	return err;
 }
 
-Error GameSingleton::_parse_province_identifier_entry(String const& identifier, Variant const& entry) {
-	const Variant::Type type = entry.get_type();
-	colour_t colour = NULL_COLOUR;
+static colour_t _parse_colour(Variant const& var) {
+	const Variant::Type type = var.get_type();
 	if (type == Variant::ARRAY) {
-		Array const& colour_array = entry;
+		Array const& colour_array = var;
 		if (colour_array.size() == 3) {
+			colour_t colour = NULL_COLOUR;
 			for (int jdx = 0; jdx < 3; ++jdx) {
 				Variant const& var = colour_array[jdx];
-				if (var.get_type() != Variant::FLOAT) {
-					colour = NULL_COLOUR;
-					break;
-				}
+				if (var.get_type() != Variant::FLOAT) return NULL_COLOUR;
 				const double colour_double = var;
-				if (std::trunc(colour_double) != colour_double) {
-					colour = NULL_COLOUR;
-					break;
-				}
+				if (std::trunc(colour_double) != colour_double) return NULL_COLOUR;
 				const int64_t colour_int = static_cast<int64_t>(colour_double);
-				if (colour_int < 0 || colour_int > 255) {
-					colour = NULL_COLOUR;
-					break;
-				}
+				if (colour_int < 0 || colour_int > 255) return NULL_COLOUR;
 				colour = (colour << 8) | colour_int;
 			}
+			return colour;
 		}
 	}
 	else if (type == Variant::STRING) {
-		String const& colour_string = entry;
+		String const& colour_string = var;
 		if (colour_string.is_valid_hex_number()) {
 			const int64_t colour_int = colour_string.hex_to_int();
-			if (0 <= colour_int && colour_int <= 0xFFFFFF)
-				colour = colour_int;
+			if (colour_int != NULL_COLOUR && colour_int <= MAX_COLOUR_RGB)
+				return colour_int;
 		}
 	}
+	return NULL_COLOUR;
+}
+
+Error GameSingleton::_parse_province_identifier_entry(String const& identifier, Variant const& entry) {
+	const colour_t colour = _parse_colour(entry);
 	if (colour == NULL_COLOUR) {
 		UtilityFunctions::push_error("Invalid colour for province identifier \"", identifier, "\": ", entry);
 		return FAILED;
@@ -192,7 +194,7 @@ Error GameSingleton::_parse_province_identifier_entry(String const& identifier,
 }
 
 Error GameSingleton::load_province_identifier_file(String const& file_path) {
-	const Error err = parse_json_dictionary_file("province identifier", file_path, "prov_",
+	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);
 		});
@@ -227,7 +229,7 @@ Error GameSingleton::_parse_region_entry(String const& identifier, Variant const
 }
 
 Error GameSingleton::load_region_file(String const& file_path) {
-	const Error err = parse_json_dictionary_file("region", file_path, "region_",
+	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);
 		});
@@ -235,38 +237,107 @@ Error GameSingleton::load_region_file(String const& file_path) {
 	return err;
 }
 
-Error GameSingleton::load_province_shape_file(String const& file_path) {
+TerrainVariant::TerrainVariant(std::string const& new_identfier, colour_t new_colour, Ref<Image> const& new_image)
+	: HasIdentifier(new_identfier), HasColour(new_colour), image(new_image) {}
+
+Ref<Image> TerrainVariant::get_image() const { return image; }
+
+Error GameSingleton::_parse_terrain_entry(String const& identifier, Variant const& entry) {
+	const colour_t colour = _parse_colour(entry);
+	if (colour == NULL_COLOUR) {
+		UtilityFunctions::push_error("Invalid colour for terrain texture \"", identifier, "\": ", entry);
+		return FAILED;
+	}
+	static const String terrain_folder = "res://art/terrain/";
+	const String terrain_path = terrain_folder + identifier;
+	Ref<Image> terrain_image;
+	terrain_image.instantiate();
+	const Error err = terrain_image->load(terrain_path);
+	if (err != OK) {
+		UtilityFunctions::push_error("Failed to load terrain image: ", terrain_path);
+		return err;
+	}
+	return ERR(terrain_variants.add_item({ identifier.utf8().get_data(), colour, terrain_image }));
+}
+
+Error GameSingleton::load_terrain_file(String const& file_path) {
+	Error parse_err = _parse_json_dictionary_file("terrain variants", file_path, "",
+		[this](String const& identifier, Variant const& entry) -> Error {
+			return _parse_terrain_entry(identifier, entry);
+		});
+	terrain_variants.lock();
+	if (terrain_variants.get_item_count() == 0) parse_err = FAILED;
+
+	Array terrain_images;
+	for (TerrainVariant const& var : terrain_variants.get_items()) {
+		terrain_variant_map[var.get_colour()] = terrain_images.size();
+		terrain_images.append(var.get_image());
+	}
+
+	terrain_texture.instantiate();
+	const Error texturearray_err = terrain_texture->create_from_images(terrain_images);
+	if (texturearray_err != OK) {
+		UtilityFunctions::push_error("Failed to create terrain texture array!");
+		return texturearray_err;
+	}
+	return parse_err;
+}
+
+Error GameSingleton::load_map_images(String const& province_image_path, String const& terrain_image_path) {
 	if (province_shape_texture.is_valid()) {
-		UtilityFunctions::push_error("Province shape file has already been loaded, cannot load: ", file_path);
+		UtilityFunctions::push_error("Map images have already been loaded, cannot load: ", province_image_path, " and ", terrain_image_path);
 		return FAILED;
 	}
-	Ref<Image> province_shape_image;
-	province_shape_image.instantiate();
-	Error err = province_shape_image->load(file_path);
+
+	// Load images
+	Ref<Image> province_image, terrain_image;
+	province_image.instantiate();
+	terrain_image.instantiate();
+	Error err = province_image->load(province_image_path);
+	if (err != OK) {
+		UtilityFunctions::push_error("Failed to load province image: ", province_image_path);
+		return err;
+	}
+	err = terrain_image->load(terrain_image_path);
 	if (err != OK) {
-		UtilityFunctions::push_error("Failed to load province shape file: ", file_path);
+		UtilityFunctions::push_error("Failed to load terrain image: ", terrain_image_path);
 		return err;
 	}
-	const Vector2i image_dims = province_shape_image->get_size();
-	if (image_dims.x < 1 || image_dims.y < 1) {
-		UtilityFunctions::push_error("Invalid dimensions (", image_dims.x, "x", image_dims.y, ") for province shape file: ", file_path);
+
+	// 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) {
+		UtilityFunctions::push_error("Invalid dimensions (", province_dims.x, "x", province_dims.y, ") for province image: ", province_image_path);
+		err = FAILED;
+	}
+	if (province_dims != terrain_dims) {
+		UtilityFunctions::push_error("Invalid dimensions (", terrain_dims.x, "x", terrain_dims.y, ") for terrain image: ",
+			terrain_image_path, " (must match province image: (", province_dims.x, "x", province_dims.x, "))");
 		err = FAILED;
 	}
-	static constexpr int32_t GPU_DIM_LIMIT = 0x3FFF;
-	// For each dimension of the image, this finds the small number of equal subdivisions required get the individual texture dims under GPU_DIM_LIMIT
-	for (int i = 0; i < 2; ++i) for (image_subdivisions[i] = 1;
-		image_dims[i] / image_subdivisions[i] > GPU_DIM_LIMIT || image_dims[i] % image_subdivisions[i] != 0; ++image_subdivisions[i]);
 	static constexpr Image::Format expected_format = Image::FORMAT_RGB8;
-	const Image::Format format = province_shape_image->get_format();
-	if (format != expected_format) {
-		UtilityFunctions::push_error("Invalid format (", format, ", should be ", expected_format, ") for province shape file: ", file_path);
+	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);
+		err = FAILED;
+	}
+	if (terrain_format != expected_format) {
+		UtilityFunctions::push_error("Invalid format (", terrain_format, ", should be ", expected_format, ") for terrain image: ", terrain_image_path);
 		err = FAILED;
 	}
 	if (err != OK) return err;
-	err = ERR(game_manager.map.generate_province_shape_image(image_dims.x, image_dims.y, province_shape_image->get_data().ptr()));
 
-	std::vector<Map::shape_pixel_t> const& province_shape_data = game_manager.map.get_province_shape_image();
-	const Vector2i divided_dims = image_dims / image_subdivisions;
+	// Generate interleaved province and terrain ID image
+	if (game_manager.map.generate_province_shape_image(province_dims.x, province_dims.y, province_image->get_data().ptr(),
+		terrain_image->get_data().ptr(), terrain_variant_map) != SUCCESS) return FAILED;
+
+	static constexpr int32_t GPU_DIM_LIMIT = 0x3FFF;
+	// For each dimension of the image, this finds the small number of equal subdivisions required get the individual texture dims under GPU_DIM_LIMIT
+	for (int i = 0; i < 2; ++i) for (image_subdivisions[i] = 1;
+		province_dims[i] / image_subdivisions[i] > GPU_DIM_LIMIT || province_dims[i] % image_subdivisions[i] != 0; ++image_subdivisions[i]);
+
+	Map::shape_pixel_t const* province_shape_data = game_manager.map.get_province_shape_image().data();
+	const Vector2i divided_dims = province_dims / image_subdivisions;
 	Array province_shape_images;
 	province_shape_images.resize(image_subdivisions.x * image_subdivisions.y);
 	for (int32_t v = 0; v < image_subdivisions.y; ++v) {
@@ -276,15 +347,15 @@ Error GameSingleton::load_province_shape_file(String const& file_path) {
 
 			for (int32_t y = 0; y < divided_dims.y; ++y)
 				memcpy(index_data_array.ptrw() + y * divided_dims.x * sizeof(Map::shape_pixel_t),
-					province_shape_data.data() + (v * divided_dims.y + y) * image_dims.x + u * divided_dims.x,
+					province_shape_data + (v * divided_dims.y + y) * province_dims.x + u * divided_dims.x,
 					divided_dims.x * sizeof(Map::shape_pixel_t));
 
-			const Ref<Image> province_index_subimage = Image::create_from_data(divided_dims.x, divided_dims.y, false, Image::FORMAT_RGB8, index_data_array);
-			if (province_index_subimage.is_null()) {
-				UtilityFunctions::push_error("Failed to create province index image (", u, ", ", v, ")");
+			const Ref<Image> province_shape_subimage = Image::create_from_data(divided_dims.x, divided_dims.y, false, Image::FORMAT_RGB8, index_data_array);
+			if (province_shape_subimage.is_null()) {
+				UtilityFunctions::push_error("Failed to create province shape image (", u, ", ", v, ")");
 				err = FAILED;
 			}
-			province_shape_images[u + v * image_subdivisions.x] = province_index_subimage;
+			province_shape_images[u + v * image_subdivisions.x] = province_shape_subimage;
 		}
 	}
 
@@ -305,7 +376,7 @@ godot::Error GameSingleton::setup() {
 
 Error GameSingleton::load_water_province_file(String const& file_path) {
 	Variant json_var;
-	Error err = load_json_file("water province", file_path, json_var);
+	Error err = _load_json_file("water province", file_path, json_var);
 	if (err != OK) return err;
 	Variant::Type type = json_var.get_type();
 	if (type != Variant::ARRAY) {
@@ -358,7 +429,7 @@ Dictionary GameSingleton::get_province_info_from_index(int32_t index) const {
 		buildings_array.resize(buildings.size());
 		for (size_t idx = 0; idx < buildings.size(); ++idx) {
 			KEY(building) KEY(level) KEY(expansion_state) KEY(start_date) KEY(end_date) KEY(expansion_progress)
-			
+
 			Dictionary building_dict;
 			Building const& building = buildings[idx];
 			building_dict[building_key] = building.get_identifier().c_str();
@@ -388,6 +459,10 @@ float GameSingleton::get_aspect_ratio() const {
 	return static_cast<float>(get_width()) / static_cast<float>(get_height());
 }
 
+Ref<Texture> GameSingleton::get_terrain_texture() const {
+	return terrain_texture;
+}
+
 Vector2i GameSingleton::get_province_shape_image_subdivisions() const {
 	return image_subdivisions;
 }
@@ -413,7 +488,7 @@ Error GameSingleton::update_colour_image() {
 	if (province_colour_image.is_null())
 		province_colour_image.instantiate();
 	province_colour_image->set_data(PROVINCE_INDEX_SQRT, PROVINCE_INDEX_SQRT,
-		false, Image::FORMAT_RGB8, colour_data_array);
+		false, Image::FORMAT_RGBA8, colour_data_array);
 	if (province_colour_image.is_null()) {
 		UtilityFunctions::push_error("Failed to update province colour image");
 		return FAILED;
diff --git a/extension/src/GameSingleton.hpp b/extension/src/GameSingleton.hpp
index d17b950..80b2d95 100644
--- a/extension/src/GameSingleton.hpp
+++ b/extension/src/GameSingleton.hpp
@@ -1,13 +1,21 @@
 #pragma once
 
-#include <functional>
-
 #include <godot_cpp/classes/image_texture.hpp>
 #include <godot_cpp/classes/texture2d_array.hpp>
 
 #include "openvic2/GameManager.hpp"
 
 namespace OpenVic2 {
+	struct TerrainVariant : HasIdentifier, HasColour {
+	private:
+		const godot::Ref<godot::Image> image;
+	public:
+		TerrainVariant(std::string const& new_identfier, colour_t new_colour,
+			godot::Ref<godot::Image> const& new_image);
+		TerrainVariant(TerrainVariant&&) = default;
+
+		godot::Ref<godot::Image> get_image() const;
+	};
 	class GameSingleton : public godot::Object {
 		GDCLASS(GameSingleton, godot::Object)
 
@@ -20,9 +28,13 @@ namespace OpenVic2 {
 		godot::Ref<godot::Image> province_colour_image;
 		godot::Ref<godot::ImageTexture> province_colour_texture;
 		Mapmode::index_t mapmode_index = 0;
+		IdentifierRegistry<TerrainVariant> terrain_variants;
+		Map::terrain_variant_map_t terrain_variant_map;
+		godot::Ref<godot::Texture2DArray> terrain_texture;
 
 		godot::Error _parse_province_identifier_entry(godot::String const& identifier, godot::Variant const& entry);
 		godot::Error _parse_region_entry(godot::String const& identifier, godot::Variant const& entry);
+		godot::Error _parse_terrain_entry(godot::String const& identifier, godot::Variant const& entry);
 		void _tick();
 	protected:
 		static void _bind_methods();
@@ -36,7 +48,12 @@ namespace OpenVic2 {
 		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_province_shape_file(godot::String const& file_path);
+		godot::Error load_terrain_file(godot::String const& file_path);
+		godot::Error load_map_images(godot::String const& province_image_path, godot::String const& terrain_image_path);
+
+		/* Post-load/restart game setup - reset the game to post-load state
+		 * and (re)generate starting data, e.g. buildings.
+		 */
 		godot::Error setup();
 
 		int32_t get_province_index_from_uv_coords(godot::Vector2 const& coords) const;
@@ -44,11 +61,32 @@ namespace OpenVic2 {
 		int32_t get_width() const;
 		int32_t get_height() const;
 		float get_aspect_ratio() const;
+
+		/* The cosmetic terrain textures stored in a Texture2DArray.
+		 */
+		godot::Ref<godot::Texture> get_terrain_texture() const;
+
+		/* Number of (vertical, horizontal) subdivisions the province shape image
+		 * was split into when making the province_shape_texture to ensure no
+		 * piece had a dimension greater than 16383.
+		 */
 		godot::Vector2i get_province_shape_image_subdivisions() const;
+
+		/* The map, encoded in RGB8 with RG representing province index and B representing terrain texture.
+		 * To support a wider range of GPUs, the image is divided so that no piece has a dimension
+		 * greater than 16383 and the pieces are stored in a Texture2DArray.
+		 */
 		godot::Ref<godot::Texture> get_province_shape_texture() const;
+
+		/* The colour each province should be tinted, arranged in
+		 * index order into a 256x256 RGB8 texture.
+		 */
 		godot::Ref<godot::Texture> get_province_colour_texture() const;
 
+		/* Generate the province_colour_texture from the current mapmode.
+		 */
 		godot::Error update_colour_image();
+
 		int32_t get_mapmode_count() const;
 		godot::String get_mapmode_identifier(int32_t index) const;
 		godot::Error set_mapmode(godot::String const& identifier);
diff --git a/extension/src/openvic2/Date.cpp b/extension/src/openvic2/Date.cpp
index bb891fd..ed800d5 100644
--- a/extension/src/openvic2/Date.cpp
+++ b/extension/src/openvic2/Date.cpp
@@ -1,9 +1,9 @@
-#include "openvic2/Date.hpp"
+#include "Date.hpp"
 
 #include <cctype>
 #include <algorithm>
 
-#include "openvic2/Logger.hpp"
+#include "Logger.hpp"
 
 using namespace OpenVic2;
 
diff --git a/extension/src/openvic2/GameAdvancementHook.cpp b/extension/src/openvic2/GameAdvancementHook.cpp
index 4b9bc25..d90b7b1 100644
--- a/extension/src/openvic2/GameAdvancementHook.cpp
+++ b/extension/src/openvic2/GameAdvancementHook.cpp
@@ -1,4 +1,4 @@
-#include "openvic2/GameAdvancementHook.hpp"
+#include "GameAdvancementHook.hpp"
 
 using namespace OpenVic2;
 
diff --git a/extension/src/openvic2/GameManager.cpp b/extension/src/openvic2/GameManager.cpp
index ca6e8ab..58e40bb 100644
--- a/extension/src/openvic2/GameManager.cpp
+++ b/extension/src/openvic2/GameManager.cpp
@@ -1,6 +1,6 @@
-#include "openvic2/GameManager.hpp"
+#include "GameManager.hpp"
 
-#include "openvic2/Logger.hpp"
+#include "Logger.hpp"
 
 using namespace OpenVic2;
 
diff --git a/extension/src/openvic2/GameManager.hpp b/extension/src/openvic2/GameManager.hpp
index 7b15dc8..70e98bd 100644
--- a/extension/src/openvic2/GameManager.hpp
+++ b/extension/src/openvic2/GameManager.hpp
@@ -1,8 +1,7 @@
 #pragma once
 
-#include "openvic2/GameAdvancementHook.hpp"
-#include "openvic2/map/Map.hpp"
-#include "openvic2/Types.hpp"
+#include "GameAdvancementHook.hpp"
+#include "map/Map.hpp"
 
 namespace OpenVic2 {
 	struct GameManager {
diff --git a/extension/src/openvic2/Good.hpp b/extension/src/openvic2/Good.hpp
index 54078dd..378bbc4 100644
--- a/extension/src/openvic2/Good.hpp
+++ b/extension/src/openvic2/Good.hpp
@@ -1,6 +1,5 @@
 #pragma once
 
-#include <string>
 #include "Types.hpp"
 
 namespace OpenVic2 {
diff --git a/extension/src/openvic2/Logger.cpp b/extension/src/openvic2/Logger.cpp
index 56d74ab..4d7378e 100644
--- a/extension/src/openvic2/Logger.cpp
+++ b/extension/src/openvic2/Logger.cpp
@@ -1,4 +1,4 @@
-#include "openvic2/Logger.hpp"
+#include "Logger.hpp"
 
 #include <iostream>
 
diff --git a/extension/src/openvic2/Types.cpp b/extension/src/openvic2/Types.cpp
index 42aa5a4..f51ad7c 100644
--- a/extension/src/openvic2/Types.cpp
+++ b/extension/src/openvic2/Types.cpp
@@ -1,9 +1,8 @@
-#include "openvic2/Types.hpp"
+#include "Types.hpp"
 
 #include <cassert>
 #include <sstream>
 #include <iomanip>
-#include "Types.hpp"
 
 using namespace OpenVic2;
 
@@ -16,7 +15,7 @@ std::string const& HasIdentifier::get_identifier() const {
 }
 
 HasColour::HasColour(colour_t const new_colour) : colour(new_colour) {
-	assert(colour <= MAX_COLOUR && colour != NULL_COLOUR);
+	assert(colour != NULL_COLOUR && colour <= MAX_COLOUR_RGB);
 }
 
 colour_t HasColour::get_colour() const { return colour; }
@@ -29,4 +28,4 @@ std::string OpenVic2::HasColour::colour_to_hex_string(colour_t const colour) {
 
 std::string HasColour::colour_to_hex_string() const {
 	return colour_to_hex_string(colour);
-}
\ No newline at end of file
+}
diff --git a/extension/src/openvic2/Types.hpp b/extension/src/openvic2/Types.hpp
index f1ba639..1359fbe 100644
--- a/extension/src/openvic2/Types.hpp
+++ b/extension/src/openvic2/Types.hpp
@@ -3,18 +3,27 @@
 #include <string>
 #include <vector>
 #include <cstdint>
+#include <algorithm>
 
-#include "openvic2/Logger.hpp"
+#include "Logger.hpp"
 
 namespace OpenVic2 {
-	//Represents a 24-bit RGB integer
+	// Represents a 24-bit RGB integer OR a 32-bit ARGB integer
 	using colour_t = uint32_t;
-	using index_t = uint16_t;
+	/* When colour_t is used as an identifier, NULL_COLOUR is disallowed
+	 * and should be reserved as an error value.
+	 * When colour_t is used in a purely graphical context, NULL_COLOUR
+	 * should be allowed.
+	 */
+	static constexpr colour_t NULL_COLOUR = 0, MAX_COLOUR_RGB = 0xFFFFFF;
+	constexpr colour_t to_alpha_value(float a) {
+		return static_cast<colour_t>(std::clamp(a, 0.0f, 1.0f) * 255.0f) << 24;
+	}
 
-	static constexpr colour_t NULL_COLOUR = 0, MAX_COLOUR = 0xFFFFFF;
+	using index_t = uint16_t;
 	static constexpr index_t NULL_INDEX = 0, MAX_INDEX = 0xFFFF;
 
-	//TODO: price_t must be changed to a fixed-point numeric type before multiplayer
+	// TODO: price_t must be changed to a fixed-point numeric type before multiplayer
 	using price_t = double;
 	using return_t = bool;
 
diff --git a/extension/src/openvic2/map/Building.cpp b/extension/src/openvic2/map/Building.cpp
index 00e121b..1e26873 100644
--- a/extension/src/openvic2/map/Building.cpp
+++ b/extension/src/openvic2/map/Building.cpp
@@ -1,9 +1,9 @@
-#include "openvic2/map/Building.hpp"
+#include "Building.hpp"
 
 #include <cassert>
 
-#include "openvic2/Logger.hpp"
-#include "openvic2/map/Province.hpp"
+#include "../Logger.hpp"
+#include "Province.hpp"
 
 using namespace OpenVic2;
 
diff --git a/extension/src/openvic2/map/Building.hpp b/extension/src/openvic2/map/Building.hpp
index 1305014..78d08ae 100644
--- a/extension/src/openvic2/map/Building.hpp
+++ b/extension/src/openvic2/map/Building.hpp
@@ -2,8 +2,8 @@
 
 #include <vector>
 
-#include "openvic2/Types.hpp"
-#include "openvic2/Date.hpp"
+#include "../Types.hpp"
+#include "../Date.hpp"
 
 namespace OpenVic2 {
 	struct Province;
diff --git a/extension/src/openvic2/map/Map.cpp b/extension/src/openvic2/map/Map.cpp
index 4e7c0bb..ab035ad 100644
--- a/extension/src/openvic2/map/Map.cpp
+++ b/extension/src/openvic2/map/Map.cpp
@@ -1,9 +1,9 @@
-#include "openvic2/map/Map.hpp"
+#include "Map.hpp"
 
 #include <cassert>
 #include <unordered_set>
 
-#include "openvic2/Logger.hpp"
+#include "../Logger.hpp"
 
 using namespace OpenVic2;
 
@@ -31,7 +31,7 @@ return_t Map::add_province(std::string const& identifier, colour_t colour) {
 		Logger::error("Invalid province identifier - empty!");
 		return FAILURE;
 	}
-	if (colour == NULL_COLOUR || colour > MAX_COLOUR) {
+	if (colour == NULL_COLOUR || colour > MAX_COLOUR_RGB) {
 		Logger::error("Invalid province colour: ", Province::colour_to_hex_string(colour));
 		return FAILURE;
 	}
@@ -175,7 +175,8 @@ static colour_t colour_at(uint8_t const* colour_data, int32_t idx) {
 	return (colour_data[idx * 3] << 16) | (colour_data[idx * 3 + 1] << 8) | colour_data[idx * 3 + 2];
 }
 
-return_t Map::generate_province_shape_image(size_t new_width, size_t new_height, uint8_t const* colour_data) {
+return_t Map::generate_province_shape_image(size_t new_width, size_t new_height, uint8_t const* colour_data,
+	uint8_t const* terrain_data, terrain_variant_map_t const& terrain_variant_map) {
 	if (!province_shape_image.empty()) {
 		Logger::error("Province index image has already been generated!");
 		return FAILURE;
@@ -192,47 +193,62 @@ return_t Map::generate_province_shape_image(size_t new_width, size_t new_height,
 		Logger::error("Province colour data pointer is null!");
 		return FAILURE;
 	}
+	if (terrain_data == nullptr) {
+		Logger::error("Province terrain data pointer is null!");
+		return FAILURE;
+	}
 	width = new_width;
 	height = new_height;
 	province_shape_image.resize(width * height);
 
 	std::vector<bool> province_checklist(provinces.get_item_count());
 	return_t ret = SUCCESS;
-	std::unordered_set<colour_t> unrecognised_colours;
+	std::unordered_set<colour_t> unrecognised_province_colours, unrecognised_terrain_colours;
 
 	for (int32_t y = 0; y < height; ++y) {
 		for (int32_t x = 0; x < width; ++x) {
 			const int32_t idx = x + y * width;
-			const colour_t colour = colour_at(colour_data, idx);
+
+			const colour_t terrain_colour = colour_at(terrain_data, idx);
+			const terrain_variant_map_t::const_iterator it = terrain_variant_map.find(terrain_colour);
+			if (it != terrain_variant_map.end()) province_shape_image[idx].terrain = it->second;
+			else {
+				if (unrecognised_terrain_colours.find(terrain_colour) == unrecognised_terrain_colours.end()) {
+					unrecognised_terrain_colours.insert(terrain_colour);
+					Logger::error("Unrecognised terrain colour ", Province::colour_to_hex_string(terrain_colour), " at (", x, ", ", y, ")");
+					ret = FAILURE;
+				}
+				province_shape_image[idx].terrain = 0;
+			}
+
+			const colour_t province_colour = colour_at(colour_data, idx);
 			if (x > 0) {
 				const int32_t jdx = idx - 1;
-				if (colour_at(colour_data, jdx) == colour) {
-					province_shape_image[idx] = province_shape_image[jdx];
+				if (colour_at(colour_data, jdx) == province_colour) {
+					province_shape_image[idx].index = province_shape_image[jdx].index;
 					continue;
 				}
 			}
 			if (y > 0) {
 				const int32_t jdx = idx - width;
-				if (colour_at(colour_data, jdx) == colour) {
-					province_shape_image[idx] = province_shape_image[jdx];
+				if (colour_at(colour_data, jdx) == province_colour) {
+					province_shape_image[idx].index = province_shape_image[jdx].index;
 					continue;
 				}
 			}
-			Province const* province = get_province_by_colour(colour);
+			Province const* province = get_province_by_colour(province_colour);
 			if (province != nullptr) {
 				const index_t index = province->get_index();
 				province_checklist[index - 1] = true;
 				province_shape_image[idx].index = index;
-				province_shape_image[idx].terrain = !province->is_water();
 				continue;
 			}
-			if (unrecognised_colours.find(colour) == unrecognised_colours.end()) {
-				unrecognised_colours.insert(colour);
-				Logger::error("Unrecognised province colour ", Province::colour_to_hex_string(colour), " at (", x, ", ", y, ")");
+			if (unrecognised_province_colours.find(province_colour) == unrecognised_province_colours.end()) {
+				unrecognised_province_colours.insert(province_colour);
+				Logger::error("Unrecognised province colour ", Province::colour_to_hex_string(province_colour), " at (", x, ", ", y, ")");
 				ret = FAILURE;
 			}
 			province_shape_image[idx].index = NULL_INDEX;
-			province_shape_image[idx].terrain = 0;
 		}
 	}
 
@@ -303,6 +319,7 @@ return_t Map::generate_mapmode_colours(Mapmode::index_t index, uint8_t* target)
 		*target++ = (colour >> 16) & 0xFF;
 		*target++ = (colour >> 8) & 0xFF;
 		*target++ = colour & 0xFF;
+		*target++ = (colour >> 24) & 0xFF;
 	}
 	return SUCCESS;
 }
diff --git a/extension/src/openvic2/map/Map.hpp b/extension/src/openvic2/map/Map.hpp
index e5be9c7..a075505 100644
--- a/extension/src/openvic2/map/Map.hpp
+++ b/extension/src/openvic2/map/Map.hpp
@@ -1,9 +1,9 @@
 #pragma once
 
 #include <functional>
+#include <unordered_map>
 
-#include "openvic2/map/Region.hpp"
-#include "openvic2/Types.hpp"
+#include "Region.hpp"
 
 namespace OpenVic2 {
 
@@ -26,10 +26,12 @@ namespace OpenVic2 {
 	 * MAP-4
 	 */
 	struct Map {
+		using terrain_t = uint8_t;
+		using terrain_variant_map_t = std::unordered_map<colour_t, terrain_t>;
 		#pragma pack(push, 1)
 		struct shape_pixel_t {
 			index_t index;
-			uint8_t terrain;
+			terrain_t terrain;
 		};
 		#pragma pack(pop)
 	private:
@@ -63,7 +65,8 @@ namespace OpenVic2 {
 		Region* get_region_by_identifier(std::string const& identifier);
 		Region const* get_region_by_identifier(std::string const& identifier) const;
 
-		return_t generate_province_shape_image(size_t new_width, size_t new_height, uint8_t const* colour_data);
+		return_t generate_province_shape_image(size_t new_width, size_t new_height, uint8_t const* colour_data,
+			uint8_t const* terrain_data, terrain_variant_map_t const& terrain_variant_map);
 		size_t get_width() const;
 		size_t get_height() const;
 		std::vector<shape_pixel_t> const& get_province_shape_image() const;
@@ -73,7 +76,7 @@ namespace OpenVic2 {
 		size_t get_mapmode_count() const;
 		Mapmode const* get_mapmode_by_index(Mapmode::index_t index) const;
 		Mapmode const* get_mapmode_by_identifier(std::string const& identifier) const;
-		static constexpr size_t MAPMODE_COLOUR_SIZE = 3;
+		static constexpr size_t MAPMODE_COLOUR_SIZE = 4;
 		return_t generate_mapmode_colours(Mapmode::index_t index, uint8_t* target) const;
 
 		return_t generate_province_buildings(BuildingManager const& manager);
diff --git a/extension/src/openvic2/map/Province.cpp b/extension/src/openvic2/map/Province.cpp
index 472cccb..b3d455b 100644
--- a/extension/src/openvic2/map/Province.cpp
+++ b/extension/src/openvic2/map/Province.cpp
@@ -1,4 +1,4 @@
-#include "openvic2/map/Province.hpp"
+#include "Province.hpp"
 
 #include <cassert>
 #include <sstream>
diff --git a/extension/src/openvic2/map/Province.hpp b/extension/src/openvic2/map/Province.hpp
index 65eaa09..9b07fc1 100644
--- a/extension/src/openvic2/map/Province.hpp
+++ b/extension/src/openvic2/map/Province.hpp
@@ -1,7 +1,6 @@
 #pragma once
 
-#include "openvic2/map/Building.hpp"
-#include "openvic2/Types.hpp"
+#include "Building.hpp"
 
 namespace OpenVic2 {
 	struct Map;
diff --git a/extension/src/openvic2/map/Region.cpp b/extension/src/openvic2/map/Region.cpp
index 6839a10..da0dfdd 100644
--- a/extension/src/openvic2/map/Region.cpp
+++ b/extension/src/openvic2/map/Region.cpp
@@ -1,7 +1,6 @@
-#include "openvic2/map/Region.hpp"
+#include "Region.hpp"
 
 #include <cassert>
-#include <algorithm>
 
 using namespace OpenVic2;
 
diff --git a/extension/src/openvic2/map/Region.hpp b/extension/src/openvic2/map/Region.hpp
index 58fad31..3920dfc 100644
--- a/extension/src/openvic2/map/Region.hpp
+++ b/extension/src/openvic2/map/Region.hpp
@@ -2,8 +2,7 @@
 
 #include <set>
 
-#include "openvic2/map/Province.hpp"
-#include "openvic2/Types.hpp"
+#include "Province.hpp"
 
 namespace OpenVic2 {