1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
#!/usr/bin/env python3
###############################################################################
###### Use: python3 tools/script_extractor --noauto --error location ######
###### --noauto turns off automatic script parsing (enter to continue) ######
###### --error stops execution if an error occurs ######
###### location can be local to bank or global. This program assumes ######
###### every script is in bank 3, which seems to be the case. ######
###### ######
###### Script list is a work in progress. The following arguments are ######
###### accepted and accounted for. ######
###### b - byte w - word j - jump (within script) t - text (tx) ######
###### f - flag d - direction i - decimal byte ######
###### q - Used when the script's arguments have not been determined yet ######
###############################################################################
import argparse
# Quit Types
DO_NOT_QUIT = 0
QUIT_CONTINUE_CODE = 1
QUIT_JUMP = 2
QUIT_SPECIAL = 3
QUIT_DEBUG = -1
def decodeLine(scriptList, game_data, loc, ignore_broken, branchList):
currLine = scriptList[game_data[loc]]
ret = "\trun_script " + currLine[0] + "\n"
loc+=1
quit = currLine[2]
for c in currLine[1]:
if c == "b":
ret += "\tdb $" + format(game_data[loc],"02x") + "\n"
loc += 1
elif c == "i":
ret += "\tdb " + str(game_data[loc]) + "\n"
loc += 1
elif c == "w":
ret += "\tdw $" + format((game_data[loc] + (game_data[loc+1]<<8)),"04x") + "\n"
loc += 2
elif c == "j":
wordLoc = (game_data[loc] + (game_data[loc+1]<<8))
if wordLoc == 0000:
ret += "\tdw NO_JUMP\n"
else:
ret += "\tdw .ows_" + format(wordLoc+0x8000,"04x") + "\n"
branchList.append(wordLoc)
loc += 2
elif c == "t":
addr = (game_data[loc] + (game_data[loc+1]<<8))
if addr == 0:
ret += "\tdw $0000\n"
else:
ret += "\ttx Text" + format(addr,"04x") + "\n"
loc += 2
elif c == "f":
ret += "\tdb EVENT_FLAG_" + format(game_data[loc],"02X") + "\n"
loc += 1
elif c == "d":
dir_list = ["NORTH","EAST","SOUTH","WEST"]
ret += "\tdb " + dir_list[game_data[loc]] + "\n"
loc += 1
elif c == "q":
print("haven't updated data for this yet")
if not ignore_broken:
quit = QUIT_DEBUG
else:
print("UNACCEPTED CHARACTER: " + c)
return (loc, ret, quit)
def main():
scriptList = createList()
branchList = []
parser = argparse.ArgumentParser(description='Pokemon TCG Script Extractor')
parser.add_argument('--noauto', action='store_true', help='turns off automatic script parsing')
parser.add_argument('--error', action='store_true', help='stops execution if an error occurs')
parser.add_argument('-r', '--rom', default="baserom.gbc", help='rom file to extract script from')
parser.add_argument('location', help='location to extract from. May be local to bank or global.')
args = parser.parse_args()
loc = int(args.location,0)
if loc > 0x7fff:
# Must be a global location
loc -= 0x8000
branchList.append(loc)
# this is a list of every start location we've read to avoid infinite loops
exploredList = []
with open(args.rom, "rb") as file:
game_data = file.read()
auto = not args.noauto
end = False
ignore_broken = not args.error
while (len(branchList) > 0):
branchList.sort() # export parts in order somewhat
loc = branchList.pop(0) + 0x8000
printScript(game_data, loc, auto, end, ignore_broken, scriptList,\
branchList, exploredList)
def printScript(game_data, loc, auto, end, ignore_broken, scriptList, \
branchList, exploredList):
if loc in exploredList:
return
exploredList.append(loc)
script = ""
if game_data[loc] != 0xe7:
#print("Error: first byte was not start_script")
print(".ows_" + format(loc,"04x"))
else:
# TODO this is hacky please don't do this
ls = format(loc,"04x")
lsa = format(loc-0x8000,"04x")
print("OWSequence_" + ls + ": ; " + ls + " (3:" + lsa + ")" )
loc += 1
print("\tstart_script")
while end == DO_NOT_QUIT:
loc, outstr, end = decodeLine(scriptList,game_data,loc,ignore_broken,branchList)
outstr = outstr[:-1] # [:-1] strips the newline at the end
if auto:
print(outstr)
else:
input(outstr)
warning = ""
if end == QUIT_CONTINUE_CODE:
warning = " WARNING: There is probably regular assembly here"
#elif end == QUIT_SPECIAL:
# warning = "\nWARNING: This will return to the place that began this Sequence"
print("; " + hex(loc) + warning)
def createList(): # this is a func just so all this can go at the bottom
# name, arg list, is an ender
return [
("OWScript_EndScriptLoop1", "", QUIT_CONTINUE_CODE),
("OWScript_CloseAdvancedTextBox", "", DO_NOT_QUIT),
("OWScript_PrintTextString", "t", DO_NOT_QUIT),
("Func_ccdc", "bb", DO_NOT_QUIT),
("OWScript_AskQuestionJump", "tj", DO_NOT_QUIT), # more complex behavior too (jumping)
("OWScript_StartBattle", "bbb", DO_NOT_QUIT),
("OWScript_PrintVariableText", "tt", DO_NOT_QUIT),
("Func_cda8", "bbbb", DO_NOT_QUIT),
("OWScript_PrintTextCloseBox", "t", QUIT_CONTINUE_CODE),
("Func_cdcb", "", DO_NOT_QUIT),
("Func_ce26", "bb", DO_NOT_QUIT),
("OWScript_CloseTextBox", "", DO_NOT_QUIT),
("OWScript_GiveBoosterPacks", "bbb", DO_NOT_QUIT),
("Func_cf0c", "bbb", DO_NOT_QUIT), # more complex behavior too (jumping)
("Func_cf12", "bbb", DO_NOT_QUIT),
("OWScript_GiveCard", "b", DO_NOT_QUIT),
("OWScript_TakeCard", "b", DO_NOT_QUIT),
("Func_cf53", "w", DO_NOT_QUIT), # more complex behavior too (jumping)
("Func_cf7b", "", DO_NOT_QUIT),
("Func_cf2d", "bbbb", DO_NOT_QUIT), # more complex behavior too (jumping + ??)
("Func_cf96", "w", DO_NOT_QUIT), # only jumps? still needs args to do that though
("Func_cfc6", "b", DO_NOT_QUIT),
("Func_cfd4", "", DO_NOT_QUIT),
("Func_d00b", "", DO_NOT_QUIT), # includes something with random and extra data
("Func_d025", "w", DO_NOT_QUIT), # possibly only jumps, still needs args
("Func_d032", "w", DO_NOT_QUIT), # see above
("Func_d03f", "", DO_NOT_QUIT),
("OWScript_Jump", "j", QUIT_JUMP), # jumps to d
("Func_d04f", "", DO_NOT_QUIT),
("OWScript_SetPlayerDirection", "d", DO_NOT_QUIT),
("OWScript_MovePlayer", "db", DO_NOT_QUIT),
("OWScript_ShowCardReceivedScreen", "b", DO_NOT_QUIT),
("OWScript_SetDialogName", "b", DO_NOT_QUIT),
("OWScript_SetNextNPCandOWSequence", "bj", DO_NOT_QUIT),
("Func_d095", "bbb", DO_NOT_QUIT),
("Func_d0be", "bb", DO_NOT_QUIT),
("OWScript_DoFrames", "b", DO_NOT_QUIT),
("Func_d0d9", "bbw", DO_NOT_QUIT), # jumps but still needs args
("OWScript_JumpIfPlayerCoordMatches", "iij", DO_NOT_QUIT), # jumps but still needs args
("Func_ce4a", "bb", DO_NOT_QUIT),
("OWScript_GiveOneOfEachTrainerBooster", "", DO_NOT_QUIT),
("Func_d103", "q", DO_NOT_QUIT),
("Func_d125", "b", DO_NOT_QUIT),
("Func_d135", "b", DO_NOT_QUIT),
("Func_d16b", "q", DO_NOT_QUIT),
("Func_cd4f", "q", DO_NOT_QUIT),
("Func_cd94", "q", DO_NOT_QUIT),
("Func_ce52", "q", DO_NOT_QUIT),
("Func_cdd8", "q", DO_NOT_QUIT),
("Func_cdf5", "q", DO_NOT_QUIT),
("Func_d195", "q", DO_NOT_QUIT),
("Func_d1ad", "", DO_NOT_QUIT),
("Func_d1b3", "q", DO_NOT_QUIT),
("OWScript_QuitScriptFully", "", QUIT_SPECIAL), # it calls inc twice but it ends anyway?
("Func_d244", "q", DO_NOT_QUIT),
("Func_d24c", "q", DO_NOT_QUIT),
("OWScript_OpenDeckMachine", "q", DO_NOT_QUIT),
("Func_d271", "q", DO_NOT_QUIT),
("OWScript_EnterMap", "bbood", DO_NOT_QUIT),
("Func_ce6f", "bbb", DO_NOT_QUIT),
("Func_d209", "q", DO_NOT_QUIT),
("Func_d38f", "q", DO_NOT_QUIT),
("Func_d396", "q", DO_NOT_QUIT),
("Func_cd76", "q", DO_NOT_QUIT),
("Func_d39d", "q", DO_NOT_QUIT),
("Func_d3b9", "q", DO_NOT_QUIT),
("OWScript_GivePCPack", "b", DO_NOT_QUIT),
("OWScript_nop", "", DO_NOT_QUIT),
("Func_d3d4", "q", DO_NOT_QUIT),
("Func_d3e0", "", DO_NOT_QUIT),
("Func_d3fe", "q", DO_NOT_QUIT),
("Func_d408", "b", DO_NOT_QUIT),
("Func_d40f", "q", DO_NOT_QUIT),
("Func_d416", "q", DO_NOT_QUIT),
("Func_d423", "q", DO_NOT_QUIT),
("Func_d429", "q", DO_NOT_QUIT),
("Func_d41d", "", DO_NOT_QUIT),
("Func_d42f", "q", DO_NOT_QUIT),
("Func_d435", "b", DO_NOT_QUIT),
("OWScript_AskQuestionJumpDefaultYes", "tj", DO_NOT_QUIT),
("Func_d2f6", "q", DO_NOT_QUIT),
("Func_d317", "", DO_NOT_QUIT),
("Func_d43d", "q", DO_NOT_QUIT),
("OWScript_EndScriptLoop2", "q", QUIT_CONTINUE_CODE),
("OWScript_EndScriptLoop3", "q", QUIT_CONTINUE_CODE),
("OWScript_EndScriptLoop4", "q", QUIT_CONTINUE_CODE),
("OWScript_EndScriptLoop5", "q", QUIT_CONTINUE_CODE),
("OWScript_EndScriptLoop6", "q", QUIT_CONTINUE_CODE),
("OWScript_SetFlagValue", "fb", DO_NOT_QUIT),
("OWScript_JumpIfFlagZero1", "q", DO_NOT_QUIT),
("OWScript_JumpIfFlagNonzero1", "q", DO_NOT_QUIT),
("OWScript_JumpIfFlagEqual", "fbj", DO_NOT_QUIT), # also capable of jumping
("OWScript_JumpIfFlagNotEqual", "fbj", DO_NOT_QUIT), # jumps
("OWScript_JumpIfFlagNotLessThan", "fbj", DO_NOT_QUIT),
("OWScript_JumpIfFlagLessThan", "fbj", DO_NOT_QUIT),
("OWScript_MaxOutFlagValue", "f", DO_NOT_QUIT),
("OWScript_ZeroOutFlagValue", "q", DO_NOT_QUIT),
("OWScript_JumpIfFlagNonzero2", "fj", DO_NOT_QUIT),
("OWScript_JumpIfFlagZero2", "fj", DO_NOT_QUIT),
("OWScript_IncrementFlagValue", "f", DO_NOT_QUIT),
("OWScript_EndScriptLoop7", "q", QUIT_CONTINUE_CODE),
("OWScript_EndScriptLoop8", "q", QUIT_CONTINUE_CODE),
("OWScript_EndScriptLoop9", "q", QUIT_CONTINUE_CODE),
("OWScript_EndScriptLoop10", "q", QUIT_CONTINUE_CODE)
]
main()
|
