combine maps-free and maps-quest into one directory

README.md

@@ -140,7 +140,7 @@ There are multiple PSO quest formats out there; newserv supports all of them. It
 1. *This is the default format. You can convert these to uncompressed format by running `newserv decompress-prs FILENAME.bin FILENAME.bind` (and similarly for .dat -> .datd)*
 2. *Similar to (1), to compress an uncompressed quest file: `newserv compress-prs FILENAME.bind FILENAME.bin` (and likewise for .datd -> .dat)*
 3. *Use the decode action to convert these quests to .bin/.dat format before putting them into the server's quests directory. If you know the encryption seed (serial number), pass it in as a hex string with the `--seed=` option. If you don't know the encryption seed, newserv will find it for you, which will likely take a long time.*
-4. *Episode 3 online quests don't go in the system/quests directory; they instead go in the system/ep3/maps-free or system/ep3/maps-quest directories. If you want an Episode 3 quest to be available for both online play and for downloading, the file must exist in both system/quests and in one of the map directories in system/ep3.*
+4. *Episode 3 online quests don't go in the system/quests directory; they instead go in the system/ep3/maps directory. If you want an Episode 3 quest to be available for both online play and for downloading, the file must exist in both system/quests and in system/ep3/maps (symbolic links are acceptable).*
 
 Episode 3 download quests consist only of a .bin file - there is no corresponding .dat file. Episode 3 download quest files may be named with the .mnm extension instead of .bin, since the format is the same as the standard map files (in system/ep3/). These files can be encoded in any of the formats described above, except .qst.
 
@@ -181,7 +181,7 @@ Episode 3 state and game data is stored in the system/ep3 directory. The files i
 * card-text.mnr: Compressed card text archive. Generally only used for debugging.
 * card-text.mnrd: Decompressed card text archive; same format as TextCardE.bin. Generally only used for debugging.
 * com-decks.json: COM decks used in tournaments. The default decks in this file come from logs from Sega's servers, so the file doesn't include every COM deck Sega ever made - the rest are probably lost to time.
-* maps-free/ and maps-quest/: Online free battle and quest maps (.mnm/.bin/.mnmd/.bind files). Free battle and quest files have exactly the same format; the only difference between the files in these directories is which section of the menu they will appear in on the client. newserv comes with all the original online and offline maps, including Story Mode quests. If you don't want the offline maps and quests to be playable online, delete the .bind files in both maps directories.
+* maps/: Online free battle and quest maps (.mnm/.bin/.mnmd/.bind files). newserv comes with all the original online and offline maps, including Story Mode quests. If you don't want the offline maps and quests to be playable online, delete the .bind files system/ep3/maps.
 * tournament-state.json: State of all active tournaments. This file is automatically written when any tournament changes state for any reason (e.g. a tournament is created/started/deleted or a match is resolved).
 
 There is no public editor for Episode 3 maps and quests, but the format is described fairly thoroughly in src/Episode3/DataIndexes.hh (see the MapDefinition structure). You'll need to use `newserv decompress-prs ...` to decompress .bin or .mnm files before editing them, but you don't need to compress the files again to use them - just put the .bind or .mnmd file in the maps directory and newserv will make it available.

src/Episode3/DataIndexes.cc

@@ -2201,49 +2201,42 @@ string CardIndex::normalize_card_name(const string& name) {
 }
 
 MapIndex::MapIndex(const string& directory) {
-  auto add_maps_from_dir = [&](const string& dir, bool is_quest) -> void {
-    for (const auto& filename : list_directory(dir)) {
-      try {
-        shared_ptr<MapEntry> entry;
+  for (const auto& filename : list_directory(directory)) {
+    try {
+      shared_ptr<MapEntry> entry;
 
-        if (ends_with(filename, ".mnmd") || ends_with(filename, ".bind")) {
-          entry.reset(new MapEntry(load_object_file<MapDefinition>(dir + "/" + filename), is_quest));
-        } else if (ends_with(filename, ".mnm") || ends_with(filename, ".bin")) {
-          entry.reset(new MapEntry(load_file(dir + "/" + filename), is_quest));
-        } else if (ends_with(filename, ".gci")) {
-          entry.reset(new MapEntry(Quest::decode_gci_file(dir + "/" + filename), is_quest));
-        } else if (ends_with(filename, ".dlq")) {
-          entry.reset(new MapEntry(Quest::decode_dlq_file(dir + "/" + filename), is_quest));
-        }
-
-        if (entry.get()) {
-          if (!this->maps.emplace(entry->map.map_number, entry).second) {
-            throw runtime_error("duplicate map number");
-          }
-          this->maps_by_name.emplace(entry->map.name, entry);
-          string name = entry->map.name;
-          static_game_data_log.info("Indexed Episode 3 %s %s (%08" PRIX32 "; %s)",
-              is_quest ? "online quest" : "free battle map",
-              filename.c_str(), entry->map.map_number.load(), name.c_str());
-        }
-
-      } catch (const exception& e) {
-        static_game_data_log.warning("Failed to index Episode 3 map %s: %s",
-            filename.c_str(), e.what());
+      if (ends_with(filename, ".mnmd") || ends_with(filename, ".bind")) {
+        entry.reset(new MapEntry(load_object_file<MapDefinition>(directory + "/" + filename)));
+      } else if (ends_with(filename, ".mnm") || ends_with(filename, ".bin")) {
+        entry.reset(new MapEntry(load_file(directory + "/" + filename)));
+      } else if (ends_with(filename, ".gci")) {
+        entry.reset(new MapEntry(Quest::decode_gci_file(directory + "/" + filename)));
+      } else if (ends_with(filename, ".dlq")) {
+        entry.reset(new MapEntry(Quest::decode_dlq_file(directory + "/" + filename)));
       }
+
+      if (entry.get()) {
+        if (!this->maps.emplace(entry->map.map_number, entry).second) {
+          throw runtime_error("duplicate map number");
+        }
+        this->maps_by_name.emplace(entry->map.name, entry);
+        string name = entry->map.name;
+        static_game_data_log.info("Indexed Episode 3 %s %s (%08" PRIX32 "; %s)",
+            entry->map.is_quest() ? "online quest" : "free battle map",
+            filename.c_str(), entry->map.map_number.load(), name.c_str());
+      }
+
+    } catch (const exception& e) {
+      static_game_data_log.warning("Failed to index Episode 3 map %s: %s",
+          filename.c_str(), e.what());
     }
-  };
-  add_maps_from_dir(directory + "/maps-free", false);
-  add_maps_from_dir(directory + "/maps-quest", true);
+  }
 }
 
-MapIndex::MapEntry::MapEntry(const MapDefinition& map, bool is_quest)
-    : map(map),
-      is_quest(is_quest) {}
+MapIndex::MapEntry::MapEntry(const MapDefinition& map) : map(map) {}
 
-MapIndex::MapEntry::MapEntry(const string& compressed, bool is_quest)
-    : is_quest(is_quest),
-      compressed_data(compressed) {
+MapIndex::MapEntry::MapEntry(const string& compressed)
+    : compressed_data(compressed) {
   string decompressed = prs_decompress(this->compressed_data);
   if (decompressed.size() != sizeof(MapDefinition)) {
     throw runtime_error(string_printf(
@@ -2316,8 +2309,7 @@ const string& MapIndex::get_compressed_list(size_t num_players) const {
       e.description_offset = strings_w.size();
       strings_w.write(map.description.data(), map.description.len());
       strings_w.put_u8(0);
-
-      e.map_category = map_it.second->is_quest ? 0x00 : 0xFF;
+      e.map_category = map_it.second->map.map_category;
 
       entries_w.put(e);
       num_maps++;

src/Episode3/DataIndexes.hh

@@ -1265,6 +1265,10 @@ struct MapDefinition { // .mnmd format; also the format of (decompressed) quests
   /* 5A10 */ parray<EntryState, 4> entry_states;
   /* 5A18 */
 
+  inline bool is_quest() const {
+    return (this->map_category <= 2);
+  }
+
   std::string str(const CardIndex* card_index = nullptr) const;
 } __attribute__((packed));
 
@@ -1362,10 +1366,9 @@ public:
   class MapEntry {
   public:
     MapDefinition map;
-    bool is_quest;
 
-    MapEntry(const MapDefinition& map, bool is_quest);
-    MapEntry(const std::string& compressed_data, bool is_quest);
+    explicit MapEntry(const MapDefinition& map);
+    explicit MapEntry(const std::string& compressed_data);
 
     const std::string& compressed(bool is_trial) const;
 

src/ServerState.cc

@@ -886,7 +886,7 @@ void ServerState::load_item_tables() {
 
 void ServerState::load_ep3_data() {
   config_log.info("Collecting Episode 3 maps");
-  this->ep3_map_index.reset(new Episode3::MapIndex("system/ep3"));
+  this->ep3_map_index.reset(new Episode3::MapIndex("system/ep3/maps"));
   config_log.info("Loading Episode 3 card definitions");
   this->ep3_card_index.reset(new Episode3::CardIndex("system/ep3/card-definitions.mnr", "system/ep3/card-definitions.mnrd", "system/ep3/card-text.mnr", "system/ep3/card-text.mnrd"));
   config_log.info("Loading Episode 3 trial card definitions");

system/ep3/maps-quest/e700-gc3.mnmd

@@ -1 +0,0 @@
-../../quests/e700-gc3.mnmd

system/ep3/maps/e765-gc3.mnmd

@@ -0,0 +1 @@
+../../quests/e765-gc3.mnmd