summaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2025-08-12Fix docker builds (#1814)Anghelo Carvajal
* Fix dockerfile. It was broken because the practicerom package changed stuff and apt didn't like whatever changed. This is the commit that seems to have broken how the old practicerom package worked: https://github.com/glankk/n64/commit/e7bec93b0b11b37a63abcf5ac28728f2fcd4045b#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5 * Update docker docs. Some references were broken in the markdown files, and there's no longer a need to run the git `safe.directory` command since the docker file was doing it already * Include `gcc-mips-linux-gnu` in the dockerfile * break up dockerfile commands a bit more * Update practicerom instructions * Update practice rom again
2025-01-12Download IDO recomp instead of commiting binaries (#1781)Derek Hensley
* download ido * silence curl
2024-09-16Update links (#1690)Derek Hensley
2024-08-14[Audio 4/?] Build Samplebanks, match Audiotable (#1672)Tharo
* [Audio 4/?] Build Samplebanks, match Audiotable * 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 * Try fix mkdir from clean * Try fix 2
2024-04-06Build Sync (#1600)Derek Hensley
* Rename outputs * Makefile target renames * Add run target * yeet z64compress * venv * baserom_uncompressed -> baserom-decompressed * input rom name to baserom.z64 * Add BUILD_DIR makefile variable * Move built roms to build dir * Move baserom to baseroms folder * Add version to map file name * Makefile cleanup * Rename ldscript to include version * Multiversion build * n64-us version name * Remove venv as dependency of setup * Readme wording * extract_baserom.py suggestion * Readd checksums * Make .venv work with windows * missed an endif * Cleaner windows venv implementation * Remove duplciate process * Build process steps * Move make_options back * Fix schedule build directory * Fix schedule includes * Makefile NON_MATCHING check -> != 0 * OOT 1704 changes * Small cleanups * Missed 1 thing * UNSET -> SYMS * Update extract_baserom.py * dmadata.py * Small cleanup * dmadata_start * Format * dmadata files * Fix makefile comment * Jenkins report fix * extracted dir * Python dependencies order in readme
2023-11-10Update README with python venv instructions (#1372)Parker
This change updates the README to include instructions for setting up a python virtual environment.
2023-09-22master to main rename (#1379)Derek Hensley
* master -> main * Missed some instances of master
2022-10-13Update README.md (#1116)Parker Burnett
Fixing game link to redirect to the correct place
2022-08-04Fixed "How to Contribute" link in README.md (#1000)Thomas
2022-07-23Fix namefixer.py (#972)Tom Overton
* Fix namefixer.py * Fix contributing link (I think)
2022-07-22EnBjt OK and documented (#912)EllipticEllipsis
* OK, data imported * Fix some typos * Start docs * Struct almost finished * Start object, add state enum * undefined_syms * Finish object, name some more stuff * Name a few states and another function * PlayState * Minor tweaks in z_room and z_sub_s * Complete documentation * spec * Review 1 * functions.txt * Schedule result enum * Rename schedule results * Review * Remove update comments * Inventory_DeleteItem * PLAYER_STATE * Format * Review * Update struct name
2022-07-11Adding Docker Support (#914)Parker Burnett
* Adding dockerfile and instructions for building * fixing readme and updating Dockerfile * Adding packages and practicerom support
2022-07-11Adding Git information to tutorial (#862)Parker Burnett
* Adding an intro to git with helpful commands for someone unfamiliar with git. Co-authored by: EllipticEllipsis <elliptic.ellipsis@gmail.com> * Adding an intro to git with helpful commands for someone unfamiliar with git. Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com> * ovl_Obj_Y2lift decompiled (#856) * ovl_Obj_Y2lift decompiled * format * pr review fixes * clean up Co-authored-by: SonicDcer <noreply@github.com> * Formating files and moving contributing.md Also fixes links. * Adding an intro to git with helpful commands for someone unfamiliar with git. formating files too Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com> * pr fixes Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com> Co-authored-by: Alejandro Asenjo <96613413+sonicdcer@users.noreply.github.com> Co-authored-by: SonicDcer <noreply@github.com>
2022-05-25Contributing docs refresh (#793)EllipticEllipsis
* Contributing docs refresh * Apply suggestions from code review Co-authored-by: LtPeriwinkle <62761190+LtPeriwinkle@users.noreply.github.com> * Link MM tutorial * Add link to XML spec * Review Co-authored-by: LtPeriwinkle <62761190+LtPeriwinkle@users.noreply.github.com>
2022-03-29Update Readme (#765)Derek Hensley
* Update * Update MacOS instructions * forgot . * New python step * typo
2021-12-28Building on Macs (#513)EllipticEllipsis
* Building on Macs * Add Mac building documentation * Review * Update for new z64compress * Review * git subrepo pull --force tools/ZAPD subrepo: subdir: "tools/ZAPD" merged: "155a463a5" upstream: origin: "https://github.com/zeldaret/ZAPD.git" branch: "master" commit: "155a463a5" git-subrepo: version: "0.4.3" origin: "https://github.com/ingydotnet/git-subrepo.git" commit: "2f68596" * Fix some obvious warnings * Rewrite docs * -; * 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" Co-authored-by: Anghelo Carvajal <angheloalf95@gmail.com>
2021-12-19Fix readme badge (#515)Anghelo Carvajal
2021-12-18Update progress script with new assets categories and update csv output ↵Anghelo Carvajal
format (#510) * Reorganize csvs and progress.py * Put stuff in the correct folders * Reduce lots of repeated code * Change csv output format * Filter out automaticaly named variables in "Matching" progress calculation for assets * Address Elliptic's review * Don't count handwritten files in progress and add a way to fix files detected in the wrong section * Add missing "total" * More fixing * Add two missing columns * Update paths in Jenkinsfile * Update progress shield in readme * Update progress link
2021-09-02Updates README to add an FAQ, and also updates CONTRIBUTING to be explicit ↵Kenix3
on the reservation workflow process. (#245)
2021-06-07Convert every submodule into subrepo (#170)Anghelo Carvajal
* remove ZAPD submodule * git subrepo clone https://github.com/zeldaret/ZAPD.git tools/ZAPD subrepo: subdir: "tools/ZAPD" merged: "ca229f19" upstream: origin: "https://github.com/zeldaret/ZAPD.git" branch: "master" commit: "ca229f19" git-subrepo: version: "0.4.3" origin: "???" commit: "???" * git subrepo clone https://github.com/simonlindholm/decomp-permuter.git tools/decomp-permuter subrepo: subdir: "tools/decomp-permuter" merged: "1e4b85a7" upstream: origin: "https://github.com/simonlindholm/decomp-permuter.git" branch: "main" commit: "1e4b85a7" git-subrepo: version: "0.4.3" origin: "???" commit: "???" * Remove asm-differ * git subrepo clone https://github.com/simonlindholm/asm-differ.git tools/asm-differ subrepo: subdir: "tools/asm-differ" merged: "eaf72269" upstream: origin: "https://github.com/simonlindholm/asm-differ.git" branch: "master" commit: "eaf72269" git-subrepo: version: "0.4.3" origin: "???" commit: "???" * remove asm-processor * git subrepo clone https://github.com/simonlindholm/asm-processor.git tools/asm-processor subrepo: subdir: "tools/asm-processor" merged: "85288fcd" upstream: origin: "https://github.com/simonlindholm/asm-processor.git" branch: "master" commit: "85288fcd" git-subrepo: version: "0.4.3" origin: "???" commit: "???" * remove .gitmodules file * Update REAMDE * Update warnings
2021-05-30Adds a REVIEWING.md documentation file (#160)Kenix3
* Adds a first pass of REVIEWING.md * Update REVIEWING.md * Clarifies better what files can be in the header. * More clarity on how to resolve jenkins build errors. * Adds a link to the Code Review Guidelines to README.md * Adds code review guidelines link to contributing.md * Clarifies trello procedures. * Adds warning that NON_MATCHING equivalence isn't reviewed for yet.
2021-05-20CONTRIBUTING.md (#157)Zach Banks
* Draft CONTRIBUTING.md * Expand PR process; mention KZ * More TODO * Add notes about documenting * Address (most) PR comments * Finish responding to PR comments; add PR template * Fix grammar * Add missing periods. More actor examples. Remove ref to booleans * Add note about `NON_EQUIVALENT`; bold asset warning * Condense PR template * PR feedback from Kenix; Condense PR template * Incorporate Thar0's feedback
2021-05-18QOL addtions to the readme (#104)Parker Burnett
* adding changes to the README * adding in progress shield adding in the shield icon to show percentage complete * updating the files, added gitignore for ctx.c * fixing the typos * fixing things to hopefully build now
2020-04-18Move installation to wiki and update readmeRozelette
2020-01-25Fix various errors in READMErozlette
2020-01-23Use 'decompilation' in READMErozlette
2019-12-15Add README.md. Minor makefile cleanup.rozlette