mirror/tmc
1
0
Fork 0
mirror of https://github.com/zeldaret/tmc synced 2026-05-24 15:21:09 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
37d03d13824fc8a6f1da88e77176e4d5d7e95c5e
tmc/tools/script_disassembler/script_disassembler.py
T
octorock 37d03d1382 Apply renaming
2021-03-06 14:53:33 +01:00

348 lines
14 KiB
Python
Raw Blame History

from dataclasses import dataclass
import struct
# Disassembler for tmc scripts
# Input 'macros' to generate the macros for the script commands
# Input the script bytes as hex to disassemble the script
@dataclass
class Context:
ptr: int
data: bytes
def u16_to_hex(value):
return '0x' + (struct.pack('>H', value).hex())
def barray_to_u16_hex(barray):
count = len(barray)//2
integers = struct.unpack('H'*count, barray)
return [u16_to_hex(x) for x in integers]
def u32_to_hex(value):
return '0x' + (struct.pack('>I', value).hex())
def barray_to_u32_hex(barray):
count = len(barray)//4
integers = struct.unpack('I'*count, barray)
return [u32_to_hex(x) for x in integers]
# tries to directly reference the function this is pointing to
def get_pointer(barray):
integers = struct.unpack('I', barray)
return 'sub_' + (struct.pack('>I', integers[0]-1).hex()).upper()
commands = [
{'fun': 'ScriptCommandNop', 'params': ''},
{'fun': 'ScriptCommand_StartScript', 'params': '', 'name': 'start executing scripts'},
{'fun': 'ScriptCommand_StopScript', 'params': '', 'name': 'stop executing scripts'},
{'fun': 'ScriptCommand_Jump', 'params': 's', 'name': 'jump by offset'},
{'fun': 'ScriptCommand_JumpIf', 'params': 's', 'name': 'jump if'},
{'fun': 'ScriptCommand_JumpIfNot', 'params': 's', 'name': 'jump if not'},
{'fun': 'ScriptCommand_0807E078', 'params': 's'},
{'fun': 'ScriptCommand_JumpAbsolute', 'params': 'w','name': 'abs jump' },
{'fun': 'ScriptCommand_JumpAbsoluteIf', 'params': 'w', 'name': 'abs jump if'},
{'fun': 'ScriptCommand_JumpAbsoluteIfNot', 'params': 'w', 'name': 'abs jump if not'},
{'fun': 'ScriptCommand_0807E0E0', 'params': 'w'},
{'fun': 'ScriptCommand_Call', 'params':'p', 'name': 'Execute function via pointer'},# 'exec': ScriptCommand_Call},
{'fun': 'ScriptCommand_CallWithArg', 'params': 'pw'},
{'fun': 'ScriptCommand_LoadRoomEntityList', 'params': 'w'},
{'fun': 'ScriptCommand_TestBit', 'params': 'w'},
{'fun': 'ScriptCommand_CheckInventory1', 'params': 's'},
{'fun': 'ScriptCommand_CheckInventory2', 'params': 's'},
{'fun': 'ScriptCommand_HasRoomItemForSale', 'params': 's'},
{'fun': 'ScriptCommand_CheckLocalFlag', 'params': 's'},
{'fun': 'ScriptCommand_CheckLocalFlagByOffset', 'params': 'ss'},
{'fun': 'ScriptCommand_CheckGlobalFlag', 'params': 's'},
{'fun': 'ScriptCommand_CheckRoomFlag', 'params': 's'},
{'fun': 'ScriptCommand_CheckPlayerInRegion', 'params': 'sss'},
{'fun': 'ScriptCommand_CheckPlayerInRegion2', 'params': 's'},
{'fun': 'ScriptCommand_CheckEntityInteractType', 'params': ''},
{'fun': 'ScriptCommand_0807E30C', 'params': ''},
{'fun': 'ScriptCommand_HasRupees', 'params': 's'},
{'fun': 'ScriptCommand_0807E3BC', 'params': 's'},
{'fun': 'ScriptCommand_0807E3E8', 'params': ''},
{'fun': 'ScriptCommand_CheckKinstoneFused', 'params': 's'},
{'fun': 'ScriptCommand_BuyItem', 'params': 'ss'},
{'fun': 'ScriptCommand_0807E48C', 'params': 's'},
{'fun': 'ScriptCommand_0807E4CC', 'params': 'w'},
{'fun': 'ScriptCommand_0807E4EC', 'params': 'w'},
{'fun': 'ScriptCommand_0807E51', 'params': 's'},
{'fun': 'ScriptCommand_CheckPlayerFlags', 'params':'w'},
{'fun': 'ScriptCommand_0807E564', 'params': ''},
{'fun': 'ScriptCommand_EntityHasHeight', 'params': ''},
{'fun': 'ScriptCommand_ComparePlayerAction', 'params': 's'},
{'fun': 'ScriptCommand_ComparePlayerAnimationState', 'params': 's'},
{'fun': 'ScriptCommand_0807E5F8', 'params': 'w'},# 'exec': ScriptCommand_0807E5F8},
{'fun': 'ScriptCommand_0807E610', 'params': 'w'},
{'fun': 'ScriptCommand_SetLocalFlag', 'params': 's'},
{'fun': 'ScriptCommand_SetLocalFlagByOffset', 'params': 'ss'},
{'fun': 'ScriptCommand_ClearLocalFlag', 'params': 's'},
{'fun': 'ScriptCommand_SetGlobalFlag', 'params': 's'},
{'fun': 'ScriptCommand_ClearGlobalFlag', 'params': 's'},
{'fun': 'ScriptCommand_SetRoomFlag', 'params': 's'},
{'fun': 'ScriptCommand_ClearRoomFlag', 'params': 's'},
{'fun': 'ScriptCommand_Wait', 'params': 's'},
{'fun': 'ScriptCommand_WaitForSomething', 'params': 'w'},
{'fun': 'ScriptCommand_WaitForSomething2', 'params': 'w'},
{'fun': 'ScriptCommand_WaitPlayerAction8', 'params': ''},
{'fun': 'ScriptCommand_WaitForPlayerAction0x17', 'params': ''},
{'fun': 'ScriptCommand_WaitFor_1', 'params': ''},
{'fun': 'ScriptCommand_WaitFor_2', 'params': ''},
{'fun': 'ScriptCommand_0807E778', 'params': 's'},
{'fun': 'ScriptCommand_0807E788', 'params': 'w'},
{'fun': 'ScriptCommand_0807E79C', 'params': ''},
{'fun': 'ScriptCommandNop2', 'params': 's'},
{'fun': 'ScriptCommand_DoFade4', 'params': ''},
{'fun': 'ScriptCommand_DoFade5', 'params': ''},
{'fun': 'ScriptCommand_DoFade6', 'params': ''},
{'fun': 'ScriptCommand_DoFade7', 'params': ''},
{'fun': 'ScriptCommand_0807E800', 'params': 'w'},
{'fun': 'ScriptCommand_0807E80C', 'params': 'w'},
{'fun': 'ScriptCommand_0807E858', 'params': 's'},
{'fun': 'ScriptCommand_0807E864', 'params': ''},
{'fun': 'ScriptCommand_0807E878', 'params': ''},
{'fun': 'ScriptCommand_0807E888', 'params': ''},
{'fun': 'ScriptCommand_SetPlayerAction', 'params': 'w'},
{'fun': 'ScriptCommand_StartPlayerScript', 'params': 'w'},
{'fun': 'ScriptCommand_0807E8D4', 'params': 's'},
{'fun': 'ScriptCommand_0807E8E4_0', 'params': ''}, # duplicate
{'fun': 'ScriptCommand_0807E8E4_1', 'params': ''}, # duplicate
{'fun': 'ScriptCommand_0807E8E4_2', 'params': ''}, # duplicate
{'fun': 'ScriptCommand_0807E8E4_3', 'params': ''}, # duplicate
{'fun': 'ScriptCommand_0807E908', 'params': 's'},
{'fun': 'ScriptCommand_0807E914', 'params': 'w'},
{'fun': 'ScriptCommand_0807E924', 'params': ''},
{'fun': 'ScriptCommand_0807E930', 'params': 's'},
{'fun': 'ScriptCommand_0807E944', 'params': ''},
{'fun': 'ScriptCommand_0807E974', 'params': 's'},
{'fun': 'ScriptCommand_0807E9D4', 'params': ''},
{'fun': 'ScriptCommand_0807E9DC', 'params': ''},
{'fun': 'ScriptCommand_0807E9E4', 'params': 's'},
{'fun': 'ScriptCommand_0807E9F0', 'params': ''},
{'fun': 'ScriptCommand_0807EA4C', 'params': ''},
{'fun': 'ScriptCommand_0807EA88', 'params': 's'},
{'fun': 'ScriptCommand_0807EA94', 'params': ''},
{'fun': 'ScriptCommand_TextboxNoOverlapFollow', 'params': 's'},
{'fun': 'ScriptCommand_TextboxNoOverlap', 'params': 's'},
{'fun': 'ScriptCommand_TextboxNoOverlapFollowPos', 'params': 'ss'},
{'fun': 'ScriptCommand_0807EAF0', 'params': 'w'},
{'fun': 'ScriptCommand_TextboxNoOverlapVar', 'params': ''},
{'fun': 'ScriptCommand_0807EB28', 'params': 's'},
{'fun': 'ScriptCommand_0807EB38', 'params': ''},
{'fun': 'ScriptCommand_0807EB44', 'params': 's'},
{'fun': 'ScriptCommand_0807EB4C', 'params': 'ss'},
{'fun': 'ScriptCommand_0807EB74', 'params': ''},
{'fun': 'ScriptCommand_0807EB8C', 'params': ''},
{'fun': 'ScriptCommand_SetEntityDirection', 'params': 's'},
{'fun': 'ScriptCommand_SetEntityDirectionWithAnimationState', 'params': 's'},
{'fun': 'ScriptCommand_SetEntityNonPlanarMovement', 'params': 's'},
{'fun': 'ScriptCommand_SetEntity0x20', 'params': 'w'},
{'fun': 'ScriptCommand_SetEntityPositionRelative', 'params': 'w'},
{'fun': 'ScriptCommand_SetEntityPosition', 'params': 'ss'},
{'fun': 'ScriptCommand_MoveEntityToPlayer', 'params': ''},
{'fun': 'ScriptCommandNop3', 'params': ''},
{'fun': 'ScriptCommand_0807EC1C', 'params': 's'},
{'fun': 'ScriptCommand_0807EC64', 'params': 's'},
{'fun': 'ScriptCommand_0807EC94', 'params': 's'},
{'fun': 'ScriptCommand_0807ECC4', 'params': 's'},
{'fun': 'ScriptCommand_0807ECF4', 'params': 's'},
{'fun': 'ScriptCommand_0807ED24', 'params': 'sss'},
{'fun': 'ScriptCommand_0807EDD4', 'params': 'ss'},
{'fun': 'ScriptCommand_0807EE04', 'params': 'ss'},
{'fun': 'ScriptCommand_0807EE30', 'params': ''},
{'fun': 'ScriptCommand_0807EEB4', 'params': ''},
{'fun': 'ScriptCommand_0807EEF4', 'params': 'ss'},
{'fun': 'ScriptCommand_0807EF3C', 'params': 'ss'},
{'fun': 'ScriptCommand_0807EF80', 'params': 's'},
{'fun': 'ScriptCommand_0807EF90', 'params': 's'},
{'fun': 'ScriptCommand_SoundReq', 'params': 's'},
{'fun': 'ScriptCommand_SoundReq2', 'params': 's'},
{'fun': 'ScriptCommand_SoundReq3', 'params': 'w'},
{'fun': 'ScriptCommand_SoundReq0x80100000', 'params': ''},
{'fun': 'ScriptCommand_ModRupees', 'params': 's'},
{'fun': 'ScriptCommand_ModHealth', 'params': 's'},
{'fun': 'ScriptCommand_IncreaseMaxHealth', 'params': 's'},
{'fun': 'ScriptCommand_0807F034', 'params': 's'},
{'fun': 'ScriptCommand_0807F050', 'params': 's'},
{'fun': 'ScriptCommand_GetInventoryValue', 'params': 's'},
{'fun': 'ScriptCommand_0807F078', 'params': 'ss'},
{'fun': 'ScriptCommand_0807F088', 'params': 's'},
{'fun': 'ScriptCommand_CameraTargetEntity', 'params': ''},
{'fun': 'ScriptCommand_CameraTargetPlayer', 'params': ''},
{'fun': 'ScriptCommand_0807F0B4', 'params': 's'},
{'fun': 'ScriptCommand_0807F0C8', 'params': 'ss'}
]
# definitions for parameters
parameters = {
'': {
'length':0,
'param': '',
'expr': '',
'read': lambda ctx: ''
},
's': {
'length': 1,
'param': 's',
'expr': ' .short \s',
'read': lambda ctx: barray_to_u16_hex(ctx.data[ctx.ptr+2:ctx.ptr+4])[0]
},
'w': {
'length': 2,
'param': 'w',
'expr': ' .word \w',
'read': lambda ctx: barray_to_u32_hex(ctx.data[ctx.ptr+2:ctx.ptr+6])[0]
},
'ss': {
'length': 2,
'param': 'a,b',
'expr': ' .short \\a\n .short \\b',
'read': lambda ctx: ', '.join(barray_to_u16_hex(ctx.data[ctx.ptr+2:ctx.ptr+6]))
},
'ww': {
'length': 4,
'param': 'a,b',
'expr': ' .word \\a\n .word \\b',
'read': lambda ctx: ', '.join(barray_to_u32_hex(ctx.data[ctx.ptr+2:ctx.ptr+10]))
},
'sss': {
'length': 3,
'param': 'a,b,c',
'expr': ' .short \\a\n .short \\b\n .short \\c',
'read': lambda ctx: ', '.join(barray_to_u16_hex(ctx.data[ctx.ptr+2:ctx.ptr+8]))
},
'p': {
'length': 2,
'param': 'w',
'expr': ' .word \w',
'read': lambda ctx: get_pointer(ctx.data[ctx.ptr+2:ctx.ptr+6])
},
'pw': {
'length': 4,
'param': 'a,b',
'expr': ' .word \\a\n .word \\b',
'read': lambda ctx: get_pointer(ctx.data[ctx.ptr+2:ctx.ptr+6]) + ', ' + barray_to_u32_hex(ctx.data[ctx.ptr+6:ctx.ptr+10])[0]
},
}
def build_script_command(name: str):
name = name.replace("ScriptCommand_", "")
if name[0].isdigit():
return '_' + name
return name
def ExecuteScriptCommandSet(ctx: Context):
cmd = struct.unpack('H', ctx.data[ctx.ptr:ctx.ptr+2])[0]
if cmd == 0:
return 0
if cmd == 0xffff:
ctx.ptr += 2
print('SCRIPT_END')
return 0
unk_06 = cmd >> 0xA
if unk_06 == 0:
# TODO error
return 0
operationId = cmd & 0x3FF
if operationId >= len(commands):
# TODO error
return 0
command = commands[operationId]
param_length = unk_06 - 1
if unk_06 > 1:
if ctx.ptr+2*unk_06 >= len(ctx.data):
# TODO raise Exception(f'Not enough data to fetch {unk_06-1} params')
return 0
meta = struct.unpack(
'H'*(unk_06-1), ctx.data[ctx.ptr+2:ctx.ptr+2*unk_06])
#print('meta', meta)
# Handle parameters
if not 'params' in command:
raise Exception('Parameters not defined for ' + command['fun'] + ' Should be of length ' + str(param_length))
if not command['params'] in parameters:
raise Exception('Parameter configuration ' + command['params'] + ' not defined')
params = parameters[command['params']]
if unk_06-1 != params['length']:
# raise Exception(f'Call {command["fun"]} with ' + str(unk_06-1) +' length, while length of ' + str(params['length'])+' defined')
return 0
#with open('log.txt', 'a') as log:
# log.write(f'Call {command["fun"]} with ' + str(unk_06-1) +' length, while length of ' + str(params['length'])+' defined\n')
# TEMPORARY WORKAROUND:
#ctx.ptr += unk_06*2
#return 1
print(build_script_command(command['fun']) + ' ' + params['read'](ctx))
# Execute script
ctx.ptr += unk_06*2
return 1
def disassemble_script(input_bytes):
ctx = Context(0, input_bytes)
while True:
if ctx.ptr >= len(ctx.data) - 1: # End of file (there need to be at least two bytes remaining for the next operation id)
break
if not ExecuteScriptCommandSet(ctx):
break
# Print rest (did not manage to get there)
if ctx.ptr < len(ctx.data):
if (len(ctx.data) - ctx.ptr) % 2 != 0:
print(ctx.data[ctx.ptr:])
# TODO error
return
print('\n'.join(['.short ' + x for x in barray_to_u16_hex(ctx.data[ctx.ptr:])]))
def generate_macros():
print('@ All the macro functions for scripts')
print('@ Generated by disassemble_script.py')
print('.macro SCRIPT_START name')
print(' .globl \\name')
print(' .section .text')
print('\\name:')
print('.endm')
print('.macro SCRIPT_END')
print(' .short 0xffff')
print('.endm')
print('')
for num, command in enumerate(commands):
if not 'params' in command:
raise Exception('Parameters not defined for ' + command['fun'] + '!')
if not command['params'] in parameters:
raise Exception('Parameter configuration ' + command['params'] + ' not defined')
params = parameters[command['params']]
id = ((params['length']+1) << 0xA) + num
print(f'.macro {build_script_command(command["fun"])} {params["param"]}')
print(f' .short {u16_to_hex(id)}')
if params['expr'] != '':
print(params['expr'])
print('.endm')
print('')
#print('#define ' + command['fun'] + '(' + params['param'] + ') asm(".short '+u16_to_hex(id)+'");' + params['expr'])
print('')
def main():
# Read input
input_data = input()
if input_data.strip() == 'macros':
generate_macros()
return
disassemble_script(bytearray.fromhex(input_data))
if __name__ == '__main__':
main()
Reference in New Issue View Git Blame Copy Permalink