summaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2026-06-08Automatically detect other common MIPS toolchains, update build dependencies ↵Tharo
in README (#2765) * Automatically detect other common MIPS toolchains, update build dependencies in README * Swap N64_GCCPREFIX and N64_INST for libdragon toolchain detection
2026-05-08Readme: fix GHA build badge (#2754)Dragorn421
2026-04-29Migrate CI to Github Actions (#2742)Dragorn421
* Migrate CI to Github Actions (#2740) Changes the CI system from Jenkins to Github Actions (GHA) as discussed on discord. I tried to adapt the original jenkinsfile as I could. One major difference from the old system is each version will now be built in parallel instead of sequentially. Also, the mapfiles will be uploaded as an GHA artifact to the Action workflow. I think having them easily available would be nice. This specific approach to handle GHA for decomp projects was adapted from the one used by the GC/Wii community. It is documented here https://github.com/encounter/dtk-template/blob/main/docs/github_actions.md There's a writeup about this adaptation for N64 projects [here](https://github.com/AngheloAlf/drmario64/pull/19). * Rename generate_patch_from_gha -> gha_fix_bss_and_generate_patch * Make check formatting always on the full repo * ruin z_fishing bss for CI testing purposes * fix not passing VERSION to tools/gha_fix_bss_and_generate_patch.sh * debugging gha_fix_bss_and_generate_patch.sh * fix the debugging... * git config safe.directory * rm debugging stuff from gha_fix_bss_and_generate_patch.sh * fix_bss gha-side machinery, attempt 1 * fix1 * fix2 * debug1 * checkout repo in merge_bss_fixes job * fix3 * fix4 * fix5 * some prettify * apply_fix_bss_patches.py complete * fix6 * generate_patch.sh is back * apply fix bss changes from gha! it works! * generate_patch.sh suggestion * ruin bss again for testing * unruin bss * Update .github/workflows/format.yml Co-authored-by: Anghelo Carvajal <angheloalf95@gmail.com> * update matrix version list * finalize apply_fix_bss_patches.py --------- Co-authored-by: Anghelo Carvajal <angheloalf95@gmail.com>
2026-04-07oot-gc-eu-dbg-2 OK (#2714)Dragorn421
* oot-gc-eu-dbg-proto OK * add gc-eu-dbg-proto to readme * mention overdump trimming for all debug roms * rename gc-eu-dbg-proto to gc-eu-dbg-2 Rationale: first version to make it into decomp (which should also be the first one that surfaces) gets an un-numbered version name, then the second version gets -2, and so on
2026-03-02gc-eu-dbg OK (#2700)Dragorn421
* gc-eu-dbg OK * cleanup/fortify makefile and line_numbers.h changes * fill segments.csv * add gc-eu-dbg to Jenkinsfile * cleanup/fortify dmadata_table.h * add gc-eu-dbg to readme * fix checksum check and compressed checksum
2026-02-25Update README and build instructions (#2704)Dragorn421
* Remove libpng from requirements * Remove unnecessary packages from dockerfile * Update README * update binutils and gcc versions in macos build instructions
2025-02-04Finish matching ique-cn (#2451)Tharo
* git subrepo clone git@github.com:Thar0/com-plugin.git tools/com-plugin subrepo: subdir: "tools/com-plugin" merged: "e8543312d" upstream: origin: "git@github.com:Thar0/com-plugin.git" branch: "main" commit: "e8543312d" git-subrepo: version: "0.4.6" origin: "https://github.com/ingydotnet/git-subrepo" commit: "110b9eb" * ique-cn OK * Review suggestions * Most suggestions * git subrepo pull tools/com-plugin subrepo: subdir: "tools/com-plugin" merged: "81595ed1c" upstream: origin: "git@github.com:Thar0/com-plugin.git" branch: "main" commit: "81595ed1c" git-subrepo: version: "0.4.6" origin: "https://github.com/ingydotnet/git-subrepo" commit: "110b9eb" * Fix other versions
2024-12-26Download ido-recomp compiler binaries instead of committing them (#2388)cadmic
* Download ido-recomp compiler binaries instead of committing them * Skip downloading compilers if ido_recomp/ exists * Use make instead of bash script
2024-11-12Completely match ntsc-1.0/1.1 bss and add to CI (#2294)cadmic
2024-10-14Add multiversion instructions to README (#2247)cadmic
* Add multiversion instructions to README * Direct users toward Makefile * Modify options "below" instead of "in the Makefile" * Reword
2024-08-15Update links in readme (#2043)Dragorn421
2024-08-14[Audio 4/?] Build Samplebanks, match Audiotable (#2032)Tharo
* [Audio 4/?] Build Samplebanks, match Audiotable * Fix some makefile formatting * Add missing scope in MARK chunk handling * Add comment to generate asm file when buffer bug data is emitted, remove duplicate CC4 definition * Adjust comment * SBCFLAGS * Remove unnecessary comments on notes_lut * Split build directories creation command into several to avoid it becoming too long * objcopy -j -> --only-section * Fix mkdir warning when extracted/VERSION/assets doesn't exist
2024-05-07Remove Cygwin support (#1951)cadmic
2024-03-04Remove 0xFF padding from uncompressed ROMs (#1910)cadmic
* Remove 0xFF padding from uncompressed ROMs * Add comment about overdump contents * Update checksum in README * Reword comment
2024-02-20Suggest explorer.exe in README.md (#1747)cadmic
* Suggest explorer.exe in README.md * Fix typo and put on separate line
2024-02-02Move roms to build folder (#1651)Derek Hensley
* Move built roms to build directory, along with rename map and linker script * PR review * sym_info fix * Revert docs/tutorial/data.md change
2024-01-25Use virtualenv in Makefile for python dependencies (#1619)cadmic
* Use virtualenv in Makefile for python dependencies * Create separate targets for venv creation and installation * Fix install-python-deps prerequisite * Try simplifying Jenkinsfile * Simplify venv targets * Fix merge * Update README.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> --------- Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2024-01-24Suggest pip install -U -r requirements.txt (#1618)cadmic
* Suggest pip install -r requirements.txt * Update README.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> --------- Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2024-01-24Setup rom decompression and compression (#1614)Anghelo Carvajal
* 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 <cadmic24@gmail.com> * 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 <Dragorn421@users.noreply.github.com> * Update crunch64 * Label compressed instead of uncompressed * Update README.md Co-authored-by: fig02 <fig02srl@gmail.com> * Fix * `make rom` * baserom-uncompressed * Update README.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Update README.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Update README.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Update README.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Update README.md Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * 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 <Dragorn421@users.noreply.github.com> --------- Co-authored-by: cadmic <cadmic24@gmail.com> Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> Co-authored-by: fig02 <fig02srl@gmail.com>
2024-01-05Create separate build directories based on version (#1591)cadmic
* Create separate build directories based on version * Fix find_unused_asm.sh * Remove find_unused_asm.sh from Jenkinsfile * Revert diff.py * Clarify that gc-eu-mq is not "supported" yet * Revert xmlcreate.py (to be deleted) * Remove gc-eu-mq for now * Add version flags to diff_settings.py and sym_info.py * --version -> --oot-version * Fix --oot-version * Revert adding version flags to tools * Delete find_unused_asm.sh * Revert changes to first_diff.py output in tutorial * Factor out sed usages for spec
2023-09-22Rename master to main (#1536)Derek Hensley
* Jenkinsfile master -> main * Missed some instances of master
2022-04-29Do not require colorama, do not use it (#1205)Dragorn421
2022-03-08Add note on cloning into WSL's Linux filesystem (#1163)EllipticEllipsis
2022-02-19Add GCC compiler option. (#1056)Revo
* GCC support. * Add note about gcc-mips-linux-gnu requirement to README.md. * changes * changes based on Tharo's suggestion * Cant reproduce file_choose.h error. Removing unnecessary -I * changes * wording based on Fig's suggestion * add AVOID_UB for eyes/mouth reordering issue. * remove unneeded flags and deprecate ZAPDFLAGS. * some changes, waiting on prs for the rest * fixes * discard header sections * change section handling in mkldscript * avoid_ub in DmaMgr_GetFileNameImpl * move asm to inline asm (consolidate gcc functions) * change prefix back * remove space * fix warnings * Revert "remove space" This reverts commit 94af6977b3eb4856b0d8e9eeac602c61f8010576. * Revert "fix warnings" This reverts commit d729ddf45743d6f039526469a15a15874926e9d0. * finish up missing_gcc_functions * revert unwanted mkldscript change * temporary workaround. TODO: Stop the asm processor from choking * fix ido build * Revert "temporary workaround. TODO: Stop the asm processor from choking" This reverts commit 9df892b7acb85b058ae33a1bb5970e9b52c36145. * review * remove unused line in mkldscript * remove tabs * clarify zf comment * review2 * review * remove duplicate cc_check * vanilla code always come first * std_dma avoid ub * add compiler_gcc to cflags * only use two blocks when necessary * clarify zf comment Co-authored-by: fig02 <fig02srl@gmail.com>
2022-01-16Building on Macs (#1086)EllipticEllipsis
* git subrepo pull (merge) tools/ZAPD subrepo: subdir: "tools/ZAPD" merged: "945e6ca1a" upstream: origin: "https://github.com/zeldaret/ZAPD.git" branch: "master" commit: "50242eca9" git-subrepo: version: "0.4.3" origin: "https://github.com/ingydotnet/git-subrepo.git" commit: "2f68596" * Fix extract_assets.py multithreading * Update binutils doc a bit * Remove * import, add multiprocessing option and way to pass arguments to ZAPD * Update format.sh to be more platform-independent * git subrepo pull --force tools/ZAPD subrepo: subdir: "tools/ZAPD" merged: "fd5a7f434" upstream: origin: "https://github.com/zeldaret/ZAPD.git" branch: "master" commit: "fd5a7f434" git-subrepo: version: "0.4.3" origin: "https://github.com/ingydotnet/git-subrepo.git" commit: "2f68596" * Remove ; * Update formatting script to not just use 11 * Add Python requirements, move the Mac stuff in the README into its own doc * Fix readme link * Minor format thing * . * Move ZAPDArgs into its own function * Update readme and remove requirements.txt * Dragorn-inspired rewrite of processZAPDArgs * git subrepo pull --force tools/ZAPD subrepo: subdir: "tools/ZAPD" merged: "a0d3f7b68" upstream: origin: "https://github.com/zeldaret/ZAPD.git" branch: "master" commit: "a0d3f7b68" git-subrepo: version: "0.4.3" origin: "https://github.com/ingydotnet/git-subrepo.git" commit: "2f68596" * Fix function definition * Building docs overhaul * Add Python packages to Mac and Cygwin * Heading number * format format.sh (!) * Replace "currently" * Remove Debian * git subrepo pull (merge) --force tools/ZAPD subrepo: subdir: "tools/ZAPD" merged: "0ba781304" upstream: origin: "https://github.com/zeldaret/ZAPD.git" branch: "master" commit: "0ba781304" git-subrepo: version: "0.4.3" origin: "https://github.com/ingydotnet/git-subrepo.git" commit: "2f68596"
2021-12-19Changed progress.py csv output to be compatible with new website (#1075)EllipticEllipsis
* Changed progress.py csv output to be compatible with new website * Increment and clarify csv version * Update csv paths
2021-12-06Minor README updates and cleanup (#1066)Roman971
* Update README for Windows 11 and distro version * Improve naming consistency in the README
2021-08-13Clarify nature of the project in the readme (#894)EllipticEllipsis
* Clarify nature of the project * Dragorn's review * Remove ignored formatting * Mollified the wording somewhat * Move sentence down * Discord suggestions * rebreak text in diff
2021-05-30ZAPD update: libpng, zroom improvements and others (#811)Anghelo Carvajal
* git subrepo pull --force tools/ZAPD subrepo: subdir: "tools/ZAPD" merged: "769f5702a" upstream: origin: "https://github.com/zeldaret/ZAPD.git" branch: "master" commit: "769f5702a" git-subrepo: version: "0.4.3" origin: "???" commit: "???" * Add `libpng` to readme * Remove `-ifp` since it doesn't exists anymore in ZAPD * Remove extra print I added * Add UNK_09 macro and other minor fixes * Simplify PNG rules * simplify gitignore * Update README.md Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com> * Update dockerfile * basic instructions for cygwin and mac * git subrepo pull --force tools/ZAPD subrepo: subdir: "tools/ZAPD" merged: "86160be69" upstream: origin: "https://github.com/zeldaret/ZAPD.git" branch: "master" commit: "86160be69" git-subrepo: version: "0.4.3" origin: "???" commit: "???" * Change nanoseconds to seconds in extract_assets.py Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com>
2021-05-20Removes qemu from the README.md (#819)Kenix3
* Removes qemu from the README.md * Increments the step references in other parts of the README.md * Update README.md Co-authored-by: Anghelo Carvajal <anghelo.carvajal.14@sansano.usm.cl> * Update README.md Co-authored-by: Anghelo Carvajal <anghelo.carvajal.14@sansano.usm.cl> * Update README.md Co-authored-by: Anghelo Carvajal <anghelo.carvajal.14@sansano.usm.cl> * Update README.md Co-authored-by: Anghelo Carvajal <anghelo.carvajal.14@sansano.usm.cl> Co-authored-by: Anghelo Carvajal <anghelo.carvajal.14@sansano.usm.cl>
2021-05-03Delete `-j` from `make setup` and document use of `-jN` and `-j` in readme ↵EllipticEllipsis
(#804) * Add nproc to make setup * Add cross-platform nproc equivalents * Scrap that, just ditch -j in makefile altogether * Clarified thread advice
2021-03-26Update Jenkins links in README (#738)Roman971
2021-02-11Various README updates (#671)Roman971
* Update README * Add shields.io badges in the README * Add a mention about shiftability in README * Fix shield json command in JenkinsFile * Improve progress badge formatting Now it should show the percentage as 51.2% instead of 51.17%, and 100% instead of 100.00%
2021-01-20Add Cygwin support (#594)Random
* Add Cygwin support * revert .gitignore changes * Add Cygwin instructions * corrections * specify dependencies in README.md
2021-01-14fixbaserom.py: Add support to v64 format and improve performance (#629)Anghelo Carvajal
* Add byte swap for v64 files Signed-off-by: angie <angheloalf95@gmail.com> * Reduce `len` function calls Signed-off-by: angie <angheloalf95@gmail.com> * Optimze a bit the byte-swapped v64 format Signed-off-by: angie <angheloalf95@gmail.com> * Strip the overdump before doing the byte-swap The previous way wasted time by byte-swapping data that would be discarded anyway. Signed-off-by: angie <angheloalf95@gmail.com> * Swap twice the bytes per cycle to improve performance Signed-off-by: angie <angheloalf95@gmail.com> * Read and write 16 bytes at a time and specify explicit endianness Reading more bytes per cycle allow to speed up the swapping proccess Signed-off-by: angie <angheloalf95@gmail.com> * Add v64 compatibility in the Readme Signed-off-by: angie <angheloalf95@gmail.com> * Read whole file as little endian and write it as big endian without the loop Signed-off-by: angie <angheloalf95@gmail.com>
2020-11-28Fix 'make' failing due to missing 'md5sum' command (#502)mnzlmstr
2020-09-21Native MacOS build support (#399)Ethan Roseman
* MacOS build OK * Adding build instructions for building mips-linux-binutils on MacOS * * * Update Makefile Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com> Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com>
2020-08-27fix typo in MacOS docker instructions (#353)notyouraveragehooman
2020-08-22Ido Static Recomp (#337)Ethan Roseman
* Ido Recomp test * try 2 * Recomp by default * Fix Jenkinsfile * Fix 2 * CFE errors * CFE fix -O2 * Update Makefile Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com> * Update README.md Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com> * Update README.md Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com> * PR suggestions * PR updates Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com>
2020-05-01Update README with "qemu-irix" instead of "qemu-irix.zip" (#106)Roman971
2020-04-30Add installation instructions to the README (+ minor improvements) (#100)Roman971
2020-04-17Update README.mdNicholas Estelami
2020-03-28Updated jenkins file, readme, and replaced 'extract' target with 'setup'Jack Walker
2020-03-28Forgot to save updated readmeJack Walker
2020-03-17First proper commit.Jack Walker
2020-03-17Initial commitJack Walker