texture shuffle for rando levels, new painting, fix bparam matching

Author: andre-meyer

.gitignore

@@ -65,4 +65,5 @@ web/design
 # js crap
 node_modules/
 
-.data
+.data
+/*.zip

Assets/img/custom_paintings/mika/PSS.png

@@ -176,6 +176,8 @@ levels:
   - name: "Big Boo's Haunt"
     course_id: 0x04
     properties:
+      - disable_planes: # the middle layer in BBH will make objects unaccessible
+        - y_range: [-1428, -206]
       - shuffle_painting:
         - custom_painting: 'painting_bbh'
   - name: "Hazy Maze Cave"
@@ -208,6 +210,7 @@ levels:
             - name: 'painting_lll_lower'
               segment_index: 23
               segment_offset: 0x12800
+              format: 'rgba16'
               size: [64, 32] # width, height
       - requires_key: 0x1
   - name: "Shifting Sand Land"
@@ -224,6 +227,7 @@ levels:
             - name: 'painting_ssl_lower'
               segment_index: 23
               segment_offset: 0x15800
+              format: 'rgba16'
               size: [64, 32] # width, height
       - requires_key: 0x1
   - name: "Dire, Dire Docks"
@@ -325,7 +329,7 @@ levels:
     course_id: 0x0D
     properties:
       - shuffle_painting:
-        - game_painting: 'painting_ttm'
+        - game_painting: 'painting_thi'
           sections:
           - name: 'painting_thi_upper'
             segment_index: 23
@@ -342,14 +346,14 @@ levels:
     course_id: 0x0E
     properties:
       - shuffle_painting:
-        - game_painting: 'painting_thi'
+        - game_painting: 'painting_ttc'
           sections:
-          - name: 'painting_thi_upper'
+          - name: 'painting_ttc_upper'
             segment_index: 23
             segment_offset: 0x1D800
             format: 'rgba16'
             size: [64, 32] # width, height
-          - name: 'painting_thi_lower'
+          - name: 'painting_ttc_lower'
             segment_index: 23
             segment_offset: 0x1E800
             format: 'rgba16'
@@ -377,6 +381,7 @@ levels:
   - name: "Wing Cap"
     course_id: 0x1D
     properties:
+      - fly_stage
       - shuffle_painting:
         - custom_painting: 'painting_wc'
 
@@ -526,7 +531,7 @@ object_randomization:
         - name: Bob-Omb
           match: 0x13003174
         - name: Goomba
-          match: 0x13004770
+          match: 0x1300472C
         - name: Goomba Triplet
           match: 0x13004770
         - name: Thwomp
@@ -598,24 +603,25 @@ object_randomization:
             - bparam2: 0
           rules:
             - bounding_box: [1000, 100, 100] # length, width, height
-            - spawn_height: [100, 600]
+            - spawn_height: [200, 600]
         - name: Grounded Ring Formation (8x)
           match:
             - bparam2: 2
           rules:
             - bounding_box: [1000, 1000, 100] # length, width, height
-            - spawn_height: [100, 600]
+            - spawn_height: [200, 600]
         - name: Grounded Arrow (8x)
           match:
             - bparam2: 4
           rules:
             - bounding_box: [500, 500, 100] # length, width, height
-            - spawn_height: [100, 600]
+            - spawn_height: [200, 600]
         - name: Horizontal Floating Line (x5)
           match:
             - bparam2: 16
           rules:
             - bounding_box: [600, 100, 100] # length, width, height
+            - spawn_height: [200, 500]
         - name: Vertical Floating Line (x5)
           match:
             - bparam2: 17
@@ -641,8 +647,9 @@ object_randomization:
       objects:
         - name: Yellow Coin
           match:
-            - 0x1300090C
-            - 0x1300091C # For Triggers?
+            - behaviours:
+              - 0x1300090C
+              - 0x1300091C # For Triggers?
         - name: Red Coin
           match: 0x13003EAC
         - name: Blue Coin
@@ -657,8 +664,10 @@ object_randomization:
       objects:
         - name: Star
           match:
-            - 0x13003E3C
-            - 0x13003EFC # Hidden
+            - behaviours:
+              - 0x13003E3C
+              - 0x13003EFC # Hidden
+              - 0x13003E8C # Red Coin Star
         - name: Star in Box
           match: 0x13002250
           rules:
@@ -762,8 +771,6 @@ object_randomization:
           match: 0x13002E58
         - name: "Pink Bob-Omb (Message)"
           match: 0x130031DC
-          rules:
-            - underwater: never
         - name: "Pink Bob-Omb (Canon)"
           match: 0x13003228
 
@@ -798,6 +805,8 @@ object_randomization:
             - course_property: slide
           for:
             - "Warps"
+          rules:
+            - disabled
 
     - name: "Level Special Cases"
       objects:
@@ -808,20 +817,27 @@ object_randomization:
           for:
             - 'Stars'
           rules:
-            - max_y: 1858
+            - max_y: 1800
         - name: "THI: Red Coins / Red Coin Star below Boss Room"
           match:
-            - 0x13003EAC # Red Coin
-            - 0x13003E8C # Red Coin Star
+            - course_id: 0x0D
+            - area_id: 0x2
+            - behaviours:
+              - 0x13003EAC # Red Coin
+              - 0x13003E8C # Red Coin Star
           rules:
             - max_y: 1750
         - name: "WC: Coins within Reach of Platform"
           match:
+            - course_property: fly_stage
             - course_id: 0x1D
           rules:
+            - no_floor_required
+            - min_y: -2260
+            - max_y: 4064
             - distance_to:
               - origin: [0, -2047, 0]
-                max_distance: 6000
+                max_distance: 5000
           for:
             - 'Coin'
             - 'Coin Formations'
@@ -837,9 +853,18 @@ object_randomization:
         - name: "WMotR: Disable Itembox Shuffle"
           match:
             - course_id: 0x1F
-            - behaviour: 0x13002250
+            - behaviours: 0x13002250
           rules:
             - disabled
+        - name: "BOB: Disable coin ring shuffle"
+          match:
+            - course_id: 0x09
+            - area_id: 0x01
+            - behaviours: 0x130008EC
+            - bparam2: 19
+          rules:
+            - disabled
+            
 
 # Define custom painting authors/names
 custom_paintings:
@@ -871,4 +896,8 @@ custom_paintings:
     - name: painting_wc
       file: "Assets/img/custom_paintings/mika/WC.png"
       transform:
-        - type: split-horizontal
+        - type: split-horizontal
+    - name: painting_pss
+    file: "Assets/img/custom_paintings/mika/PSS.png"
+    transform:
+      - type: split-horizontal

Config/sm64.vanilla.yml

@@ -134,9 +134,11 @@ def run_with_parsed_args(opt_args : argparse.Namespace):
       # initialize texture atlas and dynamic positions
       textures = TextureAtlas(rom)
       textures.add_dynamic_positions()
+      textures.load_default_unknown_texture()
 
     # Segment Finder
     # rom.match_segments(0xD78271)
+    # rom.match_segments(0xA8181C) # texture for question mark
 
     start_time = time.time()
 

sm64r/CLI.py

@@ -27,6 +27,7 @@
   'shuffle_painting[].sections[].name': ["str"],
   'requires_key': ["int"],
   'loading_zones': ["list"],
+  'disable_planes': ["list"],
   'shuffle_warps': ["list"],
   'shuffle_warps[].to': ["list"],
   'shuffle_warps[].to[].course_id': ["int"],
@@ -53,7 +54,7 @@
 
 # Which entries are allowed in objects[] (...) .match[]
 MATCH_DEFINITIONS = {
-  'behaviour': ["int", "list"],
+  'behaviours': ["int", "list"],
   'bparam1': ["int"],
   'bparam2': ["int"],
   'bparam3': ["int"],
@@ -99,6 +100,9 @@ def __init__(self, filename, source):
 
     #print(json.dumps(source, indent=2))
 
+    if os.path.exists("sm64_rando_rules.log"):
+      os.unlink("sm64_rando_rules.log")
+
     if not self.validate(source):
       print(f"Validation Error founds:{NL}{NL.join(self.validation_errors)}")
       raise TypeError(f"{filename} is invalid")
@@ -221,10 +225,10 @@ def validate_match(self, match, parents):
           match_type = entry
           match_value = True
         elif type(entry) is int:
-          match_type = "behaviour"
-          match_value = entry
+          match_type = "behaviours"
+          match_value = [entry]
         elif type(entry) is list:
-          match_type = "behaviour"
+          match_type = "behaviours"
           match_value = entry
         else:
           self.validation_errors.append(f'Invalid Match property in "{" => ".join(parents)}" - supplied an invalid type of rule-set for a match property. Either boolean or key:value')
@@ -516,7 +520,10 @@ def parse_object_table(self, table, rules = None, match = None, exclude = None):
               match["behaviours"].append(entry)
             if type(entry) is dict:
               prop_name = list(entry.keys())[0]
-              match[prop_name] = entry[prop_name]
+              if prop_name == "behaviours":
+                match[prop_name] = [entry[prop_name]]
+              else:
+                match[prop_name] = entry[prop_name]
 
     # Exclude Matching
     if "exclude" in table:
@@ -646,6 +653,10 @@ def parse(self, source):
     if "object_randomization" in source:
       self.parse_object_table(source["object_randomization"])
 
+    with open("sm64_rando_rules.log", "a") as rule_log:
+      for object_entry in self.object_entries:
+        rule_log.write(json.dumps(object_entry) + "\n")
+
     print(f"Configuration '{self.name}' loaded {len(self.object_entries)} object-rule entries")
 
   def has_checksum_configuration(self, checksum):

sm64r/Config.py

@@ -181,7 +181,7 @@ def process(self):
         self.level_forbidden_boundaries.append(bounding_box)
 
   def plot_placement(self, obj, *targets):
-    print("plotting debug placement")
+    #print("plotting placement")
     level_traces = []
 
     # Plot level wide boundaries
@@ -454,6 +454,6 @@ def plot(self):
             )
           )
 
-      print(f'plotting {self.level.name} {hex(area_id)}')
+      #print(f'plotting {self.level.name} {hex(area_id)}')
       py.plot(traces, filename=f'dumps/level_plots/{self.level.name}_{hex(area_id)}.html', auto_open=False)
-      print('done')
+      #print('done')

sm64r/Entities/LevelGeometry.py

@@ -1,13 +1,19 @@
 from PIL import Image
+import numpy as np
 
 class N64Image:
   def __init__(self, img : Image):
     self.img = img
     self.bytes_original = self.img.tobytes()
 
-  def scale_8_to_5(self, val):
+  @staticmethod
+  def scale_8_to_5(val):
     return int(((((val) + 4) * 0x1F) / 0xFF))
 
+  @staticmethod
+  def scale_5_to_8(val):
+    return int(int(val * 0xFF) / 0x1F)
+  
   def read_rgba16(self):
     """ Returns the loaded image as a bytearray of the RGBA16 format present on the N64
 
@@ -20,15 +26,15 @@ def read_rgba16(self):
 
     n64_img_bytes = bytearray(len(self.bytes_original))
 
-    for y in range(0, width):
-      for x in range(0, height):
+    for y in range(0, height):
+      for x in range(0, width):
         idx = (y * width + x) * 2
 
         (r, g, b, a) = px[x, y]
 
-        r_5 = self.scale_8_to_5(r)
-        g_5 = self.scale_8_to_5(g)
-        b_5 = self.scale_8_to_5(b)
+        r_5 = N64Image.scale_8_to_5(r)
+        g_5 = N64Image.scale_8_to_5(g)
+        b_5 = N64Image.scale_8_to_5(b)
 
         n64_img_bytes[idx] = int((r_5 << 3) | (g_5 >> 2))
         n64_img_bytes[idx+1] = int(((g & 0x03) << 6) | (b_5 << 1) | (1 if a > 0 else 0))
@@ -42,3 +48,33 @@ def parse_image(path):
       loaded_img = Image.open(file)
 
       return N64Image(loaded_img)
+
+  @staticmethod
+  def from_ingame(rom, texture):
+    ingame_bytes = rom.read_bytes(texture.position, texture.size)
+    
+    width = texture.width
+    height = texture.height
+
+    img_bytes = np.zeros((width, height, 4), dtype="uint8")
+    for y in range(0, height):
+      for x in range(0, width):
+        img_idx = (y * width + x)
+        idx = img_idx * 2
+
+        px1 = ingame_bytes[idx]
+        px2 = ingame_bytes[idx+1]
+
+        r = N64Image.scale_5_to_8((px1 & 0xF8) >> 3)
+        g = N64Image.scale_5_to_8((px1 & 0x07) << 2 | ((px2 & 0xC0) >> 6))
+        b = N64Image.scale_5_to_8((px1 & 0x3E) >> 1)
+        a = 255 if (px2 & 0x1) > 0 else 0
+
+        img_bytes[y,x,0] = r
+        img_bytes[y,x,1] = g
+        img_bytes[y,x,2] = b
+        img_bytes[y,x,3] = a
+    
+    img = Image.fromarray(img_bytes)
+    #img.show()
+    return N64Image(img)