diff --git a/.gitattributes b/.gitattributes index 15a5c58091..668ebff92c 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1,4 @@ *.h linguist-language=C + +# suppress asm/nonmatchings/ in GitHub diffs +asm/nonmatchings/**/*.s linguist-generated diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 412af57536..755f2ad1e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,4 +79,4 @@ $ ./format.sh If `format.sh` has any problems with your code, go and fix the issues. If you can't fix a warning without making the function not match anymore, append `// NOLINT` to the offending line. -Then, please [create a pull request](https://github.com/pmret/nananian/pulls)! +Then, please [create a pull request](https://github.com/pmret/papermario/pulls)! diff --git a/INSTALL.md b/INSTALL.md index 60707d768b..ba0a912e3d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -23,7 +23,7 @@ Install build dependencies: ./install.sh ``` -Copy a Paper Mario (USA) ROM into the root directory of the repository with the name `baserom.z64`. If you're using WSL, you can enter the Linux filesystem by opening `\\wsl$` in File Explorer; e.g. `\\wsl$\Ubuntu\home\\papermario`. +Copy an unmodified Paper Mario (USA) ROM (sha1: `3837f44cda784b466c9a2d99df70d77c322b97a0`) into the root directory of the repository with the name `baserom.z64`. If you're using WSL, you can enter the Linux filesystem by opening `\\wsl$` in File Explorer; e.g. `\\wsl$\Ubuntu\home\\papermario`. Configure the build and extract assets from the base ROM: ```sh diff --git a/Jenkinsfile b/Jenkinsfile index 5da835cee9..da120335b0 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -18,7 +18,7 @@ pipeline { } steps { sh 'python3 progress.py --csv >> /var/www/papermar.io/html/reports/progress.csv' - sh 'python3 progress.py --shield-json >> /var/www/papermar.io/html/reports/progress_shield.json' + sh 'python3 progress.py --shield-json > /var/www/papermar.io/html/reports/progress_shield.json' } } } diff --git a/README.md b/README.md index bc37b29312..dfb82e6c5a 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ This is a work-in-progress decompilation of Paper Mario (USA). It builds the following ROM: -* [**papermario.z64**](https://datomatic.no-intro.org/index.php?page=show_record&s=24&n=0537) `sha1: 3837f44cda784b466c9a2d99df70d77c322b97a0` +* papermario.z64 `sha1: 3837f44cda784b466c9a2d99df70d77c322b97a0` To set up the repository, see [INSTALL.md](INSTALL.md). diff --git a/configure.py b/configure.py index 1b4257b062..5955f77742 100755 --- a/configure.py +++ b/configure.py @@ -13,7 +13,6 @@ sys.path.append(os.path.dirname(__file__) + "/tools/n64splat") import split INCLUDE_ASM_RE = re.compile(r"_INCLUDE_ASM\([^,]+, ([^,]+), ([^,)]+)") # note _ prefix -CPPFLAGS = "-Iinclude -Isrc -D _LANGUAGE_C -D _FINALROM -ffreestanding -DF3DEX_GBI_2 -D_MIPS_SZLONG=32" TARGET = "papermario" @@ -72,9 +71,9 @@ async def task(coro): num_tasks_done += 1 print(f"\rConfiguring build... {(num_tasks_done / num_tasks) * 100:.0f}%", end="") -async def build_c_file(c_file: str, generated_headers): +async def build_c_file(c_file: str, generated_headers, cppflags): # preprocess c_file, but simply put an _ in front of INCLUDE_ASM and SCRIPT - stdout, stderr = await shell(f"{cpp} {CPPFLAGS} '-DINCLUDE_ASM(...)=_INCLUDE_ASM(__VA_ARGS__)' '-DSCRIPT(...)=_SCRIPT(__VA_ARGS__)' {c_file} -o -") + stdout, stderr = await shell(f"{cpp} {cppflags} '-DINCLUDE_ASM(...)=_INCLUDE_ASM(__VA_ARGS__)' '-DSCRIPT(...)=_SCRIPT(__VA_ARGS__)' {c_file} -o -") # search for macro usage (note _ prefix) uses_dsl = "_SCRIPT(" in stdout @@ -122,6 +121,7 @@ async def main(): parser = ArgumentParser(description="Paper Mario build.ninja generator") parser.add_argument("--cpp", help="GNU C preprocessor command") parser.add_argument("--baserom", default="baserom.z64", help="Path to unmodified Paper Mario (U) z64 ROM") + parser.add_argument("--cflags", default="", help="Extra cc/cpp flags") args = parser.parse_args() # on macOS, /usr/bin/cpp defaults to clang rather than gcc (but we need gcc's) @@ -173,14 +173,16 @@ async def main(): # generate build.ninja n = ninja_syntax.Writer(open("build.ninja", "w"), width=120) + cppflags = "-Iinclude -Isrc -D _LANGUAGE_C -D _FINALROM -ffreestanding -DF3DEX_GBI_2 -D_MIPS_SZLONG=32 " + args.cflags + n.variable("builddir", "build") n.variable("target", TARGET) n.variable("cross", "mips-linux-gnu-") n.variable("python", sys.executable) n.variable("os", "mac" if sys.platform == "darwin" else "linux") n.variable("iconv", "tools/iconv.py UTF-8 SHIFT-JIS" if sys.platform == "darwin" else "iconv --from UTF-8 --to SHIFT-JIS") - n.variable("cppflags", f"{CPPFLAGS} -Wcomment") - n.variable("cflags", "-O2 -quiet -G 0 -mcpu=vr4300 -mfix4300 -mips3 -mgp32 -mfp32 -Wuninitialized -Wshadow") + n.variable("cppflags", f"{cppflags} -Wcomment") + n.variable("cflags", "-O2 -quiet -G 0 -mcpu=vr4300 -mfix4300 -mips3 -mgp32 -mfp32 -Wuninitialized -Wshadow " + args.cflags) n.newline() n.rule("cc", @@ -413,7 +415,7 @@ async def main(): # slow tasks generated concurrently n.comment("c") - tasks = [task(build_c_file(f, "generated_headers")) for f in c_files] + tasks = [task(build_c_file(f, "generated_headers", cppflags)) for f in c_files] num_tasks = len(tasks) num_tasks_done = 0 await asyncio.gather(*tasks)