summaryrefslogtreecommitdiff
path: root/include
AgeCommit message (Collapse)Author
2026-09-02z_scene Some comments and function names (#2808)djevangelia
* z_scene Some comments and function names * review changes * further fixing from comments * vromAddr --------- Co-authored-by: djevangelia <djevangelia>
2026-09-01Document an includes style, apply to z_demo.c and z_play.c (#2803)Dragorn421
* Document an includes style, apply to z_demo.c and z_play.c * "reverse" style includes * bss * clarify what a "main header" is * Update docs/includes.md Co-authored-by: Tharo <tharo10600@gmail.com> * Update docs/includes.md --------- Co-authored-by: Tharo <tharo10600@gmail.com>
2026-08-31Document pass on WaterBox code (#2695)mzxrules
* Document pass on WaterBox code * implement suggestions, missing comment --------- Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-08-31[cc0 oot] z_vis* (#2782)Dragorn421
* [cc0 oot] z_vis* * bss * docs * fixup * further vis docs * add FbFilterType enum * bss * gfxP
2026-08-31gActorSetupDls (#2802)Derek Hensley
* gActorSetupXluDL * gActorSetupOpaDL * ACTOR_SETUP_OPA_DL * BSS * Some more usages of ACTOR_SETUP_OPA_DL * docs --------- Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-08-31[cc0 oot] bowling things (#2793)Dragorn421
* [cc0 oot] bowling things * bowling fixups * bowling things cleanup
2026-08-31[cc0 oot] BgDyYoseizo (#2796)Dragorn421
* [cc0 oot] BgDyYoseizo * BgDyYoseizo small cleanup * bgdyyoseizo comment on D_80875440
2026-08-30Useful Eventchkinf flag renames (#2807)Olvivi
* Rename EVENTCHKINF 40, 45, 80, C7 * Rename EVENTCHKINF 40, 45, 80, C7 w format * updated save.h comment for accuracy Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> * Applied 'Zelda' to 'Zeldas' & 'Pulled' to 'Obtained' adjustments * EVENTCHKINF_INDEX_OBTAINED_ZELDA_LETTER -> EVENTCHKINF_INDEX_OBTAINED_ZELDAS_LETTER --------- Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-08-19Document z_eff_ss_stone1.[ch] (#2670)Gabriel Ravier
* Document z_eff_ss_stone1.[ch] * Incorporate feedback from PR review. From https://github.com/zeldaret/oot/pull/2670: - Shortened excessively verbose suppressRTransFadeFlashAlphaStepAfterTwoFrames name to suppressFadeFlash - Fixed up comment that went waaaaaay beyond the column limit in z_eff_ss_stone1.h - Shortened comparison with 0 of variable bool semantics in z_eff_ss_stone1.c Signed-off-by: Gabriel Ravier <gabravier@gmail.com> * Fix misnaming from PR review and document some more From https://github.com/zeldaret/oot/pull/2670: - shortenFadeFlash is incorrect - renamed to freezeFadeFlash - Used `false` instead of 0 in EnArrow_Fly - Elaborated comments about what exactly freezeFadeFlash does Also added a few extra comments to z_eff_ss_stone1.c * Ran clang-format * More feedback from PR review, clarified comment From https://github.com/zeldaret/oot/pull/2670: - Change 0 to false in header comment - Remove verbose speculation about former use of unused variable - Made comment on use of viewDepth clearer - Separated matrix and gfx code with a newline Signed-off-by: Gabriel Ravier <gabravier@gmail.com> * Marked the "1500" as being in units --------- Signed-off-by: Gabriel Ravier <gabravier@gmail.com>
2026-08-19Document `EnIn` (AKA the hard-working Ingo) (#2778)Jordan Longstaff
* Document `EnIn` (AKA the hard-working Ingo) * Fix variable references * Revert switch * Rename race outcome functions for clarity * Apply suggestions
2026-08-19[cc0 oot] kanji_tex (#2784)Dragorn421
* [cc0 oot] "kanread" * format * document kanji_tex * fixup
2026-08-05[cc0 oot] z_memory_utils (#2783)Dragorn421
* [cc0 oot] z_memory_utils * format * doc * MemCopy: The memory regions must not overlap.
2026-08-02[rsp] Introduce microcode build process, disassemble and build both rspboot ↵Tharo
versions (#2764) * [rsp] Introduce microcode build process, disassemble and build both rspboot versions * Suggested changes * Check-in tool for generating armips.cpp from upstream sources, regen armips.cpp against a newer commit * License armips_gen.py, add notice that armips.cpp is automatically generated * Qualify comment with X105 * Clarify the assumed purpose of rspboot releasing SP_SEMAPHORE
2026-05-27Document `EnSa` (#2744)Jordan Longstaff
* Document `EnSa` * Rename INFTABLE entries * Animation set -> group * Remove trailing commas * Rename textState field * Remove trailing comma * Rename EVENTCHKINF flag * Correct frowning/closed swap of enum * Rename INFTABLE flag
2026-05-06Child Ruto Actions Part 6: Sitting (#2623)Jordan Longstaff
* Child Ruto Actions Part 6: Sitting * Format * Enum indices in comments * Remove trailing whitespace * Rename room number fields * Rename to EnRu1_UpdateBgCheckInfo * Revert "Rename to EnRu1_UpdateBgCheckInfo" This reverts commit 7926cfeeca3e27166e7eeebc65d6d6832a6d9202. * Rename to UpdateBouncing * Rename INFTABLE flags * Rename to actorIter * Remove unneeded parentheses * Rectify comments in `EnRu1_UpdateSittingAction` * Reformat * Proposed name changes * Change comment * Multiple reversions
2026-05-06Document CIC6105 (#2739)Tharo
* Document CIC6105 * Changes, AUDIOMGR_DEBUG_LEVEL -> AUDIOMGR_ACTIVITY_LEVEL
2026-05-03Finish `EnDivingGame` documentation (#2733)Jordan Longstaff
* Finish `EnDivingGame` documentation * Rupee phase enum * Fix overlooked field rename * Shorten some field names for formatting * Reformat * Revert "unthrown Rupees" rename * Parenthesize textId conditions * Rename `GiveScale` functions * Rename `nextTextState` * Clang-format --------- Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-04-24`Item_DropCollectibleRandom`: params macro and drop tables enum (#2707)Dragorn421
* `Item_DropCollectibleRandom`: params macro and drop tables enum * fixup
2026-04-24Rename NoteSubEu -> NoteSampleState (#2738)Tharo
2026-04-16Macro-ify access to pauseCtx->playerSegment regions (#2693)Tharo
* Macro-ify access to pauseCtx->playerSegment regions. Using macros to indicate which region in the player segment is being accessed makes the memory layout more obvious and indicates the intended level of memory ownership, particularly in the case of the texture image at the start of the segment. * Add clarifications for gameplay_keep details * Uniform macro name for the render texture * Comment
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-21Comment more original names for audio functions from animal crossing (#2721)Tharo
* Comment more original names for audio functions from animal crossing * Drop delayparam, not original
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-26Finish `EnMThunder` documentation (#2702)Jordan Longstaff
* Finish `EnMThunder` documentation * Boolean conversion * Hex to decimal conversions * Rename static variables
2026-02-22Fix F3DEX2 ucode name on N64 versions (not PosLight) (#2701)Dragorn421
* Fix F3DEX2 ucode name on N64 versions (not PosLight) * put the not-PosLight / PosLight differences under F3DEX_GBI_PL * revert bss changes
2026-02-22Fix misc 23 (#2699)Dragorn421
* remove noop macros Fault_SetFontColor Fault_SetCharPad under PLATFORM_N64 * remove duplicate declarations in sfx.h * use render mode presets more * decimal for alpha values * fix some z_camera comments typos * fix references to preprocess.sh (used to be preprocess.py) * remove outdated comment on deps in makefile * code_800AD920 was renamed to z_viszbuf * fix capitalization typo: gOcarinaofTimeDesignTex -> gOcarinaOfTimeDesignTex * fix typo: gLinkAdultEyesClosedfTex, gLinkChildEyesClosedfTex -> remove extra f * fix typo: gCrstalSwitchRedTex, gCrstalSwitchBlueTex -> gCrystal * fix PARAMS_GET_U amount of bits
2026-02-22Child Ruto Actions Part 5: Speakable (#2619)Jordan Longstaff
* Child Ruto Actions Part 5: Speakable * Rename to "Speakable Jabu"
2026-02-21Document src/n64dd/n64dd_error_headers.c (#2667)Gabriel Ravier
* Document src/n64dd/n64dd_error_headers.c * Incorporate feedback from PR review. (see also https://github.com/zeldaret/oot/pull/2667) * Put translation of gN64DDLocalizedErrorNumberHeaders[0] in a line comment (From feedback to https://github.com/zeldaret/oot/pull/2667)
2026-02-21Child Ruto Actions Part 4: Sapphire platform (#2618)Jordan Longstaff
* Child Ruto Actions Part 4: Sapphire platform * One more function rename
2026-02-18Document sys_freeze.[ch] (#2666)Gabriel Ravier
2026-02-15Fix wrong BGM entry names (#2671)Jordan Longstaff
2025-11-20Document N64DD data buffer (#2665)Gabriel Ravier
2025-07-15Add `ENV_LIGHT_SETTINGS_BLEND_RATE_AND_FOG_NEAR_PACK`, fix extracted ↵Dragorn421
negative `blendRate` (#2653) * Add ENV_LIGHT_SETTINGS_BLEND_RATE_AND_FOG_NEAR_PACK, fix extracted negative blendRate * -> BLEND_RATE_AND_FOG_NEAR
2025-07-15Finish rename scene lists (#2652)Dragorn421
2025-07-15Pause docs: UIOverlay L/R buttons details (#2650)Dragorn421
2025-07-03Child Ruto Actions Part 2: First encounter (#2601)Jordan Longstaff
* Child Ruto Actions Part 2: First encounter * Rename action enum entries * Rename to Sfx * Rename "first encounter" to "meeting"
2025-06-28Cleanup extracted colliders 3: Use `HIT_SPECIAL_EFFECT_`, `HIT_BACKLASH_` ↵Dragorn421
names (#2646) * Cleanup extracted colliders 3: Use `HIT_SPECIAL_EFFECT_`, `HIT_BACKLASH_` names * revert removing FLARE_DANCER_BODY_DMG (oops)
2025-06-28Pause docs: UIOverlay quads dimensions (#2644)Dragorn421
2025-06-27Reevaluate player hit response names (#2640)Dragorn421
* PlayerHitResponseType * PLAYER_HIT_RESPONSE_ICE_TRAP -> FROZEN * PLAYER_KNOCKBACK_LARGE_SHOCK, PLAYER_HIT_RESPONSE_ELECTRIC_SHOCK -> PLAYER_KNOCKBACK_LARGE_ELECTRIFIED, PLAYER_HIT_RESPONSE_ELECTRIFIED * damageResponseType -> hitResponseType
2025-06-26`Camera_KeepOn4` docs 2: RO and RW data (#2632)Dragorn421
* `Camera_KeepOn4` docs 2: RO and RW data * fix unk_14 rename * CAM_DATA_UNK_22 -> CAM_DATA_INIT_TIMER
2025-06-25Pause docs: "uiOverlay" quads (renamed from "InfoPanel") (#2635)Dragorn421
* Pause docs: "InfoPanel" quads * bss * rename infoPanelVtx to decorVtx * rename to uiOverlayVtx / UI_OVERLAY_QUAD_ * fixup
2025-06-22Name `HIT_BACKLASH_` and `HIT_SPECIAL_EFFECT_` values (#2639)Dragorn421
* Name HIT_BACKLASH_ and HIT_SPECIAL_EFFECT_ values * SHOCK -> ELECTRIC
2025-06-20Rename AT `effect` to `hitSpecialEffect` (#2637)Dragorn421
* Rename AT `effect` to `hitSpecialEffect` * bss
2025-06-17Document `Save.cutsceneIndex` and adjacent data / code (#2286)Leonid Kapitonov
* introduce `enum CutsceneIndex` as a first step * crudely rename `enum CutsceneIndex` entries * run `check_format.py ...` separetely so that it doesn't clutter previous commit. still, allowing `clangd LSP` to run format-on-save yields inconsistent results for me with the project's tooling, especially for header files * apply a draft PR suggestion Co-authored-by: mzxrules <mzxrules@gmail.com> * rename `CS_INDEX_*` with PR suggestions and some additional observations reverified with > `check_format.py ...` > `make ...` additionally: - current clang-format lacks a rule for trailing commas - compiler says about them `cfe: Warning 624` * improve `CS_INDEX_*` naming, rem `ENTRANCE` suffix https://github.com/zeldaret/oot/pull/2286#discussion_r1829165205 reverified with > `check_format.py ...` > `make ...` * apply Jenkins fixes https://jenkins.deco.mp/job/OOT/job/PR-2286/4/console hmm, i do need this automation locally to * apply a PR suggestion https://github.com/zeldaret/oot/pull/2286#discussion_r1829219841 * remove redundant comments, fix the header comment and add a comment chunk from https://github.com/zeldaret/oot/pull/2286#discussion_r1829108940 * rename the flag for freeing `nextCutsceneIndex` * rename the flag for automatic `sceneLayer` calc it gets assigned to the `nextCutsceneIndex`, so `CS_INDEX_NONE` name was misleading * use explicit scene layer names instead of numbers * ok, now the last two `CS_INDEX_*` are less unknown the purpose of `CS_INDEX_BARRIER` is not quite clear still * apply Jenkins fixes https://jenkins.deco.mp/job/OOT/job/PR-2286/14/console * run `fix_bss` locally `ntsc-1.2` refused to comply though * revert all local to the branch bss shifts * ugh, use defines instead of an enum probably size of enum entries doesn't match well? originally these were just numbers. besides, not like it's a real enumeration from zero to a value or some bit flags * still, add a BSS pragma for `z_demo.c` * apply review changes * factor out a cutscene layer formula * give scene layers names throughout code * apply Jenkins fixes https://jenkins.deco.mp/job/OOT/job/PR-2286/32/console * tweak `CS_INDEX` descriptions * apply PR review suggestions * rename "auto" -> "default" * apply PR review suggestions https://github.com/zeldaret/oot/pull/2286#discussion_r1868693980 essentially reverts 106cb1021be88f745ee303838c11c7d7cbf9c79d, except for 2 generic `z_scene.c` lines * apply Jenkins fixes https://jenkins.deco.mp/job/OOT/job/PR-2286/77/console * Apply suggestions from code review Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> Co-authored-by: mzxrules <mzxrules@gmail.com> * apply Jenkins fixes https://jenkins.deco.mp/job/OOT/job/PR-2286/175/console * Move CS_INDEX_* macros to z64save.h, with the definition of gSaveContext.save.cutsceneIndex * `#define CS_INDEX_D 0xFFFD` and co. Co-authored-by: cadmic <cadmic24@gmail.com> * add comment on CS_INDEX_D * review * CS_INDEX_NONE is back * bss * expand comment about 0xFFFD * fix comment about 0xFFFF usage * review --------- Co-authored-by: mzxrules <mzxrules@gmail.com> Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com> Co-authored-by: cadmic <cadmic24@gmail.com>
2025-06-17fixup rename hitBacklash (#2638)Dragorn421
2025-06-17Rename `acDmgInfo.effect` -> `hitBacklash` (#2555)Dragorn421
* CollisionCheckInfo.atHitEffect -> atHitBacklash * ColliderElementDamageInfoAC.effect -> hitBacklash * add HIT_BACKLASH_ enum * bss * bss * bss * bss * bss * Update comments
2025-06-15Macroify PlaySfxGeneral calls: introduce `SFX_PLAY_CENTERED` and ↵Dragorn421
`SFX_PLAY_AT_POS` (#2633) * Add `SFX_PLAY_CENTERED` * Add `SFX_PLAY_AT_POS`
2025-06-10Introduce `CAM_DATA_SET_`, `CAM_ITEM_TYPE_` and name ↵Dragorn421
`Player_SetTurnAroundCamera`, `Player_RequestCameraSetting` (#2608) * Introduce `CAM_SET_CAMERA_DATA_`, `CAM_ITEM_TYPE_` and name `Player_CameraChangeSettingTurnAround` * bss and formatting * func_80835E44 -> Player_RequestCameraSetting * -> Player_SetTurnAroundCamera * -> CAM_DATA_SET_
2025-06-07`WeaponInfo` docs (#1596)Dragorn421
* WeaponInfo docs * format * disasm metadata * merge fixup * Add MELEE_WEAPON_INFO_TIP and _BASE * format * Offset
2025-06-07Commit `do_action_static` (#2597)Dragorn421
* Commit `do_action_static` * fix * rm do_action_static from write_source.txt