mirror of
https://github.com/MarioSpore/Grinch-AP.git
synced 2025-10-21 12:11:33 -06:00
611e1c2b19
### Features:
- Trap Link
- When you receive a trap, you send a copy of it to every other player with Trap Link enabled
- Ring Link
- Any coin amounts gained and lost by a linked player will be instantly shared with all other active linked players
Co-authored-by: TheLX5 <luisyuregi@gmail.com>
925 lines
38 KiB
Python
925 lines
38 KiB
Python
import logging
|
|
import time
|
|
from typing import Any
|
|
|
|
from NetUtils import ClientStatus, NetworkItem, color
|
|
from worlds.AutoSNIClient import SNIClient
|
|
from .Names.TextBox import generate_received_text, generate_received_trap_link_text
|
|
from .Items import trap_value_to_name, trap_name_to_value
|
|
|
|
snes_logger = logging.getLogger("SNES")
|
|
|
|
# FXPAK Pro protocol memory mapping used by SNI
|
|
ROM_START = 0x000000
|
|
WRAM_START = 0xF50000
|
|
WRAM_SIZE = 0x20000
|
|
SRAM_START = 0xE00000
|
|
|
|
SMW_ROMHASH_START = 0x7FC0
|
|
ROMHASH_SIZE = 0x15
|
|
|
|
SMW_PROGRESS_DATA = WRAM_START + 0x1F02
|
|
SMW_DRAGON_COINS_DATA = WRAM_START + 0x1F2F
|
|
SMW_PATH_DATA = WRAM_START + 0x1EA2
|
|
SMW_EVENT_ROM_DATA = ROM_START + 0x2D608
|
|
SMW_ACTIVE_LEVEL_DATA = ROM_START + 0x37F70
|
|
SMW_MOON_DATA = WRAM_START + 0x1FEE
|
|
SMW_HIDDEN_1UP_DATA = WRAM_START + 0x1F3C
|
|
SMW_BONUS_BLOCK_DATA = WRAM_START + 0x1A000
|
|
SMW_BLOCKSANITY_DATA = WRAM_START + 0x1A400
|
|
SMW_BLOCKSANITY_FLAGS = WRAM_START + 0x1A010
|
|
SMW_LEVEL_CLEAR_FLAGS = WRAM_START + 0x1A200
|
|
SMW_SPECIAL_WORLD_CLEAR = WRAM_START + 0x1F1E
|
|
|
|
|
|
SMW_GOAL_DATA = ROM_START + 0x01BFA0
|
|
SMW_REQUIRED_BOSSES_DATA = ROM_START + 0x01BFA1
|
|
SMW_REQUIRED_EGGS_DATA = ROM_START + 0x01BFA2
|
|
SMW_SEND_MSG_DATA = ROM_START + 0x01BFA3
|
|
SMW_RECEIVE_MSG_DATA = ROM_START + 0x01BFA4
|
|
SMW_DEATH_LINK_ACTIVE_ADDR = ROM_START + 0x01BFA5
|
|
SMW_DRAGON_COINS_ACTIVE_ADDR = ROM_START + 0x01BFA6
|
|
SMW_SWAMP_DONUT_GH_ADDR = ROM_START + 0x01BFA7
|
|
SMW_MOON_ACTIVE_ADDR = ROM_START + 0x01BFA8
|
|
SMW_HIDDEN_1UP_ACTIVE_ADDR = ROM_START + 0x01BFA9
|
|
SMW_BONUS_BLOCK_ACTIVE_ADDR = ROM_START + 0x01BFAA
|
|
SMW_BLOCKSANITY_ACTIVE_ADDR = ROM_START + 0x01BFAB
|
|
SMW_TRAP_LINK_ACTIVE_ADDR = ROM_START + 0x01BFB7
|
|
SMW_RING_LINK_ACTIVE_ADDR = ROM_START + 0x01BFB8
|
|
|
|
|
|
SMW_GAME_STATE_ADDR = WRAM_START + 0x100
|
|
SMW_MARIO_STATE_ADDR = WRAM_START + 0x71
|
|
SMW_COIN_COUNT_ADDR = WRAM_START + 0xDBF
|
|
SMW_BOSS_STATE_ADDR = WRAM_START + 0xD9B
|
|
SMW_ACTIVE_BOSS_ADDR = WRAM_START + 0x13FC
|
|
SMW_CURRENT_LEVEL_ADDR = WRAM_START + 0x13BF
|
|
SMW_CURRENT_SUBLEVEL_ADDR = WRAM_START + 0x10B
|
|
SMW_MESSAGE_BOX_ADDR = WRAM_START + 0x1426
|
|
SMW_BONUS_STAR_ADDR = WRAM_START + 0xF48
|
|
SMW_EGG_COUNT_ADDR = WRAM_START + 0x1F24
|
|
SMW_BOSS_COUNT_ADDR = WRAM_START + 0x1F26
|
|
SMW_NUM_EVENTS_ADDR = WRAM_START + 0x1F2E
|
|
SMW_SFX_ADDR = WRAM_START + 0x1DFC
|
|
SMW_PAUSE_ADDR = WRAM_START + 0x13D4
|
|
SMW_MESSAGE_QUEUE_ADDR = WRAM_START + 0xC391
|
|
SMW_ACTIVE_THWIMP_ADDR = WRAM_START + 0x0F3C
|
|
SMW_GOAL_ITEM_COUNT = WRAM_START + 0x1A01E
|
|
|
|
SMW_RECV_PROGRESS_ADDR = WRAM_START + 0x01F2B
|
|
|
|
SMW_BLOCKSANITY_BLOCK_COUNT = 582
|
|
|
|
SMW_GOAL_LEVELS = [0x28, 0x31, 0x32]
|
|
SMW_INVALID_MARIO_STATES = [0x05, 0x06, 0x0A, 0x0C, 0x0D]
|
|
SMW_BAD_TEXT_BOX_LEVELS = [0x00, 0x26, 0x02, 0x4B]
|
|
SMW_BOSS_STATES = [0x80, 0xC0, 0xC1]
|
|
SMW_UNCOLLECTABLE_LEVELS = [0x25, 0x07, 0x0B, 0x40, 0x0E, 0x1F, 0x20, 0x1B, 0x1A, 0x35, 0x34, 0x31, 0x32]
|
|
SMW_UNCOLLECTABLE_DRAGON_COINS = [0x24]
|
|
|
|
|
|
class SMWSNIClient(SNIClient):
|
|
game = "Super Mario World"
|
|
patch_suffix = ".apsmw"
|
|
slot_data: dict[str, Any] | None
|
|
|
|
async def deathlink_kill_player(self, ctx):
|
|
from SNIClient import DeathState, snes_buffered_write, snes_flush_writes, snes_read
|
|
game_state = await snes_read(ctx, SMW_GAME_STATE_ADDR, 0x1)
|
|
if game_state[0] != 0x14:
|
|
return
|
|
|
|
mario_state = await snes_read(ctx, SMW_MARIO_STATE_ADDR, 0x1)
|
|
if mario_state[0] != 0x00:
|
|
return
|
|
|
|
message_box = await snes_read(ctx, SMW_MESSAGE_BOX_ADDR, 0x1)
|
|
if message_box[0] != 0x00:
|
|
return
|
|
|
|
pause_state = await snes_read(ctx, SMW_PAUSE_ADDR, 0x1)
|
|
if pause_state[0] != 0x00:
|
|
return
|
|
|
|
snes_buffered_write(ctx, WRAM_START + 0x9D, bytes([0x30])) # Freeze Gameplay
|
|
snes_buffered_write(ctx, WRAM_START + 0x1DFB, bytes([0x09])) # Death Music
|
|
snes_buffered_write(ctx, WRAM_START + 0x0DDA, bytes([0xFF])) # Flush Music Buffer
|
|
snes_buffered_write(ctx, WRAM_START + 0x1407, bytes([0x00])) # Flush Cape Fly Phase
|
|
snes_buffered_write(ctx, WRAM_START + 0x140D, bytes([0x00])) # Flush Spin Jump Flag
|
|
snes_buffered_write(ctx, WRAM_START + 0x188A, bytes([0x00])) # Flush Empty Byte because the game does it
|
|
snes_buffered_write(ctx, WRAM_START + 0x7D, bytes([0x90])) # Mario Y Speed
|
|
snes_buffered_write(ctx, WRAM_START + 0x1496, bytes([0x30])) # Death Timer
|
|
snes_buffered_write(ctx, SMW_MARIO_STATE_ADDR, bytes([0x09])) # Mario State -> Dead
|
|
|
|
await snes_flush_writes(ctx)
|
|
|
|
ctx.death_state = DeathState.dead
|
|
ctx.last_death_link = time.time()
|
|
|
|
|
|
def on_package(self, ctx: SNIClient, cmd: str, args: dict[str, Any]) -> None:
|
|
super().on_package(ctx, cmd, args)
|
|
|
|
if cmd == "Connected":
|
|
self.slot_data = args.get("slot_data", None)
|
|
|
|
if cmd != "Bounced":
|
|
return
|
|
if "tags" not in args:
|
|
return
|
|
|
|
if not hasattr(self, "instance_id"):
|
|
self.instance_id = time.time()
|
|
|
|
source_name = args["data"]["source"]
|
|
if "TrapLink" in ctx.tags and "TrapLink" in args["tags"] and source_name != ctx.slot_info[ctx.slot].name:
|
|
trap_name: str = args["data"]["trap_name"]
|
|
if trap_name not in trap_name_to_value:
|
|
# We don't know how to handle this trap, ignore it
|
|
return
|
|
|
|
trap_id: int = trap_name_to_value[trap_name]
|
|
|
|
if "trap_weights" not in self.slot_data:
|
|
return
|
|
|
|
if f"{trap_id}" not in self.slot_data["trap_weights"]:
|
|
return
|
|
|
|
if self.slot_data["trap_weights"][f"{trap_id}"] == 0:
|
|
# The player disabled this trap type
|
|
return
|
|
|
|
self.priority_trap = NetworkItem(trap_id, None, None)
|
|
self.priority_trap_message = generate_received_trap_link_text(trap_name, source_name)
|
|
self.priority_trap_message_str = f"Received linked {trap_name} from {source_name}"
|
|
elif "RingLink" in ctx.tags and "RingLink" in args["tags"] and source_name != self.instance_id:
|
|
if not hasattr(self, "pending_ring_link"):
|
|
self.pending_ring_link = 0
|
|
self.pending_ring_link += args["data"]["amount"]
|
|
|
|
async def send_trap_link(self, ctx: SNIClient, trap_name: str):
|
|
if "TrapLink" not in ctx.tags or ctx.slot == None:
|
|
return
|
|
|
|
await ctx.send_msgs([{
|
|
"cmd": "Bounce", "tags": ["TrapLink"],
|
|
"data": {
|
|
"time": time.time(),
|
|
"source": ctx.player_names[ctx.slot],
|
|
"trap_name": trap_name
|
|
}
|
|
}])
|
|
snes_logger.info(f"Sent linked {trap_name}")
|
|
|
|
async def send_ring_link(self, ctx: SNIClient, amount: int):
|
|
from SNIClient import DeathState, snes_buffered_write, snes_flush_writes, snes_read
|
|
|
|
if "RingLink" not in ctx.tags or ctx.slot == None:
|
|
return
|
|
|
|
game_state = await snes_read(ctx, SMW_GAME_STATE_ADDR, 0x1)
|
|
if game_state[0] != 0x14:
|
|
return
|
|
|
|
if not hasattr(self, "instance_id"):
|
|
self.instance_id = time.time()
|
|
|
|
await ctx.send_msgs([{
|
|
"cmd": "Bounce", "tags": ["RingLink"],
|
|
"data": {
|
|
"time": time.time(),
|
|
"source": self.instance_id,
|
|
"amount": amount
|
|
}
|
|
}])
|
|
|
|
|
|
async def validate_rom(self, ctx):
|
|
from SNIClient import snes_buffered_write, snes_flush_writes, snes_read
|
|
|
|
rom_name = await snes_read(ctx, SMW_ROMHASH_START, ROMHASH_SIZE)
|
|
if rom_name is None or rom_name == bytes([0] * ROMHASH_SIZE) or rom_name[:3] != b"SMW":
|
|
return False
|
|
|
|
ctx.game = self.game
|
|
ctx.items_handling = 0b111 # remote items
|
|
|
|
receive_option = await snes_read(ctx, SMW_RECEIVE_MSG_DATA, 0x1)
|
|
send_option = await snes_read(ctx, SMW_SEND_MSG_DATA, 0x1)
|
|
trap_link = await snes_read(ctx, SMW_TRAP_LINK_ACTIVE_ADDR, 0x1)
|
|
|
|
ctx.receive_option = receive_option[0]
|
|
ctx.send_option = send_option[0]
|
|
ctx.trap_link = trap_link[0]
|
|
|
|
ctx.allow_collect = True
|
|
|
|
death_link = await snes_read(ctx, SMW_DEATH_LINK_ACTIVE_ADDR, 1)
|
|
if death_link:
|
|
await ctx.update_death_link(bool(death_link[0] & 0b1))
|
|
|
|
if trap_link and bool(trap_link[0] & 0b1) and "TrapLink" not in ctx.tags:
|
|
ctx.tags.add("TrapLink")
|
|
await ctx.send_msgs([{"cmd": "ConnectUpdate", "tags": ctx.tags}])
|
|
|
|
ring_link = await snes_read(ctx, SMW_RING_LINK_ACTIVE_ADDR, 1)
|
|
if ring_link and bool(ring_link[0] & 0b1) and "RingLink" not in ctx.tags:
|
|
ctx.tags.add("RingLink")
|
|
await ctx.send_msgs([{"cmd": "ConnectUpdate", "tags": ctx.tags}])
|
|
|
|
if ctx.rom != rom_name:
|
|
ctx.current_sublevel_value = 0
|
|
|
|
ctx.rom = rom_name
|
|
|
|
return True
|
|
|
|
|
|
def add_message_to_queue(self, new_message):
|
|
if not hasattr(self, "message_queue"):
|
|
self.message_queue = []
|
|
|
|
self.message_queue.append(new_message)
|
|
|
|
def add_message_to_queue_front(self, new_message):
|
|
if not hasattr(self, "message_queue"):
|
|
self.message_queue = []
|
|
|
|
self.message_queue.insert(0, new_message)
|
|
|
|
|
|
async def handle_message_queue(self, ctx):
|
|
from SNIClient import snes_buffered_write, snes_flush_writes, snes_read
|
|
|
|
if not hasattr(self, "message_queue") or len(self.message_queue) == 0:
|
|
return
|
|
|
|
game_state = await snes_read(ctx, SMW_GAME_STATE_ADDR, 0x1)
|
|
if game_state[0] != 0x14:
|
|
return
|
|
|
|
mario_state = await snes_read(ctx, SMW_MARIO_STATE_ADDR, 0x1)
|
|
if mario_state[0] != 0x00:
|
|
return
|
|
|
|
message_box = await snes_read(ctx, SMW_MESSAGE_BOX_ADDR, 0x1)
|
|
if message_box[0] != 0x00:
|
|
return
|
|
|
|
pause_state = await snes_read(ctx, SMW_PAUSE_ADDR, 0x1)
|
|
if pause_state[0] != 0x00:
|
|
return
|
|
|
|
current_level = await snes_read(ctx, SMW_CURRENT_LEVEL_ADDR, 0x1)
|
|
if current_level[0] in SMW_BAD_TEXT_BOX_LEVELS:
|
|
return
|
|
|
|
boss_state = await snes_read(ctx, SMW_BOSS_STATE_ADDR, 0x1)
|
|
if boss_state[0] in SMW_BOSS_STATES:
|
|
return
|
|
|
|
active_boss = await snes_read(ctx, SMW_ACTIVE_BOSS_ADDR, 0x1)
|
|
if active_boss[0] != 0x00:
|
|
return
|
|
|
|
next_message = self.message_queue.pop(0)
|
|
|
|
snes_buffered_write(ctx, SMW_MESSAGE_QUEUE_ADDR, bytes(next_message))
|
|
snes_buffered_write(ctx, SMW_MESSAGE_BOX_ADDR, bytes([0x03]))
|
|
snes_buffered_write(ctx, SMW_SFX_ADDR, bytes([0x22]))
|
|
|
|
await snes_flush_writes(ctx)
|
|
|
|
|
|
def add_trap_to_queue(self, trap_item, trap_msg):
|
|
self.trap_queue = getattr(self, "trap_queue", [])
|
|
|
|
self.trap_queue.append((trap_item, trap_msg))
|
|
|
|
def should_show_message(self, ctx, next_item):
|
|
return ctx.receive_option == 1 or \
|
|
(ctx.receive_option == 2 and ((next_item.flags & 1) != 0)) or \
|
|
(ctx.receive_option == 3 and ((next_item.flags & 1) != 0 and next_item.item != 0xBC0002))
|
|
|
|
|
|
async def handle_trap_queue(self, ctx):
|
|
from SNIClient import snes_buffered_write, snes_flush_writes, snes_read
|
|
|
|
if (not hasattr(self, "trap_queue") or len(self.trap_queue) == 0) and\
|
|
(not hasattr(self, "priority_trap") or self.priority_trap == 0):
|
|
return
|
|
|
|
game_state = await snes_read(ctx, SMW_GAME_STATE_ADDR, 0x1)
|
|
if game_state[0] != 0x14:
|
|
return
|
|
|
|
mario_state = await snes_read(ctx, SMW_MARIO_STATE_ADDR, 0x1)
|
|
if mario_state[0] != 0x00:
|
|
return
|
|
|
|
pause_state = await snes_read(ctx, SMW_PAUSE_ADDR, 0x1)
|
|
if pause_state[0] != 0x00:
|
|
return
|
|
|
|
|
|
next_trap = None
|
|
message = bytearray()
|
|
message_str = ""
|
|
from_queue = False
|
|
|
|
if getattr(self, "priority_trap", None) and self.priority_trap.item != 0:
|
|
next_trap = self.priority_trap
|
|
message = self.priority_trap_message
|
|
message_str = self.priority_trap_message_str
|
|
self.priority_trap = None
|
|
self.priority_trap_message = bytearray()
|
|
self.priority_trap_message_str = ""
|
|
elif hasattr(self, "trap_queue") and len(self.trap_queue) > 0:
|
|
from_queue = True
|
|
next_trap, message = self.trap_queue.pop(0)
|
|
else:
|
|
return
|
|
|
|
from .Rom import trap_rom_data
|
|
if next_trap.item in trap_rom_data:
|
|
trap_active = await snes_read(ctx, WRAM_START + trap_rom_data[next_trap.item][0], 0x3)
|
|
|
|
if next_trap.item == 0xBC0016:
|
|
# Timer Trap
|
|
if trap_active[0] == 0 or (trap_active[0] == 1 and trap_active[1] == 0 and trap_active[2] == 0):
|
|
# Trap already active
|
|
if from_queue:
|
|
self.add_trap_to_queue(next_trap, message)
|
|
return
|
|
else:
|
|
if len(message_str) > 0:
|
|
snes_logger.info(message_str)
|
|
if "TrapLink" in ctx.tags and from_queue:
|
|
await self.send_trap_link(ctx, trap_value_to_name[next_trap.item])
|
|
snes_buffered_write(ctx, WRAM_START + trap_rom_data[next_trap.item][0], bytes([0x01]))
|
|
snes_buffered_write(ctx, WRAM_START + trap_rom_data[next_trap.item][0] + 1, bytes([0x00]))
|
|
snes_buffered_write(ctx, WRAM_START + trap_rom_data[next_trap.item][0] + 2, bytes([0x00]))
|
|
else:
|
|
if trap_active[0] > 0:
|
|
# Trap already active
|
|
if from_queue:
|
|
self.add_trap_to_queue(next_trap, message)
|
|
return
|
|
else:
|
|
if next_trap.item == 0xBC001D:
|
|
# Special case thwimp trap
|
|
# Do not fire if the previous thwimp hasn't reached the player's Y pos
|
|
active_thwimp = await snes_read(ctx, SMW_ACTIVE_THWIMP_ADDR, 0x1)
|
|
if active_thwimp[0] != 0xFF:
|
|
if from_queue:
|
|
self.add_trap_to_queue(next_trap, message)
|
|
return
|
|
verify_game_state = await snes_read(ctx, SMW_GAME_STATE_ADDR, 0x1)
|
|
if verify_game_state[0] == 0x14 and len(trap_rom_data[next_trap.item]) > 2:
|
|
snes_buffered_write(ctx, SMW_SFX_ADDR, bytes([trap_rom_data[next_trap.item][2]]))
|
|
|
|
if len(message_str) > 0:
|
|
snes_logger.info(message_str)
|
|
if "TrapLink" in ctx.tags and from_queue:
|
|
await self.send_trap_link(ctx, trap_value_to_name[next_trap.item])
|
|
|
|
new_item_count = trap_rom_data[next_trap.item][1]
|
|
snes_buffered_write(ctx, WRAM_START + trap_rom_data[next_trap.item][0], bytes([new_item_count]))
|
|
|
|
current_level = await snes_read(ctx, SMW_CURRENT_LEVEL_ADDR, 0x1)
|
|
if current_level[0] in SMW_BAD_TEXT_BOX_LEVELS:
|
|
return
|
|
|
|
boss_state = await snes_read(ctx, SMW_BOSS_STATE_ADDR, 0x1)
|
|
if boss_state[0] in SMW_BOSS_STATES:
|
|
return
|
|
|
|
active_boss = await snes_read(ctx, SMW_ACTIVE_BOSS_ADDR, 0x1)
|
|
if active_boss[0] != 0x00:
|
|
return
|
|
|
|
if self.should_show_message(ctx, next_trap):
|
|
self.add_message_to_queue_front(message)
|
|
elif next_trap.item == 0xBC0015:
|
|
if self.should_show_message(ctx, next_trap):
|
|
self.add_message_to_queue_front(message)
|
|
if len(message_str) > 0:
|
|
snes_logger.info(message_str)
|
|
if "TrapLink" in ctx.tags and from_queue:
|
|
await self.send_trap_link(ctx, trap_value_to_name[next_trap.item])
|
|
|
|
# Handle Literature Trap
|
|
from .Names.LiteratureTrap import lit_trap_text_list
|
|
import random
|
|
rand_trap = random.choice(lit_trap_text_list)
|
|
|
|
for message in rand_trap:
|
|
self.add_message_to_queue(message)
|
|
|
|
|
|
async def handle_ring_link(self, ctx):
|
|
from SNIClient import snes_buffered_write, snes_flush_writes, snes_read
|
|
|
|
if "RingLink" not in ctx.tags:
|
|
return
|
|
|
|
if not hasattr(self, "prev_coins"):
|
|
self.prev_coins = 0
|
|
|
|
curr_coins_byte = await snes_read(ctx, SMW_COIN_COUNT_ADDR, 0x1)
|
|
curr_coins = curr_coins_byte[0]
|
|
|
|
if curr_coins < self.prev_coins:
|
|
# Coins rolled over from 1-Up
|
|
curr_coins += 100
|
|
|
|
coins_diff = curr_coins - self.prev_coins
|
|
if coins_diff > 0:
|
|
await self.send_ring_link(ctx, coins_diff)
|
|
self.prev_coins = curr_coins % 100
|
|
|
|
new_coins = curr_coins
|
|
if not hasattr(self, "pending_ring_link"):
|
|
self.pending_ring_link = 0
|
|
|
|
if self.pending_ring_link != 0:
|
|
new_coins += self.pending_ring_link
|
|
new_coins = max(new_coins, 0)
|
|
|
|
new_1_ups = 0
|
|
while new_coins >= 100:
|
|
new_1_ups += 1
|
|
new_coins -= 100
|
|
|
|
if new_1_ups > 0:
|
|
curr_lives_inc_byte = await snes_read(ctx, WRAM_START + 0x18E4, 0x1)
|
|
curr_lives_inc = curr_lives_inc_byte[0]
|
|
new_lives_inc = curr_lives_inc + new_1_ups
|
|
snes_buffered_write(ctx, WRAM_START + 0x18E4, bytes([new_lives_inc]))
|
|
|
|
snes_buffered_write(ctx, SMW_COIN_COUNT_ADDR, bytes([new_coins]))
|
|
if self.pending_ring_link > 0:
|
|
snes_buffered_write(ctx, SMW_SFX_ADDR, bytes([0x01]))
|
|
else:
|
|
snes_buffered_write(ctx, SMW_SFX_ADDR, bytes([0x2A]))
|
|
self.pending_ring_link = 0
|
|
self.prev_coins = new_coins
|
|
|
|
await snes_flush_writes(ctx)
|
|
|
|
|
|
async def game_watcher(self, ctx):
|
|
from SNIClient import snes_buffered_write, snes_flush_writes, snes_read
|
|
|
|
boss_state = await snes_read(ctx, SMW_BOSS_STATE_ADDR, 0x1)
|
|
game_state = await snes_read(ctx, SMW_GAME_STATE_ADDR, 0x1)
|
|
mario_state = await snes_read(ctx, SMW_MARIO_STATE_ADDR, 0x1)
|
|
if game_state is None:
|
|
# We're not properly connected
|
|
return
|
|
elif game_state[0] >= 0x18:
|
|
if not ctx.finished_game:
|
|
current_level = await snes_read(ctx, SMW_CURRENT_LEVEL_ADDR, 0x1)
|
|
|
|
if current_level[0] in SMW_GOAL_LEVELS:
|
|
await ctx.send_msgs([{"cmd": "StatusUpdate", "status": ClientStatus.CLIENT_GOAL}])
|
|
ctx.finished_game = True
|
|
return
|
|
elif game_state[0] < 0x0B:
|
|
# We haven't loaded a save file
|
|
ctx.message_queue = []
|
|
ctx.current_sublevel_value = 0
|
|
return
|
|
elif mario_state[0] in SMW_INVALID_MARIO_STATES:
|
|
# Mario can't come to the phone right now
|
|
return
|
|
|
|
if "DeathLink" in ctx.tags and game_state[0] == 0x14 and ctx.last_death_link + 1 < time.time():
|
|
currently_dead = mario_state[0] == 0x09
|
|
await ctx.handle_deathlink_state(currently_dead)
|
|
|
|
# Check for Egg Hunt ending
|
|
goal = await snes_read(ctx, SMW_GOAL_DATA, 0x1)
|
|
if game_state[0] == 0x14 and goal[0] == 1:
|
|
current_level = await snes_read(ctx, SMW_CURRENT_LEVEL_ADDR, 0x1)
|
|
message_box = await snes_read(ctx, SMW_MESSAGE_BOX_ADDR, 0x1)
|
|
egg_count = await snes_read(ctx, SMW_EGG_COUNT_ADDR, 0x1)
|
|
required_egg_count = await snes_read(ctx, SMW_REQUIRED_EGGS_DATA, 0x1)
|
|
|
|
if current_level[0] == 0x28 and message_box[0] == 0x01 and egg_count[0] >= required_egg_count[0]:
|
|
snes_buffered_write(ctx, WRAM_START + 0x13C6, bytes([0x08]))
|
|
snes_buffered_write(ctx, WRAM_START + 0x13CE, bytes([0x01]))
|
|
snes_buffered_write(ctx, WRAM_START + 0x1DE9, bytes([0x01]))
|
|
snes_buffered_write(ctx, SMW_GAME_STATE_ADDR, bytes([0x18]))
|
|
|
|
await snes_flush_writes(ctx)
|
|
return
|
|
|
|
egg_count = await snes_read(ctx, SMW_EGG_COUNT_ADDR, 0x1)
|
|
boss_count = await snes_read(ctx, SMW_BOSS_COUNT_ADDR, 0x1)
|
|
display_count = await snes_read(ctx, SMW_BONUS_STAR_ADDR, 0x1)
|
|
|
|
if goal[0] == 0 and boss_count[0] > display_count[0]:
|
|
snes_buffered_write(ctx, SMW_BONUS_STAR_ADDR, bytes([boss_count[0]]))
|
|
await snes_flush_writes(ctx)
|
|
elif goal[0] == 1 and egg_count[0] > display_count[0]:
|
|
snes_buffered_write(ctx, SMW_BONUS_STAR_ADDR, bytes([egg_count[0]]))
|
|
await snes_flush_writes(ctx)
|
|
|
|
await self.handle_message_queue(ctx)
|
|
await self.handle_trap_queue(ctx)
|
|
await self.handle_ring_link(ctx)
|
|
|
|
new_checks = []
|
|
event_data = await snes_read(ctx, SMW_EVENT_ROM_DATA, 0x60)
|
|
progress_data = bytearray(await snes_read(ctx, SMW_PROGRESS_DATA, 0x0F))
|
|
dragon_coins_data = bytearray(await snes_read(ctx, SMW_DRAGON_COINS_DATA, 0x0C))
|
|
dragon_coins_active = await snes_read(ctx, SMW_DRAGON_COINS_ACTIVE_ADDR, 0x1)
|
|
moon_data = bytearray(await snes_read(ctx, SMW_MOON_DATA, 0x0C))
|
|
moon_active = await snes_read(ctx, SMW_MOON_ACTIVE_ADDR, 0x1)
|
|
hidden_1up_data = bytearray(await snes_read(ctx, SMW_HIDDEN_1UP_DATA, 0x0C))
|
|
hidden_1up_active = await snes_read(ctx, SMW_HIDDEN_1UP_ACTIVE_ADDR, 0x1)
|
|
bonus_block_data = bytearray(await snes_read(ctx, SMW_BONUS_BLOCK_DATA, 0x0C))
|
|
bonus_block_active = await snes_read(ctx, SMW_BONUS_BLOCK_ACTIVE_ADDR, 0x1)
|
|
blocksanity_data = bytearray(await snes_read(ctx, SMW_BLOCKSANITY_DATA, SMW_BLOCKSANITY_BLOCK_COUNT))
|
|
blocksanity_flags = bytearray(await snes_read(ctx, SMW_BLOCKSANITY_FLAGS, 0xC))
|
|
blocksanity_active = await snes_read(ctx, SMW_BLOCKSANITY_ACTIVE_ADDR, 0x1)
|
|
level_clear_flags = bytearray(await snes_read(ctx, SMW_LEVEL_CLEAR_FLAGS, 0x60))
|
|
from .Rom import item_rom_data, ability_rom_data, trap_rom_data, icon_rom_data
|
|
from .Levels import location_id_to_level_id, level_info_dict, level_blocks_data
|
|
from worlds import AutoWorldRegister
|
|
for loc_name, level_data in location_id_to_level_id.items():
|
|
loc_id = AutoWorldRegister.world_types[ctx.game].location_name_to_id[loc_name]
|
|
if loc_id not in ctx.locations_checked:
|
|
|
|
event_id = event_data[level_data[0]]
|
|
|
|
if level_data[1] == 2:
|
|
# Dragon Coins Check
|
|
if not dragon_coins_active or dragon_coins_active[0] == 0:
|
|
continue
|
|
|
|
progress_byte = (level_data[0] // 8)
|
|
progress_bit = 7 - (level_data[0] % 8)
|
|
|
|
data = dragon_coins_data[progress_byte]
|
|
masked_data = data & (1 << progress_bit)
|
|
bit_set = (masked_data != 0)
|
|
|
|
if bit_set:
|
|
new_checks.append(loc_id)
|
|
elif level_data[1] == 3:
|
|
# Moon Check
|
|
if not moon_active or moon_active[0] == 0:
|
|
continue
|
|
|
|
progress_byte = (level_data[0] // 8)
|
|
progress_bit = 7 - (level_data[0] % 8)
|
|
|
|
data = moon_data[progress_byte]
|
|
masked_data = data & (1 << progress_bit)
|
|
bit_set = (masked_data != 0)
|
|
|
|
if bit_set:
|
|
new_checks.append(loc_id)
|
|
elif level_data[1] == 4:
|
|
# Hidden 1-Up Check
|
|
if not hidden_1up_active or hidden_1up_active[0] == 0:
|
|
continue
|
|
|
|
progress_byte = (level_data[0] // 8)
|
|
progress_bit = 7 - (level_data[0] % 8)
|
|
|
|
data = hidden_1up_data[progress_byte]
|
|
masked_data = data & (1 << progress_bit)
|
|
bit_set = (masked_data != 0)
|
|
|
|
if bit_set:
|
|
new_checks.append(loc_id)
|
|
elif level_data[1] == 5:
|
|
# Bonus Block Check
|
|
if not bonus_block_active or bonus_block_active[0] == 0:
|
|
continue
|
|
|
|
progress_byte = (level_data[0] // 8)
|
|
progress_bit = 7 - (level_data[0] % 8)
|
|
|
|
data = bonus_block_data[progress_byte]
|
|
masked_data = data & (1 << progress_bit)
|
|
bit_set = (masked_data != 0)
|
|
|
|
if bit_set:
|
|
new_checks.append(loc_id)
|
|
elif level_data[1] >= 100:
|
|
if not blocksanity_active or blocksanity_active[0] == 0:
|
|
continue
|
|
block_index = level_data[1] - 100
|
|
if blocksanity_data[block_index] != 0:
|
|
new_checks.append(loc_id)
|
|
else:
|
|
event_id_value = event_id + level_data[1]
|
|
|
|
progress_byte = (event_id_value // 8)
|
|
progress_bit = 7 - (event_id_value % 8)
|
|
|
|
data = progress_data[progress_byte]
|
|
masked_data = data & (1 << progress_bit)
|
|
bit_set = (masked_data != 0)
|
|
|
|
if bit_set:
|
|
new_checks.append(loc_id)
|
|
|
|
verify_game_state = await snes_read(ctx, SMW_GAME_STATE_ADDR, 0x1)
|
|
if verify_game_state is None or verify_game_state[0] < 0x0B or verify_game_state[0] > 0x29:
|
|
# We have somehow exited the save file (or worse)
|
|
print("Exit Save File")
|
|
return
|
|
|
|
rom = await snes_read(ctx, SMW_ROMHASH_START, ROMHASH_SIZE)
|
|
if rom != ctx.rom:
|
|
ctx.rom = None
|
|
print("Exit ROM")
|
|
# We have somehow loaded a different ROM
|
|
return
|
|
|
|
for new_check_id in new_checks:
|
|
ctx.locations_checked.add(new_check_id)
|
|
location = ctx.location_names.lookup_in_game(new_check_id)
|
|
snes_logger.info(
|
|
f'New Check: {location} ({len(ctx.locations_checked)}/{len(ctx.missing_locations) + len(ctx.checked_locations)})')
|
|
await ctx.send_msgs([{"cmd": 'LocationChecks', "locations": [new_check_id]}])
|
|
|
|
# Send Current Room for Tracker
|
|
current_sublevel_data = await snes_read(ctx, SMW_CURRENT_SUBLEVEL_ADDR, 2)
|
|
current_sublevel_value = current_sublevel_data[0] + (current_sublevel_data[1] << 8)
|
|
|
|
if game_state[0] != 0x14:
|
|
current_sublevel_value = 0
|
|
|
|
if ctx.current_sublevel_value != current_sublevel_value:
|
|
ctx.current_sublevel_value = current_sublevel_value
|
|
|
|
# Send level id data to tracker
|
|
await ctx.send_msgs(
|
|
[
|
|
{
|
|
"cmd": "Set",
|
|
"key": f"smw_curlevelid_{ctx.team}_{ctx.slot}",
|
|
"default": 0,
|
|
"want_reply": False,
|
|
"operations": [
|
|
{
|
|
"operation": "replace",
|
|
"value": ctx.current_sublevel_value,
|
|
}
|
|
],
|
|
}
|
|
]
|
|
)
|
|
|
|
if game_state[0] != 0x14:
|
|
# Don't receive items or collect locations outside of in-level mode
|
|
ctx.current_sublevel_value = 0
|
|
return
|
|
|
|
if boss_state[0] in SMW_BOSS_STATES:
|
|
# Don't receive items or collect locations inside boss battles
|
|
return
|
|
|
|
recv_count = await snes_read(ctx, SMW_RECV_PROGRESS_ADDR, 2)
|
|
if recv_count is None:
|
|
# Add a small failsafe in case we get a None. Other SNI games do this...
|
|
return
|
|
recv_index = recv_count[0] | (recv_count[1] << 8)
|
|
|
|
if recv_index < len(ctx.items_received):
|
|
item = ctx.items_received[recv_index]
|
|
recv_index += 1
|
|
sending_game = ctx.slot_info[item.player].game
|
|
logging.info('Received %s from %s (%s) (%d/%d in list)' % (
|
|
color(ctx.item_names.lookup_in_game(item.item), 'red', 'bold'),
|
|
color(ctx.player_names[item.player], 'yellow'),
|
|
ctx.location_names.lookup_in_slot(item.location, item.player), recv_index, len(ctx.items_received)))
|
|
|
|
if self.should_show_message(ctx, item):
|
|
if item.item != 0xBC0012 and item.item != 0xBC0015 and item.item not in trap_rom_data:
|
|
# Don't send messages for Boss Tokens
|
|
item_name = ctx.item_names.lookup_in_game(item.item)
|
|
player_name = ctx.player_names[item.player]
|
|
|
|
receive_message = generate_received_text(item_name, player_name)
|
|
self.add_message_to_queue(receive_message)
|
|
|
|
snes_buffered_write(ctx, SMW_RECV_PROGRESS_ADDR, bytes([recv_index&0xFF, (recv_index>>8)&0xFF]))
|
|
if item.item in trap_rom_data or item.item == 0xBC0015:
|
|
item_name = ctx.item_names.lookup_in_game(item.item)
|
|
player_name = ctx.player_names[item.player]
|
|
|
|
receive_message = generate_received_text(item_name, player_name)
|
|
self.add_trap_to_queue(item, receive_message)
|
|
elif item.item in item_rom_data:
|
|
item_count = await snes_read(ctx, WRAM_START + item_rom_data[item.item][0], 0x1)
|
|
increment = item_rom_data[item.item][1]
|
|
|
|
new_item_count = item_count[0]
|
|
if increment > 1:
|
|
new_item_count = increment
|
|
else:
|
|
new_item_count += increment
|
|
|
|
if verify_game_state[0] == 0x14 and len(item_rom_data[item.item]) > 2:
|
|
snes_buffered_write(ctx, SMW_SFX_ADDR, bytes([item_rom_data[item.item][2]]))
|
|
|
|
snes_buffered_write(ctx, WRAM_START + item_rom_data[item.item][0], bytes([new_item_count]))
|
|
elif item.item in icon_rom_data:
|
|
queue_addr = await snes_read(ctx, WRAM_START + icon_rom_data[item.item][0], 2)
|
|
queue_addr = queue_addr[0] + (queue_addr[1] << 8)
|
|
queue_addr += 1
|
|
snes_buffered_write(ctx, WRAM_START + icon_rom_data[item.item][0], bytes([queue_addr&0xFF, (queue_addr>>8)&0xFF]))
|
|
if (goal[0] == 0 and item.item == 0xBC0012) or (goal[0] == 1 and item.item == 0xBC0002):
|
|
goal_item_count = await snes_read(ctx, SMW_GOAL_ITEM_COUNT, 1)
|
|
snes_buffered_write(ctx, SMW_GOAL_ITEM_COUNT, bytes([goal_item_count[0] + 1]))
|
|
|
|
elif item.item in ability_rom_data:
|
|
# Handle Upgrades
|
|
for rom_data in ability_rom_data[item.item]:
|
|
data = await snes_read(ctx, WRAM_START + rom_data[0], 1)
|
|
masked_data = data[0] | (1 << rom_data[1])
|
|
snes_buffered_write(ctx, WRAM_START + rom_data[0], bytes([masked_data]))
|
|
snes_buffered_write(ctx, SMW_SFX_ADDR, bytes([0x3E])) # SMW_TODO: Custom sounds for each
|
|
elif item.item == 0xBC000A:
|
|
# Handle Progressive Powerup
|
|
data = await snes_read(ctx, WRAM_START + 0x1F2D, 1)
|
|
mushroom_data = data[0] & (1 << 0)
|
|
fire_flower_data = data[0] & (1 << 1)
|
|
cape_data = data[0] & (1 << 2)
|
|
if mushroom_data == 0:
|
|
masked_data = data[0] | (1 << 0)
|
|
snes_buffered_write(ctx, WRAM_START + 0x1F2D, bytes([masked_data]))
|
|
snes_buffered_write(ctx, SMW_SFX_ADDR, bytes([0x3E]))
|
|
elif fire_flower_data == 0:
|
|
masked_data = data[0] | (1 << 1)
|
|
snes_buffered_write(ctx, WRAM_START + 0x1F2D, bytes([masked_data]))
|
|
snes_buffered_write(ctx, SMW_SFX_ADDR, bytes([0x3E]))
|
|
elif cape_data == 0:
|
|
masked_data = data[0] | (1 << 2)
|
|
snes_buffered_write(ctx, WRAM_START + 0x1F2D, bytes([masked_data]))
|
|
snes_buffered_write(ctx, SMW_SFX_ADDR, bytes([0x41]))
|
|
else:
|
|
# Extra Powerup?
|
|
pass
|
|
|
|
await snes_flush_writes(ctx)
|
|
|
|
# Handle Collected Locations
|
|
new_events = 0
|
|
path_data = bytearray(await snes_read(ctx, SMW_PATH_DATA, 0x60))
|
|
donut_gh_swapped = await snes_read(ctx, SMW_SWAMP_DONUT_GH_ADDR, 0x1)
|
|
new_dragon_coin = False
|
|
new_moon = False
|
|
new_hidden_1up = False
|
|
new_bonus_block = False
|
|
new_blocksanity = False
|
|
new_blocksanity_flags = False
|
|
|
|
for loc_id in ctx.checked_locations:
|
|
if loc_id not in ctx.locations_checked:
|
|
ctx.locations_checked.add(loc_id)
|
|
loc_name = ctx.location_names.lookup_in_game(loc_id)
|
|
|
|
if loc_name not in location_id_to_level_id:
|
|
continue
|
|
|
|
level_data = location_id_to_level_id[loc_name]
|
|
|
|
if level_data[1] == 2:
|
|
# Dragon Coins Check
|
|
if level_data[0] in SMW_UNCOLLECTABLE_DRAGON_COINS:
|
|
continue
|
|
|
|
progress_byte = (level_data[0] // 8)
|
|
progress_bit = 7 - (level_data[0] % 8)
|
|
|
|
data = dragon_coins_data[progress_byte]
|
|
new_data = data | (1 << progress_bit)
|
|
dragon_coins_data[progress_byte] = new_data
|
|
|
|
new_dragon_coin = True
|
|
elif level_data[1] == 3:
|
|
# Moon Check
|
|
|
|
progress_byte = (level_data[0] // 8)
|
|
progress_bit = 7 - (level_data[0] % 8)
|
|
|
|
data = moon_data[progress_byte]
|
|
new_data = data | (1 << progress_bit)
|
|
moon_data[progress_byte] = new_data
|
|
|
|
new_moon = True
|
|
elif level_data[1] == 4:
|
|
# Hidden 1-Up Check
|
|
progress_byte = (level_data[0] // 8)
|
|
progress_bit = 7 - (level_data[0] % 8)
|
|
|
|
data = hidden_1up_data[progress_byte]
|
|
new_data = data | (1 << progress_bit)
|
|
hidden_1up_data[progress_byte] = new_data
|
|
|
|
new_hidden_1up = True
|
|
elif level_data[1] == 5:
|
|
# Bonus block prize Check
|
|
|
|
progress_byte = (level_data[0] // 8)
|
|
progress_bit = 7 - (level_data[0] % 8)
|
|
|
|
data = bonus_block_data[progress_byte]
|
|
new_data = data | (1 << progress_bit)
|
|
bonus_block_data[progress_byte] = new_data
|
|
|
|
new_bonus_block = True
|
|
elif level_data[1] >= 100:
|
|
# Blocksanity flag Check
|
|
block_index = level_data[1] - 100
|
|
blocksanity_data[block_index] = 1
|
|
new_blocksanity = True
|
|
|
|
# All blocksanity blocks flag
|
|
new_blocksanity_flags = True
|
|
for block_id in level_blocks_data[level_data[0]]:
|
|
if blocksanity_data[block_id] != 1:
|
|
new_blocksanity_flags = False
|
|
continue
|
|
if new_blocksanity_flags is True:
|
|
progress_byte = (level_data[0] // 8)
|
|
progress_bit = 7 - (level_data[0] % 8)
|
|
data = blocksanity_flags[progress_byte]
|
|
new_data = data | (1 << progress_bit)
|
|
blocksanity_flags[progress_byte] = new_data
|
|
else:
|
|
if level_data[0] in SMW_UNCOLLECTABLE_LEVELS:
|
|
continue
|
|
|
|
# Handle map indicators
|
|
flag = 1 if level_data[1] == 0 else 2
|
|
level_clear_flags[level_data[0]] |= flag
|
|
|
|
event_id = event_data[level_data[0]]
|
|
event_id_value = event_id + level_data[1]
|
|
|
|
progress_byte = (event_id_value // 8)
|
|
progress_bit = 7 - (event_id_value % 8)
|
|
|
|
data = progress_data[progress_byte]
|
|
masked_data = data & (1 << progress_bit)
|
|
bit_set = (masked_data != 0)
|
|
|
|
if bit_set:
|
|
continue
|
|
|
|
new_events += 1
|
|
new_data = data | (1 << progress_bit)
|
|
progress_data[progress_byte] = new_data
|
|
|
|
tile_id = await snes_read(ctx, SMW_ACTIVE_LEVEL_DATA + level_data[0], 0x1)
|
|
|
|
level_info = level_info_dict[tile_id[0]]
|
|
|
|
path = level_info.exit1Path if level_data[1] == 0 else level_info.exit2Path
|
|
|
|
if donut_gh_swapped[0] != 0 and tile_id[0] == 0x04:
|
|
# Handle Swapped Donut GH Exits
|
|
path = level_info.exit2Path if level_data[1] == 0 else level_info.exit1Path
|
|
|
|
if not path:
|
|
continue
|
|
|
|
this_end_path = path_data[tile_id[0]]
|
|
new_data = this_end_path | path.thisEndDirection
|
|
path_data[tile_id[0]] = new_data
|
|
|
|
other_end_path = path_data[path.otherLevelID]
|
|
new_data = other_end_path | path.otherEndDirection
|
|
path_data[path.otherLevelID] = new_data
|
|
|
|
if new_dragon_coin:
|
|
snes_buffered_write(ctx, SMW_DRAGON_COINS_DATA, bytes(dragon_coins_data))
|
|
if new_moon:
|
|
snes_buffered_write(ctx, SMW_MOON_DATA, bytes(moon_data))
|
|
if new_hidden_1up:
|
|
snes_buffered_write(ctx, SMW_HIDDEN_1UP_DATA, bytes(hidden_1up_data))
|
|
if new_bonus_block:
|
|
snes_buffered_write(ctx, SMW_BONUS_BLOCK_DATA, bytes(bonus_block_data))
|
|
if new_blocksanity:
|
|
snes_buffered_write(ctx, SMW_BLOCKSANITY_DATA, bytes(blocksanity_data))
|
|
if new_blocksanity_flags:
|
|
snes_buffered_write(ctx, SMW_BLOCKSANITY_FLAGS, bytes(blocksanity_flags))
|
|
if new_events > 0:
|
|
snes_buffered_write(ctx, SMW_LEVEL_CLEAR_FLAGS, bytes(level_clear_flags))
|
|
snes_buffered_write(ctx, SMW_PROGRESS_DATA, bytes(progress_data))
|
|
snes_buffered_write(ctx, SMW_PATH_DATA, bytes(path_data))
|
|
old_events = await snes_read(ctx, SMW_NUM_EVENTS_ADDR, 0x1)
|
|
snes_buffered_write(ctx, SMW_NUM_EVENTS_ADDR, bytes([old_events[0] + new_events]))
|
|
|
|
await snes_flush_writes(ctx)
|