1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
#include "GruntyQuestionFactory.h"
#include "BKDialogShared.h"
#include "BKEmitText.h"
#include "Companion.h"
#include "spdlog/spdlog.h"
#include "types/RawBuffer.h"
#include "utils/Decompressor.h"
#include "utils/TorchUtils.h"
#define GRUNTY_QUESTION_HEADER_1 0x01
#define GRUNTY_QUESTION_HEADER_2 0x03
#define GRUNTY_QUESTION_HEADER_3 0x00
#define GRUNTY_QUESTION_HEADER_4 0x05
#define GRUNTY_QUESTION_HEADER_5 0x00
namespace BK64 {
namespace {
constexpr int8_t kUsHeader[3] = { GRUNTY_QUESTION_HEADER_1, GRUNTY_QUESTION_HEADER_2, GRUNTY_QUESTION_HEADER_3 };
constexpr int8_t kPalHeader[3] = { 0x03, 0x03, 0x00 };
// One language's question data. Same shape for every language. Unlike quiz options,
// these split their leading control pair out of the string.
GruntyQuestionLang ParseGruntyBlock(LUS::BinaryReader& reader, const std::string& symbol) {
const int textSize = reader.ReadUByte();
auto text = ReadDialogStrings(reader, textSize - kQuestionOptionCount, symbol, "GruntyQuestion");
std::vector<OptionString> options;
if (textSize >= kQuestionOptionCount) {
for (int i = 0; i < kQuestionOptionCount; i++) {
// cmd + length + the two control bytes, then the string past them
if (!HasBytes(reader, 4)) {
SPDLOG_WARN("[BK64] GruntyQuestion {}: option {} of {} runs past the end of the blob; dropping "
"the rest.",
symbol, i + 1, kQuestionOptionCount);
break;
}
OptionString optionString;
optionString.cmd = reader.ReadUByte();
const auto strLen = reader.ReadUByte();
optionString.unk0 = reader.ReadUByte();
optionString.unk1 = reader.ReadUByte();
if (strLen < 2 || !HasBytes(reader, strLen - 2)) {
SPDLOG_WARN("[BK64] GruntyQuestion {}: option {} of {} claims {} bytes the blob doesn't hold; "
"dropping the rest.",
symbol, i + 1, kQuestionOptionCount, strLen);
break;
}
optionString.str = reader.ReadString(strLen - 2);
options.push_back(optionString);
}
}
return { std::move(text), std::move(options) };
}
void WriteGruntyLangBlock(LUS::BinaryWriter& writer, const std::vector<DialogString>& text,
const std::vector<OptionString>& options) {
WriteDialogStrings(writer, text);
writer.Write((uint32_t)options.size());
for (const auto& optionString : options) {
writer.Write(optionString.cmd);
writer.Write(optionString.unk0);
writer.Write(optionString.unk1);
writer.Write((uint32_t)optionString.str.length());
// [port] Write(string) would prefix the length twice
writer.Write((char*)optionString.str.data(), optionString.str.size());
}
}
void EmitGruntyLang(YAML::Emitter& out, const std::vector<DialogString>& text,
const std::vector<OptionString>& options) {
out << YAML::Key << "Text";
out << YAML::Value;
EmitDialogStringSeq(out, text);
out << YAML::Key << "Options";
out << YAML::Value;
out << YAML::BeginSeq;
for (const auto& [cmd, unk0, unk1, str] : options) {
out << YAML::Flow;
out << YAML::BeginSeq;
out << YAML_HEX((uint32_t)cmd);
out << YAML_HEX((uint32_t)unk0);
out << YAML_HEX((uint32_t)unk1);
EmitText(out, str);
out << YAML::EndSeq;
}
out << YAML::EndSeq;
}
GruntyQuestionLang ReadGruntyLang(const YAML::Node& lang) {
auto text = ReadModdingDialogSeq(lang["Text"]);
std::vector<OptionString> options;
auto optionsNode = lang["Options"];
for (YAML::iterator it = optionsNode.begin(); it != optionsNode.end(); ++it) {
if (options.size() >= kQuestionOptionCount) {
SPDLOG_WARN("BK64 GruntyQuestion: Only 3 Options Allowed; extra options ignored");
break;
}
OptionString optionString;
optionString.cmd = (*it)[0].as<uint32_t>();
optionString.unk0 = (*it)[1].as<uint32_t>();
optionString.unk1 = (*it)[2].as<uint32_t>();
optionString.str = DecodeText((*it)[3].as<std::string>());
optionString.str += '\0';
options.push_back(optionString);
}
if (options.size() != kQuestionOptionCount) {
throw std::runtime_error("BK64 GruntyQuestion: Requires Exactly 3 Options");
}
return { std::move(text), std::move(options) };
}
} // namespace
ExportResult GruntyQuestionCodeExporter::Export(std::ostream& write, std::shared_ptr<IParsedData> raw,
std::string& entryName, YAML::Node& node, std::string* replacement) {
auto offset = GetSafeNode<uint32_t>(node, "offset");
auto gruntyQuestion = std::static_pointer_cast<GruntyQuestionData>(raw);
const auto symbol = GetSafeNode(node, "symbol", entryName);
write << "u8 " << symbol << "[] = {\n";
write << fourSpaceTab << "GRUNTY_QUESTION_HEADER_1"
<< ", "
<< "GRUNTY_QUESTION_HEADER_2"
<< ", "
<< "GRUNTY_QUESTION_HEADER_3"
<< ", "
<< "GRUNTY_QUESTION_HEADER_4"
<< ", "
<< "GRUNTY_QUESTION_HEADER_5"
<< ",\n";
write << fourSpaceTab << "/* GruntyQuestion */\n";
WriteDialogStringArray(write, gruntyQuestion->mText);
write << fourSpaceTab << "/* Options */\n";
write << fourSpaceTab << gruntyQuestion->mOptions.size() << ",\n";
for (const auto& [cmd, unk0, unk1, str] : gruntyQuestion->mOptions) {
write << fourSpaceTab << "0x" << FORMAT_HEX((uint32_t)cmd, 2) << ", " << str.length();
write << ", 0x" << FORMAT_HEX((uint32_t)unk0, 2) << ", 0x" << FORMAT_HEX((uint32_t)unk1, 2);
WriteEscapedChars(write, str);
write << ",\n";
}
write << "};\n\n";
return offset;
}
ExportResult BK64::GruntyQuestionBinaryExporter::Export(std::ostream& write, std::shared_ptr<IParsedData> raw,
std::string& entryName, YAML::Node& node,
std::string* replacement) {
auto writer = LUS::BinaryWriter();
const auto gruntyQuestion = std::static_pointer_cast<GruntyQuestionData>(raw);
WriteHeader(writer, Torch::ResourceType::BKGruntyQuestion, 0);
// 1 for US/JP, 3 for PAL (EN + FR + DE)
const uint32_t langCount = 1 + static_cast<uint32_t>(gruntyQuestion->mExtraLangs.size());
writer.Write(langCount);
// English always goes first
WriteGruntyLangBlock(writer, gruntyQuestion->mText, gruntyQuestion->mOptions);
// PAL only: French then German
for (const auto& lang : gruntyQuestion->mExtraLangs) {
WriteGruntyLangBlock(writer, lang.text, lang.options);
}
writer.Finish(write);
return std::nullopt;
}
ExportResult BK64::GruntyQuestionModdingExporter::Export(std::ostream& write, std::shared_ptr<IParsedData> raw,
std::string& entryName, YAML::Node& node,
std::string* replacement) {
const auto gruntyQuestion = std::static_pointer_cast<GruntyQuestionData>(raw);
const auto symbol = GetSafeNode(node, "symbol", entryName);
*replacement += ".yaml";
YAML::Emitter out;
out << YAML::BeginMap;
out << YAML::Key << symbol;
out << YAML::Value;
out.SetIndent(2);
out << YAML::BeginMap;
EmitGruntyLang(out, gruntyQuestion->mText, gruntyQuestion->mOptions);
for (size_t i = 0; i < gruntyQuestion->mExtraLangs.size() && i < std::size(kPalExtraLangs); i++) {
out << YAML::Key << kPalExtraLangs[i];
out << YAML::Value;
out << YAML::BeginMap;
EmitGruntyLang(out, gruntyQuestion->mExtraLangs[i].text, gruntyQuestion->mExtraLangs[i].options);
out << YAML::EndMap;
}
out << YAML::EndMap;
out << YAML::EndMap;
write.write(out.c_str(), out.size());
return std::nullopt;
}
std::optional<std::shared_ptr<IParsedData>> GruntyQuestionFactory::parse(std::vector<uint8_t>& buffer,
YAML::Node& node) {
auto [_, segment] = Decompressor::AutoDecode(node, buffer);
LUS::BinaryReader reader(segment.data, segment.size);
reader.SetEndianness(Torch::Endianness::Big);
const auto symbol = GetSafeNode<std::string>(node, "symbol");
const auto extraOffsets = SeekQuestionBlock(reader, symbol, "GruntyQuestion", kUsHeader, kPalHeader);
if (!extraOffsets.has_value()) {
return std::nullopt;
}
auto english = ParseGruntyBlock(reader, symbol);
std::vector<GruntyQuestionLang> extraLangs;
for (const uint16_t offset : *extraOffsets) {
reader.Seek(offset, LUS::SeekOffsetType::Start);
extraLangs.push_back(ParseGruntyBlock(reader, symbol));
}
return std::make_shared<GruntyQuestionData>(std::move(english.text), std::move(english.options),
std::move(extraLangs));
}
std::optional<std::shared_ptr<IParsedData>> GruntyQuestionFactory::parse_modding(std::vector<uint8_t>& buffer,
YAML::Node& node) {
const auto symbol = GetSafeNode<std::string>(node, "symbol");
const YAML::Node info = YamlEntry(buffer, symbol);
auto english = ReadGruntyLang(info);
std::vector<GruntyQuestionLang> extraLangs;
for (const auto& lang : ReadPalExtraLangs(info, symbol, "GruntyQuestion")) {
extraLangs.push_back(ReadGruntyLang(lang));
}
return std::make_shared<GruntyQuestionData>(std::move(english.text), std::move(english.options),
std::move(extraLangs));
}
} // namespace BK64
|