From 3d9db8d34dd56b7e8ba6dda87b2f9eca820ea749 Mon Sep 17 00:00:00 2001 From: Anghelo Carvajal Date: Wed, 24 Jan 2024 15:00:10 -0300 Subject: Setup rom decompression and compression (#1614) * decompress baserom * cleanup * specific hash check * rename baserom * git subrepo clone (merge) --branch=5da3132606e4fd427a8d72b8428e4f921cd6e56f git@github.com:z64tools/z64compress.git tools/z64compress subrepo: subdir: "tools/z64compress" merged: "5da313260" upstream: origin: "git@github.com:z64tools/z64compress.git" branch: "5da3132606e4fd427a8d72b8428e4f921cd6e56f" commit: "5da313260" git-subrepo: version: "0.4.3" origin: "https://github.com/ingydotnet/git-subrepo.git" commit: "2f68596" * setup compression * Add all compressed segments to the spec * Update md5 files * readme instructions * cleanup * Setup python dependencies on Jenkinsfile * Update Makefile Co-authored-by: cadmic * review * . .venv/bin/activate * update readme * whoops * Yeet other versions from decompress_baserom.py * my bad * Move everything to baseroms/VERSION/ * Active venv on each command * jenkinsfile: use multiline syntax * Put the correct path on the jenkinsfile * Forgot to call per_version_fixes * CC0 * Update readme * Change where baserom segments are put into * Update Makefile Co-authored-by: Dragorn421 * Update crunch64 * Label compressed instead of uncompressed * Update README.md Co-authored-by: fig02 * Fix * `make rom` * baserom-uncompressed * Update README.md Co-authored-by: Dragorn421 * Update README.md Co-authored-by: Dragorn421 * Update README.md Co-authored-by: Dragorn421 * Update README.md Co-authored-by: Dragorn421 * Update README.md Co-authored-by: Dragorn421 * review * baserom-decompressed.z64 * ignore baseroms * rm -rf tools/z64compress * wip crunch64-based compress.py * OK compress * use ipl3checksum sum directly for cic update on compressed rom * multithreading * "docs" * fix MT: move set_sigint_ignored to global level for pickling * license compress.py * rm junk * Fix (or at least sort out) compress_ranges.txt dependencies * Update tools/overlayhelpers/damage_table.py Co-authored-by: Dragorn421 --------- Co-authored-by: cadmic Co-authored-by: Dragorn421 Co-authored-by: fig02 --- docs/tutorial/beginning_decomp.md | 4 ++-- docs/tutorial/data.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/tutorial') diff --git a/docs/tutorial/beginning_decomp.md b/docs/tutorial/beginning_decomp.md index 49f25784e..54fde940b 100644 --- a/docs/tutorial/beginning_decomp.md +++ b/docs/tutorial/beginning_decomp.md @@ -229,7 +229,7 @@ which initialises common properties of actor using an InitChain, which is usuall The InitChain script is also in the tools directory, and is called `ichaindis.py`. Simply passing it the ROM address will spit out the entire contents of the InitChain, in this case: ``` -$ ./tools/ichaindis.py baserom.z64 80A88CE0 +$ ./tools/ichaindis.py baseroms/gc-eu-mq-dbg/baserom-decompressed.z64 80A88CE0 static InitChainEntry sInitChain[] = { ICHAIN_VEC3F_DIV1000(unk_50, 87, ICHAIN_CONTINUE), ICHAIN_F32(unk_F4, 4000, ICHAIN_CONTINUE), @@ -240,7 +240,7 @@ static InitChainEntry sInitChain[] = { However, some of these variables have now been given names in the Actor struct. Pass it `--names` to fill these in automatically: ``` -$ ./tools/ichaindis.py --names baserom.z64 80A88CE0 +$ ./tools/ichaindis.py --names baseroms/gc-eu-mq-dbg/baserom-decompressed.z64 80A88CE0 static InitChainEntry sInitChain[] = { ICHAIN_VEC3F_DIV1000(scale, 87, ICHAIN_CONTINUE), ICHAIN_F32(uncullZoneForward, 4000, ICHAIN_CONTINUE), diff --git a/docs/tutorial/data.md b/docs/tutorial/data.md index 421bc0fe6..a96d26d84 100644 --- a/docs/tutorial/data.md +++ b/docs/tutorial/data.md @@ -557,7 +557,7 @@ Ignore the first line: `gDmaDataTable` is always different if the ROM is shifted To fix this, we use a binary diff program. A suitable one is `vbindiff`: run it on the baserom and the zelda_whatever one the compiler generates: ``` -vbindiff baserom.z64 oot-gc-eu-mq-dbg.z64 +vbindiff baseroms/gc-eu-mq-dbg/baserom-decompressed.z64 oot-gc-eu-mq-dbg.z64 ``` In this, press `g` to open up goto position, and paste in the address `0xE3ED10` from the first important line of the `first_diff` output. This gives us the following: -- cgit v1.2.3