feat(memory): terrain and height from image POC

Author: gynt

sourcehold/__main__.py

@@ -10,6 +10,7 @@
 
 from sourcehold.tool.argparsers.common import main_parser
 from sourcehold.tool.argparsers.services import services_parser, convert_parser
+from sourcehold.tool.memory.map import memory_map
 from sourcehold.tool.modify.map import modify_map
 
 file_input_output = argparse.ArgumentParser(add_help=False)
@@ -82,6 +83,8 @@ def main():
       return
   if modify_map(args):
       return
+  if memory_map(args):
+      return
 
   if args.service == "aiv":
     if args.method == "file":

sourcehold/tool/argparsers/services.py

@@ -1,3 +1,4 @@
+import argparse
 from .common import main_parser, file_input_file_output
 
 services_parser = main_parser.add_subparsers(title="service", dest="service", required=True)
@@ -11,6 +12,24 @@
 convert_aiv_parser.add_argument('--to-format', required=False, default='')
 
 memory_parser = services_parser.add_parser('memory')
+memory_parser.add_argument('--game', choices=['SHC1.41-latin', "SHCE1.41-latin"], default="SHC1.41-latin")
+memory_subparsers = memory_parser.add_subparsers(dest='type', required=True, title='type')
+
+memory_map_parser = memory_subparsers.add_parser('map')
+memory_map_subparsers = memory_map_parser.add_subparsers(dest='action', required=True)
+
+memory_common = argparse.ArgumentParser(add_help=False)
+memory_common.add_argument('what', choices=['terrain', 'height'])
+
+memory_map_get_parser = memory_map_subparsers.add_parser('get', parents=[memory_common])
+memory_map_get_parser.add_argument('--output', default='')
+memory_map_get_parser.add_argument('--output-format', default='', choices=['png'])
+
+memory_map_set_parser = memory_map_subparsers.add_parser('set', parents=[memory_common])
+memory_map_set_parser.add_argument('--input', default='-')
+memory_map_set_parser.add_argument('--input-format', default='', choices=['png'])
+
+
 
 modify_parser = services_parser.add_parser('modify')
 modify_subparser = modify_parser.add_subparsers(dest='type', required=True, title='type')

sourcehold/tool/memory/__init__.py

@@ -0,0 +1,23 @@
+import pathlib, sys
+
+from sourcehold.tool.convert.aiv.exports import to_json
+from sourcehold.tool.convert.aiv.imports import from_json
+from sourcehold.tool.memory.map.height import set_height
+from sourcehold.tool.memory.map.terrain import set_terrain
+
+
+def memory_map(args):
+  #' returns None in case of non applicable
+  if args.service != "memory":
+    return None
+  
+  if args.type != "map":
+     return None
+  
+  if set_height(args):
+    return True
+  
+  if set_terrain(args):
+    return True
+
+  return True

sourcehold/tool/memory/map/__init__.py

@@ -0,0 +1,19 @@
+import pathlib
+from sourcehold.debugtools.memory.access import SHC, SHCE
+
+def get_process_handle(version):
+  if version == "SHC1.41-latin":
+    return SHC()
+  # if version == "SHCE1.41-latin":
+  #   return SHCE()
+  raise NotImplementedError(f"process not implemented: {version}")
+
+
+def validate_path(img_path):
+  if not img_path:
+    raise Exception(f"no input file specified")
+  if img_path == "-":
+    raise NotImplementedError(f"stdin input not yet implemented for this action. Specify a file path using --input")
+
+  if not pathlib.Path(img_path).exists():
+    raise Exception(f"file does not exist: {img_path}")

sourcehold/tool/memory/map/common.py

@@ -0,0 +1,67 @@
+
+
+
+# python -m pip install Pillow
+import pathlib
+import struct
+from sourcehold.tool.memory.map.common import get_process_handle, validate_path
+from sourcehold.world import create_selection_matrix
+import cv2 as cv # type: ignore
+
+def get_image_data_grayscale(img_path):
+  img = cv.imread(img_path)
+  img = cv.cvtColor(img, cv.COLOR_BGR2GRAY)
+  return img
+
+selection = create_selection_matrix()
+
+# (Little endian) unsigned bytes
+def get_raw_height(process):
+  return struct.unpack("<80400B", process.read_section('1045'))
+
+def set_raw_height(process, data):
+  bytes_data = struct.pack("<80400B", *data)
+  # ChangedLayer
+  process.write_bytes(0x01c5ad88, b'\x02' * 80400) # TODO: fix
+  # Logical terrain height layer: DefaultHeightLayer
+  process.write_section('1045', bytes_data)
+  # Visual height layer, I think also includes walls and towers: HeightLayer
+  process.write_section('1005', bytes_data)
+  # LogicLayer
+  process.write_section('1003', struct.pack("<80400I", *((v & 0xffffff7f) for v in struct.unpack("<80400I", process.read_section('1003')))))
+  # Logic2Layer
+  process.write_section('1037', b'\x04' * 80400)
+
+# def post_process_raw_height():
+#   # MiscDisplayLayer
+#   process.write_section('1007', struct.pack("<80400H", *(((v & 0xffdf) & 0xf83f) for v in struct.unpack("<80400H", process.read_section('1007')))))
+#   # LogicLayer, what a hot mess, probably not all required
+#   process.write_section('1003', struct.pack("<80400I", *(((((v & 0x5f81c436) & 0xffffff7f) & 0xbfffbfff) | 32768) for v in struct.unpack("<80400I", process.read_section('1003')))))
+#   # Logic2Layer
+#   process.write_section('1037', b'\x04' * 80400)
+#   # TODO: wall owner layer, and special logic2layer set to 4 or 8 depending on plateau
+#   # ChangedLayer
+#   process.write_bytes(0x01c5ad88, b'\x02' * 80400)
+
+
+# post_process_raw_height()
+
+
+def set_height(args):
+  #' returns None in case of non applicable
+  if args.what != 'height':
+    return None
+  
+  if args.action != "set":
+     return None
+  
+  img_path = args.input
+  validate_path(img_path)
+
+  img = get_image_data_grayscale(img_path)
+
+  process = get_process_handle(args.game)
+
+  set_raw_height(process, img[selection].flat)
+
+  return True

sourcehold/tool/memory/map/height/__init__.py

@@ -0,0 +1,50 @@
+MAP_SIZE = 400
+TILE_COUNT = MAP_SIZE * ((MAP_SIZE // 2) + 1 )
+# python -m pip install Pillow
+import struct, numpy
+from sourcehold.tool.memory.map.common import get_process_handle, validate_path
+from sourcehold.world import create_selection_matrix
+import cv2 as cv # type: ignore
+
+
+def get_image_data(img_path):
+  img = cv.imread(img_path)
+  #img = 255 - cv.cvtColor(img, cv.COLOR_BGR2GRAY)
+  return img
+
+selection = create_selection_matrix(size=MAP_SIZE)
+
+# (Little endian) unsigned bytes
+def get_raw_logical(process):
+  return struct.unpack(f"<{TILE_COUNT}I", process.read_section('1003'))
+
+def set_raw_logical(process, data):
+  serialized = struct.pack(f"<{TILE_COUNT}I", *data)
+  # Logical terrain height layer
+  process.write_section('1003', serialized)
+
+
+# 16 is used for the inaccessible parts of the map, including the outer border of the 800x800 space, and 32 is used for a border just within that
+
+def set_terrain(args):
+  #' returns None in case of non applicable
+  if args.what != 'terrain':
+    return None
+  
+  if args.action != "set":
+     return None  
+
+  img_path = args.input
+  validate_path(img_path)
+  img = get_image_data(img_path)
+
+  process = get_process_handle(args.game)
+
+  matrix = numpy.zeros((400, 400), dtype='uint32')
+  matrix[selection] = get_raw_logical(process)
+
+  # matrix[img > 255//128] |= 0x20000 # boulder flag?
+
+  set_raw_logical(process, matrix[selection].flat)
+
+  return True

sourcehold/tool/memory/map/terrain/__init__.py

@@ -0,0 +1,18 @@
+monsterfish1 = {
+  'swamp': "#475937",
+  'pitch': '#314235',
+  'stone': '#c3bdb4',
+  'gravel': '#978f80',
+  'rocks': '#675335',
+  'iron': '#9e4f00',
+  'ford': '#567c71',
+  'river': '#427068',
+  'ocean': '#1e4a44',
+  'oasis': '#47540b',
+  'thick_scrub': '#6a692b',
+  'light_scrub': '#937e44',
+  'earth_and_stones': '#7c7059',
+  'earth': '#ae9467',
+  'dunes': '#b79453',
+  'beach': '#deb977',
+}

sourcehold/tool/memory/map/terrain/colors.py

@@ -0,0 +1,18 @@
+logic1 = {
+  'swamp': 1 << 1, # TODO
+  'pitch': '#314235',
+  'stone': '#c3bdb4',
+  'gravel': '#978f80',
+  'rocks': '#675335',
+  'iron': '#9e4f00',
+  'ford': '#567c71',
+  'river': '#427068',
+  'ocean': '#1e4a44',
+  'oasis': '#47540b',
+  'thick_scrub': '#6a692b',
+  'light_scrub': '#937e44',
+  'earth_and_stones': '#7c7059',
+  'earth': '#ae9467',
+  'dunes': '#b79453',
+  'beach': '#deb977',
+}