summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2026-07-18Document `EnTest3` (#1881)Jordan Longstaff
* Document `EnTest3` * Add comments for enum-type fields * Add scheduled action index comments Co-authored-by: Copilot <copilot@github.com> * Use enums in comparisons * Rename `sp3C` * Rewrite comments on speak data Co-authored-by: Copilot <copilot@github.com> * Reformat * Missed a text comment * Missed another text comment --------- Co-authored-by: Copilot <copilot@github.com>
2026-03-09Soundfont Compiler: Implement fine-tuning in the final tuning calculation ↵Tharo
(#1863)
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-02-21Remove asm-processor in favor of preprocess.sh (#1760)Derek Hensley
* Remove asm-processor in favor of preprocess.sh * Remove duplicate CMD_F * preprocess_pragmas gitignore * Mac fixes * Macos + clang as cc check fixes * Need quotes for paths with spaces * Fix bss
2025-01-29Fix /bin/bash -> /usr/bin/env bash (#1793)Sirius902
2025-01-12Download IDO recomp instead of commiting binaries (#1781)Derek Hensley
* download ido * silence curl
2024-12-13[Audio 9/9] Loose ends (#1755)Tharo
* [Audio 9/9] Loose ends * Fix sampleconv memset bug * Doc updates from oot
2024-12-13Remove THIS macro (#1756)Tom Overton
* Remove THIS macro * Revert changes to the documentation * Undo revert to STYLE.md
2024-11-07libu64 (#1705)Dragorn421
* libu64 * libu64 -O2 * Add libu64.md
2024-10-23Further Attention Docs (#1732)engineer124
* more attention docs * more docs * cleanup * more cleanup * spacing * more attention docs * small cleanup * consistency
2024-10-22Update vscode doc (#1734)Derek Hensley
2024-10-22Cleanup gSPMatrix, rename `Matrix_New` -> `Matrix_Finalize`, add ↵engineer124
MATRIX_FINALIZE_AND_LOAD (#1729) * mtx-finalize * cleanup gSPMatrix
2024-10-20Target -> Attention (System Rename) Part 2 (#1721)engineer124
* remaining attention rename * cleanup
2024-10-18Sync Colliders Final (#1718)Derek Hensley
* ElementDamageInfoAT * ElementDamageInfoAC * colMaterial * elemMaterial
2024-10-14Player "Hostile" Docs (#1706)engineer124
* actor flag hostile * player hostile
2024-09-16Update links (#1690)Derek Hensley
2024-09-10Remove assets from automatic includes (#1683)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-06-14Msgevent OK (#1637)Derek Hensley
* Decompiled, some commands still unnamed * Use full weekevent reg names * Fix func_8094E69C * Fix Player_GetMask * Eventinf, mask worn, and item action argument formatting * decimal rupees * Times (day, hours, minutes) as decimal * msgEventScriptPos * Callbacks * Name final commands * Enum * Arrays * functions * Small cleanups * Clean up actors * Remove event from some variable names to make them shorter * Some more function renames * newline * Missed a few unks in commands * Update functions.txt * PlayerMask * MSGMODE_PAUSED * Script time macros * EnSob1_GetWelcome default * Whole bunch of renames * Format * Add CMD to commands * Update code_functions * structs for size * z64scripts.h * MsgEventCallback -> MsgScriptCallback * format * MsgEvent_RunScript stop * Remove cmd handler comment * cmd -> script in MsgEvent_RunScript --------- Co-authored-by: Thar0 <17233964+Thar0@users.noreply.github.com>
2024-06-03More General Cleanup (#1638)Derek Hensley
* LINKER_FILES in makefile * COLPOLY_GET_NORMAL * math header * libc * M_PI for cosf and sinf files * MAXFLOAT * Revert "MAXFLOAT" This reverts commit 96b75ffaa89b1a4ca1c08278b28bc3c70224701a. * Remove SHT_MINV * SHRT_MAX * Add M_PI * Angle macros * f suffix * Format
2024-06-01Even more general cleanup (#1640)Derek Hensley
* floats * obj_lightblock externs * Couple more floats * slime floats * undefined_syms * Move some tools to the tools folder * format * Update src/overlays/actors/ovl_Bg_Dblue_Waterfall/z_bg_dblue_waterfall.c Co-authored-by: Anghelo Carvajal <angheloalf95@gmail.com> --------- Co-authored-by: Anghelo Carvajal <angheloalf95@gmail.com>
2024-04-20Remove tailing comma from vscode json file (#1613)Derek Hensley
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
2024-02-01A higher level language for schedule scripts (#1462)Anghelo Carvajal
* schedule script * start something * tokenize * make a tree * start to emit macros * start to handle args * handle branch targets * cleanup a bit * script to convert the current schedule scripts to the new language * Add schedule compilation to Makefile * Fix bug on compiler if the script doesn't have an extra empty line * Allow to have `else`s without braces * convert a lot of schedules * door * en_tk * fix some checks being the wrong way around * borkens * door borken schedules * kafei schedule * postman schedule * Implement `if_since_time_*` command * Allow `if`s to not have an `else` * Implement some debugging options * fix another one from door * D_808675D0 * door D_8086775C * don't print else if there isn't one * start supporting labels * rewrite comment handling * add branch support * emit debugging information * postman and one door * the remaining scripts * add tokens for the non _s/_l versions * meh * Add built schedules * Remove _s/_l suffixes from almost every command * TokenProperties * Move macros and length into TokenProperties * move short and long to TokenType * rename member * some cleanups * fatalError * Write various notes on the compiler * more errors and comments * debug flags * Move the built schedules to the build folder * manually cleanup control flow of many schedule scripts * cleanup postman schedule * start write up * write more stuff * write a little more * Start writing about the commands * 2 more commands * more * almost everything, except returns * hopefully finish documenting the commands * cleanup * formal grammar * Table of contents * typo * Rename schc.py * remove todo * Warn if a if_before_time/if_since_time is negated * Add colors to warnings and errors * delete rebuild schedules script * version * Apply suggestions from code review Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * suggestions on md file * compiler review * invented is invented * ScheduleScript typedef * fix * Convert Anju's schedule to the new format * simplify anju's schedule * forgot to remove `_s`/`_l` * bss * Rework schc to allow multiple scripts per file * Migrate all the schedules to the new format * update language specification * Update docs/schedule_scripting_language.md Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com> * Update docs/schedule_scripting_language.md Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com> --------- Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
2023-11-21Document `Actor_TalkOfferAccepted` (#1502)engineer124
* rename * PR Review
2023-10-27Remove `(ActorFunc)` cast on `InitVars` (#1148)Anghelo Carvajal
* Remove ActorFunc cast * Format * Revert "Format" This reverts commit a6e89b39692c22cfae26c8aa3a8fe288ccd61c32. * Messing with formatting * format header a bit * Revert "Messing with formatting" This reverts commit c8db520278d7730a83e3fbc460ebe87929c16928. * comment * format * more comments * format * format * format * properly format
2023-10-08Object Name Cleanup (#1427)engineer124
2023-09-22master to main rename (#1379)Derek Hensley
* master -> main * Missed some instances of master
2023-09-14Docs namefixer (#1378)Derek Hensley
2023-09-02Documentation pass for the Target system (#1281)Anghelo Carvajal
* cleanup * import bss * sActorHiliteMtx * some cleanups on func_800BB604 * Actor_IsInTargetableRange * rematch func_800BB604 Co-authored-by: engineer124 <engineer124engineer124@gmail.com> * Name ACTOR_FLAG_UNFRIENDLY and ACTOR_FLAG_FRIENDLY * Rename some Target_ functions * cleanusp * TargetMode enum * Target_800B82EC * sNaming * more * more naming * fairyHintPos * rotation * ACTOR_FLAG_TARGETABLE * update namefixer * remove trailing comma * bss * Wall of text for Target_800BB604 * function naming * cleanups * Target_GetAdjustedDistSq * NotLeash * more comments * minor comment * review * fix * rotZTick * review * name last members * fix * review * review * more namefixer * swap members * comment * Update src/code/z_actor.c Co-authored-by: Derek Hensley <hensley.derek58@gmail.com> * Update src/code/z_actor.c Co-authored-by: Derek Hensley <hensley.derek58@gmail.com> * review * format * Update src/code/z_actor.c Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com> * Update include/z64actor.h Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com> * review * review * fix * fix --------- Co-authored-by: engineer124 <engineer124engineer124@gmail.com> Co-authored-by: Derek Hensley <hensley.derek58@gmail.com> Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
2023-07-29Remove plural "Limbs" from object decomp example (#1344)Tom Overton
* Remove plural "Limbs" from object decomp example * Missed one
2023-07-27Clang-Format 14 (#1321)Derek Hensley
* format * Update dockerfile and other documentation * Update mac instructions
2023-06-20Audio Sfx Functions Decompiled and Documented (code_8019AF00.c) (#1242)engineer124
* sfx decomp and docs * function headers * namefixer * oops * better sfx name * PR review * namefixer * PR review * float * namefixer * namefixer * namefixer * PR Suggestions
2023-06-15Update link (#1291)Derek Hensley
2023-05-28z_rcp.c setupDL docs/cleanup (#1253)engineer124
* SetupDL enum * name functions * namefixer * cleanup * small cleanup * PR Review * don't need address of array * PR Suggestion
2023-04-18Add `SaveInfo` substruct to `SaveContext` (#1191)Anghelo Carvajal
* SaveInfo * fix accesses in sram_NES.c * some more fixing * more fixes * format * fix unk * namefixer * format * bss * review * weekeventregconvert * namefixer * bss
2023-03-31Update documentation to use updated Z64Utils release + updated directions ↵Tom Overton
(#1223)
2023-03-16Document z_en_time_tag (#1140)engineer124
* time-tag docs * simplify enums * PR Reviews * PR Suggestions * small change * small fix * PR Suggestions * add extra func ref * rm raw text from first actor I decompiled * Stock Pot Inn * fix master merge
2023-03-09`z_actor` documentation pass (#1154)Anghelo Carvajal
* ActorContext_unk_1F4 * a * ACTOR_FLAG_IGNORE_QUAKE * ACTOR_FLAG_TALK_REQUESTED and ACTOR_FLAG_CANT_LOCK_ON * actorCtx->unkC => ctorCtx->halfDaysBit * HALFDAYBIT defines * actor.halfDaysBits * format * Actor_InitHalfDaysBit * Name actor-killing functions * cleanup variables.h a bit * DAWN * bss * Actor_RequestRumble and Actor_GetArrowDmgFlags * name vars of func_800BC620 * format * fix missing PLAYER_IA * Actor_OfferGetItem * Actor_SetClosestSecretDistance * freezeCategoryPlayerFlags1 Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * DROPFLAG_ * a * COLORFILTER * format * sCategoryFreezeMasks * Actor_OfferCarry * review Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * change hex to dec * COLORFILTER_INTENSITY_FLAG * format * review Co-authored-by: Derek Hensley <hensley.derek58@gmail.com> * shiftedHalfDaysBit Co-authored-by: Derek Hensley <hensley.derek58@gmail.com> * cleanup * Undo Actor_RequestRumble * Undo ACTOR_FLAG_IGNORE_QUAKE * format * Remove COLORFILTER_GET_BUFFLAG * Undo Actor_KillAllFromUnloadedRooms * format * Update Actor_OfferGetItem comment * Update Actor_OfferGetItem description * diving * bss * namefixer * format * speed * review --------- Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>
2023-03-08Rename `GameInfo` to `RegEditor` (#1178)Anghelo Carvajal
* Rename RegEditor and move it to regs.h * bring over some minor doc from oot * add missing include * Update tools/disasm/variables.txt Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com> * update comment * bss --------- Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
2023-03-03speedXZ -> speed (#1186)engineer124
* speedXZ to speed * brackets
2023-02-07Fix Website 404 and Format script error message (#1161)Derek Hensley
* Fix Website 404 * format script fix
2022-10-16Introduce `actor_table.h` (#985)Anghelo Carvajal
* Make actor_table.h * DECLARE_OVERLAY_SEGMENT * InitVars * Remove InitVars from actor headers * format * Use table for ActorID enum * Move segment symbols declarations back to segment_symbols.h * add newline to actor_table.h * Add effects back to segnt_symbols.h * Update include/tables/actor_table.h Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com> * Update src/overlays/actors/ovl_Shot_Sun/z_shot_sun.h Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com> * name unused parameters Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com> * format * Revert "name unused parameters" This reverts commit 14fe63313a32b4779ccfb6cf71cb227542a3958f. * Remove `const` from InitVars * Add underscore to unused parameters * ActorID -> ActorId * bss * missing symbols and bss * lower diff a bit Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com> Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>
2022-10-15Replace `Actor_MarkForDeath` with `Actor_Kill` (#1118)Tom Overton
* Replace `Actor_MarkForDeath` with `Actor_Kill` * Replace if-else with early returns, as per hensldm's review * Respond to Elliptic's review * Redundant spelling
2022-10-05z_kaleido_map.c OK and Documented (Pause Menu Map Page) + related icon_item ↵engineer124
statics (dungeon/field/jpn) (#1094) * import pause menu map page * better owl-warp docs * fix func name * missed some owlwarps * fix merge from master * fix scene region code * PR Suggestions * add comment * add description of gWorldMapImageTex, thanks @EllipticEllipsis * clearup docs * missed a comma * bad formatter, drop comment * more cleanup
2022-10-04Format Script Update (#904)Derek Hensley
* Bring over format.sh and .clang-tidy and run it * Little fixes * Adjustments * Jenkins kick * Jenkins kick 2 * format * small fixes * Bring over new formatter by Roman Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com> * Force use of clang-11 * check_format * Update error messages * Fix from Tharo for python3.6 Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com> * Just use nproc to determine num jobs for check format * Update error message * AnimatedMat_DrawStepOpa texture arg -> matAnim * Fix enTwig draw prototype * Tidying up * Bring over fixes in OoT #1387 Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com> * Fix * Update doc tools * PR Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com> Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
2022-09-27z_kaleido_item.c Ok and Documented (Pause Menu Item Page) (#1027)engineer124
* import wip from kaleido * small cleanup * add for-loop comments * pr review 1 * spacing * Update src/overlays/kaleido_scope/ovl_kaleido_scope/z_kaleido_item.c Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com> Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>
2022-08-15Make names related to animations more consistent (#998)Tom Overton
* Make names related to animations more consistent * Standardize on sAnimationInfo * Respond to hensldm's review * Standardize on ChangeAnim * Respond to hensldm's review * Small formatting thing * Consistency after merging master * A few more things I missed * Respond to Elliptic's review * Some more stuff that was requested
2022-07-12`z_parameter`: Items & Import Data (#799)engineer124
* Import Data * More functions * cleanup * Add Enum * Many changes, PR and add-ons * Fix bss * Better data * Extra space * DoubleDefense is boolean * Missed a macro * More enums missed * macro -> enum * More item cleanup... * missing/wrong quest items * Next PR Review * Revert Interface_AddMagic to Parameter_AddMagic * Remove QUEST_HEART_CONTAINER * Fix bss * Move Color_RGB16 up + fix incorrect numbers * Add texture pointers * Add comment * EQUIP_SLOT_A * rm redundant comment * Fix merge * PR Suggestions * fix bss
2022-07-11Adding Docker Support (#914)Parker Burnett
* Adding dockerfile and instructions for building * fixing readme and updating Dockerfile * Adding packages and practicerom support