dionmoustos/Pokemon-Firered
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add support for local IDs in map.json

Browse Source
This commit is contained in:
GriffinR
2024-10-14 22:44:16 -04:00
parent bb50006fc9
commit a2e408cf4e
5 changed files with 145 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Makefile
+2 -1
View File
@@ -255,7 +255,8 @@ generated: $(AUTO_GEN_TARGETS)
# NOTE: Tools must have been built prior (FIXME) # NOTE: Tools must have been built prior (FIXME)
generated: tools $(AUTO_GEN_TARGETS) generated: tools $(AUTO_GEN_TARGETS)
clean-generated: clean-generated:
-rm -f $(AUTO_GEN_TARGETS) @rm -f $(AUTO_GEN_TARGETS)
@echo "rm -f <AUTO_GEN_TARGETS>"
ifeq ($(MODERN),0) ifeq ($(MODERN),0)
$(C_BUILDDIR)/agb_flash.o: CFLAGS := -O -mthumb-interwork $(C_BUILDDIR)/agb_flash.o: CFLAGS := -O -mthumb-interwork
include/constants/.gitignore
+1
View File
@@ -1,3 +1,4 @@
# Will be moved to build/ eventually # Will be moved to build/ eventually
map_groups.h map_groups.h
layouts.h layouts.h
map_event_ids.h
include/constants/event_objects.h
+15 -3
View File
@@ -1,6 +1,8 @@
#ifndef GUARD_CONSTANTS_EVENT_OBJECTS_H #ifndef GUARD_CONSTANTS_EVENT_OBJECTS_H
#define GUARD_CONSTANTS_EVENT_OBJECTS_H #define GUARD_CONSTANTS_EVENT_OBJECTS_H
#include "constants/map_event_ids.h"
#define OBJ_EVENT_GFX_RED_NORMAL 0 #define OBJ_EVENT_GFX_RED_NORMAL 0
#define OBJ_EVENT_GFX_RED_BIKE 1 #define OBJ_EVENT_GFX_RED_BIKE 1
#define OBJ_EVENT_GFX_RED_SURF 2 #define OBJ_EVENT_GFX_RED_SURF 2
@@ -192,9 +194,19 @@
#define OBJ_KIND_NORMAL 0 #define OBJ_KIND_NORMAL 0
#define OBJ_KIND_CLONE 255 #define OBJ_KIND_CLONE 255
// Special object event local ids // Each object event template gets an ID that can be used to refer to it in scripts and elsewhere.
#define OBJ_EVENT_ID_PLAYER 0xFF // This is referred to as the "local id" (and it's really just 1 + its index in the templates array).
#define OBJ_EVENT_ID_CAMERA 0x7F // There are a few special IDs reserved for objects that don't have templates in the map data -- one for the player
// in regular offline play, five for linked players while playing Berry Blender, and one for an invisible object that
// can be spawned for the camera to track instead of the player. Additionally, the value 0 is reserved as an "empty" indicator.
#define LOCALID_NONE 0
#define LOCALID_CAMERA 127
#define LOCALID_BERRY_BLENDER_PLAYER_END 240 // This will use 5 (MAX_RFU_PLAYERS) IDs ending at 240, i.e. 236-240
#define LOCALID_PLAYER 255
// Aliases for old names. "object event id" normally refers to an index into gObjectEvents, which these are not.
#define OBJ_EVENT_ID_CAMERA LOCALID_CAMERA
#define OBJ_EVENT_ID_PLAYER LOCALID_PLAYER
// Object event local ids referenced in C files // Object event local ids referenced in C files
#define LOCALID_UNION_ROOM_PLAYER_4 2 #define LOCALID_UNION_ROOM_PLAYER_4 2
map_data_rules.mk
+6 -2
View File
@@ -11,6 +11,7 @@ INCLUDECONSTS_OUTDIR := include/constants
AUTO_GEN_TARGETS += $(INCLUDECONSTS_OUTDIR)/map_groups.h AUTO_GEN_TARGETS += $(INCLUDECONSTS_OUTDIR)/map_groups.h
AUTO_GEN_TARGETS += $(INCLUDECONSTS_OUTDIR)/layouts.h AUTO_GEN_TARGETS += $(INCLUDECONSTS_OUTDIR)/layouts.h
AUTO_GEN_TARGETS += $(INCLUDECONSTS_OUTDIR)/map_event_ids.h
AUTO_GEN_TARGETS += $(DATA_SRC_SUBDIR)/heal_locations.h AUTO_GEN_TARGETS += $(DATA_SRC_SUBDIR)/heal_locations.h
MAP_DIRS := $(dir $(wildcard $(MAPS_DIR)/*/map.json)) MAP_DIRS := $(dir $(wildcard $(MAPS_DIR)/*/map.json))
@@ -33,5 +34,8 @@ $(MAPS_OUTDIR)/connections.inc $(MAPS_OUTDIR)/groups.inc $(MAPS_OUTDIR)/events.i
$(LAYOUTS_OUTDIR)/layouts.inc $(LAYOUTS_OUTDIR)/layouts_table.inc $(INCLUDECONSTS_OUTDIR)/layouts.h: $(LAYOUTS_DIR)/layouts.json $(LAYOUTS_OUTDIR)/layouts.inc $(LAYOUTS_OUTDIR)/layouts_table.inc $(INCLUDECONSTS_OUTDIR)/layouts.h: $(LAYOUTS_DIR)/layouts.json
$(MAPJSON) layouts firered $< $(LAYOUTS_OUTDIR) $(INCLUDECONSTS_OUTDIR) $(MAPJSON) layouts firered $< $(LAYOUTS_OUTDIR) $(INCLUDECONSTS_OUTDIR)
$(DATA_SRC_SUBDIR)/heal_locations.h: $(MAP_JSONS) # Generate files that depends on data that's distributed across the map.json files.
@$(MAPJSON) heal_locations firered $^ $(DATA_SRC_SUBDIR)/heal_locations.h # There's a lot of map.json files, so we print an abbreviated output with echo.
$(INCLUDECONSTS_OUTDIR)/map_event_ids.h $(DATA_SRC_SUBDIR)/heal_locations.h: $(MAP_JSONS)
@$(MAPJSON) event_constants firered $^ $(INCLUDECONSTS_OUTDIR)/map_event_ids.h $(DATA_SRC_SUBDIR)/heal_locations.h
@echo "$(MAPJSON) event_constants firered <MAP_JSONS> $(INCLUDECONSTS_OUTDIR)/map_event_ids.h $(DATA_SRC_SUBDIR)/heal_locations.h"
tools/mapjson/mapjson.cpp
+103 -55
View File
@@ -96,6 +96,29 @@ string json_to_string(const Json &data, const string &field = "", bool silent =
return output; return output;
} }
string get_generated_warning(const string &filename, bool isAsm) {
string comment = isAsm ? "@" : "//";
ostringstream warning;
warning << comment << "\n"
<< comment << " DO NOT MODIFY THIS FILE! It is auto-generated from " << filename << "\n"
<< comment << "\n\n";
return warning.str();
}
string get_include_guard_start(const string &name) {
ostringstream guard;
guard << "#ifndef GUARD_" << name << "_H\n"
<< "#define GUARD_" << name << "_H\n\n";
return guard.str();
}
string get_include_guard_end(const string &name) {
ostringstream guard;
guard << "#endif // GUARD_" << name << "_H\n";
return guard.str();
}
string generate_map_header_text(Json map_data, Json layouts_data) { string generate_map_header_text(Json map_data, Json layouts_data) {
string map_layout_id = json_to_string(map_data, "layout"); string map_layout_id = json_to_string(map_data, "layout");
@@ -114,8 +137,7 @@ string generate_map_header_text(Json map_data, Json layouts_data) {
ostringstream text; ostringstream text;
string mapName = json_to_string(map_data, "name"); string mapName = json_to_string(map_data, "name");
text << get_generated_warning("data/maps/" + mapName + "/map.json", true);
text << "@\n@ DO NOT MODIFY THIS FILE! It is auto-generated from data/maps/" << mapName << "/map.json\n@\n\n";
text << mapName << ":\n" text << mapName << ":\n"
<< "\t.4byte " << json_to_string(layout, "name") << "\n"; << "\t.4byte " << json_to_string(layout, "name") << "\n";
@@ -167,12 +189,10 @@ string generate_map_connections_text(Json map_data) {
if (map_data["connections"] == Json()) if (map_data["connections"] == Json())
return string("\n"); return string("\n");
ostringstream text;
string mapName = json_to_string(map_data, "name"); string mapName = json_to_string(map_data, "name");
text << "@\n@ DO NOT MODIFY THIS FILE! It is auto-generated from data/maps/" << mapName << "/map.json\n@\n\n"; ostringstream text;
text << get_generated_warning("data/maps/" + mapName + "/map.json", true);
text << mapName << "_MapConnectionsList:\n"; text << mapName << "_MapConnectionsList:\n";
for (auto &connection : map_data["connections"].array_items()) { for (auto &connection : map_data["connections"].array_items()) {
@@ -193,11 +213,11 @@ string generate_map_events_text(Json map_data) {
if (map_data.object_items().find("shared_events_map") != map_data.object_items().end()) if (map_data.object_items().find("shared_events_map") != map_data.object_items().end())
return string("\n"); return string("\n");
ostringstream text;
string mapName = json_to_string(map_data, "name"); string mapName = json_to_string(map_data, "name");
text << "@\n@ DO NOT MODIFY THIS FILE! It is auto-generated from data/maps/" << mapName << "/map.json\n@\n\n\t.align 2\n\n"; ostringstream text;
text << get_generated_warning("data/maps/" + mapName + "/map.json", true);
text << "\t.align 2\n\n";
string objects_label, warps_label, coords_label, bgs_label; string objects_label, warps_label, coords_label, bgs_label;
@@ -371,10 +391,16 @@ void process_map(string map_filepath, string layouts_filepath, string output_dir
write_text_file(out_dir + "connections.inc", connections_text); write_text_file(out_dir + "connections.inc", connections_text);
} }
void process_heal_locations(const vector<string> &map_filepaths, string output_file) { void process_event_constants(const vector<string> &map_filepaths, string output_ids_file, string output_heal_locations_file) {
ostringstream heal_locations_text; string warning = get_generated_warning("data/maps/*/map.json", false);
ostringstream respawn_maps_text;
ostringstream respawn_npcs_text; ostringstream heal_locations_arr_text;
ostringstream respawn_maps_arr_text;
ostringstream respawn_npcs_arr_text;
string guard_name = "CONSTANTS_MAP_EVENT_IDS";
ostringstream ids_file_text;
ids_file_text << get_include_guard_start(guard_name) << warning;
// Get heal location data from each map // Get heal location data from each map
for (const string &filepath : map_filepaths) { for (const string &filepath : map_filepaths) {
@@ -382,19 +408,39 @@ void process_heal_locations(const vector<string> &map_filepaths, string output_f
string map_json_text = read_text_file(filepath); string map_json_text = read_text_file(filepath);
Json map_data = Json::parse(map_json_text, err); Json map_data = Json::parse(map_json_text, err);
if (map_data == Json()) if (map_data == Json())
FATAL_ERROR("Failed to read '%s' while generating '%s': %s\n", filepath.c_str(), output_file.c_str(), err.c_str()); FATAL_ERROR("Failed to read '%s' while generating map event constants: %s\n", filepath.c_str(), err.c_str());
// Skip if no heal locations present
if (map_data.object_items().find("heal_locations") == map_data.object_items().end() || map_data["heal_locations"].array_items().size() <= 0)
continue;
string map_id = json_to_string(map_data, "id"); string map_id = json_to_string(map_data, "id");
// Get IDs from the object/clone events.
ostringstream map_ids_text;
auto obj_events = map_data["object_events"].array_items();
for (unsigned int i = 0; i < obj_events.size(); i++) {
auto obj_event = obj_events[i];
if (obj_event.object_items().find("local_id") != obj_event.object_items().end())
map_ids_text << "#define " << json_to_string(obj_event, "local_id") << " " << i + 1 << "\n";
}
// Get IDs from the warp events.
auto warp_events = map_data["warp_events"].array_items();
for (unsigned int i = 0; i < warp_events.size(); i++) {
auto warp_event = warp_events[i];
if (warp_event.object_items().find("warp_id") != warp_event.object_items().end())
map_ids_text << "#define " << json_to_string(warp_event, "warp_id") << " " << i << "\n";
}
// Only output if we found any IDs
string temp = map_ids_text.str();
if (!temp.empty()) {
ids_file_text << "// " << map_id << "\n" << temp << "\n";
}
// Process heal locations. Maps are not required to have a heal locations array, so we check if it exists first.
if (map_data.object_items().find("heal_locations") != map_data.object_items().end()) {
for (auto &heal_location : map_data["heal_locations"].array_items()) { for (auto &heal_location : map_data["heal_locations"].array_items()) {
// Each array is indexed with the heal location's ID, e.g. '[HEAL_LOCATION_NAME - 1] = ' // Each array is indexed with the heal location's ID, e.g. '[HEAL_LOCATION_NAME - 1] = '
string index_text = "\t[" + json_to_string(heal_location, "id") + " - 1] ="; string index_text = "\t[" + json_to_string(heal_location, "id") + " - 1] =";
// Add element to main heal locations array // Add element to main heal locations array
heal_locations_text << index_text << "\n\t{\n" heal_locations_arr_text << index_text << "\n\t{\n"
<< "\t\t.mapGroup = MAP_GROUP(" << map_id << "),\n" << "\t\t.mapGroup = MAP_GROUP(" << map_id << "),\n"
<< "\t\t.mapNum = MAP_NUM(" << map_id << "),\n" << "\t\t.mapNum = MAP_NUM(" << map_id << "),\n"
<< "\t\t.x = " << json_to_string(heal_location, "x") << ",\n" << "\t\t.x = " << json_to_string(heal_location, "x") << ",\n"
@@ -404,7 +450,7 @@ void process_heal_locations(const vector<string> &map_filepaths, string output_f
// Add element to respawn map array (if field is present) // Add element to respawn map array (if field is present)
if (heal_location.object_items().find("respawn_map") != heal_location.object_items().end()) { if (heal_location.object_items().find("respawn_map") != heal_location.object_items().end()) {
string respawn_map_id = json_to_string(heal_location, "respawn_map"); string respawn_map_id = json_to_string(heal_location, "respawn_map");
respawn_maps_text << index_text << " {" respawn_maps_arr_text << index_text << " {"
<< "MAP_GROUP(" << respawn_map_id << "), " << "MAP_GROUP(" << respawn_map_id << "), "
<< "MAP_NUM(" << respawn_map_id << ")" << "MAP_NUM(" << respawn_map_id << ")"
<< "},\n"; << "},\n";
@@ -412,32 +458,39 @@ void process_heal_locations(const vector<string> &map_filepaths, string output_f
// Add element to respawn NPC array (if field is present) // Add element to respawn NPC array (if field is present)
if (heal_location.object_items().find("respawn_npc") != heal_location.object_items().end()) { if (heal_location.object_items().find("respawn_npc") != heal_location.object_items().end()) {
respawn_npcs_text << index_text << " " << json_to_string(heal_location, "respawn_npc") << ",\n"; respawn_npcs_arr_text << index_text << " " << json_to_string(heal_location, "respawn_npc") << ",\n";
}
} }
} }
} }
ostringstream text; // Write event ids file
text << "//\n// DO NOT MODIFY THIS FILE! It is auto-generated from data/maps/*/map.json\n//\n\n"; ids_file_text << get_include_guard_end(guard_name);
write_text_file(output_ids_file, ids_file_text.str());
string arr_body = heal_locations_text.str();
text << "static const struct HealLocation sHealLocations[] =\n{\n" << arr_body << "};\n\n";
arr_body = respawn_maps_text.str(); // Write heal locations data file
ostringstream heal_locations_file_text;
heal_locations_file_text << warning;
string arr_body = heal_locations_arr_text.str();
heal_locations_file_text << "static const struct HealLocation sHealLocations[] =\n{\n" << arr_body << "};\n\n";
arr_body = respawn_maps_arr_text.str();
if (!arr_body.empty()) if (!arr_body.empty())
text << "static const u16 sWhiteoutRespawnHealCenterMapIdxs[][2] =\n{\n" << arr_body << "};\n\n"; heal_locations_file_text << "static const u16 sWhiteoutRespawnHealCenterMapIdxs[][2] =\n{\n" << arr_body << "};\n\n";
arr_body = respawn_npcs_text.str(); arr_body = respawn_npcs_arr_text.str();
if (!arr_body.empty()) if (!arr_body.empty())
text << "static const u8 sWhiteoutRespawnHealerNpcIds[] =\n{\n" << arr_body << "};\n\n"; heal_locations_file_text << "static const u8 sWhiteoutRespawnHealerNpcIds[] =\n{\n" << arr_body << "};\n\n";
write_text_file(output_file, text.str()); write_text_file(output_heal_locations_file, heal_locations_file_text.str());
} }
string generate_groups_text(Json groups_data) { string generate_groups_text(Json groups_data) {
ostringstream text; ostringstream text;
text << "@\n@ DO NOT MODIFY THIS FILE! It is auto-generated from data/maps/map_groups.json\n@\n\n"; text << get_generated_warning("data/maps/map_groups.json", true);
for (auto &key : groups_data["group_order"].array_items()) { for (auto &key : groups_data["group_order"].array_items()) {
string group = json_to_string(key); string group = json_to_string(key);
@@ -478,7 +531,7 @@ string generate_connections_text(Json groups_data, string include_path) {
ostringstream text; ostringstream text;
text << "@\n@ DO NOT MODIFY THIS FILE! It is auto-generated from data/maps/map_groups.json\n@\n\n"; text << get_generated_warning("data/maps/map_groups.json", true);
for (Json map_name : map_names) for (Json map_name : map_names)
text << "\t.include \"" << include_path << "/" << json_to_string(map_name) << "/connections.inc\"\n"; text << "\t.include \"" << include_path << "/" << json_to_string(map_name) << "/connections.inc\"\n";
@@ -495,7 +548,7 @@ string generate_headers_text(Json groups_data, string include_path) {
ostringstream text; ostringstream text;
text << "@\n@ DO NOT MODIFY THIS FILE! It is auto-generated from data/maps/map_groups.json\n@\n\n"; text << get_generated_warning("data/maps/map_groups.json", true);
for (string map_name : map_names) for (string map_name : map_names)
text << "\t.include \"" << include_path << "/" << map_name << "/header.inc\"\n"; text << "\t.include \"" << include_path << "/" << map_name << "/header.inc\"\n";
@@ -512,7 +565,7 @@ string generate_events_text(Json groups_data, string include_path) {
ostringstream text; ostringstream text;
text << "@\n@ DO NOT MODIFY THIS FILE! It is auto-generated from " << include_path << "/map_groups.json\n@\n\n"; text << get_generated_warning(include_path + "/map_groups.json", true);
for (string map_name : map_names) for (string map_name : map_names)
text << "\t.include \"" << include_path << "/" << map_name << "/events.inc\"\n"; text << "\t.include \"" << include_path << "/" << map_name << "/events.inc\"\n";
@@ -523,12 +576,9 @@ string generate_events_text(Json groups_data, string include_path) {
string generate_map_constants_text(string groups_filepath, Json groups_data) { string generate_map_constants_text(string groups_filepath, Json groups_data) {
string file_dir = file_parent(groups_filepath) + sep; string file_dir = file_parent(groups_filepath) + sep;
string guard_name = "CONSTANTS_MAP_GROUPS";
ostringstream text; ostringstream text;
text << get_include_guard_start(guard_name) << get_generated_warning("data/maps/map_groups.json", false);
text << "#ifndef GUARD_CONSTANTS_MAP_GROUPS_H\n"
<< "#define GUARD_CONSTANTS_MAP_GROUPS_H\n\n";
text << "//\n// DO NOT MODIFY THIS FILE! It is auto-generated from data/maps/map_groups.json\n//\n\n";
int group_num = 0; int group_num = 0;
@@ -561,7 +611,7 @@ string generate_map_constants_text(string groups_filepath, Json groups_data) {
} }
text << "#define MAP_GROUPS_COUNT " << group_num << "\n\n"; text << "#define MAP_GROUPS_COUNT " << group_num << "\n\n";
text << "#endif // GUARD_CONSTANTS_MAP_GROUPS_H\n"; text << get_include_guard_end(guard_name);
return text.str(); return text.str();
} }
@@ -593,7 +643,7 @@ void process_groups(string groups_filepath, string output_asm, string output_c)
string generate_layout_headers_text(Json layouts_data) { string generate_layout_headers_text(Json layouts_data) {
ostringstream text; ostringstream text;
text << "@\n@ DO NOT MODIFY THIS FILE! It is auto-generated from data/layouts/layouts.json\n@\n\n"; text << get_generated_warning("data/layouts/layouts.json", true);
for (auto &layout : layouts_data["layouts"].array_items()) { for (auto &layout : layouts_data["layouts"].array_items()) {
if (layout == Json::object()) continue; if (layout == Json::object()) continue;
@@ -626,7 +676,7 @@ string generate_layout_headers_text(Json layouts_data) {
string generate_layouts_table_text(Json layouts_data) { string generate_layouts_table_text(Json layouts_data) {
ostringstream text; ostringstream text;
text << "@\n@ DO NOT MODIFY THIS FILE! It is auto-generated from data/layouts/layouts.json\n@\n\n"; text << get_generated_warning("data/layouts/layouts.json", true);
text << "\t.align 2\n" text << "\t.align 2\n"
<< json_to_string(layouts_data, "layouts_table_label") << "::\n"; << json_to_string(layouts_data, "layouts_table_label") << "::\n";
@@ -641,12 +691,9 @@ string generate_layouts_table_text(Json layouts_data) {
} }
string generate_layouts_constants_text(Json layouts_data) { string generate_layouts_constants_text(Json layouts_data) {
string guard_name = "CONSTANTS_LAYOUTS";
ostringstream text; ostringstream text;
text << get_include_guard_start(guard_name) << get_generated_warning("data/layouts/layouts.json", false);
text << "#ifndef GUARD_CONSTANTS_LAYOUTS_H\n"
<< "#define GUARD_CONSTANTS_LAYOUTS_H\n\n";
text << "//\n// DO NOT MODIFY THIS FILE! It is auto-generated from data/layouts/layouts.json\n//\n\n";
int i = 1; int i = 1;
for (auto &layout : layouts_data["layouts"].array_items()) { for (auto &layout : layouts_data["layouts"].array_items()) {
@@ -655,7 +702,7 @@ string generate_layouts_constants_text(Json layouts_data) {
i++; i++;
} }
text << "\n#endif // GUARD_CONSTANTS_LAYOUTS_H\n"; text << get_include_guard_end(guard_name);
return text.str(); return text.str();
} }
@@ -723,24 +770,25 @@ int main(int argc, char *argv[]) {
process_layouts(filepath, output_asm, output_c); process_layouts(filepath, output_asm, output_c);
} }
else if (mode == "heal_locations") { else if (mode == "event_constants") {
if (argc < 5) if (argc < 6)
FATAL_ERROR("USAGE: mapjson heal_locations <game-version> <map_file> [additional_map_files] <output_file>"); FATAL_ERROR("USAGE: mapjson event_constants <game-version> <map_file> [additional_map_files] <output_ids_file> <output_heal_locations_file>");
infer_separator(argv[3]); infer_separator(argv[3]);
vector<string> filepaths; vector<string> filepaths;
const int firstMapFileArg = 3; const int firstMapFileArg = 3;
const int lastMapFileArg = argc - 2; const int lastMapFileArg = argc - 3;
for (int i = firstMapFileArg; i <= lastMapFileArg; i++) { for (int i = firstMapFileArg; i <= lastMapFileArg; i++) {
filepaths.push_back(argv[i]); filepaths.push_back(argv[i]);
} }
string output_file(argv[argc - 1]); string output_ids_file(argv[argc - 2]);
string output_heal_locations_file(argv[argc - 1]);
process_heal_locations(filepaths, output_file); process_event_constants(filepaths, output_ids_file, output_heal_locations_file);
} }
else { else {
FATAL_ERROR("ERROR: <mode> must be 'layouts', 'map', 'heal_locations', or 'groups'.\n"); FATAL_ERROR("ERROR: <mode> must be 'layouts', 'map', 'event_constants', or 'groups'.\n");
} }
return 0; return 0;