Parse Text/Speech Data from TSV

CMake/Assets.cmake

@@ -176,6 +176,7 @@ set(devilutionx_assets
   txtdata/quests/questdat.tsv
   txtdata/sound/effects.tsv
   txtdata/spells/spelldat.tsv
+  txtdata/text/textdat.tsv
   ui_art/diablo.pal
   ui_art/creditsw.clx
   ui_art/dvl_but_sml.clx

Source/CMakeLists.txt

@@ -728,6 +728,7 @@ else()
     DevilutionX::SDL
     SDL_audiolib::SDL_audiolib
     fmt::fmt
+    magic_enum::magic_enum
     tl
     unordered_dense::unordered_dense
     libdevilutionx_options

Source/diablo.cpp

@@ -143,9 +143,9 @@
 
 // Controller support: Actions to run after updating the cursor state.
 // Defined in SourceX/controls/plctrls.cpp.
 extern void plrctrls_after_check_curs_move();
 extern void plrctrls_every_frame();
 extern void plrctrls_after_game_logic();
 
 namespace {
 
@@ -230,7 +230,7 @@
 	return true;
 }
 
 void LeftMouseCmd(bool bShift)
 {
 	bool bNear;
 
@@ -316,7 +316,7 @@
 	return true;
 }
 
 void LeftMouseDown(uint16_t modState)
 {
 	LastPlayerAction = PlayerActionType::None;
 
@@ -479,7 +479,7 @@
 	QuestLogIsOpen = false;
 }
 
 void PressKey(SDL_Keycode vkey, uint16_t modState)
 {
 	Options &options = GetOptions();
 	remap_keyboard_key(&vkey);
@@ -712,7 +712,7 @@
 	}
 }
 
 void GameEventHandler(const SDL_Event &event, uint16_t modState)
 {
 	[[maybe_unused]] const Options &options = GetOptions();
 	StaticVector<ControllerButtonEvent, 4> ctrlEvents = ToControllerButtonEvents(event);
@@ -733,7 +733,7 @@
 			}
 		}
 	}
 	if (ctrlEvents.size() > 0 && ctrlEvents[0].button != ControllerButton_NONE) {
 		return;
 	}
 
@@ -787,12 +787,12 @@
 				ChatLogScrollUp();
 			} else if (IsStashOpen) {
 				Stash.PreviousPage();
 			} else if (SDL_GetModState() & KMOD_CTRL) {
 				if (AutomapActive) {
 					AutomapZoomIn();
 				}
 			} else {
 				KeymapperPress(MouseScrollUpButton);
 			}
 		} else if (event.wheel.y < 0) { // down
 			if (IsPlayerInStore()) {
@@ -2666,6 +2666,8 @@
 	// Finally load game data
 	LoadGameArchives();
 
+	LoadTextData();
+
 	// Load dynamic data before we go into the menu as we need to initialise player characters in memory pretty early.
 	LoadPlayerDataFiles();
 

Source/effects.cpp

@@ -9,6 +9,7 @@
 #include <string_view>
 
 #include <expected.hpp>
+#include <magic_enum/magic_enum.hpp>
 
 #include "data/file.hpp"
 #include "data/iterators.hpp"
@@ -21,6 +22,12 @@
 #include "player.h"
 #include "utils/is_of.hpp"
 
+template <>
+struct magic_enum::customize::enum_range<devilution::SfxID> {
+	static constexpr int min = static_cast<int>(devilution::SfxID::None);
+	static constexpr int max = static_cast<int>(devilution::SfxID::LAST);
+};
+
 namespace devilution {
 
 int sfxdelay;
@@ -310,4 +317,13 @@ int GetSFXLength(SfxID nSFX)
 	return sfx.pSnd->DSB.GetLength();
 }
 
+tl::expected<SfxID, std::string> ParseSfxId(std::string_view value)
+{
+	const std::optional<SfxID> enumValueOpt = magic_enum::enum_cast<SfxID>(value);
+	if (enumValueOpt.has_value()) {
+		return enumValueOpt.value();
+	}
+	return tl::make_unexpected("Unknown enum value.");
+}
+
 } // namespace devilution

Source/effects.h

@@ -9,6 +9,8 @@
 #include <memory>
 #include <string>
 
+#include <expected.hpp>
+
 #include "engine/sound.h"
 #include "sound_effect_enums.h"
 
@@ -35,4 +37,6 @@ void ui_sound_init();
 void effects_play_sound(SfxID);
 int GetSFXLength(SfxID nSFX);
 
+tl::expected<SfxID, std::string> ParseSfxId(std::string_view value);
+
 } // namespace devilution

Source/lua/lua_global.cpp

@@ -230,6 +230,7 @@ void LuaReloadActiveMods()
 	}
 
 	// Reload game data (this can probably be done later in the process to avoid having to reload it)
+	LoadTextData();
 	LoadPlayerDataFiles();
 	LoadSpellData();
 	LoadMissileData();

Source/quests/validation.cpp

@@ -20,7 +20,7 @@ bool IsQuestDeltaValid(quest_id qidx, quest_state qstate, uint8_t qlog, int16_t
 	if (IsNoneOf(qlog, 0, 1))
 		return false;
 
-	if (qmsg < 0 || static_cast<size_t>(qmsg) >= SpeechCount)
+	if (qmsg < 0 || static_cast<size_t>(qmsg) >= Speeches.size())
 		return false;
 
 	switch (qstate) {

Source/textdat.h

@@ -354,7 +354,6 @@ enum _speech_id : int16_t {
 	TEXT_BBOOKA,
 	TEXT_BBOOKB,
 	TEXT_BBOOKC,
-	/*
 	TEXT_DEADGUY,
 	TEXT_FARNHAM14,
 	TEXT_FARNHAM15,
@@ -424,20 +423,20 @@ enum _speech_id : int16_t {
 	TEXT_GRISWOLD35,
 	TEXT_GRISWOLD36,
 	TEXT_GRISWOLD37,
-	*/
-	NUM_TEXT_IDS,
+	NUM_DEFAULT_TEXT_IDS,
 	TEXT_NONE = -1,
 };
 
 struct Speech {
-	const char *txtstr;
+	std::string txtstr;
 	bool scrlltxt;
 	SfxID sfxnr;
 };
 
-extern const size_t SpeechCount;
-extern const Speech Speeches[];
+extern std::vector<Speech> Speeches;
 
 tl::expected<_speech_id, std::string> ParseSpeechId(std::string_view value);
 
+void LoadTextData();
+
 } // namespace devilution

tools/extract_translation_data.py

@@ -14,6 +14,7 @@
     "item_suffixes": root.joinpath("assets/txtdata/items/item_suffixes.tsv"),
     "questdat": root.joinpath("assets/txtdata/quests/questdat.tsv"),
     "spelldat": root.joinpath("assets/txtdata/spells/spelldat.tsv"),
+    "textdat": root.joinpath("assets/txtdata/text/textdat.tsv"),
 }
 
 hf_paths = {
@@ -97,6 +98,13 @@ def process_files(paths, temp_source):
             var_name = 'SPELL_' + row['name'].upper().replace(' ', '_').replace('-', '_')
             write_entry(temp_source, f'{var_name}_NAME', "spell", row['name'], True)
 
+    # Text/Speeches
+    if "textdat" in paths:
+        with open(paths["textdat"], 'r') as tsv:
+            reader = csv.DictReader(tsv, delimiter='\t')
+            for i, row in enumerate(reader):
+                write_entry(temp_source, f'TEXT_{i}', "default", row['txtstr'], False)
+
 with open(translation_dummy_path, 'w') as temp_source:
     temp_source.write(f'/**\n')
     temp_source.write(f' * @file translation_dummy.cpp\n')