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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
#include "GruntyQuestionFactory.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
#define FORMAT_HEX(x, w) \
std::hex << std::uppercase << std::setfill('0') << std::setw(w) << x << std::nouppercase << std::dec
#define YAML_HEX(num) YAML::Hex << (num) << YAML::Dec
namespace BK64 {
ExportResult GruntyQuestionHeaderExporter::Export(std::ostream& write, std::shared_ptr<IParsedData> raw,
std::string& entryName, YAML::Node& node, std::string* replacement) {
const auto symbol = GetSafeNode(node, "symbol", entryName);
if (Companion::Instance->IsOTRMode()) {
write << "static const ALIGN_ASSET(2) char " << symbol << "[] = \"__OTR__" << (*replacement) << "\";\n\n";
return std::nullopt;
}
return std::nullopt;
}
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";
write << fourSpaceTab << gruntyQuestion->mText.size() << ",\n";
for (const auto [cmd, str] : gruntyQuestion->mText) {
write << fourSpaceTab << "0x" << FORMAT_HEX((uint32_t)cmd, 2) << ", " << str.length();
for (auto& c : str) {
if (c < ' ') {
write << ", 0x" << FORMAT_HEX((uint32_t)c, 2);
} else if (c == '\'') {
write << ", \'\\" << c << "\'";
} else {
write << ", \'" << c << "\'";
}
}
write << ",\n";
}
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);
for (auto& c : str) {
if (c < ' ') {
write << ", 0x" << FORMAT_HEX((uint32_t)c, 2);
} else if (c == '\'') {
write << ", \'\\" << c << "\'";
} else {
write << ", \'" << c << "\'";
}
}
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);
writer.Write((uint32_t)gruntyQuestion->mText.size());
for (const auto& dialogString : gruntyQuestion->mText) {
writer.Write(dialogString.cmd);
writer.Write((uint32_t)dialogString.str.length());
writer.Write((char*)dialogString.str.data(),
dialogString.str.size()); // [port] Write(string) would prefix the length twice
}
writer.Write((uint32_t)gruntyQuestion->mOptions.size());
for (const auto& optionString : gruntyQuestion->mOptions) {
writer.Write(optionString.cmd);
writer.Write(optionString.unk0);
writer.Write(optionString.unk1);
writer.Write((uint32_t)optionString.str.length());
writer.Write((char*)optionString.str.data(),
optionString.str.size()); // [port] Write(string) would prefix the length twice
}
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;
out << YAML::Key << "Text";
out << YAML::Value;
out << YAML::BeginSeq;
for (const auto [cmd, str] : gruntyQuestion->mText) {
out << YAML::Flow;
out << YAML::BeginSeq;
out << YAML_HEX((uint32_t)cmd);
out << str.c_str();
out << YAML::EndSeq;
}
out << YAML::EndSeq;
out << YAML::Key << "Options";
out << YAML::Value;
out << YAML::BeginSeq;
for (const auto [cmd, unk0, unk1, str] : gruntyQuestion->mOptions) {
out << YAML::Flow;
out << YAML::BeginSeq;
out << YAML_HEX((uint32_t)cmd);
out << YAML_HEX((uint32_t)unk0);
out << YAML_HEX((uint32_t)unk1);
out << str.c_str();
out << YAML::EndSeq;
}
out << YAML::EndSeq;
out << YAML::EndMap;
out << YAML::EndMap;
write.write(out.c_str(), out.size());
return std::nullopt;
}
// The actual question data. Same shape whether we got here via US or PAL English.
static std::shared_ptr<GruntyQuestionData> ParseGruntyBlock(LUS::BinaryReader& reader) {
std::vector<DialogString> text;
std::vector<OptionString> options;
auto textSize = reader.ReadUByte();
for (uint8_t i = 0; i < textSize - 3; i++) {
DialogString dialogString;
dialogString.cmd = reader.ReadUByte();
auto strLen = reader.ReadUByte();
dialogString.str = reader.ReadString(strLen);
text.push_back(dialogString);
}
for (uint8_t i = textSize - 3; i < textSize; i++) {
OptionString optionString;
optionString.cmd = reader.ReadUByte();
auto strLen = reader.ReadUByte();
optionString.unk0 = reader.ReadUByte();
optionString.unk1 = reader.ReadUByte();
optionString.str = reader.ReadString(strLen - 2);
options.push_back(optionString);
}
return std::make_shared<GruntyQuestionData>(text, options);
}
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");
auto header1 = reader.ReadInt8();
auto header2 = reader.ReadInt8();
auto header3 = reader.ReadInt8();
if (header1 == GRUNTY_QUESTION_HEADER_1 && header2 == GRUNTY_QUESTION_HEADER_2 &&
header3 == GRUNTY_QUESTION_HEADER_3) {
// US: 01 03 00 05 00, then the question data
reader.ReadInt8(); // header4 (0x05)
reader.ReadInt8(); // header5 (0x00)
return ParseGruntyBlock(reader);
}
if (header1 == 0x03 && header2 == 0x03 && header3 == 0x00) {
// PAL: 03 03 00, then 3 x LE u16 offsets (EN/FR/DE start positions)
uint16_t enOffset = reader.ReadUByte() | (reader.ReadUByte() << 8);
reader.ReadUByte();
reader.ReadUByte(); // skip FR offset
reader.ReadUByte();
reader.ReadUByte(); // skip DE offset
// We're now at byte 9 = enOffset, so just read the English block.
return ParseGruntyBlock(reader);
}
SPDLOG_ERROR("Invalid Header For BK64 GruntyQuestion {}: {:02X} {:02X} {:02X}", symbol, header1, header2, header3);
return std::nullopt;
}
std::optional<std::shared_ptr<IParsedData>> GruntyQuestionFactory::parse_modding(std::vector<uint8_t>& buffer,
YAML::Node& node) {
YAML::Node assetNode;
try {
std::string text((char*)buffer.data(), buffer.size());
assetNode = YAML::Load(text.c_str());
} catch (YAML::ParserException& e) {
SPDLOG_ERROR("Failed to parse message data: {}", e.what());
SPDLOG_ERROR("{}", (char*)buffer.data());
return std::nullopt;
}
const auto info = assetNode.begin()->second;
std::vector<DialogString> text;
std::vector<OptionString> options;
auto textNode = info["Text"];
auto optionsNode = info["Options"];
for (YAML::iterator it = textNode.begin(); it != textNode.end(); ++it) {
DialogString dialogString;
dialogString.cmd = (*it)[0].as<uint32_t>();
dialogString.str = (*it)[1].as<std::string>();
dialogString.str += '\0';
text.push_back(dialogString);
}
uint32_t i = 0;
for (YAML::iterator it = optionsNode.begin(); it != optionsNode.end(); ++it) {
if (i >= 3) {
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 = (*it)[3].as<std::string>();
optionString.str += '\0';
options.push_back(optionString);
i++;
}
if (i != 3) {
throw std::runtime_error("BK64 GruntyQuestion: Requires Exactly 3 Options");
}
return std::make_shared<GruntyQuestionData>(text, options);
}
} // namespace BK64
|
