11#include "absl/strings/ascii.h"
12#include "absl/strings/str_cat.h"
13#include "absl/strings/str_format.h"
14#include "absl/strings/str_split.h"
63absl::StatusOr<std::optional<RoomPropertyManifestContext>>
65 bool require_object_allocator) {
66 const auto manifest_path = parser.
GetString(
"manifest");
67 if (!manifest_path.has_value()) {
73 if (!require_object_allocator) {
74 return std::optional<RoomPropertyManifestContext>(std::move(context));
79 if (manifest_layout ==
nullptr) {
80 return absl::FailedPreconditionError(
81 "Manifest does not define dungeon_stream_regions.objects");
84 return absl::FailedPreconditionError(
85 "dungeon_stream_regions.objects must use copy_on_write");
92 return std::optional<RoomPropertyManifestContext>(std::move(context));
97 const std::vector<std::pair<uint32_t, uint32_t>>& ranges) {
99 return absl::PermissionDeniedError(
"Write conflict with Hack Manifest");
101 return absl::OkStatus();
107 return absl::FailedPreconditionError(
108 "Object-stream header manifest is missing allocator capability");
111 std::vector<std::pair<uint32_t, uint32_t>> ranges;
113 uint32_t pointer_table_snes = 0;
116 const uint32_t pointer_table_pc =
SnesToPc(pointer_table_snes);
117 const uint64_t pointer_slot =
static_cast<uint64_t
>(pointer_table_pc) +
118 static_cast<uint64_t
>(room_id) * 3u;
119 if (pointer_slot + 3u > rom.
size()) {
120 return absl::OutOfRangeError(
121 "Selected object pointer slot is outside the ROM");
124 uint32_t stream_snes = 0;
126 const uint32_t stream_pc =
SnesToPc(stream_snes);
127 if (
static_cast<uint64_t
>(stream_pc) + 2u > rom.
size()) {
128 return absl::OutOfRangeError(
129 "Selected object stream header is outside the ROM");
131 ranges.emplace_back(stream_pc, stream_pc + 2u);
134 ranges.emplace_back(range.begin, range.end);
136 const uint64_t cow_pointer_slot =
138 static_cast<uint64_t
>(room_id) * 3u;
139 if (cow_pointer_slot + 3u > std::numeric_limits<uint32_t>::max()) {
140 return absl::OutOfRangeError(
"Selected COW pointer range overflows");
142 ranges.emplace_back(
static_cast<uint32_t
>(cow_pointer_slot),
143 static_cast<uint32_t
>(cow_pointer_slot + 3u));
145 const uint64_t door_pointer_slot =
147 static_cast<uint64_t
>(room_id) * 3u;
148 if (door_pointer_slot + 3u > std::numeric_limits<uint32_t>::max()) {
149 return absl::OutOfRangeError(
"Selected door pointer range overflows");
151 ranges.emplace_back(
static_cast<uint32_t
>(door_pointer_slot),
152 static_cast<uint32_t
>(door_pointer_slot + 3u));
157absl::StatusOr<std::vector<std::pair<uint32_t, uint32_t>>>
159 uint32_t header_pointer_snes = 0;
162 const uint32_t header_pointer_pc =
SnesToPc(header_pointer_snes);
163 const uint64_t table_offset =
static_cast<uint64_t
>(header_pointer_pc) +
164 static_cast<uint64_t
>(room_id) * 2u;
165 if (table_offset + 2u > rom.
size()) {
166 return absl::OutOfRangeError(
167 "Selected room header pointer slot is outside the ROM");
170 uint16_t header_offset = 0;
172 uint8_t header_bank = 0;
174 const uint32_t header_pc =
175 SnesToPc((
static_cast<uint32_t
>(header_bank) << 16) | header_offset);
176 if (
static_cast<uint64_t
>(header_pc) + 14u > rom.
size()) {
177 return absl::OutOfRangeError(
"Selected room header is outside the ROM");
180 const uint64_t message_pc =
182 static_cast<uint64_t
>(room_id) * 2u;
183 if (message_pc + 2u > rom.
size()) {
184 return absl::OutOfRangeError(
"Selected room message ID is outside the ROM");
187 return std::vector<std::pair<uint32_t, uint32_t>>{
188 {header_pc, header_pc + 14u},
189 {
static_cast<uint32_t
>(message_pc),
190 static_cast<uint32_t
>(message_pc + 2u)}};
195 std::vector<std::pair<uint32_t, uint32_t>> ranges;
205 for (
int i = 0; i < static_cast<int>(existing.
tiles.size()); ++i) {
215 if (parser.
HasFlag(
"mock-rom")) {
216 formatter.
AddField(
"save_status",
"mock-rom-skipped");
217 return absl::OkStatus();
222 auto save_status = rom->
SaveToFile(save_settings);
223 if (!save_status.ok()) {
224 formatter.
AddField(
"save_error", std::string(save_status.message()));
228 formatter.
AddField(
"save_status",
"saved");
229 return absl::OkStatus();
234 auto registry_path = parser.
GetString(
"sprite-registry");
235 if (!registry_path.has_value()) {
236 return absl::OkStatus();
239 std::ifstream file(registry_path.value());
240 if (!file.is_open()) {
241 return absl::NotFoundError(absl::StrFormat(
242 "Could not open sprite registry: %s", registry_path.value()));
245 std::stringstream buffer;
246 buffer << file.rdbuf();
254 std::string_view object_title) {
256 return absl::InvalidArgumentError(absl::StrFormat(
257 "Dungeon spawn point ID %d out of range (0x00-0x06).", spawn_id));
261 if (!spawn_or.ok()) {
262 return spawn_or.status();
264 const auto& spawn = spawn_or.value();
266 if (!object_title.empty()) {
271 formatter.
AddField(
"is_spawn_point",
true);
272 formatter.
AddHexField(
"room_id", spawn.room_id, 4);
273 formatter.
AddHexField(
"dungeon_id", spawn.dungeon_id, 2);
274 formatter.
AddHexField(
"quadrant", spawn.quadrant, 2);
275 formatter.
AddHexField(
"overworld_door_tilemap", spawn.overworld_door_tilemap,
277 formatter.
AddHexField(
"entrance_id", spawn.entrance_id, 4);
280 formatter.
AddField(
"x",
static_cast<int>(spawn.x_coordinate));
281 formatter.
AddField(
"y",
static_cast<int>(spawn.y_coordinate));
285 formatter.
AddField(
"horizontal_scroll",
286 static_cast<int>(spawn.horizontal_scroll));
287 formatter.
AddField(
"vertical_scroll",
288 static_cast<int>(spawn.vertical_scroll));
289 formatter.
AddField(
"trigger_x",
static_cast<int>(spawn.camera_trigger_x));
290 formatter.
AddField(
"trigger_y",
static_cast<int>(spawn.camera_trigger_y));
294 formatter.
AddHexField(
"main_gfx", spawn.main_gfx, 2);
298 spawn.camera_scroll_controller, 2);
303 formatter.
AddHexField(
"qn", spawn.camera_scroll_boundaries[0], 2);
304 formatter.
AddHexField(
"fn", spawn.camera_scroll_boundaries[1], 2);
305 formatter.
AddHexField(
"qs", spawn.camera_scroll_boundaries[2], 2);
306 formatter.
AddHexField(
"fs", spawn.camera_scroll_boundaries[3], 2);
307 formatter.
AddHexField(
"qw", spawn.camera_scroll_boundaries[4], 2);
308 formatter.
AddHexField(
"fw", spawn.camera_scroll_boundaries[5], 2);
309 formatter.
AddHexField(
"qe", spawn.camera_scroll_boundaries[6], 2);
310 formatter.
AddHexField(
"fe", spawn.camera_scroll_boundaries[7], 2);
313 if (!object_title.empty()) {
316 return absl::OkStatus();
323 auto registry_status = MaybeLoadSpriteRegistry(parser);
324 if (!registry_status.ok()) {
325 return registry_status;
328 auto room_id_str = parser.
GetString(
"room").value();
331 if (!ParseHexString(room_id_str, &room_id)) {
332 return absl::InvalidArgumentError(
"Invalid room ID format. Must be hex.");
336 formatter.
AddField(
"room_id", room_id);
342 formatter.
AddField(
"total_sprites",
static_cast<int>(sprites.size()));
343 formatter.
AddField(
"status",
"success");
346 for (
const auto& sprite : sprites) {
348 formatter.
AddHexField(
"sprite_id", sprite.id(), 2);
350 formatter.
AddField(
"x", sprite.x());
351 formatter.
AddField(
"y", sprite.y());
352 formatter.
AddField(
"subtype", sprite.subtype());
353 formatter.
AddField(
"layer", sprite.layer());
354 if (sprite.key_drop() > 0) {
355 formatter.
AddField(
"key_drop", sprite.key_drop());
362 return absl::OkStatus();
369 auto registry_status = MaybeLoadSpriteRegistry(parser);
370 if (!registry_status.ok()) {
371 return registry_status;
374 auto room_id_str = parser.
GetString(
"room").value();
377 if (!ParseHexString(room_id_str, &room_id)) {
378 return absl::InvalidArgumentError(
"Invalid room ID format. Must be hex.");
381 formatter.
AddField(
"room_id", room_id);
385 const bool include_objects = parser.
HasFlag(
"include-objects");
388 formatter.
AddField(
"status",
"success");
389 formatter.
AddField(
"name", absl::StrFormat(
"Room %d", room.
id()));
391 formatter.
AddField(
"room_type",
"Dungeon Room");
402 formatter.
AddField(
"tag1",
static_cast<int>(room.
tag1()));
403 formatter.
AddField(
"tag2",
static_cast<int>(room.
tag2()));
406 const int object_count = include_objects
407 ?
static_cast<int>(std::count_if(
408 tile_objects.begin(), tile_objects.end(),
409 IsEncodedRoomStreamObject))
410 :
static_cast<int>(tile_objects.size());
411 formatter.
AddField(
"object_count", object_count);
415 if (include_objects) {
417 int stream_index = 0;
418 for (
const auto&
object : tile_objects) {
419 if (!IsEncodedRoomStreamObject(
object)) {
423 const auto encoded =
object.EncodeObjectToBytes();
425 formatter.
AddHexField(
"object_id",
static_cast<uint16_t
>(
object.id_), 3);
426 formatter.
AddField(
"entity_kind",
"room_object");
428 formatter.
AddField(
"name_source",
"vanilla_object_catalog");
429 formatter.
AddField(
"coordinate_space",
"room_tile8");
431 encoded.b1, encoded.b3));
432 formatter.
AddField(
"x",
static_cast<int>(
object.x()));
433 formatter.
AddField(
"y",
static_cast<int>(
object.y()));
434 formatter.
AddField(
"size",
static_cast<int>(
object.size()));
435 formatter.
AddField(
"stream_index", stream_index++);
443 const auto& doors = room.
GetDoors();
444 for (
size_t index = 0; index < doors.size(); ++index) {
445 const auto& door = doors[index];
447 formatter.
AddField(
"index",
static_cast<int>(index));
448 formatter.
AddField(
"entity_kind",
"door");
449 formatter.
AddField(
"position", door.position);
450 formatter.
AddField(
"direction", std::string(door.GetDirectionName()));
451 formatter.
AddField(
"type", std::string(door.GetTypeName()));
452 formatter.
AddHexField(
"type_id",
static_cast<uint8_t
>(door.type), 2);
453 auto [tx, ty] = door.GetTileCoords();
456 const auto [px, py, width, height] = door.GetBounds();
461 formatter.
AddField(
"height", height);
462 formatter.
AddField(
"coordinate_space",
"room_pixels");
470 for (
const auto& stair : room.
GetStairs()) {
475 "tile_y", stair.room);
476 formatter.
AddField(
"label", stair.label);
481 if (parser.
HasFlag(
"include-staircase-resolution")) {
486 input.objects.insert(input.objects.begin(), prefix.begin(), prefix.end());
489 formatter.
AddField(
"model",
"vanilla_collision_preview");
490 formatter.
AddField(
"runtime_qualified",
false);
491 formatter.
AddField(
"layout_loaded", layout_status.ok());
494 for (
const auto& resolution : resolutions) {
495 if (resolution.object_index < prefix.size())
497 const auto index = resolution.object_index - prefix.size();
498 const auto&
object = tile_objects[index];
500 formatter.
AddField(
"object_index",
static_cast<int>(index));
502 formatter.
AddField(
"x",
object.x());
503 formatter.
AddField(
"y",
object.y());
504 formatter.
AddField(
"stream_index",
object.GetLayerValue());
505 const char* status =
"trigger_unavailable";
506 switch (resolution.status) {
513 status =
"overlapping_stairs";
516 status =
"outside_room";
519 status =
"too_many_stairs";
522 formatter.
AddField(
"vanilla_status", status);
523 if (resolution.slot && layout_status.ok()) {
524 formatter.
AddField(
"vanilla_slot", *resolution.slot);
528 formatter.
AddField(
"vanilla_arrival_plane",
531 if (!layout_status.ok())
532 status =
"layout_unavailable";
534 status =
"custom_collision";
535 formatter.
AddField(
"status", status);
536 if (resolution.slot && layout_status.ok() &&
538 formatter.
AddField(
"slot", *resolution.slot);
557 formatter.
AddField(
"item_name_source",
564 return absl::OkStatus();
570 auto room_id_opt = parser.
GetString(
"room");
572 bool has_room_filter = room_id_opt.has_value();
573 int room_filter = -1;
574 if (has_room_filter) {
575 if (!ParseHexString(room_id_opt.value(), &room_filter)) {
576 return absl::InvalidArgumentError(
"Invalid room ID format. Must be hex.");
581 int rooms_with_chests = 0;
582 int total_chests = 0;
583 std::map<int, int> item_counts;
586 formatter.
AddField(
"room_filter", has_room_filter
587 ? absl::StrFormat(
"0x%02X", room_filter)
591 int start_room = has_room_filter ? room_filter : 0;
594 for (
int room_id = start_room; room_id <= end_room; ++room_id) {
600 if (chests.empty()) {
605 total_chests +=
static_cast<int>(chests.size());
608 formatter.
AddField(
"room_id", absl::StrFormat(
"0x%02X", room_id));
610 formatter.
AddField(
"chest_count",
static_cast<int>(chests.size()));
614 for (
const auto&
chest : chests) {
616 formatter.
AddField(
"index", chest_index++);
619 formatter.
AddField(
"item_name_source",
624 item_counts[
chest.id]++;
632 formatter.
AddField(
"total_rooms", total_rooms);
633 formatter.
AddField(
"rooms_with_chests", rooms_with_chests);
634 formatter.
AddField(
"total_chests", total_chests);
635 formatter.
AddField(
"unique_items",
static_cast<int>(item_counts.size()));
638 for (
const auto& [item_id, count] : item_counts) {
645 formatter.
AddField(
"item_name_source",
654 return absl::OkStatus();
660 auto entrance_id_str = parser.
GetString(
"entrance").value();
661 bool is_spawn_point = parser.
HasFlag(
"spawn");
664 if (!ParseHexString(entrance_id_str, &entrance_id)) {
665 return absl::InvalidArgumentError(
666 "Invalid entrance ID format. Must be hex.");
669 if (is_spawn_point) {
674 return absl::OutOfRangeError(
"Regular dungeon entrance ID is out of range");
679 formatter.
AddField(
"entrance_id", absl::StrFormat(
"0x%02X", entrance_id));
680 formatter.
AddField(
"is_spawn_point", is_spawn_point);
681 formatter.
AddField(
"room_id", absl::StrFormat(
"0x%04X", entrance.
room_));
682 formatter.
AddField(
"exit_id", absl::StrFormat(
"0x%04X", entrance.
exit_));
698 formatter.
AddField(
"floor", absl::StrFormat(
"0x%02X", entrance.
floor_));
701 formatter.
AddField(
"door", absl::StrFormat(
"0x%02X", entrance.
door_));
703 absl::StrFormat(
"0x%02X", entrance.
ladder_bg_));
705 absl::StrFormat(
"0x%02X", entrance.
scrolling_));
706 formatter.
AddField(
"scroll_quadrant",
708 formatter.
AddField(
"music", absl::StrFormat(
"0x%02X", entrance.
music_));
730 return absl::OkStatus();
736 auto room_id_str = parser.
GetString(
"room").value();
739 if (!ParseHexString(room_id_str, &room_id)) {
740 return absl::InvalidArgumentError(
"Invalid room ID format. Must be hex.");
744 formatter.
AddField(
"room_id", room_id);
748 auto room_or = dungeon_editor.
GetRoom(room_id);
750 formatter.
AddField(
"status",
"error");
751 formatter.
AddField(
"error", room_or.status().ToString());
753 return room_or.status();
756 auto& room = room_or.value();
759 formatter.
AddField(
"status",
"success");
760 formatter.
AddField(
"room_width",
"Unknown");
761 formatter.
AddField(
"room_height",
"Unknown");
762 formatter.
AddField(
"room_name", absl::StrFormat(
"Room %d", room.id()));
766 formatter.
AddField(
"tiles",
"Room tile data would be exported here");
767 formatter.
AddField(
"sprites",
"Room sprite data would be exported here");
768 formatter.
AddField(
"doors",
"Room door data would be exported here");
773 return absl::OkStatus();
779 auto room_id_str = parser.
GetString(
"room").value();
782 if (!ParseHexString(room_id_str, &room_id)) {
783 return absl::InvalidArgumentError(
"Invalid room ID format. Must be hex.");
787 formatter.
AddField(
"room_id", room_id);
791 auto room_or = dungeon_editor.
GetRoom(room_id);
793 formatter.
AddField(
"status",
"error");
794 formatter.
AddField(
"error", room_or.status().ToString());
796 return room_or.status();
799 auto& room = room_or.value();
804 const auto& objects = room.GetTileObjects();
805 formatter.
AddField(
"total_objects",
static_cast<int>(objects.size()));
806 formatter.
AddField(
"status",
"success");
809 for (
const auto& obj : objects) {
812 formatter.
AddField(
"id_hex", absl::StrFormat(
"0x%04X", obj.id_));
815 formatter.
AddField(
"size", obj.size_);
816 formatter.
AddField(
"layer",
static_cast<int>(obj.layer_));
826 return absl::OkStatus();
832 auto room_id_str = parser.
GetString(
"room").value();
835 if (!ParseHexString(room_id_str, &room_id)) {
836 return absl::InvalidArgumentError(
"Invalid room ID format. Must be hex.");
840 formatter.
AddField(
"room_id", room_id);
844 auto room_or = dungeon_editor.
GetRoom(room_id);
846 formatter.
AddField(
"status",
"error");
847 formatter.
AddField(
"error", room_or.status().ToString());
849 return room_or.status();
852 auto& room = room_or.value();
856 formatter.
AddField(
"room_width", 64);
857 formatter.
AddField(
"room_height", 64);
858 formatter.
AddField(
"total_tiles", 64 * 64);
859 formatter.
AddField(
"has_custom_collision", room.has_custom_collision());
861 static_cast<int>(room.GetTileObjects().size()));
862 formatter.
AddField(
"status",
"success");
867 const auto& collision = room.custom_collision().tiles;
868 for (
int y = 0; y < 64; ++y) {
871 for (
int x = 0; x < 64; ++x) {
875 absl::StrAppend(&row, absl::StrFormat(
"%02X", collision[y * 64 + x]));
882 return absl::OkStatus();
888 auto room_id_str = parser.
GetString(
"room").value();
889 auto property = parser.
GetString(
"property").value();
890 auto value = parser.
GetString(
"value").value();
893 if (!ParseHexString(room_id_str, &room_id)) {
894 return absl::InvalidArgumentError(
"Invalid room ID format. Must be hex.");
897 formatter.
BeginObject(
"Dungeon Room Property Set");
898 formatter.
AddField(
"room_id", room_id);
899 formatter.
AddField(
"property", property);
903 const absl::Status room_status =
904 absl::InvalidArgumentError(
"Invalid room ID");
905 formatter.
AddField(
"status",
"error");
906 formatter.
AddField(
"error", room_status.ToString());
911 int parsed_value = 0;
912 if (!ParseHexString(value, &parsed_value)) {
913 const absl::Status value_status =
914 absl::InvalidArgumentError(absl::StrFormat(
915 "Invalid value format: %s (expected integer/hex)", value));
916 formatter.
AddField(
"status",
"error");
917 formatter.
AddField(
"error", std::string(value_status.message()));
922 const std::string prop = absl::AsciiStrToLower(property);
923 const bool is_layout = prop ==
"layout" || prop ==
"layout_id";
924 const bool is_floor = prop ==
"floor1" || prop ==
"floor2";
925 const bool is_object_stream_header = is_layout || is_floor;
926 const bool is_room_header = prop ==
"palette" || prop ==
"blockset" ||
927 prop ==
"spriteset" || prop ==
"effect" ||
928 prop ==
"tag1" || prop ==
"tag2" ||
930 const int property_max = is_layout ? 0x07 : (is_floor ? 0x0F : 0xFF);
931 if (is_object_stream_header &&
932 (parsed_value < 0 || parsed_value > property_max)) {
933 const absl::Status property_status =
934 absl::InvalidArgumentError(absl::StrFormat(
935 "Property %s must be in range 0..%d", property, property_max));
936 formatter.
AddField(
"status",
"error");
937 formatter.
AddField(
"error", std::string(property_status.message()));
939 return property_status;
942 std::optional<RoomPropertyManifestContext> manifest_context;
943 if (is_object_stream_header || is_room_header) {
945 LoadRoomPropertyManifestContext(parser, is_object_stream_header);
946 if (!context_or.ok()) {
947 formatter.
AddField(
"status",
"error");
948 formatter.
AddField(
"error", std::string(context_or.status().message()));
950 return context_or.status();
952 manifest_context = std::move(context_or).value();
953 if (manifest_context.has_value()) {
954 const absl::Status manifest_status =
955 is_object_stream_header
956 ? ValidateObjectStreamHeaderManifestConflicts(*rom, room_id,
958 : ValidateRoomHeaderManifestConflicts(*rom, room_id,
959 manifest_context->manifest);
960 if (!manifest_status.ok()) {
961 formatter.
AddField(
"status",
"error");
962 formatter.
AddField(
"error", std::string(manifest_status.message()));
964 return manifest_status;
967 if (is_object_stream_header) {
968 formatter.
AddField(
"allocator_capability",
"copy_on_write");
975 if (prop ==
"palette") {
976 room.
SetPalette(
static_cast<uint8_t
>(parsed_value & 0xFF));
977 }
else if (prop ==
"blockset") {
978 room.
SetBlockset(
static_cast<uint8_t
>(parsed_value & 0xFF));
979 }
else if (prop ==
"spriteset") {
980 room.
SetSpriteset(
static_cast<uint8_t
>(parsed_value & 0xFF));
981 }
else if (is_layout) {
982 room.
SetLayoutId(
static_cast<uint8_t
>(parsed_value));
983 }
else if (prop ==
"floor1") {
984 room.
set_floor1(
static_cast<uint8_t
>(parsed_value));
985 }
else if (prop ==
"floor2") {
986 room.
set_floor2(
static_cast<uint8_t
>(parsed_value));
987 }
else if (prop ==
"effect") {
989 }
else if (prop ==
"tag1") {
991 }
else if (prop ==
"tag2") {
993 }
else if (prop ==
"holewarp") {
994 room.
SetHolewarp(
static_cast<uint8_t
>(parsed_value & 0xFF));
996 const absl::Status property_status = absl::InvalidArgumentError(
997 absl::StrFormat(
"Unsupported property: %s", property));
998 formatter.
AddField(
"status",
"error");
999 formatter.
AddField(
"error", std::string(property_status.message()));
1001 return property_status;
1004 const absl::Status write_status =
1005 is_object_stream_header
1007 manifest_context.has_value() &&
1008 manifest_context->allocator_layout.has_value()
1009 ? &*manifest_context->allocator_layout
1012 if (!write_status.ok()) {
1013 formatter.
AddField(
"status",
"error");
1014 formatter.
AddField(
"write_error", std::string(write_status.message()));
1016 return write_status;
1019 if (parser.
HasFlag(
"mock-rom")) {
1021 formatter.
AddField(
"save_status",
"mock-rom-skipped");
1025 const absl::Status save_status = rom->
SaveToFile(save_settings);
1026 if (!save_status.ok()) {
1027 formatter.
AddField(
"status",
"error");
1028 formatter.
AddField(
"save_error", std::string(save_status.message()));
1033 formatter.
AddField(
"save_status",
"saved");
1035 formatter.
AddField(
"status",
"success");
1038 return absl::OkStatus();
1044 auto room_id_str = parser.
GetString(
"room").value();
1047 if (!ParseHexString(room_id_str, &room_id)) {
1048 return absl::InvalidArgumentError(
"Invalid room ID format. Must be hex.");
1052 formatter.
AddField(
"room_id", room_id);
1066 int header_pointer_pc =
SnesToPc(header_pointer);
1069 formatter.
AddHexField(
"snes_address", header_pointer, 6);
1070 formatter.
AddHexField(
"pc_address", header_pointer_pc, 6);
1074 int table_offset = header_pointer_pc + (room_id * 2);
1076 (rom->
data()[table_offset + 1] << 8) +
1077 rom->
data()[table_offset];
1078 int room_header_pc =
SnesToPc(room_header_addr);
1081 formatter.
AddHexField(
"table_offset_pc", table_offset, 6);
1082 formatter.
AddHexField(
"snes_address", room_header_addr, 6);
1083 formatter.
AddHexField(
"pc_address", room_header_pc, 6);
1088 for (
int i = 0; i < 14; ++i) {
1089 if (room_header_pc + i <
static_cast<int>(rom->
size())) {
1091 absl::StrFormat(
"0x%02X", rom->
data()[room_header_pc + i]));
1097 if (room_header_pc >= 0 &&
1098 room_header_pc + 13 <
static_cast<int>(rom->
size())) {
1099 uint8_t byte0 = rom->
data()[room_header_pc];
1100 uint8_t byte1 = rom->
data()[room_header_pc + 1];
1101 uint8_t byte2 = rom->
data()[room_header_pc + 2];
1102 uint8_t byte3 = rom->
data()[room_header_pc + 3];
1105 formatter.
AddField(
"bg2", (byte0 >> 5) & 0x07);
1106 formatter.
AddField(
"collision", (byte0 >> 2) & 0x07);
1107 formatter.
AddField(
"is_light", (byte0 & 0x01) == 1);
1110 formatter.
AddField(
"palette", byte1);
1111 formatter.
AddField(
"blockset", byte2);
1112 formatter.
AddField(
"spriteset", byte3);
1113 formatter.
AddField(
"effect", rom->
data()[room_header_pc + 4]);
1114 formatter.
AddField(
"tag1", rom->
data()[room_header_pc + 5]);
1115 formatter.
AddField(
"tag2", rom->
data()[room_header_pc + 6]);
1116 formatter.
AddField(
"holewarp", rom->
data()[room_header_pc + 9]);
1117 formatter.
AddField(
"stair1_room", rom->
data()[room_header_pc + 10]);
1118 formatter.
AddField(
"stair2_room", rom->
data()[room_header_pc + 11]);
1119 formatter.
AddField(
"stair3_room", rom->
data()[room_header_pc + 12]);
1120 formatter.
AddField(
"stair4_room", rom->
data()[room_header_pc + 13]);
1123 formatter.
AddHexField(
"holewarp_destination_room",
1125 room_id, rom->
data()[room_header_pc + 9]),
1127 for (
int slot = 0; slot < 4; ++slot) {
1129 absl::StrFormat(
"stair%d_destination_room", slot + 1),
1131 room_id, rom->
data()[room_header_pc + 10 + slot]),
1136 formatter.
AddField(
"error",
"Room header address out of range");
1140 return absl::OkStatus();
1150 auto switch_str = parser.
GetString(
"promote-switch");
1151 if (switch_str.has_value()) {
1152 for (absl::string_view pair :
1153 absl::StrSplit(switch_str.value(),
' ', absl::SkipEmpty())) {
1154 std::vector<std::string> coords =
1155 absl::StrSplit(pair,
',', absl::SkipEmpty());
1156 if (coords.size() == 2) {
1158 if (ParseHexString(coords[0], &sx) && ParseHexString(coords[1], &sy)) {
1165 bool do_write = parser.
HasFlag(
"write");
1166 bool do_preserve_stops = parser.
HasFlag(
"preserve-stops");
1167 bool do_visualize = parser.
HasFlag(
"visualize");
1170 std::vector<int> room_ids;
1171 auto rooms_arg = parser.
GetString(
"rooms");
1172 auto room_arg = parser.
GetString(
"room");
1174 if (rooms_arg.has_value()) {
1176 for (absl::string_view token :
1177 absl::StrSplit(rooms_arg.value(),
',', absl::SkipEmpty())) {
1179 std::string token_str(token);
1180 if (!ParseHexString(token_str, &rid)) {
1181 return absl::InvalidArgumentError(absl::StrFormat(
1182 "Invalid room ID '%s' in --rooms list. Must be hex.", token_str));
1184 room_ids.push_back(rid);
1186 if (room_ids.empty()) {
1187 return absl::InvalidArgumentError(
"--rooms list is empty.");
1189 }
else if (room_arg.has_value()) {
1192 if (!ParseHexString(room_arg.value(), &rid)) {
1193 return absl::InvalidArgumentError(
"Invalid room ID format. Must be hex.");
1195 room_ids.push_back(rid);
1197 return absl::InvalidArgumentError(
"Either --room or --rooms is required.");
1200 bool is_batch = room_ids.size() > 1;
1201 std::unique_ptr<ScopedRomTransaction> transaction;
1203 transaction = std::make_unique<ScopedRomTransaction>(*rom);
1208 formatter.
BeginObject(
"Batch Track Collision Generation");
1209 formatter.
AddField(
"mode", do_write ?
"write" :
"dry-run");
1210 formatter.
AddField(
"room_count",
static_cast<int>(room_ids.size()));
1212 int total_tiles = 0;
1213 int total_stops = 0;
1214 int total_corners = 0;
1215 int total_switches = 0;
1216 int rooms_succeeded = 0;
1219 for (
int room_id : room_ids) {
1228 formatter.
AddField(
"error", std::string(result.status().message()));
1230 return absl::InternalError(
1231 absl::StrFormat(
"Generation failed for room 0x%03X: %s", room_id,
1232 result.status().message()));
1235 if (do_preserve_stops && do_write) {
1237 if (existing.ok() && existing->has_data) {
1238 MergeStopTiles(*existing, result->collision_map);
1244 formatter.
AddField(
"tiles_generated", result->tiles_generated);
1245 formatter.
AddField(
"stop_count", result->stop_count);
1246 formatter.
AddField(
"corner_count", result->corner_count);
1247 formatter.
AddField(
"switch_count", result->switch_count);
1248 if (do_preserve_stops) {
1249 formatter.
AddField(
"stops_preserved",
true);
1253 formatter.
AddField(
"visualization", result->ascii_visualization);
1259 if (!write_status.ok()) {
1262 std::string(write_status.message()));
1266 return absl::Status(
1267 write_status.code(),
1268 absl::StrFormat(
"Write failed for room 0x%03X: %s", room_id,
1269 write_status.message()));
1271 formatter.
AddField(
"write_status",
"success");
1274 total_tiles += result->tiles_generated;
1275 total_stops += result->stop_count;
1276 total_corners += result->corner_count;
1277 total_switches += result->switch_count;
1286 auto save_status = SaveTrackCollisionRom(rom, parser, formatter);
1287 if (!save_status.ok()) {
1291 transaction->Commit();
1296 formatter.
AddField(
"rooms_succeeded", rooms_succeeded);
1297 formatter.
AddField(
"tiles_generated", total_tiles);
1298 formatter.
AddField(
"stop_count", total_stops);
1299 formatter.
AddField(
"corner_count", total_corners);
1300 formatter.
AddField(
"switch_count", total_switches);
1306 int room_id = room_ids[0];
1313 return result.status();
1316 if (do_preserve_stops && do_write) {
1318 if (existing.ok() && existing->has_data) {
1319 MergeStopTiles(*existing, result->collision_map);
1323 formatter.
BeginObject(
"Track Collision Generation");
1325 formatter.
AddField(
"tiles_generated", result->tiles_generated);
1326 formatter.
AddField(
"stop_count", result->stop_count);
1327 formatter.
AddField(
"corner_count", result->corner_count);
1328 formatter.
AddField(
"switch_count", result->switch_count);
1329 formatter.
AddField(
"mode", do_write ?
"write" :
"dry-run");
1330 if (do_preserve_stops) {
1331 formatter.
AddField(
"stops_preserved",
true);
1334 if (do_visualize || !do_write) {
1335 formatter.
AddField(
"visualization", result->ascii_visualization);
1341 if (!write_status.ok()) {
1342 formatter.
AddField(
"write_error", std::string(write_status.message()));
1344 return write_status;
1346 formatter.
AddField(
"write_status",
"success");
1347 auto save_status = SaveTrackCollisionRom(rom, parser, formatter);
1348 if (!save_status.ok()) {
1352 transaction->Commit();
1359 return absl::OkStatus();
The Rom class is used to load, save, and modify Rom data. This is a generic SNES ROM container and do...
absl::StatusOr< uint8_t > ReadByte(int offset) const
absl::Status SaveToFile(const SaveSettings &settings)
absl::StatusOr< uint16_t > ReadWord(int offset) const
absl::StatusOr< uint32_t > ReadLong(int offset) const
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
absl::Status Execute(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
Execute the command business logic.
Utility for parsing common CLI argument patterns.
std::optional< std::string > GetString(const std::string &name) const
Parse a named argument (e.g., –format=json or –format json)
bool HasFlag(const std::string &name) const
Check if a flag is present.
Loads and queries the hack manifest JSON for yaze-ASM integration.
const DungeonStreamLayout * GetDungeonStreamLayout(DungeonStreamType stream) const
Get an explicitly declared dungeon stream layout.
absl::Status LoadFromFile(const std::string &filepath)
Load manifest from a JSON file path.
std::vector< WriteConflict > AnalyzePcWriteRanges(const std::vector< std::pair< uint32_t, uint32_t > > &pc_ranges) const
Analyze a set of PC-offset ranges for write conflicts.
Core dungeon editing system.
absl::StatusOr< Room > GetRoom(int room_id)
static absl::StatusOr< DungeonSpawnPoint > Load(const Rom &rom, int spawn_id)
absl::Status ImportOracleSpriteRegistry(const std::string &csv_content)
Import sprite labels from Oracle of Secrets registry.csv format.
Dungeon Room Entrance or Spawn Point.
uint8_t camera_boundary_fw_
uint8_t camera_boundary_qe_
uint8_t camera_boundary_fe_
uint8_t camera_boundary_fs_
uint8_t camera_boundary_qs_
uint8_t camera_boundary_qw_
uint16_t camera_trigger_y_
uint8_t camera_boundary_fn_
uint16_t camera_trigger_x_
uint8_t camera_boundary_qn_
const absl::Status & load_status() const
const std::vector< RoomObject > & GetObjects() const
absl::Status LoadLayout(int layout_id, util::StopToken stop_token={})
static int DetermineObjectType(uint8_t b1, uint8_t b3)
const std::vector< chest_data > & GetChests() const
void set_floor2(uint8_t value)
int staircase_destination_room(int index) const
void set_floor1(uint8_t value)
void SetTag2(TagKey tag2)
const std::vector< Door > & GetDoors() const
void SetLayoutId(uint8_t id)
void SetHolewarp(uint8_t hw)
const std::vector< staircase > & GetStairs() const
absl::Status SaveRoomHeader()
void SetEffect(EffectKey effect)
absl::Status SaveObjectStreamHeader(const DungeonStreamLayout *layout=nullptr)
uint8_t spriteset() const
void SetTag1(TagKey tag1)
const std::vector< zelda3::Sprite > & GetSprites() const
const std::vector< RoomObject > & GetTileObjects() const
void SetSpriteset(uint8_t ss)
void SetBlockset(uint8_t bs)
uint8_t staircase_plane(int index) const
void SetPalette(uint8_t pal)
uint8_t layout_id() const
bool has_custom_collision() const
#define ASSIGN_OR_RETURN(type_variable_name, expression)
absl::Status MaybeLoadSpriteRegistry(const resources::ArgumentParser &parser)
absl::Status ValidateManifestWriteRanges(const core::HackManifest &manifest, const std::vector< std::pair< uint32_t, uint32_t > > &ranges)
absl::StatusOr< std::vector< std::pair< uint32_t, uint32_t > > > CollectRoomHeaderWriteRanges(const Rom &rom, int room_id)
absl::Status ValidateRoomHeaderManifestConflicts(const Rom &rom, int room_id, const core::HackManifest &manifest)
bool IsStopTile(uint8_t v)
constexpr uint8_t kStopTileMin
constexpr uint8_t kStopTileMax
absl::Status ValidateObjectStreamHeaderManifestConflicts(const Rom &rom, int room_id, const RoomPropertyManifestContext &context)
bool IsEncodedRoomStreamObject(const zelda3::RoomObject &object)
absl::Status SaveTrackCollisionRom(Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter)
absl::StatusOr< std::optional< RoomPropertyManifestContext > > LoadRoomPropertyManifestContext(const resources::ArgumentParser &parser, bool require_object_allocator)
void MergeStopTiles(const zelda3::CustomCollisionMap &existing, zelda3::CustomCollisionMap &generated)
absl::Status WriteDungeonSpawnPointReport(Rom *rom, int spawn_id, resources::OutputFormatter &formatter, std::string_view object_title)
absl::StatusOr< zelda3::DungeonStreamLayout > ToDungeonStreamAllocatorLayout(DungeonStreamType stream_type, const DungeonStreamLayout &manifest_layout)
bool ParseHexString(absl::string_view str, uint64_t *out)
constexpr int kDoorPointers
absl::Status WriteTrackCollision(Rom *rom, int room_id, const CustomCollisionMap &map)
const char * GetItemReceiptLabelSource(uint8_t id, const ResourceLabelProvider::ProjectLabels *project_labels)
constexpr int ResolveHeaderDestinationRoom(int source_room_id, uint8_t header_byte)
Room LoadRoomHeaderFromRom(Rom *rom, int room_id)
std::string GetRoomLabel(int id)
Convenience function to get a room label.
constexpr int kMessagesIdDungeon
std::string GetItemReceiptLabel(uint8_t id, const ResourceLabelProvider::ProjectLabels *project_labels)
constexpr int kNumRegularDungeonEntrances
absl::StatusOr< CustomCollisionMap > LoadCustomCollisionMap(Rom *rom, int room_id)
Room LoadRoomFromRom(Rom *rom, int room_id)
constexpr int kNumDungeonSpawnPoints
std::string GetObjectName(int object_id)
constexpr int kNumberOfRooms
constexpr int kRoomHeaderPointer
constexpr int kRoomHeaderPointerBank
RoomCollisionInput MakeRoomCollisionInput(const Room &room, const RoomTilemaps &tilemaps)
std::vector< StaircaseSlotResolution > ResolveVanillaStaircaseSlots(const Rom &rom, const RoomCollisionInput &input, const UnderworldRoomLoadState &state)
const char * ResolveSpriteName(uint16_t id)
absl::StatusOr< TrackCollisionResult > GenerateTrackCollision(Room *room, const GeneratorOptions &options)
ResourceLabelProvider & GetResourceLabels()
Get the global ResourceLabelProvider instance.
constexpr int kRoomObjectPointer
uint32_t SnesToPc(uint32_t addr) noexcept
#define RETURN_IF_ERROR(expr)
std::optional< zelda3::DungeonStreamLayout > allocator_layout
core::HackManifest manifest
std::array< uint8_t, 64 *64 > tiles
std::vector< std::pair< int, int > > switch_promotions