mirror of
https://github.com/isledecomp/isle.git
synced 2026-01-20 23:01:16 +00:00
8ef38caf7d
* Introduce "configure.py" and "build.py" * Running "python configure.py && python build.py" will successfully build a clean clone of the project with no additional effort needed. * The repo now includes a copy of ninja for each platform, and the configure script will download MSVC420 for you as part of configuring the project. You can specify --modern-compiler when configuring to configure with a different toolchain if desired. * This also establishes a specific place (/original) for you to put your original game files. The build process will let you know that you need to put them there if you have not yet when you ask to compare to the original game. * The repo also now includes a .vscode folder by default, which contains a tasks.json file including the build / configure tasks. * This includes "build and compare function by cursor" task which allows a very effective workflow where you just hit Ctrl+Shift+B and get an updated diff of the function you were just editing.
78 lines
2.8 KiB
Python
78 lines
2.8 KiB
Python
|
|
import pathlib
|
|
import subprocess
|
|
import argparse
|
|
import re
|
|
import requests
|
|
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument("-i", "--inspect", metavar='<offset>',
|
|
help="Get an assembly diff for the function at a given offset after building. "
|
|
"When decomping you will typically run this command over and over again as "
|
|
"you refine your code towards a 100% match.")
|
|
parser.add_argument("-s", "--status", action="store_true",
|
|
help="Get a general status report on the progress decompiling all functions.")
|
|
parser.add_argument("--inspect-shim", nargs=2, metavar=('<file>', '<line>'),
|
|
help="Inspect the assembly diff of the function spanning <line> in <file>. "
|
|
"Intended to be invoked by IDE commands.")
|
|
args = parser.parse_args()
|
|
|
|
# Figure out what offset to pass to the reccmp tool if any
|
|
def get_inspect_offset():
|
|
if inspect_offset := args.inspect:
|
|
if inspect_offset.startswith("0x"):
|
|
return inspect_offset
|
|
else:
|
|
return "0x" + inspect_offset
|
|
elif args.inspect_shim:
|
|
print("Inspect: ", args.inspect_shim[0], ":", args.inspect_shim[1])
|
|
with open(args.inspect_shim[0], 'r') as f:
|
|
# get the lines in an array
|
|
lines = f.readlines()
|
|
OFFSET_PATTERN = re.compile(r'OFFSET:\s*LEGO1\s*(0x[0-9a-f]+)')
|
|
for i in range(int(args.inspect_shim[1]), 0, -1):
|
|
if i > 0 and i < len(lines):
|
|
if match := OFFSET_PATTERN.search(lines[i]):
|
|
inspect_offset = match.group(1)
|
|
break
|
|
if inspect_offset:
|
|
return inspect_offset
|
|
else:
|
|
print("Could not find any function to inspect near cursor.")
|
|
exit(1)
|
|
return None
|
|
|
|
# If the build directory doesn't exist yet, run configure.py
|
|
if not pathlib.Path("build").exists():
|
|
print("Not configured yet, please run configure.py first.")
|
|
exit(1)
|
|
|
|
# Run cmake, with no parallel build because that does not play nice the
|
|
# MSVC420 compiler the original game was built with thanks to the different
|
|
# threads contending over the pdb file.
|
|
result = subprocess.run(["cmake", "--build", ".", "-j", "1"], cwd="build")
|
|
|
|
def require_original():
|
|
if not pathlib.Path("original/LEGO1.DLL").exists():
|
|
print("Could not find original/LEGO1.DLL to compare results against. "
|
|
"Please obtain a copy the game and place its LEGO1.dll into the `original` folder.")
|
|
exit(1)
|
|
|
|
# If the build succeeded, run the decompiler
|
|
if result.returncode == 0:
|
|
if inspect_offset := get_inspect_offset():
|
|
require_original()
|
|
subprocess.run(["python", "tools/reccmp/reccmp.py",
|
|
"original/LEGO1.DLL", "build/LEGO1.DLL",
|
|
"build/LEGO1.PDB", ".",
|
|
"-v", inspect_offset])
|
|
|
|
elif args.status:
|
|
require_original()
|
|
subprocess.run(["python", "tools/reccmp/reccmp.py",
|
|
"original/LEGO1.DLL", "build/LEGO1.DLL",
|
|
"build/LEGO1.PDB", "."])
|
|
|
|
else:
|
|
print("Build failed.")
|
|
exit(1) |