Translation Extensions & Issues Pt 1

CMakeLists.txt

@@ -306,6 +306,8 @@ add_library(${PROJECT_NAME} OBJECT
 	src/scene_import.h
 	src/scene_item.cpp
 	src/scene_item.h
+	src/scene_language.cpp
+	src/scene_language.h
 	src/scene_load.cpp
 	src/scene_load.h
 	src/scene_logo.cpp

Makefile.am

@@ -287,6 +287,8 @@ libeasyrpg_player_a_SOURCES = \
 	src/scene_gameover.h \
 	src/scene_item.cpp \
 	src/scene_item.h \
+	src/scene_language.cpp \
+	src/scene_language.h \
 	src/scene_load.cpp \
 	src/scene_load.h \
 	src/scene_logo.cpp \

src/game_config.cpp

@@ -525,6 +525,8 @@ void Game_Config::LoadFromStream(Filesystem_Stream::InputStream& is) {
 	player.font1_size.FromIni(ini);
 	player.font2.FromIni(ini);
 	player.font2_size.FromIni(ini);
+	player.lang_select_on_start.FromIni(ini);
+	player.lang_select_in_title.FromIni(ini);
 }
 
 void Game_Config::WriteToStream(Filesystem_Stream::OutputStream& os) const {
@@ -610,6 +612,8 @@ void Game_Config::WriteToStream(Filesystem_Stream::OutputStream& os) const {
 	player.font1_size.ToIni(os);
 	player.font2.ToIni(os);
 	player.font2_size.ToIni(os);
+	player.lang_select_on_start.ToIni(os);
+	player.lang_select_in_title.ToIni(os);
 
 	os << "\n";
 }

src/game_config.h

@@ -58,6 +58,14 @@ namespace ConfigEnum {
 		All
 	};
 
+	enum class StartupLangSelect {
+		Never,
+		/* Shows language screen when no saves are found */
+		FirstStartup,
+		/* Always show the language screen before the title */
+		Always
+	};
+
 	enum class ShowFps {
 		/** Do not show */
 		OFF,
@@ -89,6 +97,12 @@ struct Game_ConfigPlayer {
 	RangeConfigParam<int> font1_size { "Font 1 Size", "", "Player", "Font1Size", 12, 6, 16};
 	PathConfigParam font2 { "Font 2", "The game chooses whether it wants font 1 or 2", "Player", "Font2", "" };
 	RangeConfigParam<int> font2_size { "Font 2 Size", "", "Player", "Font2Size", 12, 6, 16};
+	EnumConfigParam<ConfigEnum::StartupLangSelect, 3> lang_select_on_start{
+		"Startup Language Select", "Show the language select before starting the game", "Player", "StartupLangSelect", ConfigEnum::StartupLangSelect::FirstStartup ,
+		Utils::MakeSvArray("Never", "FirstStartup", "Always"),
+		Utils::MakeSvArray("never", "firststartup", "always"),
+		Utils::MakeSvArray("Never show language menu on start", "Show language menu on first start (when no save files are found)", "Always show the language menu prior to the title screen") };
+	BoolConfigParam lang_select_in_title{ "Show language menu on title screen", "Display language menu item on the title screen", "Player", "LanguageInTitle", true };
 
 	void Hide();
 };

src/game_interpreter_map.cpp

@@ -51,6 +51,8 @@
 #include "scene_shop.h"
 #include "scene_debug.h"
 #include "scene_gameover.h"
+#include "scene_settings.h"
+#include "scene_language.h"
 #include "scene.h"
 #include "graphics.h"
 #include "input.h"
@@ -161,17 +163,14 @@ bool Game_Interpreter_Map::RequestMainMenuScene(int subscreen_id, int actor_inde
 			Scene::instance->SetRequestedScene(std::make_shared<Scene_Order>());
 			return true;
 		}
-	/*
 	case 6: // Settings
 		Scene::instance->SetRequestedScene(std::make_shared<Scene_Settings>());
 		return true;
 	case 7: // Language
-		Scene::instance->SetRequestedScene(std::make_shared<Scene_Language>());
-		return true;
-	case 8: // Debug
-		Scene::instance->SetRequestedScene(std::make_shared<Scene_Debug>());
+		if (Player::translation.HasTranslations()) {
+			Scene::instance->SetRequestedScene(std::make_shared<Scene_Language>());
+		}
 		return true;
-		*/
 	}
 
 	Scene::instance->SetRequestedScene(std::make_shared<Scene_Menu>());

src/player.cpp

@@ -122,6 +122,7 @@ namespace Player {
 	std::string escape_symbol;
 	uint32_t escape_char;
 	std::string game_title;
+	std::string game_title_original;
 	std::shared_ptr<Meta> meta;
 	FileExtGuesser::RPG2KFileExtRemap fileext_map;
 	std::string startup_language;
@@ -737,16 +738,7 @@ void Player::CreateGameObjects() {
 		}
 	}
 
-	std::stringstream title;
-	if (!game_title.empty()) {
-		Output::Debug("Loading game {}", game_title);
-		title << game_title << " - ";
-		Input::AddRecordingData(Input::RecordingData::GameTitle, game_title);
-	} else {
-		Output::Debug("Could not read game title.");
-	}
-	title << GAME_TITLE;
-	DisplayUi->SetTitle(title.str());
+	UpdateTitle(game_title);
 
 	if (no_rtp_warning_flag) {
 		Output::Debug("Game does not need RTP (FullPackageFlag=1)");
@@ -852,6 +844,28 @@ void Player::CreateGameObjects() {
 	}
 }
 
+void Player::UpdateTitle(std::string new_game_title) {
+	if (!game_title.empty() && game_title != new_game_title) {
+		if (game_title_original == new_game_title) {
+			game_title_original = "";
+		} else {
+			game_title_original = game_title;
+		}
+		game_title = new_game_title;
+	}
+
+	std::stringstream title;
+	if (!game_title.empty()) {
+		Output::Debug("Loading game {}", game_title);
+		title << new_game_title << " - ";
+		Input::AddRecordingData(Input::RecordingData::GameTitle, game_title);
+	} else {
+		Output::Debug("Could not read game title.");
+	}
+	title << GAME_TITLE;
+	DisplayUi->SetTitle(title.str());
+}
+
 bool Player::ChangeResolution(int width, int height) {
 	if (!DisplayUi->ChangeDisplaySurfaceResolution(width, height)) {
 		Output::Warning("Resolution change to {}x{} failed", width, height);

src/player.h

@@ -302,6 +302,11 @@ namespace Player {
 	 */
 	bool HasEasyRpgExtensions();
 
+	/**
+	 * Update the game title displayed in the Player's UI
+	 */
+	void UpdateTitle(std::string new_game_title);
+
 	/**
 	 * @return Running engine version. 2000 for RPG2k and 2003 for RPG2k3
 	 */
@@ -395,6 +400,9 @@ namespace Player {
 	/** Game title. */
 	extern std::string game_title;
 
+	/** Original game title, in case it was overriden by a translation. */
+	extern std::string game_title_original;
+
 	/** Meta class containing additional external data for this game. */
 	extern std::shared_ptr<Meta> meta;
 

src/scene.cpp

@@ -24,12 +24,15 @@
 #include "player.h"
 #include "output.h"
 #include "audio.h"
+#include "filefinder.h"
 #include "transition.h"
 #include "game_actors.h"
 #include "game_interpreter.h"
 #include "game_system.h"
 #include "main_data.h"
+#include "scene_language.h"
 #include "scene_settings.h"
+#include "scene_title.h"
 #include "game_map.h"
 
 #ifndef NDEBUG
@@ -64,7 +67,9 @@ const char Scene::scene_names[SceneMax][12] =
 	"Logo",
 	"Order",
 	"GameBrowser",
-	"Teleport"
+	"Teleport",
+	"Settings",
+	"Language"
 };
 
 enum PushPopOperation {
@@ -95,6 +100,7 @@ lcf::rpg::SaveSystem::Scene Scene::rpgRtSceneFromSceneType(SceneType t) {
 		case Order:
 		case End:
 		case Settings:
+		case LanguageMenu:
 			return lcf::rpg::SaveSystem::Scene_menu;
 		case File:
 		case Save:
@@ -265,6 +271,12 @@ void Scene::Push(std::shared_ptr<Scene> const& new_scene, bool pop_stack_top) {
 	DEBUG_VALIDATE("Push");
 }
 
+std::shared_ptr<Scene> Scene::Peek() {
+	if (instances.size() == 1)
+		return nullptr;
+	return instances[instances.size() - 2];
+}
+
 void Scene::Pop() {
 	old_instances.push_back(instances.back());
 	instances.pop_back();
@@ -355,6 +367,25 @@ inline void Scene::DebugValidate(const char* caller) {
 	}
 }
 
+void Scene::PushTitleScene(bool pop_stack_top) {
+	auto title_scene = Scene::Find(Scene::Title);
+	if (title_scene) {
+		return;
+	}
+
+	if (!Player::startup_language.empty()) {
+		Player::translation.SelectLanguage(Player::startup_language);
+	} else if (Player::translation.HasTranslations()) {
+		if (Player::player_config.lang_select_on_start.Get() == ConfigEnum::StartupLangSelect::Always
+			|| (!FileFinder::HasSavegame() && Player::player_config.lang_select_on_start.Get() == ConfigEnum::StartupLangSelect::FirstStartup)) {
+			Scene::Push(std::make_shared<Scene_Language>(), pop_stack_top);
+			return;
+		}
+	}
+
+	Scene::Push(std::make_shared<Scene_Title>(), pop_stack_top);
+}
+
 bool Scene::ReturnToTitleScene() {
 	if (Scene::instance && Scene::instance->type == Scene::Title) {
 		return false;

src/scene.h

@@ -59,6 +59,7 @@ class Scene {
 		GameBrowser,
 		Teleport,
 		Settings,
+		LanguageMenu,
 		SceneMax
 	};
 
@@ -160,6 +161,14 @@ class Scene {
 	 */
 	static void Push(std::shared_ptr<Scene> const& new_scene, bool pop_stack_top = false);
 
+	/**
+	 * Finds the the scene previous to the current, top-most one and
+	 * returns it without popping it from the stack.
+	 *
+	 * @return the scene found, or NULL if the current scene is already the top.
+	 */
+	static std::shared_ptr<Scene> Peek();
+
 	/**
 	 * Removes the scene that is on the top of the stack.
 	 */
@@ -247,6 +256,12 @@ class Scene {
 	/** Decrement delay frames by 1 if we're waiting */
 	void UpdateDelayFrames();
 
+	/**
+	 * Pushes the title screen onto the stack to boot up the game.
+	 * If there already is a title scene ín the stack, this function exits without doing anything.
+	 */
+	static void PushTitleScene(bool pop_stack_top = false);
+
 	/**
 	 * Pops the stack until the title screen and sets proper delay.
 	 *

src/scene_gamebrowser.cpp

@@ -28,7 +28,6 @@
 #include "input.h"
 #include "player.h"
 #include "scene_logo.h"
-#include "scene_title.h"
 #include "bitmap.h"
 #include "audio.h"
 #include "output.h"
@@ -59,6 +58,7 @@ void Scene_GameBrowser::Continue(SceneType /* prev_scene */) {
 	Player::RestoreBaseResolution();
 
 	Player::game_title = "";
+	Player::game_title_original = "";
 
 	Font::ResetDefault();
 
@@ -242,8 +242,5 @@ void Scene_GameBrowser::BootGame() {
 		return;
 	}
 
-	if (!Player::startup_language.empty()) {
-		Player::translation.SelectLanguage(Player::startup_language);
-	}
-	Scene::Push(std::make_shared<Scene_Title>());
+	Scene::PushTitleScene();
 }