Documentation and string extraction

CleverRaven · Dec 23, 2021 · 76eabb0 · 76eabb0
1 parent 25cafa8
commit 76eabb0
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/doc/OVERMAP.md b/doc/OVERMAP.md
@@ -134,6 +134,20 @@ those overmap terrains relative to each other, and some data used to drive the p
 overmap special / city building (e.g. how far from a city, should be it connected to a road, can it
 be placed in a forest/field/river, etc).
 
+When retiring or migrating an overmap special, the id should be defined in a new `overmap_special_migration`,
+usually defined in `data/json/overmap/overmap_special/overmap_special_migration.json` as follows:
+
+```json
+{
+  "type": "overmap_special_migration",
+  "id": "Military Bunker",
+  "new_id": "military_bunker"
+}
+```
+
+Specials that have been removed (not just renamed) should have a blank `new_id`, or just omit
+the `new_id` field altogether.
+
 ### overmap_connection
 
 Speaking of roads, the concept of linear features like roads, sewers, subways, railroads, and

diff --git a/lang/string_extractor/parser.py b/lang/string_extractor/parser.py
@@ -169,6 +169,7 @@ def dummy_parser(json, origin):
     "overmap_land_use_code": parse_overmap_land_use_code,
     "overmap_location": dummy_parser,
     "overmap_special": dummy_parser,
+    "overmap_special_migration": dummy_parser,
     "overmap_terrain": parse_overmap_terrain,
     "palette": parse_palette,
     "pet_armor": parse_generic,