Basic support for Co-Op using World Ids.

Author: Crain-32

asm/custom_symbols.txt

@@ -85,6 +85,7 @@ sys/main.dol:
   give_temporary_sword_during_ganondorf_fight_in_swordless: 0x803FED10
   give_temporary_sword_in_orcas_house_in_swordless: 0x803FED2C
   remove_temporary_sword_when_loading_stage_in_swordless: 0x803FED74
+  custom_write_item_world_id: 0x803FF6B9
   test_room_stage_name: 0x8022D034
   test_room_starting_items_list: 0x8022D03C
   test_room_spawn_id: 0x800531E3

asm/patch_diffs/multiworld_scripts_diff.txt

@@ -0,0 +1,14 @@
+sys/main.dol:
+  0x803F60E0:
+    Data: [0x01]
+  0x803FF6B8:
+    Data: [0x94, 0x21, 0xFF, 0xF0, 0x7C, 0x08, 0x02, 0xA6, 0x90, 0x01, 0x00, 0x14,
+      0x3C, 0xA0, 0x80, 0x40, 0x38, 0xA5, 0xF6, 0xFD, 0xA8, 0x1E, 0x01, 0xDC, 0x54,
+      0x00, 0xC6, 0x3E, 0x90, 0x05, 0x00, 0x00, 0x3C, 0xA0, 0x80, 0x40, 0x38, 0xA5,
+      0xF7, 0x01, 0xA8, 0x1E, 0x01, 0xE0, 0x54, 0x04, 0xC6, 0x3E, 0x90, 0x85, 0x00,
+      0x00, 0x80, 0x01, 0x00, 0x14, 0x7C, 0x08, 0x03, 0xA6, 0x38, 0x21, 0x00, 0x10,
+      0x4E, 0x80, 0x00, 0x20, 0x60, 0x00, 0x00, 0x00, 0x60, 0x00, 0x00, 0x00]
+files/rels/d_a_tbox.rel:
+  0x2764:
+    Data: [0x48, 0x00, 0x00, 0x01]
+    Relocations: [{SymbolName: custom_write_item_world_id, Offset: 0x00, Type: R_PPC_REL24}]

asm/patcher.py

@@ -33,6 +33,7 @@ def apply_patch(self, patch_name):
 
       if file_path == "sys/main.dol":
         if org_address >= free_space_start:
+          print("Bad Free Space for {} at Address {:02X}".format(patch_name, org_address))
           add_or_extend_main_dol_free_space_section(self, new_bytes, org_address)
           continue
         else:

asm/patches/multiworld_scripts.asm

@@ -0,0 +1,40 @@
+.open "sys/main.dol"
+.org @NextFreeSpace
+.global custom_write_item_world_id
+custom_write_item_world_id:
+stwu sp, -0x10 (sp)
+mflr r0
+stw r0, 0x14 (sp)
+lis r5, world_id@ha
+addi r5, r5, world_id@l
+lha r0, 0x1DC(r30)
+rlwinm r0, r0, 0x18, 0x18, 0x1f
+stw r0, 0x0(r5)
+
+lis r5, item_id@ha
+addi r5, r5, item_id@l
+lha r0, 0x1E0(r30)
+rlwinm r4, r0, 0x18, 0x18, 0x1f
+stw r4, 0x0(r5)
+
+lwz r0, 0x14 (sp)
+mtlr r0
+addi sp, sp, 0x10
+blr
+
+.global world_id
+world_id:
+nop
+.global item_id
+item_id:
+nop
+
+.org 0x803F60E0 ; Enable Developer Mode
+.byte 1
+.close
+
+
+.open "files/rels/d_a_tbox.rel" ; Treasure chests
+.org 0x2761 ; In actionOpenWait__8daTbox_cFv
+  b custom_write_item_world_id
+.close

data/actor_parameters.txt

@@ -3135,6 +3135,9 @@ d_a_tbox:
   chest_type:
     Bitfield name: params
     Mask: 0x00F00000
+  world_id:
+    Bitfield name: x_rot
+    Mask: 0xFF00
   room_num:
     Bitfield name: x_rot
     Mask: 0x003F

randomizer.py

@@ -461,6 +461,7 @@ def apply_necessary_tweaks(self):
     patcher.apply_patch(self, "flexible_item_locations")
     patcher.apply_patch(self, "fix_vanilla_bugs")
     patcher.apply_patch(self, "misc_rando_features")
+    patcher.apply_patch(self, "multiworld_scripts")
     tweaks.add_custom_actor_rels(self)
     tweaks.skip_wakeup_intro_and_start_at_dock(self)
     tweaks.start_ship_at_outset(self)

randomizers/items.py

@@ -2,7 +2,7 @@
 import os
 import re
 from collections import OrderedDict
-
+import random
 from fs_helpers import *
 import tweaks
 
@@ -507,9 +507,6 @@ def randomize_progression_items(self):
   if not game_beatable:
     raise Exception("Game is not beatable on this seed! This error shouldn't happen.")
 
-
-
-
 def write_changed_items(self):
   for location_name, item_name in self.logic.done_item_locations.items():
     paths = self.logic.item_locations[location_name]["Paths"]
@@ -590,13 +587,14 @@ def change_hardcoded_item_in_rel(self, path, offset, item_id):
   rel = self.get_rel(path)
   rel.write_data(write_u8, offset, item_id)
 
-def change_chest_item(self, arc_path, chest_index, layer, item_id):
+def change_chest_item(self, arc_path, chest_index, layer, item_id, world_id=0):
   if arc_path.endswith("Stage.arc"):
     dzx = self.get_arc(arc_path).get_file("stage.dzs")
   else:
     dzx = self.get_arc(arc_path).get_file("room.dzr")
   chest = dzx.entries_by_type_and_layer("TRES", layer)[chest_index]
   chest.item_id = item_id
+  chest.world_id = 1
   chest.save_changes()
 
 def change_event_item(self, arc_path, event_index, actor_index, action_index, item_id):